This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilLMTOCExplorerGUI:

Collaboration diagram for ilLMTOCExplorerGUI:

Public Member Functions
	__construct ( $a_parent_obj, string $a_parent_cmd, ilLMPresentationService $service, string $a_lang="-", int $a_focus_id=0, bool $export_all_languages=false)
	Constructor. More...

	getRootNode ()
	Get root node. More...

	setTracker (ilLMTracker $a_val)

	getTracker ()

	setHighlightNode (int $a_val)

	getHighlightNode ()

	isNodeHighlighted ($a_node)

	getNodeContent ($a_node)

	getNodeIcon ($a_node)

	isNodeClickable ($a_node)

	getNodeIconAlt ($a_node)

	getNodeHref ($a_node)

	isNodeVisible ($a_node)

	renderLSToc (\LSTOCBuilder $toc)

Public Member Functions inherited from ilLMExplorerGUI
	__construct ( $a_parent_obj, string $a_parent_cmd, ilObjContentObject $a_lm, string $a_id="")

	beforeRendering ()
	Before rendering. More...

	getNodeContent ($a_node)

	isNodeHighlighted ($a_node)

Public Member Functions inherited from ilTreeExplorerGUI
	__construct (string $a_expl_id, $a_parent_obj, string $a_parent_cmd, ilTree $a_tree, string $a_node_parameter_name="node_id")

	getTree ()

	setOrderField (string $a_val, bool $a_numeric=false)

	getOrderField ()

	setTypeWhiteList (array $a_val)
	Set type white list. More...

	getTypeWhiteList ()
	Get type white list. More...

	setTypeBlackList (array $a_val)
	Set type black list. More...

	getTypeBlackList ()
	Get type black list. More...

	setPreloadChilds (bool $a_val)

	getPreloadChilds ()

	getSuccessorNode ( $a_node_id, string $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 ($record, $environment=null)
	Get a list of records (that list can also be empty). More...

	build (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record, $environment=null)

	getTreeLabel ()

	getTreeComponent ()

	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
	setChildLimit (int $a_val)

	getChildLimit ()

	setSearchTerm (string $a_val)

	getSearchTerm ()

	setMainTemplate (?ilGlobalTemplateInterface $a_main_tpl=null)

	getRootNode ()
	Get root node. More...

	getChildsOfNode ($a_parent_node_id)
	Get children 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 children Please note that this standard method may not be optimal depending on what a derived class does in isNodeVisible. More...

	sortChilds (array $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 (bool $a_val)

	getSkipRootNode ()

	setAjax (bool $a_val)

	getAjax ()

	setSecondaryHighlightedNodes (array $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 (string $a_postvar, bool $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 (bool $a_val)

	getOfflineMode ()

	handleCommand ()
	Handle explorer internal command. More...

	getContainerId ()

	openNode ()
	Open node. More...

	closeNode ()
	Close node. More...

	getNodeAsync ()
	Get node asynchronously. More...

	beforeRendering ()
	Before rendering. More...

	getOnLoadCode ()
	Get on load code. More...

	getHTML ()

	renderNode ($a_node, ilTemplate $tpl)
	Render node. More...

	renderChilds ($a_node_id, ilTemplate $tpl)
	Render childs. More...

	getDomNodeIdForNodeId ($a_node_id)
	Get DOM node id for node id. More...

	getNodeIdForDomNodeId (string $a_dom_node_id)
	Get node id for dom node id. More...

	listItemStart (ilTemplate $tpl, $a_node)
	List item start. More...

	listItemEnd (ilTemplate $tpl)

	listStart (ilTemplate $tpl)

	listEnd (ilTemplate $tpl)

	isNodeOnclickEnabled ()

	setNodeOnclickEnabled (bool $nodeOnclickEnabled)

	isEnableDnd ()

	setEnableDnd (bool $enable_dnd)

Public Member Functions inherited from ILIAS\UI\Component\Tree\TreeRecursion
	getChildren ( $record, $environment=null)
	Get a list of records (that list can also be empty). More...

	build (Node\Factory $factory, $record, $environment=null)
	Build and return a Node. More...

Protected Member Functions
	initTreeData ()

	initVisibilityData (int $node_id)

	highlightContent (array $node, string $content)

	renderLSTocNode (\LSTOCBuilder $toc, ?array $current_node=null)

Protected Member Functions inherited from ilLMExplorerGUI
	checkLPIcon (int $a_id)

Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()

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

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

	isNodeRequested (string $a_node_id)

Protected Attributes
string	$lang

int	$highlight_node = 0

bool	$export_all_languages

ilPageActivationDBRepository	$activation_repo

array	$complete_tree = []

array	$activation_data = []

ilSetting	$lm_set

ilLMPresentationLinker	$linker

int	$focus_id = 0

ilLMPresentationService	$service

ilLMTracker	$tracker

Protected Attributes inherited from ilLMExplorerGUI
ilObjContentObject	$lm

ilObjUser	$user

array	$lp_cache = []

int	$cnt_lmobj = 0

string	$obj_id = ""

string	$transl = ""

Protected Attributes inherited from ilTreeExplorerGUI
ilLanguage	$lng

Psr Http Message ServerRequestInterface	$httpRequest

ilTree	$tree = null

string	$tree_label = ""

string	$order_field = ""

bool	$order_field_numeric = false

array	$type_white_list = array()

array	$type_black_list = array()

array	$childs = array()

bool	$preloaded = false

bool	$preload_childs = false

array	$root_node_data = null

array	$all_childs = array()

	$root_id = 0

ILIAS DI UIServices	$ui

Protected Attributes inherited from ilExplorerBaseGUI
string	$node_parameter_name

ilLogger	$log

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

bool	$skip_root_node = false

bool	$ajax = false

array	$custom_open_nodes = array()

array	$selected_nodes = array()

string	$select_postvar = ""

bool	$offline_mode = false

array	$sec_highl_nodes = array()

bool	$enable_dnd = false

string	$search_term = ""

array	$open_nodes = []

ilSessionIStorage	$store

bool	$select_multi = false

	$parent_obj

int	$child_limit = 0

string	$parent_cmd = ''

string	$requested_exp_cmd = ""

string	$requested_exp_cont = ""

string	$requested_searchterm = ""

string	$requested_node_id = ""

string	$id

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()

static	getLocalJsTreeJsPath ()

static	getLocalJsTreeCssPath ()

static	createHTMLExportDirs (string $a_target_dir)

static	init (?ilGlobalTemplateInterface $a_main_tpl=null)

Static Protected Attributes inherited from ilExplorerBaseGUI
static string	$js_tree_path = "./node_modules/jstree/dist/jstree.js"

static string	$js_tree_path_css = "./node_modules/jstree/dist/themes/default/style.min.css"

static string	$js_expl_path = "assets/js/Explorer2.js"

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning LM presentation (left frame) explorer GUI class

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilLMTOCExplorerGUI::__construct	(		$a_parent_obj,
		string	$a_parent_cmd,
		ilLMPresentationService	$service,
		string	$a_lang = `"-"`,
		int	$a_focus_id = `0`,
		bool	$export_all_languages = `false`
	)

Constructor.

Parameters

object | string $a_parent_obj parent gui object

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

      {
        global $DIC;
 
        $this->service = $service;
        $this->user = $DIC->user();
        $this->lm = $service->getLearningModule();
        $this->linker = $service->getLinker();
        $this->tracker = $service->getTracker();
 
        $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) {
            $sec_high = [];
            foreach ($this->tree->getSubTree($this->tree->getNodeData($a_focus_id)) as $node) {
                $sec_high[] = $node["child"];
            }
            $this->setSecondaryHighlightedNodes($sec_high);
        }
        if ($this->lm->getTOCMode() != "pages") {
            $this->setTypeWhiteList(array("st", "du"));
        }
        $this->focus_id = $a_focus_id;
        $this->export_all_languages = $export_all_languages;
 
        $this->activation_repo = new ilPageActivationDBRepository();
 
        $this->initTreeData();
    }

References $DIC, $export_all_languages, $service, ILIAS\GlobalScreen\Provider\__construct(), ilLMPresentationService\getLearningModule(), ilLMPresentationService\getLinker(), ilExplorerBaseGUI\getOfflineMode(), ilLMPresentationService\getTracker(), initTreeData(), ilExplorerBaseGUI\setSecondaryHighlightedNodes(), ilTreeExplorerGUI\setTypeWhiteList(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ getHighlightNode()

ilLMTOCExplorerGUI::getHighlightNode ( )

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

                                      : int
    {
        return $this->highlight_node;
    }

◆ getNodeContent()

ilLMTOCExplorerGUI::getNodeContent ( $a_node )

Parameters

array | object $a_node

Reimplemented from ilLMExplorerGUI.

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

                                           : string
    {
        if ($a_node["type"] == "st") {
            $content = ilStructureObject::_getPresentationTitle(
                $a_node["child"],
                ilLMObject::CHAPTER_TITLE,
                $this->lm->isActiveNumbering(),
                false,
                false,
                $this->lm->getId(),
                $this->lang,
                true
            );
        } elseif ($a_node["type"] == "pg") {
            $content = ilLMPageObject::_getPresentationTitle(
                $a_node["child"],
                $this->lm->getPageHeader(),
                $this->lm->isActiveNumbering(),
                (bool) $this->lm_set->get("time_scheduled_page_activation"),
                true,
                $this->lm->getId(),
                $this->lang,
                true
            );
        } elseif ($a_node["child"] == $this->getNodeId($this->getRootNode())) {
            $content = $this->service->getPresentationStatus()->getLMPresentationTitle();
        }
 
        return $this->highlightContent($a_node, $content);
    }

References ilLMPageObject\_getPresentationTitle(), ilStructureObject\_getPresentationTitle(), and ilLMObject\CHAPTER_TITLE.

Here is the call graph for this function:

◆ getNodeHref()

ilLMTOCExplorerGUI::getNodeHref ( $a_node )

Parameters

array | object $a_node

Reimplemented from ilExplorerBaseGUI.

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

                                        : string
    {
        if (!$this->getOfflineMode()) {
            return $this->linker->getLink("", $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");
                    $active = ilLMPage::_lookupActive(
                        $a_node["child"],
                        $this->lm->getType(),
                        (bool) $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;
                }
            }
 
            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 $lang, ilPageObject\_lookupActive(), and ilLMObject\getExportId().

Here is the call graph for this function:

◆ getNodeIcon()

ilLMTOCExplorerGUI::getNodeIcon ( $a_node )

Parameters

array | object $a_node

Reimplemented from ilExplorerBaseGUI.

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

                                        : string
    {
        // 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);
        }
 
        if ($a_node["type"] == "du") {
            $a_node["type"] = "lm";
        }
        $a_name = "standard/icon_" . $a_node["type"] . ".svg";
        if ($a_node["type"] == "pg") {
            $lm_set = new ilSetting("lm");
            $active = ilLMPage::_lookupActive(
                $a_node["child"],
                $this->lm->getType(),
                (bool) $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 = "standard/icon_pg" . $img_sc . ".svg";
 
            if (!$active && !$this->getOfflineMode()) {
                $a_name = "standard/icon_pg_d" . $img_sc . ".svg";
            }
        }
 
        return ilUtil::getImagePath($a_name, false, "output", $this->getOfflineMode());
    }

References $lm_set, ilPageObject\_isScheduledActivation(), ilPageObject\_lookupActive(), and ilUtil\getImagePath().

Here is the call graph for this function:

◆ getNodeIconAlt()

ilLMTOCExplorerGUI::getNodeIconAlt ( $a_node )

Parameters

array | object $a_node

Reimplemented from ilTreeExplorerGUI.

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

                                           : string
    {
        return "";
    }

◆ getRootNode()

ilLMTOCExplorerGUI::getRootNode ( )

Get root node.

Returns: object|array node

Reimplemented from ilTreeExplorerGUI.

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

                                 : array
    {
        $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().

Here is the call graph for this function:

◆ getTracker()

ilLMTOCExplorerGUI::getTracker ( )

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

                                : ilLMTracker
    {
        return $this->tracker;
    }

◆ highlightContent()

ilLMTOCExplorerGUI::highlightContent	(	array	$node,
		string	$content
	)

protected

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

                                                                     : string
    {
        if ($this->isNodeHighlighted($node)) {
            $content = "<b>" . $content . "</b>";
        }
        $sec = $this->getSecondaryHighlightedNodes();
        if (in_array($node["child"], $sec)) {
            return "<span class='ilHighlighted'>" . $content . "</span>";
        }
        return $content;
    }

◆ initTreeData()

ilLMTOCExplorerGUI::initTreeData ( )

protected

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

                                     : void
    {
        $nodes = $this->tree->getCompleteTree();
        foreach ($nodes as $node) {
            $this->complete_tree["childs"][$node["parent"]][] = $node;
            $this->complete_tree["parent"][$node["child"]] = $node["parent"];
            $this->complete_tree["nodes"][$node["child"]] = $node;
        }
 
        $page_ids = array_column($this->complete_tree["nodes"], "child");
        $this->activation_data = $this->activation_repo->get(
            "lm",
            $page_ids,
            (bool) $this->lm_set->get("time_scheduled_page_activation"),
            $this->lang
        );
        $this->initVisibilityData($this->tree->readRootId());
    }

References initVisibilityData().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initVisibilityData()

ilLMTOCExplorerGUI::initVisibilityData ( int $node_id )

protected

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

     : void {
        $current_node = $this->complete_tree["nodes"][$node_id];
 
        if (isset($this->complete_tree["childs"][$node_id])) {
            foreach ($this->complete_tree["childs"][$node_id] as $node) {
                $this->initVisibilityData($node["child"]);
            }
        }
 
        // pages are visible if they are active or activation info should be shown
        if ($current_node["type"] == "pg") {
            $this->complete_tree["visibility"][$node_id] = ($this->activation_data[$node_id]["active"] ||
                $this->activation_data[$node_id]["show_info"]);
        } elseif ($current_node["type"] == "st") {
            // make chapters visible as soon as there is one visible child
            $this->complete_tree["visibility"][$node_id] = false;
            if (isset($this->complete_tree["childs"][$node_id])) {
                foreach ($this->complete_tree["childs"][$node_id] as $node) {
                    if (isset($this->complete_tree["visibility"][$node["child"]]) &&
                        $this->complete_tree["visibility"][$node["child"]]) {
                        $this->complete_tree["visibility"][$node_id] = true;
                    }
                }
            }
        } else {
            $this->complete_tree["visibility"][$node_id] = true;
        }
    }

References initVisibilityData().

Referenced by initTreeData(), and initVisibilityData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isNodeClickable()

ilLMTOCExplorerGUI::isNodeClickable ( $a_node )

Parameters

array | object $a_node

Reimplemented from ilExplorerBaseGUI.

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

                                            : bool
    {
        $ilUser = $this->user;
        $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) == 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");
                    }
                    $active = ilLMPage::_lookupActive(
                        $a_node["child"],
                        $this->lm->getType(),
                        (bool) $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;
                    }
                }
            }
        }
 
        return true;
    }

References $path, and ilPageObject\_lookupActive().

Here is the call graph for this function:

◆ isNodeHighlighted()

ilLMTOCExplorerGUI::isNodeHighlighted ( $a_node )

Parameters

object | array $a_node

Reimplemented from ilLMExplorerGUI.

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

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

◆ isNodeVisible()

ilLMTOCExplorerGUI::isNodeVisible ( $a_node )

Parameters

array | object $a_node

Reimplemented from ilExplorerBaseGUI.

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

                                          : bool
    {
        return (bool) $this->complete_tree["visibility"][$a_node["child"]];
    }

◆ renderLSToc()

ilLMTOCExplorerGUI::renderLSToc ( \LSTOCBuilder $toc )

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

                                                   : void
    {
        $this->renderLSTocNode($toc, null);
    }

◆ renderLSTocNode()

ilLMTOCExplorerGUI::renderLSTocNode	(	\LSTOCBuilder	$toc,
		?array	$current_node = `null`
	)

protected

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

                                                                                       : void
    {
        $root = false;
        if ($current_node == 0) {
            $root = true;
            $current_node = $this->tree->getNodeData($this->tree->readRootId());
        }
 
        $children = $this->getChildren($current_node);
        if (count($children) > 0) {
            if ($root) {
                $node_toc = $toc;
            } else {
                // current workaround
                $lp = LSTOCBuilder::LP_IN_PROGRESS;
                $node_icon = $this->getNodeIcon($current_node);
                if (strpos($node_icon, "complete")) {
                    $lp = LSTOCBuilder::LP_COMPLETED;
                }
 
                $node_toc = $toc->node($current_node["title"], $current_node["child"], $lp);
            }
            foreach ($this->getChildren($current_node) as $child) {
                $this->renderLSTocNode($node_toc, $child);
            }
            $node_toc->end();
        } else {
            $highlight = $this->isNodeHighlighted($current_node);
            $toc->item($current_node["title"], $current_node["child"], null, $highlight);
        }
    }

References LSTOCBuilder\item(), ILIAS\KioskMode\TOCBuilder\LP_COMPLETED, ILIAS\KioskMode\TOCBuilder\LP_IN_PROGRESS, and LSTOCBuilder\node().

Here is the call graph for this function:

◆ setHighlightNode()

ilLMTOCExplorerGUI::setHighlightNode ( int $a_val )

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

                                                : void
    {
        $this->highlight_node = $a_val;
    }

◆ setTracker()

ilLMTOCExplorerGUI::setTracker ( ilLMTracker $a_val )

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

                                                  : void
    {
        $this->tracker = $a_val;
    }

Field Documentation

◆ $activation_data

array ilLMTOCExplorerGUI::$activation_data = []

protected

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

◆ $activation_repo

ilPageActivationDBRepository ilLMTOCExplorerGUI::$activation_repo

protected

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

◆ $complete_tree

array ilLMTOCExplorerGUI::$complete_tree = []

protected

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

◆ $export_all_languages

bool ilLMTOCExplorerGUI::$export_all_languages

protected

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

Referenced by __construct().

◆ $focus_id

int ilLMTOCExplorerGUI::$focus_id = 0

protected

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

◆ $highlight_node

int ilLMTOCExplorerGUI::$highlight_node = 0

protected

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

◆ $lang

string ilLMTOCExplorerGUI::$lang

protected

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

◆ $linker

ilLMPresentationLinker ilLMTOCExplorerGUI::$linker

protected

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

◆ $lm_set

ilSetting ilLMTOCExplorerGUI::$lm_set

protected

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

◆ $service

ilLMPresentationService ilLMTOCExplorerGUI::$service

protected

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

Referenced by __construct().

◆ $tracker

ilLMTracker ilLMTOCExplorerGUI::$tracker

protected

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

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

components/ILIAS/LearningModule/Presentation/class.ilLMTOCExplorerGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getHighlightNode()

◆ getNodeContent()

◆ getNodeHref()

◆ getNodeIcon()

◆ getNodeIconAlt()

◆ getRootNode()

◆ getTracker()

◆ highlightContent()

◆ initTreeData()

◆ initVisibilityData()

◆ isNodeClickable()

◆ isNodeHighlighted()

◆ isNodeVisible()

◆ renderLSToc()

◆ renderLSTocNode()

◆ setHighlightNode()

◆ setTracker()

Field Documentation

◆ $activation_data

◆ $activation_repo

◆ $complete_tree

◆ $export_all_languages

◆ $focus_id

◆ $highlight_node

◆ $lang

◆ $linker

◆ $lm_set

◆ $service

◆ $tracker