ilPublicSectionExplorerGUI Class Reference

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 More...
	getNodeContent ($a_node)
	get node content More...
	getNodeIcon ($a_node)
	Get node icon. More...
	beforeRendering ()
	select public pages and open public chapter More...
	isNodeClickable ($a_node)
	Is not clickable? 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...
	setRootId ($a_root)
	setPathOpen ($a_id)
	Set node path to be opened. More...
	getHTML ($new=false)
	Get HTML. More...
	getChildren ($node, $environment=null)
	Get a list of records (that list can also be empty).Each record will be relayed to $this->build to retrieve a Node. Also, each record will be asked for Sub-Nodes using this function. Returns array More...
	build (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record, $environment=null)
	getTreeLabel ()
	getTreeComponent ()
	Get Tree UI. More...
	toggleExplorerNodeState ()
	Should be called by an ilCtrl-enabled command class if a tree node toggle action should be processed. More...
Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor. More...
	setChildLimit ($a_val)
	Set child limit. More...
	getChildLimit ()
	Get child limit. More...
	setSearchTerm ($a_val)
	Set search term. More...
	getSearchTerm ()
	Get search term. More...
	setMainTemplate ($a_main_tpl=null)
	Set main template (that is responsible for adding js/css) 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...
Public Member Functions inherited from ILIAS\UI\Component\Tree\TreeRecursion
	build (Node\Factory $factory, $record, $environment=null)
	Build and return a Node. More...

Data Fields
	$exp_id = "public_section"

Protected Member Functions
	getAllNodes ($from_id=null)
	Returns all nodes from tree recursive. More...
Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()
	Preload childs. More...
	matches ($node)
	Does a node match a search term (or is search term empty) More...
	getRootId ()
	createNode (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record)
	Creates at tree node, can be overwritten in derivatives if another node type should be used. More...
	getNodeStateToggleCmdClasses ($record)
	Should return an array of ilCtrl-enabled command classes which should be used to build the URL for the expand/collapse actions applied on a tree node. More...
	render ()
	Render tree. 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...
	isNodeOpen ($node_id)
	Get all open nodes. More...
	getJSTreePlugins ()

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	getLocalJsTreeCssPath ()
	Get local path of jsTree js. More...
static	createHTMLExportDirs ($a_target_dir)
	Create html export directories. More...
static	init ($a_main_tpl=null)
	Init JS. More...
Protected Attributes inherited from ilTreeExplorerGUI
	$lng
	$httpRequest
	$tree = null
	$tree_label = ""
	$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()
	$ui
Protected Attributes inherited from ilExplorerBaseGUI
	$log
	$ctrl
	$tpl
	$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
	$search_term = ""
	$open_nodes = []
	$store
	$parent_obj
	$child_limit = 0
	$parent_cmd = ''
Static Protected Attributes inherited from ilExplorerBaseGUI
static	$js_tree_path = "./node_modules/jstree/dist/jstree.js"
static	$js_tree_path_css = "./node_modules/jstree/dist/themes/default/style.min.css"
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 13 of file class.ilPublicSectionExplorerGUI.php.

Constructor & Destructor Documentation

__construct()

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

constructor

Parameters

object	$a_parent_obj
string	$a_parent_cmd
ilObjLearningModule	$a_lm

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

References ilTreeExplorerGUI\$tree, ILIAS\GlobalScreen\Provider\__construct(), and ilLMTree\getInstance().

    {
        $this->lm = $a_lm;

        $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

beforeRendering()

ilPublicSectionExplorerGUI::beforeRendering

(

)

select public pages and open public chapter

Definition at line 104 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:

getAllNodes()

ilPublicSectionExplorerGUI::getAllNodes (   $from_id = null )

protected

Returns all nodes from tree recursive.

Parameters

mixed

$from_id

Returns

array nodes

Definition at line 123 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:

getNodeContent()

ilPublicSectionExplorerGUI::getNodeContent

(

$a_node

)

get node content

Parameters

mixed

$a_node

Returns

string note name

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

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

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

Here is the call graph for this function:

getNodeIcon()

ilPublicSectionExplorerGUI::getNodeIcon

(

$a_node

)

Get node icon.

Parameters

array

$a_node

node array

Returns

string icon path

Definition at line 61 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") {
                $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 {
                    $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:

isNodeClickable()

ilPublicSectionExplorerGUI::isNodeClickable

(

$a_node

)

Is not clickable?

Parameters

array

$a_node

node array

Returns

bool

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

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

Field Documentation

$exp_id

ilPublicSectionExplorerGUI::$exp_id = "public_section"

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

---

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

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