ilLMEditorExplorerGUI Class Reference

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

Inheritance diagram for ilLMEditorExplorerGUI:

Collaboration diagram for ilLMEditorExplorerGUI:

Public Member Functions
	__construct ( $a_parent_obj, string $a_parent_cmd, ilObjContentObject $a_lm, string $a_id="")
	ilLMEditorExplorerGUI constructor. More...
	getNodeIcon ($a_node)
	getNodeIconAlt ($a_node)
	getNodeHref ($a_node)
Public Member Functions inherited from ilLMExplorerGUI
	__construct ( $a_parent_obj, string $a_parent_cmd, ilObjContentObject $a_lm, string $a_id="")
	beforeRendering ()
	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
	build (Node\Factory $factory, $record, $environment=null)
	Build and return a Node. More...

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)
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 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
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 = "./Services/UIComponent/Explorer2/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 editor explorer GUI class

Author

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

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

Constructor & Destructor Documentation

__construct()

ilLMEditorExplorerGUI::__construct	(		$a_parent_obj,
		string	$a_parent_cmd,
		ilObjContentObject	$a_lm,
		string	$a_id = ""
	)

ilLMEditorExplorerGUI constructor.

Parameters

object | string

$a_parent_obj

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

      {
        global $DIC;
        parent::__construct($a_parent_obj, $a_parent_cmd, $a_lm, $a_id);

        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
    }

Here is the call graph for this function:

Member Function Documentation

getNodeHref()

ilLMEditorExplorerGUI::getNodeHref

(

$a_node

)

Parameters

object | array

$a_node

Definition at line 124 of file class.ilLMEditorExplorerGUI.php.

References ilExplorerBaseGUI\$ctrl, and ilLMExplorerGUI\$obj_id.

                                        : string
    {
        $ilCtrl = $this->ctrl;

        if ($a_node["child"] == "") {
            $a_node["child"] = null;
        }
        $obj_id = ($this->obj_id == "")
            ? null
            : $this->obj_id;

        switch ($a_node["type"]) {
            case "du":
                $ilCtrl->setParameterByClass("ilobjlearningmodulegui", "obj_id", null);
                $ret = $ilCtrl->getLinkTargetByClass("ilobjlearningmodulegui", "chapters");
                return $ret;

            case "pg":
                $ilCtrl->setParameterByClass("illmpageobjectgui", "obj_id", $a_node["child"]);
                $ret = $ilCtrl->getLinkTargetByClass(array("ilobjlearningmodulegui", "illmpageobjectgui"), "edit");
                $ilCtrl->setParameterByClass("illmpageobjectgui", "obj_id", $obj_id);
                return $ret;

            case "st":
                $ilCtrl->setParameterByClass("ilstructureobjectgui", "obj_id", $a_node["child"]);
                $ret = $ilCtrl->getLinkTargetByClass(array("ilobjlearningmodulegui", "ilstructureobjectgui"), "view");
                $ilCtrl->setParameterByClass("ilstructureobjectgui", "obj_id", $obj_id);
                return $ret;
        }
        return "";
    }

getNodeIcon()

ilLMEditorExplorerGUI::getNodeIcon

(

$a_node

)

Parameters

object | array

$a_node

Definition at line 47 of file class.ilLMEditorExplorerGUI.php.

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

                                        : string
    {
        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(),
                    (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()))
                    ? "_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:

getNodeIconAlt()

ilLMEditorExplorerGUI::getNodeIconAlt

(

$a_node

)

Parameters

object | array

$a_node

Definition at line 90 of file class.ilLMEditorExplorerGUI.php.

References $lm_set, ilTreeExplorerGUI\$lng, ilPageObject\_lookupActive(), ilPageObject\_lookupContainsDeactivatedElements(), and ilLanguage\txt().

                                           : string
    {
        $lng = $this->lng;

        if ($a_node["type"] == "du") {
            $a_node["type"] = "lm";
        }

        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")
            );

            if (!$active) {
                return $lng->txt("cont_page_deactivated");
            } else {
                $contains_dis = ilLMPage::_lookupContainsDeactivatedElements(
                    $a_node["child"],
                    $this->lm->getType()
                );
                if ($contains_dis) {
                    return $lng->txt("cont_page_deactivated_elements");
                }
            }
        }
        return parent::getNodeIconAlt($a_node);
    }

Here is the call graph for this function:

---

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

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