Inheritance diagram for ilOrgUnitExplorerGUI:

Collaboration diagram for ilOrgUnitExplorerGUI:

Public Member Functions
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree, \ilAccessHandler $access=null)

	getNodeContent ($node)

	getRootNode ()

	getNodeIcon ($a_node)
	Get node icon Return custom icon of OrgUnit type if existing. More...

	getNodeHref ($node)

	isNodeClickable ($a_node)

	isNodeSelectable ($a_node)

	getChildsOfNode ($a_parent_node_id)
	Get childs of node. 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
	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
	getLinkTarget ()

	getPluginLinkTarget ()

	filterChildrenByPermission (array $children)

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

Protected Attributes
const	ORGU = "orgu"

	$stay_with_command = array('', 'render', 'view', 'infoScreen', 'showStaff', 'performPaste', 'cut')

	$tree

	$access

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 = ''

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...

Static Protected Attributes inherited from ilExplorerBaseGUI
static	$js_tree_path = "./libs/bower/bower_components/jstree/dist/jstree.js"

static	$js_tree_path_css = "./libs/bower/bower_components/jstree/dist/themes/default/style.min.css"

static	$js_expl_path = "./Services/UIComponent/Explorer2/js/Explorer2.js"

Detailed Description

Class ilOrgUnitExplorerGUI.

Author: : Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; : Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 13 of file class.ilOrgUnitExplorerGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitExplorerGUI::__construct	(		$a_expl_id,
			$a_parent_obj,
			$a_parent_cmd,
			$a_tree,
		\ilAccessHandler	$access = `null`
	)

Parameters

$a_expl_id
$a_parent_obj
$a_parent_cmd
$a_tree
$access

Definition at line 38 of file class.ilOrgUnitExplorerGUI.php.

    {
        parent::__construct($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree);
        $this->setAjax(true);
        $this->setTypeWhiteList(array(self::ORGU));
        $this->tree->initLangCode();
        $this->access = $access;
    }

References $access, ILIAS\GlobalScreen\Provider\__construct(), ilExplorerBaseGUI\setAjax(), and ilTreeExplorerGUI\setTypeWhiteList().

Here is the call graph for this function:

Member Function Documentation

◆ filterChildrenByPermission()

ilOrgUnitExplorerGUI::filterChildrenByPermission ( array $children )

protected

Definition at line 195 of file class.ilOrgUnitExplorerGUI.php.

                                                                   : array
    {
        return array_filter(
            $children,
            function ($child) {
                return $this->access->checkAccess("visible", "", $child["ref_id"]);
            }
        );
    }

Referenced by getChildsOfNode().

Here is the caller graph for this function:

◆ getChildsOfNode()

ilOrgUnitExplorerGUI::getChildsOfNode ( $a_parent_node_id )

Get childs of node.

Parameters

int $a_parent_node_id parent id

Returns: array childs

Reimplemented from ilTreeExplorerGUI.

Definition at line 184 of file class.ilOrgUnitExplorerGUI.php.

    {
        $children = parent::getChildsOfNode($a_parent_node_id);
 
        if (!is_null($this->access)) {
            $children = $this->filterChildrenByPermission($children);
        }
 
        return $children;
    }

References filterChildrenByPermission().

Here is the call graph for this function:

◆ getLinkTarget()

ilOrgUnitExplorerGUI::getLinkTarget ( )

protected

Returns: string

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

                                       : string
    {
        global $DIC;
        if ($DIC->ctrl()->getCmdClass() === strtolower(ilObjOrgUnitGUI::class) && in_array($DIC->ctrl()->getCmd(), $this->stay_with_command, true)) {
            return $DIC->ctrl()->getLinkTargetByClass(array(ilAdministrationGUI::class, $DIC->ctrl()->getCmdClass()), $DIC->ctrl()->getCmd());
        }
 
        return $DIC->ctrl()->getLinkTargetByClass(array(ilAdministrationGUI::class, ilObjOrgUnitGUI::class), 'view');
    }

References $DIC.

Referenced by getNodeHref().

Here is the caller graph for this function:

◆ getNodeContent()

ilOrgUnitExplorerGUI::getNodeContent ( $node )

Parameters

mixed $node

Returns: string

Reimplemented from ilExplorerBaseGUI.

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

                                          : ?string
    {
        global $DIC;
        if ($node['title'] === '__OrgUnitAdministration') {
            $node['title'] = $DIC->language()->txt('objs_orgu');
        }
        if ((int) $node['child'] === (int) $_GET['ref_id']) {
            return "<span class='ilExp2NodeContent ilHighlighted'>" . $node['title'] . '</span>';
        }
 
        return $node['title'];
    }

References $_GET, and $DIC.

◆ getNodeHref()

ilOrgUnitExplorerGUI::getNodeHref ( $node )

Parameters

array $node

Returns: string

Reimplemented from ilExplorerBaseGUI.

Definition at line 105 of file class.ilOrgUnitExplorerGUI.php.

                                       : string
    {
        global $DIC;
 
        if ($this->select_postvar) {
            return '#';
        }
 
        if ($DIC->ctrl()->getCmd() === 'performPaste') {
            $DIC->ctrl()->setParameterByClass(ilObjOrgUnitGUI::class, 'target_node', $node['child']);
        }
        $array = $DIC->ctrl()->getParameterArrayByClass(ilObjOrgUnitGUI::class);
        $temp = $array['ref_id'];
 
        $DIC->ctrl()->setParameterByClass(ilObjOrgUnitGUI::class, 'ref_id', $node['child']);
        $DIC->ctrl()->setParameterByClass(ilObjPluginDispatchGUI::class, 'ref_id', $node['child']);
 
        $link_target = ($node['type'] === self::ORGU) ? $this->getLinkTarget() : $this->getPluginLinkTarget();
        $DIC->ctrl()->setParameterByClass(ilObjOrgUnitGUI::class, 'ref_id', $temp);
 
        return $link_target;
    }

References $DIC, getLinkTarget(), getPluginLinkTarget(), and ORGU.

Here is the call graph for this function:

◆ getNodeIcon()

ilOrgUnitExplorerGUI::getNodeIcon ( $a_node )

Get node icon Return custom icon of OrgUnit type if existing.

Parameters

array $a_node

Returns: string

Reimplemented from ilExplorerBaseGUI.

Definition at line 84 of file class.ilOrgUnitExplorerGUI.php.

                                         : string
    {
        global $DIC;
        $ilias = $DIC['ilias'];
        if ($ilias->getSetting('custom_icons')) {
            $icons_cache = ilObjOrgUnit::getIconsCache();
            $obj_id = ilObject::_lookupObjId($a_node["child"]);
            if (isset($icons_cache[$obj_id])) {
                return $icons_cache[$obj_id];
            }
        }
 
        return ilObject::_getIcon($obj_id, "tiny", $a_node["type"]);
    }

References $DIC, and ilObject\_lookupObjId().

Here is the call graph for this function:

◆ getPluginLinkTarget()

ilOrgUnitExplorerGUI::getPluginLinkTarget ( )

protected

Returns: string

Definition at line 146 of file class.ilOrgUnitExplorerGUI.php.

                                             : string
    {
        global $DIC;
 
        return $DIC->ctrl()->getLinkTargetByClass(ilObjPluginDispatchGUI::class, 'forward');
    }

References $DIC.

Referenced by getNodeHref().

Here is the caller graph for this function:

◆ getRootNode()

ilOrgUnitExplorerGUI::getRootNode ( )

Returns: array

Reimplemented from ilTreeExplorerGUI.

Definition at line 70 of file class.ilOrgUnitExplorerGUI.php.

                                  : array
    {
        return $this->getTree()->getNodeData(ilObjOrgUnit::getRootOrgRefId());
    }

References ilObjOrgUnit\getRootOrgRefId(), and ilTreeExplorerGUI\getTree().

Here is the call graph for this function:

◆ isNodeClickable()

ilOrgUnitExplorerGUI::isNodeClickable ( $a_node )

Parameters

array $a_node

Returns: bool

Reimplemented from ilExplorerBaseGUI.

Definition at line 159 of file class.ilOrgUnitExplorerGUI.php.

                                             : bool
    {
        global $DIC;
        $ilAccess = $DIC->access();
 
        if ($ilAccess->checkAccess('read', '', $a_node['ref_id'])) {
            return true;
        }
 
        return false;
    }

References $DIC.

◆ isNodeSelectable()

ilOrgUnitExplorerGUI::isNodeSelectable ( $a_node )

Parameters

array $a_node

Returns: bool

Reimplemented from ilExplorerBaseGUI.

Definition at line 177 of file class.ilOrgUnitExplorerGUI.php.

                                              : bool
    {
        $current_node = filter_input(INPUT_GET, 'item_ref_id') ?? ilObjOrgUnit::getRootOrgRefId();
 
        return !($a_node['child'] === $current_node || $this->tree->isGrandChild($current_node, $a_node['child']));
    }

References ilObjOrgUnit\getRootOrgRefId().

Here is the call graph for this function:

Field Documentation

◆ $access

ilOrgUnitExplorerGUI::$access

protected

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

Referenced by __construct().

◆ $stay_with_command

ilOrgUnitExplorerGUI::$stay_with_command = array('', 'render', 'view', 'infoScreen', 'showStaff', 'performPaste', 'cut')

protected

Definition at line 19 of file class.ilOrgUnitExplorerGUI.php.

◆ $tree

ilOrgUnitExplorerGUI::$tree

protected

Definition at line 23 of file class.ilOrgUnitExplorerGUI.php.

◆ ORGU

const ilOrgUnitExplorerGUI::ORGU = "orgu"

protected

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

Referenced by getNodeHref().

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

Modules/OrgUnit/classes/class.ilOrgUnitExplorerGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ filterChildrenByPermission()

◆ getChildsOfNode()

◆ getLinkTarget()

◆ getNodeContent()

◆ getNodeHref()

◆ getNodeIcon()

◆ getPluginLinkTarget()

◆ getRootNode()

◆ isNodeClickable()

◆ isNodeSelectable()

Field Documentation

◆ $access

◆ $stay_with_command

◆ $tree

◆ ORGU