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

Protected Attributes

 $lang
 $highlight_node
 $tracker
- 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()

Additional Inherited Members

- Static Public Member Functions inherited from ilExplorerBaseGUI
static getLocalExplorerJsPath ()
 Get local path of explorer js.
static getLocalJsTreeJsPath ()
 Get local path of jsTree js.
static createHTMLExportDirs ($a_target_dir)
 Create html export directories.
static init ()
 Init JS.
- Protected Member Functions inherited from ilLMExplorerGUI
 checkLPIcon ($a_id)
 Check learning progress icon.
- 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

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

Constructor.

Parameters
object$a_parent_objparent gui object
string$a_parent_cmdparent cmd
ilLMPresentationGUI$a_lm_preslearning module presentation gui object
string$a_langlanguage

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

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

{
$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;
}

+ Here is the call graph for this function:

Member Function Documentation

ilLMTOCExplorerGUI::getHighlightNode ( )

Get highlighted node.

Returns
int node id

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

References $highlight_node.

Referenced by isNodeHighlighted().

{
return $this->highlight_node;
}

+ Here is the caller graph for this function:

ilLMTOCExplorerGUI::getNodeContent (   $a_node)

Get node content.

Parameters
array$a_nodenode array
Returns
string node content

Reimplemented from ilLMExplorerGUI.

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

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

{
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"];
}

+ Here is the call graph for this function:

ilLMTOCExplorerGUI::getNodeHref (   $a_node)

Get href for node.

Parameters
mixed$a_nodenode object/array
Returns
string href attribute

Reimplemented from ilExplorerBaseGUI.

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

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

{
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;
}
}
}
include_once("./Modules/LearningModule/classes/class.ilLMPageObject.php");
if ($nid = ilLMPageObject::getExportId($this->lm->getId(), $a_node["child"]))
{
return "lm_pg_".$nid.".html";
}
return "lm_pg_".$a_node["child"].".html";
}
}

+ Here is the call graph for this function:

ilLMTOCExplorerGUI::getNodeIcon (   $a_node)

Get node icon.

Parameters
array$a_nodenode array
Returns
string icon path

Reimplemented from ilExplorerBaseGUI.

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

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

{
// 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());
}

+ Here is the call graph for this function:

ilLMTOCExplorerGUI::getNodeIconAlt (   $a_node)

Get node icon alt text.

Parameters
array$a_nodenode array
Returns
string alt text

Reimplemented from ilTreeExplorerGUI.

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

{
}
ilLMTOCExplorerGUI::getRootNode ( )

Get root node.

Reimplemented from ilTreeExplorerGUI.

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

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

Referenced by getNodeContent().

{
$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);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilLMTOCExplorerGUI::getTracker ( )

Get tracker.

Returns
ilLMTracker tracker object

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

References $tracker.

Referenced by isNodeClickable().

{
return $this->tracker;
}

+ Here is the caller graph for this function:

ilLMTOCExplorerGUI::isNodeClickable (   $a_node)

Is node clickable.

Parameters
array$a_nodenode array
Returns
bool clickable?

Reimplemented from ilExplorerBaseGUI.

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

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

{
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;
}

+ Here is the call graph for this function:

ilLMTOCExplorerGUI::isNodeHighlighted (   $a_node)

Is node highlighted?

Parameters
mixed$a_nodenode object/array
Returns
boolean node visible true/false

Reimplemented from ilLMExplorerGUI.

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

References getHighlightNode().

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

+ Here is the call graph for this function:

ilLMTOCExplorerGUI::isNodeVisible (   $a_node)

Is node visible?

Parameters
mixed$a_nodenode object/array
Returns
boolean node visible true/false

Reimplemented from ilExplorerBaseGUI.

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

References ilLMTracker\_isNodeVisible().

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

+ Here is the call graph for this function:

ilLMTOCExplorerGUI::setHighlightNode (   $a_val)

Set highlighted node.

Parameters
int$a_valnode id

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

{
$this->highlight_node = $a_val;
}
ilLMTOCExplorerGUI::setTracker (   $a_val)

Set tracker.

Parameters
ilLMTracker$a_valtracker object

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

{
$this->tracker = $a_val;
}

Field Documentation

ilLMTOCExplorerGUI::$highlight_node
protected

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

Referenced by getHighlightNode().

ilLMTOCExplorerGUI::$lang
protected

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

Referenced by getNodeContent().

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: