ilRepositorySelectorExplorerGUI Class Reference

Explorer for selecting repository items. More...

Inheritance diagram for ilRepositorySelectorExplorerGUI:

Collaboration diagram for ilRepositorySelectorExplorerGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $a_selection_gui=null, $a_selection_cmd="selectObject", $a_selection_par="sel_ref_id", $a_id="rep_exp_sel")
	Constructor. More...
	setNodeContentModifier (callable $a_val)
	Set node content modifier. More...
	getNodeContentModifier ()
	Get node content modifier. More...
	getNodeContent ($a_node)
	Get node content. More...
	getNodeIcon ($a_node)
	Get node icon. More...
	getNodeIconAlt ($a_node)
	Get node icon alt text. More...
	isNodeHighlighted ($a_node)
	Is node highlighted? More...
	getNodeHref ($a_node)
	Get href for node. More...
	isNodeVisible ($a_node)
	Is node visible. More...
	sortChilds ($a_childs, $a_parent_node_id)
	Sort childs. More...
	getChildsOfNode ($a_parent_node_id)
	Get childs of node. More...
	isNodeClickable ($a_node)
	Is node clickable? More...
	setHighlightedNode ($a_value)
	set an alternate highlighted node if $_GET["ref_id"] is not set or wrong More...
	getHighlightedNode ()
	get an alternate highlighted node if $_GET["ref_id"] is not set or wrong Returns null if not set More...
	setClickableTypes ($a_types)
	set Whitelist for clickable items More...
	getClickableTypes ()
	get whitelist for clickable items More...
	setSelectableTypes ($a_types)
	Get HTML. More...
	getSelectableTypes ()
	get whitelist for clickable items 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 ()
	Get HTML. More...
Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor. 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...

Protected Member Functions
	isNodeSelectable ($a_node)
	Is node selectable? More...
Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()
	Preload childs. More...
	getRootId ()
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...
	getJSTreePlugins ()

Protected Attributes
	$type_grps = array()
	$session_materials = array()
	$highlighted_node = null
	$clickable_types = array()
	$nc_modifier = null
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()
Protected Attributes inherited from ilExplorerBaseGUI
	$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

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	createHTMLExportDirs ($a_target_dir)
	Create html export directories. More...
static	init ()
	Init JS. More...
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

Explorer for selecting repository items.

The implementation starts as a replacement for the often (ab)used ilSearchRootSelector class. Clicking items triggers a "selection" command. However ajax/checkbox/radio and use in an inputgui class should be implemented in the future, too.

The class has some things in commong with ilRepositoryExplorerGUI. Maybe a common parent class would be a good idea in the future.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 21 of file class.ilRepositorySelectorExplorerGUI.php.

Constructor & Destructor Documentation

__construct()

ilRepositorySelectorExplorerGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd,
			$a_selection_gui = null,
			$a_selection_cmd = "selectObject",
			$a_selection_par = "sel_ref_id",
			$a_id = "rep_exp_sel"
	)

Constructor.

Parameters

object	$a_parent_obj	parent gui object
string	$a_parent_cmd	parent cmd that renders the explorer
	object/string	$a_selection_gui gui class that should be called for the selection command
string	$a_selection_cmd	selection command
string	$a_selection_par	selection parameter

Reimplemented in ilPoolSelectorGUI.

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

        {
                global $tree, $objDefinition;
 
                if (is_null($a_selection_gui))
                {
                        $a_selection_gui = $a_parent_obj;
                }
 
                $this->selection_gui = is_object($a_selection_gui)
                        ? strtolower(get_class($a_selection_gui))
                        : strtolower($a_selection_gui);
                $this->selection_cmd = $a_selection_cmd;
                $this->selection_par = $a_selection_par;
                parent::__construct($a_id, $a_parent_obj, $a_parent_cmd, $tree);
 
                $this->setSkipRootNode(false);
                $this->setAjax(true);
                $this->setOrderField("title");
 
                // per default: all object types, except item groups
                $white = array();
                foreach ($objDefinition->getSubObjectsRecursively("root") as $rtype)
                {
                        if ($rtype["name"] != "itgr" && !$objDefinition->isSideBlock($rtype["name"]))
                        {
                                $white[] = $rtype["name"];
                        }
                }
                $this->setTypeWhiteList($white);
 
                // always open the path to the current ref id
                if ((int) $_GET["ref_id"] > 0)
                {
                        $this->setPathOpen((int) $_GET["ref_id"]);
                }
        }

References $_GET, ilTreeExplorerGUI\$tree, $white, ilExplorerBaseGUI\setAjax(), ilTreeExplorerGUI\setOrderField(), ilTreeExplorerGUI\setPathOpen(), ilExplorerBaseGUI\setSkipRootNode(), and ilTreeExplorerGUI\setTypeWhiteList().

Here is the call graph for this function:

Member Function Documentation

getChildsOfNode()

ilRepositorySelectorExplorerGUI::getChildsOfNode

(

$a_parent_node_id

)

Get childs of node.

Parameters

int

$a_parent_node_id

node id

Returns

array childs array

Reimplemented from ilTreeExplorerGUI.

Definition at line 312 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                global $ilAccess;
 
                if (!$ilAccess->checkAccess("read", "", $a_parent_node_id))
                {
                        return array();
                }
 
                return parent::getChildsOfNode($a_parent_node_id);
        }

Referenced by ilPoolSelectorGUI\isNodeVisible().

Here is the caller graph for this function:

getClickableTypes()

ilRepositorySelectorExplorerGUI::getClickableTypes

(

)

get whitelist for clickable items

Returns

array types

Definition at line 392 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                return (array)$this->clickable_types;
        }

References $clickable_types.

Referenced by isNodeClickable().

Here is the caller graph for this function:

getHighlightedNode()

ilRepositorySelectorExplorerGUI::getHighlightedNode

(

)

get an alternate highlighted node if $_GET["ref_id"] is not set or wrong Returns null if not set

Returns

mixed ref_id

Definition at line 368 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                return $this->highlighted_node;
        }

References $highlighted_node.

Referenced by isNodeHighlighted().

Here is the caller graph for this function:

getNodeContent()

ilRepositorySelectorExplorerGUI::getNodeContent

(

$a_node

)

Get node content.

Parameters

array

$a_node

node data

Returns

string content

Reimplemented from ilExplorerBaseGUI.

Definition at line 107 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                global $lng;
 
                $c = $this->getNodeContentModifier();
                if (is_callable($c))
                {
                        return $c($a_node);
                }
 
                $title = $a_node["title"];
                if ($a_node["child"] == $this->getNodeId($this->getRootNode()))
                {
                        if ($title == "ILIAS")
                        {
                                $title = $lng->txt("repository");
                        }
                }
 
                return $title;
        }

References $lng, $title, getNodeContentModifier(), ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

Here is the call graph for this function:

getNodeContentModifier()

ilRepositorySelectorExplorerGUI::getNodeContentModifier

(

)

Get node content modifier.

Returns

callable

Definition at line 96 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                return $this->nc_modifier;
        }

References $nc_modifier.

Referenced by getNodeContent().

Here is the caller graph for this function:

getNodeHref()

ilRepositorySelectorExplorerGUI::getNodeHref

(

$a_node

)

Get href for node.

Parameters

mixed

$a_node

node object/array

Returns

string href attribute

Reimplemented from ilExplorerBaseGUI.

Reimplemented in ilPoolSelectorGUI, and ilIntLinkRepItemExplorerGUI.

Definition at line 196 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                global $ilCtrl;
 
                if ($this->select_postvar == "")
                {
                        $ilCtrl->setParameterByClass($this->selection_gui, $this->selection_par, $a_node["child"]);
                        $link = $ilCtrl->getLinkTargetByClass($this->selection_gui, $this->selection_cmd);
                        $ilCtrl->setParameterByClass($this->selection_gui, $this->selection_par, "");
                }
                else
                {
                        return "#";
                }
 
                return $link;
        }

References $ilCtrl.

getNodeIcon()

ilRepositorySelectorExplorerGUI::getNodeIcon

(

$a_node

)

Get node icon.

Parameters

array

$a_node

node data

Returns

string icon path

Reimplemented from ilExplorerBaseGUI.

Definition at line 135 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                $obj_id = ilObject::_lookupObjId($a_node["child"]);
                return ilObject::_getIcon($obj_id, "tiny", $a_node["type"]);
        }

References ilObject\_getIcon(), and ilObject\_lookupObjId().

Here is the call graph for this function:

getNodeIconAlt()

ilRepositorySelectorExplorerGUI::getNodeIconAlt

(

$a_node

)

Get node icon alt text.

Parameters

array

$a_node

node data

Returns

string alt text

Reimplemented from ilTreeExplorerGUI.

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

        {
                global $lng;
 
                if ($a_node["child"] == $this->getNodeId($this->getRootNode()))
                {
                        $title = $a_node["title"];
                        if ($title == "ILIAS")
                        {
                                $title = $lng->txt("repository");
                        }
                        return $lng->txt("icon")." ".$title;
                }
 
 
                return parent::getNodeIconAlt($a_node);
        }

References $lng, $title, ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

Here is the call graph for this function:

getSelectableTypes()

ilRepositorySelectorExplorerGUI::getSelectableTypes

(

)

get whitelist for clickable items

Returns

array types

Definition at line 440 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                return (array)$this->selectable_types;
        }

Referenced by isNodeSelectable().

Here is the caller graph for this function:

isNodeClickable()

ilRepositorySelectorExplorerGUI::isNodeClickable

(

$a_node

)

Is node clickable?

Parameters

array

$a_node

node data

Returns

boolean node clickable true/false

Reimplemented from ilExplorerBaseGUI.

Reimplemented in ilConditionSelector, and ilLinkTargetObjectExplorerGUI.

Definition at line 330 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                global $ilAccess;
 
                if ($this->select_postvar != "")
                {
                        // return false; #14354
                }
 
                if (!$ilAccess->checkAccess("read", "", $a_node["child"]))
                {
                        return false;
                }
 
                if(is_array($this->getClickableTypes()) && count($this->getClickableTypes())>0)
                {
                        return in_array($a_node["type"], $this->getClickableTypes());
                }
 
                return true;
        }

References getClickableTypes().

Referenced by ilPoolSelectorGUI\isNodeVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

isNodeHighlighted()

ilRepositorySelectorExplorerGUI::isNodeHighlighted

(

$a_node

)

Is node highlighted?

Parameters

mixed

$a_node

node object/array

Returns

boolean node visible true/false

Reimplemented from ilExplorerBaseGUI.

Reimplemented in ilConditionSelector.

Definition at line 171 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                if($this->getHighlightedNode())
                {
                        if($this->getHighlightedNode() == $a_node["child"])
                        {
                                return true;
                        }
                        return false;
                }
 
                if ($a_node["child"] == $_GET["ref_id"] ||
                        ($_GET["ref_id"] == "" && $a_node["child"] == $this->getNodeId($this->getRootNode())))
                {
                        return true;
                }
                return false;
        }

References $_GET, getHighlightedNode(), ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

Here is the call graph for this function:

isNodeSelectable()

ilRepositorySelectorExplorerGUI::isNodeSelectable (   $a_node )

protected

Is node selectable?

Parameters

mixed

$a_node

node object/array

Returns

boolean node selectable true/false

Reimplemented from ilExplorerBaseGUI.

Definition at line 451 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                if(count($this->getSelectableTypes()))
                {
                        return in_array($a_node['type'],$this->getSelectableTypes() );
                }
                return true;
        }

References getSelectableTypes().

Here is the call graph for this function:

isNodeVisible()

ilRepositorySelectorExplorerGUI::isNodeVisible

(

$a_node

)

Is node visible.

Parameters

array

$a_node

node data

Returns

bool visible true/false

Reimplemented from ilExplorerBaseGUI.

Reimplemented in ilForumMoveTopicsExplorer, ilConditionSelector, and ilPoolSelectorGUI.

Definition at line 220 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                global $ilAccess,$tree,$ilSetting;
 
                if (!$ilAccess->checkAccess('visible', '', $a_node["child"]))
                {
                        return false;
                }
 
                return true;
        }

References $ilSetting, and ilTreeExplorerGUI\$tree.

setClickableTypes()

ilRepositorySelectorExplorerGUI::setClickableTypes

(

$a_types

)

set Whitelist for clickable items

Parameters

array/string

$a_types array type

Definition at line 378 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                if(!is_array($a_types))
                {
                        $a_types = array($a_types);
                }
                $this->clickable_types = $a_types;
        }

setHighlightedNode()

ilRepositorySelectorExplorerGUI::setHighlightedNode

(

$a_value

)

set an alternate highlighted node if $_GET["ref_id"] is not set or wrong

Parameters

int

$a_value

ref_id

Definition at line 357 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                $this->highlighted_node = $a_value;
        }

setNodeContentModifier()

ilRepositorySelectorExplorerGUI::setNodeContentModifier

(

callable

$a_val

)

Set node content modifier.

Parameters

callable

$a_val

Definition at line 86 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                $this->nc_modifier = $a_val;
        }

setSelectableTypes()

ilRepositorySelectorExplorerGUI::setSelectableTypes

(

$a_types

)

Get HTML.

Parameters

return set Whitelist for clickable items

Parameters

array/string

$a_types array type

Definition at line 426 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                if(!is_array($a_types))
                {
                        $a_types = array($a_types);
                }
                $this->selectable_types = $a_types;
        }

sortChilds()

ilRepositorySelectorExplorerGUI::sortChilds	(		$a_childs,
			$a_parent_node_id
	)

Sort childs.

Parameters

array	$a_childs	array of child nodes
int	$a_parent_node_id	parent node id

Returns

array array of childs nodes

Reimplemented from ilExplorerBaseGUI.

Definition at line 239 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                global $objDefinition;
 
                $parent_obj_id = ilObject::_lookupObjId($a_parent_node_id);
 
                if ($parent_obj_id > 0)
                {
                        $parent_type = ilObject::_lookupType($parent_obj_id);
                }
                else
                {
                        $parent_type  = "dummy";
                        $this->type_grps["dummy"] = array("root" => "dummy");
                }
 
                if (empty($this->type_grps[$parent_type]))
                {
                        $this->type_grps[$parent_type] =
                                $objDefinition->getGroupedRepositoryObjectTypes($parent_type);
                }
                $group = array();
 
                foreach ($a_childs as $child)
                {
                        $g = $objDefinition->getGroupOfObj($child["type"]);
                        if ($g == "")
                        {
                                $g = $child["type"];
                        }
                        $group[$g][] = $child;
                }
 
                // #14587 - $objDefinition->getGroupedRepositoryObjectTypes does NOT include side blocks!
                $wl = $this->getTypeWhiteList();
                if(is_array($wl) && in_array("poll", $wl))
                {
                        $this->type_grps[$parent_type]["poll"] = array();
                }
 
                $childs = array();
                foreach ($this->type_grps[$parent_type] as $t => $g)
                {
                        if (is_array($group[$t]))
                        {
                                // do we have to sort this group??
                                include_once("./Services/Container/classes/class.ilContainer.php");
                                include_once("./Services/Container/classes/class.ilContainerSorting.php");
                                $sort = ilContainerSorting::_getInstance($parent_obj_id);
                                $group = $sort->sortItems($group);
 
                                // need extra session sorting here
                                if ($t == "sess")
                                {
 
                                }
 
                                foreach ($group[$t] as $k => $item)
                                {
                                        $childs[] = $item;
                                }
                        }
                }
 
                return $childs;
        }

References ilTreeExplorerGUI\$childs, $t, ilContainerSorting\_getInstance(), ilObject\_lookupObjId(), ilObject\_lookupType(), and ilTreeExplorerGUI\getTypeWhiteList().

Here is the call graph for this function:

Field Documentation

$clickable_types

ilRepositorySelectorExplorerGUI::$clickable_types = array()

protected

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

Referenced by getClickableTypes().

$highlighted_node

ilRepositorySelectorExplorerGUI::$highlighted_node = null

protected

Definition at line 25 of file class.ilRepositorySelectorExplorerGUI.php.

Referenced by getHighlightedNode().

$nc_modifier

ilRepositorySelectorExplorerGUI::$nc_modifier = null

protected

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

Referenced by getNodeContentModifier().

$session_materials

ilRepositorySelectorExplorerGUI::$session_materials = array()

protected

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

$type_grps

ilRepositorySelectorExplorerGUI::$type_grps = array()

protected

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

---

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

• Services/Repository/classes/class.ilRepositorySelectorExplorerGUI.php