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")
	Constructor.
	getNodeContent ($a_node)
	Get node content.
	getNodeIcon ($a_node)
	Get node icon.
	getNodeIconAlt ($a_node)
	Get node icon alt text.
	isNodeHighlighted ($a_node)
	Is node highlighted?
	getNodeHref ($a_node)
	Get href for node.
	isNodeVisible ($a_node)
	Is node visible.
	sortChilds ($a_childs, $a_parent_node_id)
	Sort childs.
	getChildsOfNode ($a_parent_node_id)
	Get childs of node.
	isNodeClickable ($a_node)
	Is node clickable?
	setHighlightedNode ($a_value)
	set an alternate highlighted node if $_GET["ref_id"] is not set or wrong
	getHighlightedNode ()
	get an alternate highlighted node if $_GET["ref_id"] is not set or wrong Returns null if not set
	setClickableTypes ($a_types)
	set Whitelist for clickable items
	getClickableTypes ()
	get whitelist for clickable items
Public Member Functions inherited from ilTreeExplorerGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree)
	Constructor.
	getTree ()
	Get tree.
	setOrderField ($a_val, $a_numeric=false)
	Set order field.
	getOrderField ()
	Get order field.
	setTypeWhiteList ($a_val)
	Set type white list.
	getTypeWhiteList ()
	Get type white list.
	setTypeBlackList ($a_val)
	Set type black list.
	getTypeBlackList ()
	Get type black list.
	setPreloadChilds ($a_val)
	Set preload childs.
	getPreloadChilds ()
	Get preload childs.
	getSuccessorNode ($a_node_id, $a_type="")
	Get successor node (currently only(!) based on lft/rgt tree values)
	getNodeId ($a_node)
	Get id for node.
	getRootNode ()
	Get root node.
	setPathOpen ($a_id)
	Set node path to be opened.
	getHTML ()
	Get HTML.
Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor.
	nodeHasVisibleChilds ($a_node)
	Node has childs?
	getNodeTarget ($a_node)
	Get node target (frame) attribute.
	getNodeOnClick ($a_node)
	Get node onclick attribute.
	getId ()
	Get id of explorer element.
	setSkipRootNode ($a_val)
	Set skip root node.
	getSkipRootNode ()
	Get skip root node.
	setAjax ($a_val)
	Set ajax.
	getAjax ()
	Get ajax.
	setNodeOpen ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour)
	setSelectMode ($a_postvar, $a_multi=false)
	Set select mode (to deactivate, pass an empty string as postvar)
	setNodeSelected ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour)
	setOfflineMode ($a_val)
	Set offline mode.
	getOfflineMode ()
	Get offline mode.
	handleCommand ()
	Handle explorer internal command.
	getContainerId ()
	Get container id.
	openNode ()
	Open node.
	closeNode ()
	Close node.
	getNodeAsync ()
	Get node asynchronously.
	beforeRendering ()
	Before rendering.
	renderNode ($a_node, $tpl)
	Render node.
	renderChilds ($a_node_id, $tpl)
	Render childs.
	getDomNodeIdForNodeId ($a_node_id)
	Get DOM node id for node id.
	getNodeIdForDomNodeId ($a_dom_node_id)
	Get node id for dom node id.
	listItemStart ($tpl, $a_node)
	List item start.
	listItemEnd ($tpl)
	List item end.
	listStart ($tpl)
	List start.
	listEnd ($tpl)
	List end.

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

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()
	Get local path of explorer js.
static	getLocalJsTreeJsPath ()
	Get local path of jsTree js.
static	createHTMLExportDirs ($a_target_dir)
	Create html export directories.
Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()
	Preload childs.
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

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

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

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

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

        {
                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("rep_exp_sel", $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"]);
                }
        }

Here is the call graph for this function:

Member Function Documentation

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 268 of file class.ilRepositorySelectorExplorerGUI.php.

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

ilRepositorySelectorExplorerGUI::getClickableTypes ( )

get whitelist for clickable items

Returns: array types

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

References $clickable_types.

Referenced by isNodeClickable().

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

Here is the caller graph for this function:

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 324 of file class.ilRepositorySelectorExplorerGUI.php.

References $highlighted_node.

Referenced by isNodeHighlighted().

        {
                return $this->highlighted_node;
        }

Here is the caller graph for this function:

ilRepositorySelectorExplorerGUI::getNodeContent ( $a_node )

Get node content.

Parameters

array $a_node node data

Returns: string content

Reimplemented from ilExplorerBaseGUI.

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

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

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

Here is the call graph for this function:

ilRepositorySelectorExplorerGUI::getNodeHref ( $a_node )

Get href for node.

Parameters

mixed $a_node node object/array

Returns: string href attribute

Reimplemented from ilExplorerBaseGUI.

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

References $ilCtrl.

        {
                global $ilCtrl;
                $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, "");
                return $link;
        }

ilRepositorySelectorExplorerGUI::getNodeIcon ( $a_node )

Get node icon.

Parameters

array $a_node node data

Returns: string icon path

Reimplemented from ilExplorerBaseGUI.

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

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

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

Here is the call graph for this function:

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 117 of file class.ilRepositorySelectorExplorerGUI.php.

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

        {
                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);
        }

Here is the call graph for this function:

ilRepositorySelectorExplorerGUI::isNodeClickable ( $a_node )

Is node clickable?

Parameters

array $a_node node data

Returns: boolean node clickable true/false

Reimplemented from ilExplorerBaseGUI.

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

References getClickableTypes().

Referenced by ilForumMoveTopicsExplorer\renderNode().

        {
                global $ilAccess;
                if ($this->select_postvar != "")
                {
                        return false;
                }
                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;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilRepositorySelectorExplorerGUI::isNodeHighlighted ( $a_node )

Is node highlighted?

Parameters

mixed $a_node node object/array

Returns: boolean node visible true/false

Reimplemented from ilExplorerBaseGUI.

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

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

        {
                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;
        }       

Here is the call graph for this function:

ilRepositorySelectorExplorerGUI::isNodeVisible ( $a_node )

Is node visible.

Parameters

array $a_node node data

Returns: bool visible true/false

Reimplemented from ilExplorerBaseGUI.

Reimplemented in ilForumMoveTopicsExplorer.

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

References $ilSetting, and ilTreeExplorerGUI\$tree.

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

ilRepositorySelectorExplorerGUI::setClickableTypes ( $a_types )

set Whitelist for clickable items

Parameters

array/string $a_types array type

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

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

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 313 of file class.ilRepositorySelectorExplorerGUI.php.

        {
                $this->highlighted_node = $a_value;
        }

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 202 of file class.ilRepositorySelectorExplorerGUI.php.

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

        {
                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;
                }
                $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;
        }