tree explorer lm public area More...

Inheritance diagram for ilPublicSectionExplorerGUI:

Collaboration diagram for ilPublicSectionExplorerGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $a_lm)
	constructor
	getNodeContent ($a_node)
	get node content
	getNodeIcon ($a_node)
	Get node icon.
	beforeRendering ()
	select public pages and open public chapter
	isNodeClickable ($a_node)
	Is not clickable?
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.
	getNodeIconAlt ($a_node)
	Get node icon alt attribute.
	getRootNode ()
	Get root node.
	setPathOpen ($a_id)
	Set node path to be opened.
	getHTML ()
	Get HTML.
Public Member Functions inherited from ilExplorerBaseGUI
	getNodeHref ($a_node)
	Get href for node.
	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.
	isNodeVisible ($a_node)
	Is node visible?
	isNodeHighlighted ($a_node)
	Is node highlighted?
	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.

Data Fields
	$exp_id = "public_section"

Protected Member Functions
	getAllNodes ($from_id=null)
	Returns all nodes from tree recursive.
Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()
	Preload childs.
Protected Member Functions inherited from ilExplorerBaseGUI
	getNodeToggleOnClick ($a_node)
	Get onclick attribute for node toggling.
	getSelectOnClick ($a_node)
	Get onclick attribute for selecting radio/checkbox.

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 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()
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

tree explorer lm public area

Author: Fabian Wolf wolf@.nosp@m.leif.nosp@m.os.co.nosp@m.m

Version: $Id$

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

Constructor & Destructor Documentation

ilPublicSectionExplorerGUI::__construct	(	$a_parent_obj,
		$a_parent_cmd,
		$a_lm
	)

constructor

Parameters

object	$a_parent_obj
string	$a_parent_cmd
ilObjLearningModule	$a_lm

Reimplemented from ilExplorerBaseGUI.

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

References ilTreeExplorerGUI\$tree, and ilLMTree\getInstance().

        {
                $this->lm = $a_lm;
                include_once("./Modules/LearningModule/classes/class.ilLMTree.php");
                $tree = ilLMTree::getInstance($this->lm->getId());
                parent::__construct("lm_public_section_".$this->lm->getId(),$a_parent_obj,$a_parent_cmd,$tree);
        }

Here is the call graph for this function:

Member Function Documentation

ilPublicSectionExplorerGUI::beforeRendering ( )

select public pages and open public chapter

Reimplemented from ilExplorerBaseGUI.

Definition at line 108 of file class.ilPublicSectionExplorerGUI.php.

References getAllNodes(), ilExplorerBaseGUI\setNodeOpen(), and ilExplorerBaseGUI\setNodeSelected().

        {
                //select public pages and open public chapters
                foreach($this->getAllNodes() as $node)
                {
                        if($node["public_access"] == "y" && $node["type"] == "pg")
                        {
                                $this->setNodeSelected($node["obj_id"]);
                        }
                        if($node["public_access"] == "y" && $node["type"]== "st")
                        {
                                $this->setNodeOpen($node["obj_id"]);
                        }
                }
        }

Here is the call graph for this function:

ilPublicSectionExplorerGUI::getAllNodes ( $from_id = null )

protected

Returns all nodes from tree recursive.

Parameters

mixed $from_id

Returns: array nodes

Definition at line 130 of file class.ilPublicSectionExplorerGUI.php.

References ilTreeExplorerGUI\getChildsOfNode(), ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

Referenced by beforeRendering().

        {
                $nodes = array();
                if($from_id === null)
                {
                        $from_id = $this->getNodeId($this->getRootNode());
                }
                foreach($this->getChildsOfNode($from_id) as $node)
                {
                        $nodes[] = $node;
                        if($node["type"] == "st")
                        {
                                $nodes = array_merge($nodes, $this->getAllNodes($node["obj_id"]));
                        }
                }
                return $nodes;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilPublicSectionExplorerGUI::getNodeContent ( $a_node )

get node content

Parameters

mixed $a_node

Returns: string note name

Reimplemented from ilExplorerBaseGUI.

Definition at line 45 of file class.ilPublicSectionExplorerGUI.php.

References $_GET, $lang, ilLMObject\_getPresentationTitle(), and IL_PAGE_TITLE.

        {
                $lang = ($_GET["transl"] != "")
                        ? $_GET["transl"]
                        : "-";
                return ilLMObject::_getPresentationTitle($a_node, IL_PAGE_TITLE,
                        $this->lm->isActiveNumbering(), false, false, $this->lm->getId(), $lang);
        }

Here is the call graph for this function:

ilPublicSectionExplorerGUI::getNodeIcon ( $a_node )

Get node icon.

Parameters

array $a_node node array

Returns: string icon path

Reimplemented from ilExplorerBaseGUI.

Definition at line 60 of file class.ilPublicSectionExplorerGUI.php.

References $lm_set, ilPageObject\_isScheduledActivation(), ilPageObject\_lookupActive(), ilPageObject\_lookupContainsDeactivatedElements(), ilUtil\getImagePath(), ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

        {
                if ($a_node["child"] == $this->getNodeId($this->getRootNode()))
                {
                        $icon = ilUtil::getImagePath("icon_lm.svg");
                }
                else
                {
                        $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()))
                                        ? "_sc"
                                        : "";
                                $a_name = "icon_pg".$img_sc.".svg";
                                if (!$active)
                                {
                                        $a_name = "icon_pg_d".$img_sc.".svg";
                                }
                                else
                                {
                                        include_once("./Modules/LearningModule/classes/class.ilLMPage.php");
                                        $contains_dis = ilLMPage::_lookupContainsDeactivatedElements($a_node["child"],
                                                $this->lm->getType());
                                        if ($contains_dis)
                                        {
                                                $a_name = "icon_pg_del".$img_sc.".svg";
                                        }
                                }
                        }
                        $icon = ilUtil::getImagePath($a_name);
                }
                return $icon;
        }

Here is the call graph for this function:

ilPublicSectionExplorerGUI::isNodeClickable ( $a_node )

Is not clickable?

Parameters

array $a_node node array

Returns: bool

Reimplemented from ilExplorerBaseGUI.

Definition at line 157 of file class.ilPublicSectionExplorerGUI.php.

        {
                if ($a_node["type"] == "pg")
                {
                        return true;
                }
                return false;
        }

Field Documentation

ilPublicSectionExplorerGUI::$exp_id = "public_section"

Definition at line 20 of file class.ilPublicSectionExplorerGUI.php.

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

Modules/LearningModule/classes/class.ilPublicSectionExplorerGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation