ilLMTOCExplorerGUI Class Reference

LM presentation (left frame) explorer GUI class. More...

Inheritance diagram for ilLMTOCExplorerGUI:

Collaboration diagram for ilLMTOCExplorerGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, ilLMPresentationGUI $a_lm_pres, $a_lang="-", $a_focus_id=0, $export_all_languages=false)
	Constructor. More...
	getRootNode ()
	Get root node. More...
	setTracker ($a_val)
	Set tracker. More...
	getTracker ()
	Get tracker. More...
	setHighlightNode ($a_val)
	Set highlighted node. More...
	getHighlightNode ()
	Get highlighted node. More...
	isNodeHighlighted ($a_node)
	Is node highlighted? More...
	getNodeContent ($a_node)
	Get node content. More...
	getNodeIcon ($a_node)
	Get node icon. More...
	isNodeClickable ($a_node)
	Is node clickable. More...
	getNodeIconAlt ($a_node)
	Get node icon alt text. More...
	getNodeHref ($a_node)
	Get href for node. More...
	isNodeVisible ($a_node)
	Is node visible? More...
Public Member Functions inherited from ilLMExplorerGUI
	__construct ($a_parent_obj, $a_parent_cmd, ilObjContentObject $a_lm, $a_id="")
	Constructor. More...
	beforeRendering ()
	Before rendering. More...
	getNodeContent ($a_node)
	Get node content. More...
	isNodeHighlighted ($a_node)
	Is node highlighted? More...
Public Member Functions inherited from ilTreeExplorerGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree)
	Constructor. More...
	getTree ()
	Get tree. More...
	setOrderField ($a_val, $a_numeric=false)
	Set order field. More...
	getOrderField ()
	Get order field. More...
	setTypeWhiteList ($a_val)
	Set type white list. More...
	getTypeWhiteList ()
	Get type white list. More...
	setTypeBlackList ($a_val)
	Set type black list. More...
	getTypeBlackList ()
	Get type black list. More...
	setPreloadChilds ($a_val)
	Set preload childs. More...
	getPreloadChilds ()
	Get preload childs. More...
	getSuccessorNode ($a_node_id, $a_type="")
	Get successor node (currently only(!) based on lft/rgt tree values) More...
	getChildsOfNode ($a_parent_node_id)
	Get childs of node. More...
	getNodeId ($a_node)
	Get id for node. More...
	getNodeIconAlt ($a_node)
	Get node icon alt attribute. More...
	getRootNode ()
	Get root node. More...
	setPathOpen ($a_id)
	Set node path to be opened. More...
	getHTML ()
	Get HTML. More...
Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor. More...
	getRootNode ()
	Get root node. More...
	getChildsOfNode ($a_parent_node_id)
	Get childs of node. More...
	getNodeContent ($a_node)
	Get content of a node. More...
	getNodeId ($a_node)
	Get id of a node. More...
	getNodeHref ($a_node)
	Get href for node. More...
	nodeHasVisibleChilds ($a_node)
	Node has childs? More...
	sortChilds ($a_childs, $a_parent_node_id)
	Sort childs. More...
	getNodeIcon ($a_node)
	Get node icon path. More...
	getNodeIconAlt ($a_node)
	Get node icon alt attribute. More...
	getNodeTarget ($a_node)
	Get node target (frame) attribute. More...
	getNodeOnClick ($a_node)
	Get node onclick attribute. More...
	isNodeVisible ($a_node)
	Is node visible? More...
	isNodeHighlighted ($a_node)
	Is node highlighted? More...
	isNodeClickable ($a_node)
	Is node clickable? More...
	getId ()
	Get id of explorer element. More...
	setSkipRootNode ($a_val)
	Set skip root node. More...
	getSkipRootNode ()
	Get skip root node. More...
	setAjax ($a_val)
	Set ajax. More...
	getAjax ()
	Get ajax. More...
	setSecondaryHighlightedNodes ($a_val)
	Set secondary (background) highlighted nodes. More...
	getSecondaryHighlightedNodes ()
	Get secondary (background) highlighted nodes. More...
	setNodeOpen ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour) More...
	setSelectMode ($a_postvar, $a_multi=false)
	Set select mode (to deactivate, pass an empty string as postvar) More...
	setNodeSelected ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour) More...
	setOfflineMode ($a_val)
	Set offline mode. More...
	getOfflineMode ()
	Get offline mode. More...
	handleCommand ()
	Handle explorer internal command. More...
	getContainerId ()
	Get container id. More...
	openNode ()
	Open node. More...
	closeNode ()
	Close node. More...
	getNodeAsync ()
	Get node asynchronously. More...
	beforeRendering ()
	Before rendering. More...
	getOnLoadCode ()
	Get on load code. More...
	getHTML ()
	Get HTML. More...
	renderNode ($a_node, $tpl)
	Render node. More...
	renderChilds ($a_node_id, $tpl)
	Render childs. More...
	getDomNodeIdForNodeId ($a_node_id)
	Get DOM node id for node id. More...
	getNodeIdForDomNodeId ($a_dom_node_id)
	Get node id for dom node id. More...
	listItemStart ($tpl, $a_node)
	List item start. More...
	listItemEnd ($tpl)
	List item end. More...
	listStart ($tpl)
	List start. More...
	listEnd ($tpl)
	List end. More...
	isNodeOnclickEnabled ()
	setNodeOnclickEnabled ($nodeOnclickEnabled)
	isEnableDnd ()
	setEnableDnd ($enable_dnd)
	Enable Drag & Drop functionality. More...

Protected Attributes
	$lang
	$highlight_node
	$tracker
	$export_all_languages
Protected Attributes inherited from ilLMExplorerGUI
	$lp_cache
	$cnt_lmobj
Protected Attributes inherited from ilTreeExplorerGUI
	$tree = null
	$order_field = ""
	$order_field_numeric = false
	$type_white_list = array()
	$type_black_list = array()
	$childs = array()
	$preloaded = false
	$preload_childs = false
	$root_node_data = null
	$all_childs = array()
Protected Attributes inherited from ilExplorerBaseGUI
	$skip_root_node = false
	$ajax = false
	$custom_open_nodes = array()
	$selected_nodes = array()
	$select_postvar = ""
	$offline_mode = false
	$sec_highl_nodes = array()
	$enable_dnd = false

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()
	Get local path of explorer js. More...
static	getLocalJsTreeJsPath ()
	Get local path of jsTree js. More...
static	createHTMLExportDirs ($a_target_dir)
	Create html export directories. More...
static	init ()
	Init JS. More...
Protected Member Functions inherited from ilLMExplorerGUI
	checkLPIcon ($a_id)
	Check learning progress icon. More...
Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()
	Preload childs. More...
Protected Member Functions inherited from ilExplorerBaseGUI
	isNodeSelectable ($a_node)
	Is node selectable? More...
	getNodeToggleOnClick ($a_node)
	Get onclick attribute for node toggling. More...
	getSelectOnClick ($a_node)
	Get onclick attribute for selecting radio/checkbox. More...
	getJSTreePlugins ()
Static Protected Attributes inherited from ilExplorerBaseGUI
static	$js_tree_path = "./Services/UIComponent/Explorer2/lib/jstree-v.pre1.0/jquery.jstree.js"
static	$js_expl_path = "./Services/UIComponent/Explorer2/js/Explorer2.js"

Detailed Description

LM presentation (left frame) explorer GUI class.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 14 of file class.ilLMTOCExplorerGUI.php.

Constructor & Destructor Documentation

__construct()

ilLMTOCExplorerGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd,
		ilLMPresentationGUI	$a_lm_pres,
			$a_lang = "-",
			$a_focus_id = 0,
			$export_all_languages = false
	)

Constructor.

Parameters

object	$a_parent_obj	parent gui object
string	$a_parent_cmd	parent cmd
ilLMPresentationGUI	$a_lm_pres	learning module presentation gui object
string	$a_lang	language

Definition at line 29 of file class.ilLMTOCExplorerGUI.php.

        {
                $this->lm_pres = $a_lm_pres;
                $this->lm = $this->lm_pres->lm;
                $exp_id = (!$this->getOfflineMode() && $this->lm->getProgressIcons())
                        ? "ilLMProgressTree"
                        : "";
                parent::__construct($a_parent_obj, $a_parent_cmd, $this->lm, $exp_id);
                $this->lm_set = new ilSetting("lm");
                $this->lang = $a_lang;
                if ($a_focus_id > 0)
                {
                        $this->setSecondaryHighlightedNodes(array($a_focus_id));
                }
                if ($this->lm->getTOCMode() != "pages")
                {
                        $this->setTypeWhiteList(array("st", "du"));
                }
                $this->focus_id = $a_focus_id;
                $this->export_all_languages = $export_all_languages;
        }

References $export_all_languages, ilExplorerBaseGUI\getOfflineMode(), ilExplorerBaseGUI\setSecondaryHighlightedNodes(), and ilTreeExplorerGUI\setTypeWhiteList().

Here is the call graph for this function:

Member Function Documentation

getHighlightNode()

ilLMTOCExplorerGUI::getHighlightNode

(

)

Get highlighted node.

Returns

int node id

Definition at line 101 of file class.ilLMTOCExplorerGUI.php.

        {
                return $this->highlight_node;
        }

References $highlight_node.

Referenced by isNodeHighlighted().

Here is the caller graph for this function:

getNodeContent()

ilLMTOCExplorerGUI::getNodeContent

(

$a_node

)

Get node content.

Parameters

array

$a_node

node array

Returns

string node content

Reimplemented from ilLMExplorerGUI.

Definition at line 127 of file class.ilLMTOCExplorerGUI.php.

        {
                if ($a_node["child"] == $this->getNodeId($this->getRootNode()))
                {
                        return $this->lm_pres->getLMPresentationTitle();
                }
 
                if ($a_node["type"] == "st")
                {
                        return ilStructureObject::_getPresentationTitle($a_node["child"],
                                $this->lm->isActiveNumbering(), false, $this->lm->getId(), $this->lang);
                }
                else if ($a_node["type"] == "pg")
                {
                        return ilLMPageObject::_getPresentationTitle($a_node["child"],
                                $this->lm->getPageHeader(), $this->lm->isActiveNumbering(),
                                $this->lm_set->get("time_scheduled_page_activation"), true, $this->lm->getId(), $this->lang);
                }
                else if ($a_node["child"] == $this->getNodeId($this->getRootNode()))
                {
                        return $this->lm->getTitle();
                }
 
                if ($a_node["type"] == "pg")
                {
                        return ilLMPageObject::_getPresentationTitle($a_node["child"],
                                $this->lm->getPageHeader(), $this->lm->isActiveNumbering(),
                                $this->lm_set->get("time_scheduled_page_activation"), true, $this->lm->getId(), $this->lang);
                }
 
                return $a_node["title"];
        }

References ilLMPageObject\_getPresentationTitle(), ilStructureObject\_getPresentationTitle(), ilTreeExplorerGUI\getNodeId(), and getRootNode().

Here is the call graph for this function:

getNodeHref()

ilLMTOCExplorerGUI::getNodeHref

(

$a_node

)

Get href for node.

Parameters

mixed

$a_node

node object/array

Returns

string href attribute

Reimplemented from ilExplorerBaseGUI.

Definition at line 336 of file class.ilLMTOCExplorerGUI.php.

        {
                if (!$this->getOfflineMode())
                {
                        return $this->lm_pres->getLink($this->lm->getRefId(), "", $a_node["child"]);
                        //return parent::buildLinkTarget($a_node_id, $a_type);
                }
                else
                {
                        if ($a_node["type"] != "pg")
                        {
                                // get next activated page
                                $found = false;
                                while (!$found)
                                {
                                        $a_node = $this->getTree()->fetchSuccessorNode($a_node["child"], "pg");
                                        include_once("./Modules/LearningModule/classes/class.ilLMPage.php");
                                        $active = ilLMPage::_lookupActive($a_node["child"], $this->lm->getType(),
                                                $this->lm_set->get("time_scheduled_page_activation"));
 
                                        if ($a_node["child"] > 0 && !$active)
                                        {
                                                $found = false;
                                        }
                                        else
                                        {
                                                $found = true;
                                        }
                                }
                        }
 
                        $lang_suffix = "";
                        if ($this->export_all_languages)
                        {
                                if ($this->lang != "" && $this->lang != "-")
                                {
                                        $lang_suffix = "_".$this->lang;
                                }
                        }
 
                        include_once("./Modules/LearningModule/classes/class.ilLMPageObject.php");
                        if ($nid = ilLMPageObject::getExportId($this->lm->getId(), $a_node["child"]))
                        {
                                return "lm_pg_".$nid.$lang_suffix.".html";
                        }
                        return "lm_pg_".$a_node["child"].$lang_suffix.".html";
                }
 
        }

References ilPageObject\_lookupActive(), ilLMObject\getExportId(), ilExplorerBaseGUI\getOfflineMode(), and ilTreeExplorerGUI\getTree().

Here is the call graph for this function:

getNodeIcon()

ilLMTOCExplorerGUI::getNodeIcon

(

$a_node

)

Get node icon.

Parameters

array

$a_node

node array

Returns

string icon path

Reimplemented from ilExplorerBaseGUI.

Definition at line 167 of file class.ilLMTOCExplorerGUI.php.

        {
                // overwrite chapter icons with lp info?
                if(!$this->getOfflineMode() && $a_node["type"] == "st")
                {
                        $icon = $this->checkLPIcon($a_node["child"]);
                        if ($icon != "")
                        {
                                return $icon;
                        }
                }
 
                // use progress icons (does not depend on lp mode)
                if(!$this->getOfflineMode() && $this->lm->getProgressIcons())
                {
                        return $this->tracker->getIconForLMObject($a_node, $this->highlight_node);
                }
 
                include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
 
                if ($a_node["type"] == "du")
                {
                        $a_node["type"] = "lm";
                }
                $a_name = "icon_".$a_node["type"].".svg";
                if ($a_node["type"] == "pg")
                {
                        include_once("./Modules/LearningModule/classes/class.ilLMPage.php");
                        $lm_set = new ilSetting("lm");
                        $active = ilLMPage::_lookupActive($a_node["child"], $this->lm->getType(),
                                $lm_set->get("time_scheduled_page_activation"));
 
                        // is page scheduled?
                        $img_sc = ($lm_set->get("time_scheduled_page_activation") &&
                                ilLMPage::_isScheduledActivation($a_node["child"], $this->lm->getType()) && !$active
                                && !$this->getOfflineMode())
                                ? "_sc"
                                : "";
 
                        $a_name = "icon_pg".$img_sc.".svg";
 
                        if (!$active && !$this->getOfflineMode())
                        {
                                $a_name = "icon_pg_d".$img_sc.".svg";
                        }
                }
 
                return ilUtil::getImagePath($a_name, false, "output", $this->getOfflineMode());
        }

References $lm_set, ilPageObject\_isScheduledActivation(), ilPageObject\_lookupActive(), ilLMExplorerGUI\checkLPIcon(), ilUtil\getImagePath(), and ilExplorerBaseGUI\getOfflineMode().

Here is the call graph for this function:

getNodeIconAlt()

ilLMTOCExplorerGUI::getNodeIconAlt

(

$a_node

)

Get node icon alt text.

Parameters

array

$a_node

node array

Returns

string alt text

Reimplemented from ilTreeExplorerGUI.

Definition at line 326 of file class.ilLMTOCExplorerGUI.php.

        {
        }

getRootNode()

ilLMTOCExplorerGUI::getRootNode

(

)

Get root node.

Reimplemented from ilTreeExplorerGUI.

Definition at line 55 of file class.ilLMTOCExplorerGUI.php.

        {
                $root_id = $this->getTree()->readRootId();
                if ($this->focus_id > 0 && $this->getTree()->isInTree($this->focus_id) &&
                        ilLMObject::_lookupType($this->focus_id) == "st")
                {
//                      $root_id = $this->focus_id;
                }
                return $this->getTree()->getNodeData($root_id);
        }

References ilLMObject\_lookupType(), and ilTreeExplorerGUI\getTree().

Referenced by getNodeContent().

Here is the call graph for this function:

Here is the caller graph for this function:

getTracker()

ilLMTOCExplorerGUI::getTracker

(

)

Get tracker.

Returns

ilLMTracker tracker object

Definition at line 81 of file class.ilLMTOCExplorerGUI.php.

        {
                return $this->tracker;
        }

References $tracker.

Referenced by isNodeClickable().

Here is the caller graph for this function:

isNodeClickable()

ilLMTOCExplorerGUI::isNodeClickable

(

$a_node

)

Is node clickable.

Parameters

array

$a_node

node array

Returns

bool clickable?

Reimplemented from ilExplorerBaseGUI.

Definition at line 223 of file class.ilLMTOCExplorerGUI.php.

        {
                global $ilUser;
 
                $orig_node_id = $a_node["child"];
 
                // if navigation is restricted based on correct answered questions
                // check if we have preceeding pages including unsanswered/incorrect answered questions
                if (!$this->getOfflineMode())
                {
                        if ($this->lm->getRestrictForwardNavigation())
                        {
                                if ($this->getTracker()->hasPredIncorrectAnswers($orig_node_id))
                                {
                                        return false;
                                }
                        }
                }
 
                if ($a_node["type"] == "st")
                {
                        if (!$this->getOfflineMode())
                        {
                                if ($this->lm->getTOCMode() != "pages")
                                {
                                        $a_node = $this->getTree()->fetchSuccessorNode($a_node["child"], "pg");
                                }
                                else
                                {
                                        // faster, but needs pages to be in explorer
                                        $a_node = $this->getSuccessorNode($a_node["child"], "pg");
                                }
                                if ($a_node["child"] == 0)
                                {
                                        return false;
                                }
                        }
                        else
                        {
                                // get next activated page
                                $found = false;
                                while (!$found)
                                {
                                        if ($this->lm->getTOCMode() != "pages")
                                        {
                                                $a_node = $this->getTree()->fetchSuccessorNode($a_node["child"], "pg");
                                        }
                                        else
                                        {
                                                $a_node = $this->getSuccessorNode($a_node["child"], "pg");
                                        }
                                        include_once("./Modules/LearningModule/classes/class.ilLMPage.php");
                                        $active = ilLMPage::_lookupActive($a_node["child"], $this->lm->getType(),
                                                $this->lm_set->get("time_scheduled_page_activation"));
 
                                        if ($a_node["child"] > 0 && !$active)
                                        {
                                                $found = false;
                                        }
                                        else
                                        {
                                                $found = true;
                                        }
                                }
                                if ($a_node["child"] <= 0)
                                {
                                        return false;
                                }
                                else
                                {
                                        $path = $this->getTree()->getPathId($a_node["child"]);
                                        if (!in_array($orig_node_id, $path))
                                        {
                                                return false;
                                        }
                                }
                        }
                }
 
                if ($a_node["type"] == "pg")
                {
                        // check public area mode
                        include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                        include_once 'Services/Payment/classes/class.ilPaymentObject.php';
                        if (($ilUser->getId() == ANONYMOUS_USER_ID ||
                                        ilPaymentObject::_requiresPurchaseToAccess((int)$this->lm->getRefId())) &&
                                !ilLMObject::_isPagePublic($a_node["child"], true))
                        {
                                return false;
                        }
                }
 
                return true;
 
        }

References $ilUser, $path, ilLMObject\_isPagePublic(), ilPageObject\_lookupActive(), ilPaymentObject\_requiresPurchaseToAccess(), ilExplorerBaseGUI\getOfflineMode(), ilTreeExplorerGUI\getSuccessorNode(), getTracker(), and ilTreeExplorerGUI\getTree().

Here is the call graph for this function:

isNodeHighlighted()

ilLMTOCExplorerGUI::isNodeHighlighted

(

$a_node

)

Is node highlighted?

Parameters

mixed

$a_node

node object/array

Returns

boolean node visible true/false

Reimplemented from ilLMExplorerGUI.

Definition at line 112 of file class.ilLMTOCExplorerGUI.php.

        {
                if ($a_node["child"] == $this->getHighlightNode())
                {
                        return true;
                }
                return false;
        }

References getHighlightNode().

Here is the call graph for this function:

isNodeVisible()

ilLMTOCExplorerGUI::isNodeVisible

(

$a_node

)

Is node visible?

Parameters

mixed

$a_node

node object/array

Returns

boolean node visible true/false

Reimplemented from ilExplorerBaseGUI.

Definition at line 392 of file class.ilLMTOCExplorerGUI.php.

        {
                include_once("./Modules/LearningModule/classes/class.ilLMTracker.php");
                return ilLMTracker::_isNodeVisible($a_node);
        }

References ilLMTracker\_isNodeVisible().

Here is the call graph for this function:

setHighlightNode()

ilLMTOCExplorerGUI::setHighlightNode

(

$a_val

)

Set highlighted node.

Parameters

int

$a_val

node id

Definition at line 91 of file class.ilLMTOCExplorerGUI.php.

        {
                $this->highlight_node = $a_val;
        }

setTracker()

ilLMTOCExplorerGUI::setTracker

(

$a_val

)

Set tracker.

Parameters

ilLMTracker

$a_val

tracker object

Definition at line 71 of file class.ilLMTOCExplorerGUI.php.

        {
                $this->tracker = $a_val;
        }

Field Documentation

$export_all_languages

ilLMTOCExplorerGUI::$export_all_languages

protected

Definition at line 19 of file class.ilLMTOCExplorerGUI.php.

Referenced by __construct().

$highlight_node

ilLMTOCExplorerGUI::$highlight_node

protected

Definition at line 17 of file class.ilLMTOCExplorerGUI.php.

Referenced by getHighlightNode().

$lang

ilLMTOCExplorerGUI::$lang

protected

Definition at line 16 of file class.ilLMTOCExplorerGUI.php.

$tracker

ilLMTOCExplorerGUI::$tracker

protected

Definition at line 18 of file class.ilLMTOCExplorerGUI.php.

Referenced by getTracker().

---

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

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