ilLMExplorer Class Reference

Inheritance diagram for ilLMExplorer:

Collaboration diagram for ilLMExplorer:

Public Member Functions
	ilLMExplorer ($a_target, $a_lm_obj, $a_lang="-")
	Constructor public.
	formatHeader (&$tpl, $a_obj_id, $a_option)
	overwritten method from base class public
	isClickable ($a_type, $a_obj_id=0)
	check if links for certain object type are activated
Public Member Functions inherited from ilExplorer
	ilExplorer ($a_target)
	Constructor public.
	setId ($a_val)
	Set id.
	getId ()
	Get id.
	setAsynchExpanding ($a_val)
	Set asynch expanding.
	getAsynchExpanding ()
	Get asynch expanding.
	initItemCounter ($a_number)
	Init item counter.
	setTitle ($a_val)
	Set title.
	setTitleLength ($a_length)
	Set max title length.
	getTitleLength ()
	Get max title length.
	getTitle ()
	Get title.
	setRoot ($a_root_id)
	Set root node.
	getRoot ()
	get root id
	setOrderColumn ($a_column)
	set the order column public
	setOrderDirection ($a_direction)
	set the order direction public
	setTargetGet ($a_target_get)
	set the varname in Get-string public
	setParamsGet ($a_params_get)
	set additional params to be passed in Get-string public
	setExpandTarget ($a_exp_target)
	target script for expand icons
	setFrameUpdater ($a_up_frame, $a_up_script, $a_params="")
	Set Explorer Updater.
	highlightNode ($a_id)
	set highlighted node
	checkPermissions ($a_check)
	check permissions via rbac
	setSessionExpandVariable ($a_var_name="expand")
	set name of expand session variable
	outputIcons ($a_icons)
	output icons
	setClickable ($a_type, $a_clickable)
	(de-)activates links for a certain object type
	isVisible ($a_ref_id, $a_type)
	setTreeLead ($a_val)
	Set tree leading content.
	getTreeLead ()
	Get tree leading content.
	setPostSort ($a_sort)
	process post sorting
	setFilterMode ($a_mode=IL_FM_NEGATIVE)
	set filter mode
	getFilterMode ()
	get filter mode
	setUseStandardFrame ($a_val)
	Set use standard frame.
	getUseStandardFrame ()
	Get use standard explorer frame.
	getChildsOfNode ($a_parent_id)
	Get childs of node.
	setOutput ($a_parent_id, $a_depth=1, $a_obj_id=0, $a_highlighted_subtree=false)
	Creates output for explorer view in admin menue recursive method public.
	modifyChilds ($a_parent_id, $a_objects)
	showChilds ($a_parent_id)
	determines wether the childs of an object should be shown or not note: this standard implementation always returns true but it could be overwritten by derived classes (e.g.
	forceExpanded ($a_obj_id)
	force expansion of node
	getMaximumTreeDepth ()
	Get maximum tree depth.
	getOutput ()
	Creates output recursive method public.
	handleListEndTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list end tags ( and )
	handleListStartTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list start tags (
	formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
	Creates output recursive method private.
	getImage ($a_name, $a_type="", $a_obj_id="")
	get image path (may be overwritten by derived classes)
	getImageAlt ($a_default_text, $a_type="", $a_obj_id="")
	get image alt text
	getNodeStyleClass ($a_id, $a_type)
	get style class for node
	buildLinkTarget ($a_node_id, $a_type)
	get link target (may be overwritten by derived classes)
	buildOnClick ($a_node_id, $a_type, $a_title)
	get onclick event handling (may be overwritten by derived classes)
	buildTitle ($a_title, $a_id, $a_type)
	standard implementation for title, may be overwritten by derived classes
	buildDescription ($a_desc, $a_id, $a_type)
	standard implementation for description, may be overwritten by derived classes
	buildSelect ($a_node_id, $a_type)
	standard implementation for adding an option select box between image and title
	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	get frame target (may be overwritten by derived classes)
	createTarget ($a_type, $a_node_id, $a_highlighted_subtree=false, $a_append_anch=true)
	Creates Get Parameter private.
	setFrameTarget ($a_target)
	set target frame or not frame?
	createLines ($a_depth)
	Creates lines for explorer view private.
	is_in_array ($a_start, $a_depth)
	DESCRIPTION MISSING private.
	getIndex ($a_data)
	get index of format_options array from specific ref_id,parent_id private
	addFilter ($a_item)
	adds item to the filter public
	delFilter ($a_item)
	removes item from the filter public
	setExpand ($a_node_id)
	set the expand option this value is stored in a SESSION variable to save it different view (lo view, frm view,...) private
	forceExpandAll ($a_mode, $a_show_minus=true)
	force expandAll.
	setFiltered ($a_bool)
	active/deactivate the filter public
	checkFilter ($a_item)
	check if item is in filter private
	sortNodes ($a_nodes, $a_parent_obj_id)
	sort nodes and put adm object to the end of sorted array private

Data Fields
	$root_id
	$lm_obj
	$output
Data Fields inherited from ilExplorer
	$id
	$ilias
	$output
	$format_options
	$tree
	$target
	$target_get
	$params_get
	$expanded
	$order_column
	$order_direction = "asc"
	$expand_target
	$rbac_check
	$output_icons
	$expand_variable
	$is_clickable
	$post_sort
	$filtered = false
	$filter_mode
	$expand_all = false
	$root_id = null
	$use_standard_frame = false

Protected Member Functions
	checkLPIcon ($a_id)

Protected Attributes
	$lp_cache

Detailed Description

Definition at line 15 of file class.ilLMExplorer.php.

Member Function Documentation

ilLMExplorer::checkLPIcon (   $a_id )

protected

Definition at line 107 of file class.ilLMExplorer.php.

References $ilUser, ilLPStatusFactory\_getClassById(), ilLearningProgressBaseGUI\_getImagePathForStatus(), ilLearningProgressAccess\checkAccess(), ilObjectLP\getInstance(), ilLPObjSettings\LP_MODE_COLLECTION_MANUAL, ilLPObjSettings\LP_MODE_COLLECTION_TLT, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

Referenced by ilLMTOCExplorer\getImage(), and ilTableOfContentsExplorer\getImage().

        {
                global $ilUser;
                                                
                // do it once for all chapters
                if($this->lp_cache[$this->lm_obj->getId()] === null)
                {                               
                        $this->lp_cache[$this->lm_obj->getId()] = false;

                        include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
                        if(ilLearningProgressAccess::checkAccess($this->lm_obj->getRefId()))
                        {                       
                                $info = null;
                                
                                include_once './Services/Object/classes/class.ilObjectLP.php';                  
                                $olp = ilObjectLP::getInstance($this->lm_obj->getId()); 
                                if($olp->getCurrentMode() == ilLPObjSettings::LP_MODE_COLLECTION_MANUAL ||
                                        $olp->getCurrentMode() == ilLPObjSettings::LP_MODE_COLLECTION_TLT)
                                {                                                                       
                                        include_once "Services/Tracking/classes/class.ilLPStatusFactory.php";
                                        $class = ilLPStatusFactory::_getClassById($this->lm_obj->getId(), $olp->getCurrentMode());                                      
                                        $info = $class::_getStatusInfo($this->lm_obj->getId());                                                         
                                }
                                
                                // parse collection items
                                if(is_array($info["items"]))
                                {
                                        foreach($info["items"] as $item_id)
                                        {
                                                $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
                                                if(is_array($info["in_progress"][$item_id]) && 
                                                        in_array($ilUser->getId(), $info["in_progress"][$item_id]))
                                                {
                                                        $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
                                                }
                                                else if(is_array($info["completed"][$item_id]) && 
                                                        in_array($ilUser->getId(), $info["completed"][$item_id]))
                                                {
                                                        $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
                                                }
                                                $this->lp_cache[$this->lm_obj->getId()][$item_id] =$status;
                                        }
                                }                                               
                        }               

                        include_once './Services/Tracking/classes/class.ilLearningProgressBaseGUI.php';
                }               

                if(is_array($this->lp_cache[$this->lm_obj->getId()]) &&
                        isset($this->lp_cache[$this->lm_obj->getId()][$a_id]))
                {
                        return ilLearningProgressBaseGUI::_getImagePathForStatus($this->lp_cache[$this->lm_obj->getId()][$a_id]);                                       
                }                               
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLMExplorer::formatHeader	(	&	$tpl,
			$a_obj_id,
			$a_option
	)

overwritten method from base class public

Parameters

integer	obj_id
integer	array options

Returns

string

Reimplemented from ilExplorer.

Definition at line 58 of file class.ilLMExplorer.php.

References ilExplorer\$ilias, $lng, $tpl, ilExplorer\buildLinkTarget(), ilUtil\getImagePath(), and ilUtil\shortenText().

        {
                global $lng, $ilias;
                
                $tpl->setCurrentBlock("icon");
                $tpl->setVariable("ICON_IMAGE" , ilUtil::getImagePath("icon_lm_s.png",false, "output", $this->offlineMode()));
                $tpl->setVariable("TXT_ALT_IMG", $lng->txt("obj_".$this->lm_obj->getType()));
                $tpl->parseCurrentBlock();

                $tpl->setCurrentBlock("link");
                $tpl->setVariable("TITLE", ilUtil::shortenText($this->lm_obj->getTitle(), $this->textwidth, true));
                $tpl->setVariable("LINK_TARGET", $this->buildLinkTarget("",""));
                $tpl->setVariable("TARGET", " target=\"".$this->frame_target."\"");
                $tpl->parseCurrentBlock();
                
                $tpl->touchBlock("element");
        }

Here is the call graph for this function:

ilLMExplorer::ilLMExplorer	(		$a_target,
			$a_lm_obj,
			$a_lang = "-"
	)

Constructor public.

Parameters

string	scriptname
int	user_id

Definition at line 35 of file class.ilLMExplorer.php.

References ilExplorer\checkPermissions(), ilExplorer\ilExplorer(), ilExplorer\setPostSort(), ilExplorer\setSessionExpandVariable(), and ilTree\setTableNames().

Referenced by ilLMTOCExplorer\ilLMTOCExplorer(), ilPublicSectionSelector\ilPublicSectionSelector(), and ilTableOfContentsExplorer\ilTableOfContentsExplorer().

        {
                parent::ilExplorer($a_target);
                $this->lang = $a_lang;
                $this->tree = new ilTree($a_lm_obj->getId());
                $this->tree->setTableNames('lm_tree','lm_data');
                $this->tree->setTreeTablePK("lm_id");
                $this->root_id = $this->tree->readRootId();
                $this->lm_obj =& $a_lm_obj;
                $this->order_column = "";
                $this->setSessionExpandVariable("lmexpand");
                $this->checkPermissions(false);
                $this->setPostSort(false);
                $this->textwidth = 200;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLMExplorer::isClickable	(		$a_type,
			$a_obj_id = 0
	)

check if links for certain object type are activated

Parameters

string

$a_type

object type

Returns

boolean true if linking is activated

Reimplemented from ilExplorer.

Reimplemented in ilTableOfContentsExplorer, ilLMTOCExplorer, and ilShopPublicSectionSelector.

Definition at line 83 of file class.ilLMExplorer.php.

References $ilUser, ilLMObject\_isPagePublic(), and ilPaymentObject\_requiresPurchaseToAccess().

        {
                global $ilUser;
                // in this standard implementation
                // only the type determines, wether an object should be clickable or not
                // but this method can be overwritten and make use of the ref id
                // (this happens e.g. in class ilRepositoryExplorerGUI)
                if ($this->is_clickable[$a_type] == "n")
                {
                        return false;
                }

                // check public access
                include_once 'Services/Payment/classes/class.ilPaymentObject.php';
                if (($ilUser->getId() == ANONYMOUS_USER_ID || 
                        ilPaymentObject::_requiresPurchaseToAccess((int)$this->lm_obj->getRefId())) &&
                    !ilLMObject::_isPagePublic($a_obj_id, true))
                {
                        return false;
                }
        
                return true;
        }

Here is the call graph for this function:

Field Documentation

ilLMExplorer::$lm_obj

Definition at line 24 of file class.ilLMExplorer.php.

ilLMExplorer::$lp_cache

protected

Definition at line 27 of file class.ilLMExplorer.php.

ilLMExplorer::$output

Definition at line 25 of file class.ilLMExplorer.php.

ilLMExplorer::$root_id

Definition at line 23 of file class.ilLMExplorer.php.

---

The documentation for this class was generated from the following file:

• Modules/LearningModule/classes/class.ilLMExplorer.php