Class ilExplorer class for explorer view in admin frame. More...

Inheritance diagram for ilExplorer:

Collaboration diagram for ilExplorer:

Public Member Functions
	ilExplorer ($a_target)
	Constructor @access public. More...

	setId ($a_val)
	Set id. More...

	getId ()
	Get id. More...

	setAsynchExpanding ($a_val)
	Set asynch expanding. More...

	getAsynchExpanding ()
	Get asynch expanding. More...

	initItemCounter ($a_number)
	Init item counter. More...

	setTitle ($a_val)
	Set title. More...

	setTitleLength ($a_length)
	Set max title length. More...

	getTitleLength ()
	Get max title length. More...

	getTitle ()
	Get title. More...

	setRoot ($a_root_id)
	Set root node. More...

	getRoot ()
	get root id More...

	setOrderColumn ($a_column)
	set the order column @access public More...

	setOrderDirection ($a_direction)
	set the order direction @access public More...

	setTargetGet ($a_target_get)
	set the varname in Get-string @access public More...

	setParamsGet ($a_params_get)
	set additional params to be passed in Get-string @access public More...

	setExpandTarget ($a_exp_target)
	target script for expand icons More...

	setFrameUpdater ($a_up_frame, $a_up_script, $a_params="")
	Set Explorer Updater. More...

	highlightNode ($a_id)
	set highlighted node More...

	checkPermissions ($a_check)
	check permissions via rbac More...

	setSessionExpandVariable ($a_var_name="expand")
	set name of expand session variable More...

	outputIcons ($a_icons)
	output icons More...

	setClickable ($a_type, $a_clickable)
	(de-)activates links for a certain object type More...

	isVisible ($a_ref_id, $a_type)

	setTreeLead ($a_val)
	Set tree leading content. More...

	getTreeLead ()
	Get tree leading content. More...

	isClickable ($a_type, $a_ref_id=0)
	check if links for certain object type are activated More...

	setPostSort ($a_sort)
	process post sorting More...

	setFilterMode ($a_mode=IL_FM_NEGATIVE)
	set filter mode More...

	getFilterMode ()
	get filter mode More...

	setUseStandardFrame ($a_val)
	Set use standard frame. More...

	getUseStandardFrame ()
	Get use standard explorer frame. More...

	getChildsOfNode ($a_parent_id)
	Get childs of node. More...

	setOutput ($a_parent_id, $a_depth=1, $a_obj_id=0, $a_highlighted_subtree=false)
	Creates output for explorer view in admin menue recursive method @access public. More...

	modifyChilds ($a_parent_id, $a_objects)

	showChilds ($a_parent_id)
	determines wether the childs of an object should be shown or not note: this standard implementation always returns true but it could be overwritten by derived classes (e.g. More...

	forceExpanded ($a_obj_id)
	force expansion of node More...

	getMaximumTreeDepth ()
	Get maximum tree depth. More...

	getOutput ()
	Creates output recursive method @access public. More...

	handleListEndTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list end tags ( and ) More...

	handleListStartTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list start tags ( More...

	formatHeader (&$tpl, $a_obj_id, $a_option)
	Creates output for header (is empty here but can be overwritten in derived classes) More...

	formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
	Creates output recursive method @access private. More...

	getImage ($a_name, $a_type="", $a_obj_id="")
	get image path (may be overwritten by derived classes) More...

	getImageAlt ($a_default_text, $a_type="", $a_obj_id="")
	get image alt text More...

	getNodeStyleClass ($a_id, $a_type)
	get style class for node More...

	buildLinkTarget ($a_node_id, $a_type)
	get link target (may be overwritten by derived classes) More...

	buildOnClick ($a_node_id, $a_type, $a_title)
	get onclick event handling (may be overwritten by derived classes) More...

	buildTitle ($a_title, $a_id, $a_type)
	standard implementation for title, may be overwritten by derived classes More...

	buildDescription ($a_desc, $a_id, $a_type)
	standard implementation for description, may be overwritten by derived classes More...

	buildSelect ($a_node_id, $a_type)
	standard implementation for adding an option select box between image and title More...

	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	get frame target (may be overwritten by derived classes) More...

	createTarget ($a_type, $a_node_id, $a_highlighted_subtree=false, $a_append_anch=true)
	Creates Get Parameter @access private. More...

	setFrameTarget ($a_target)
	set target frame or not frame? More...

	createLines ($a_depth)
	Creates lines for explorer view @access private. More...

	is_in_array ($a_start, $a_depth)
	DESCRIPTION MISSING @access private. More...

	getIndex ($a_data)
	get index of format_options array from specific ref_id,parent_id @access private More...

	addFilter ($a_item)
	adds item to the filter @access public More...

	delFilter ($a_item)
	removes item from the filter @access public More...

	setExpand ($a_node_id)
	set the expand option this value is stored in a SESSION variable to save it different view (lo view, frm view,...) @access private More...

	forceExpandAll ($a_mode, $a_show_minus=true)
	force expandAll. More...

	setFiltered ($a_bool)
	active/deactivate the filter @access public More...

	checkFilter ($a_item)
	check if item is in filter @access private More...

	sortNodes ($a_nodes, $a_parent_obj_id)
	sort nodes and put adm object to the end of sorted array @access private More...

Data Fields
	$id

	$ilias

	$output

	$format_options

	$tree

	$target

	$target_get

	$params_get

	$expanded

	$order_column

	$order_direction = "asc"

	$expand_target

	$rbac_check

	$output_icons

	$expand_variable

	$is_clickable

	$post_sort

	$filtered = false

	$filter_mode

	$expand_all = false

	$root_id = null

	$use_standard_frame = false

Detailed Description

Class ilExplorer class for explorer view in admin frame.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

Definition at line 16 of file class.ilExplorer.php.

Member Function Documentation

◆ addFilter()

ilExplorer::addFilter ( $a_item )

adds item to the filter @access public

Parameters

string object type to add

Returns: boolean

Definition at line 1353 of file class.ilExplorer.php.

        {
                $ispresent = 0;
 
                if (is_array($this->filter))
                {
                        //run through filter
                    foreach ($this->filter as $item)
                        {
                                if ($item == $a_item)
                                {
                                    $is_present = 1;
 
                                        return false;
                                }
                        }
                }
                else
                {
                        $this->filter = array();
                }
                if ($is_present == 0)
                {
                        $this->filter[] = $a_item;
                }
 
                return true;
        }

Referenced by ilContainerSelectionExplorer\__construct(), ilECSNodeMappingLocalExplorer\__construct(), ilSurveySkillExplorer\__construct(), ilPasteIntoMultipleItemsExplorer\__construct(), ilWorkspaceExplorer\__construct(), ilExplorer(), ilLMMenuObjectSelector\ilLMMenuObjectSelector(), ilRepositoryCopySelector\ilRepositoryCopySelector(), ilRepositoryExplorer\ilRepositoryExplorer(), ilRepositoryLinkSelector\ilRepositoryLinkSelector(), ilRoleDesktopItemSelector\ilRoleDesktopItemSelector(), ilSearchRootSelector\ilSearchRootSelector(), and ilSolutionExplorer\ilSolutionExplorer().

Here is the caller graph for this function:

◆ buildDescription()

ilExplorer::buildDescription	(	$a_desc,
		$a_id,
		$a_type
	)

standard implementation for description, may be overwritten by derived classes

Reimplemented in ilWorkspaceFolderExplorer.

Definition at line 1183 of file class.ilExplorer.php.

        {
                return "";
        }

Referenced by ilPasteIntoMultipleItemsExplorer\formatObject(), ilWorkspaceExplorer\formatObject(), formatObject(), ilECSNodeMappingCmsExplorer\formatObject(), and ilECSNodeMappingLocalExplorer\formatObject().

Here is the caller graph for this function:

◆ buildFrameTarget()

ilExplorer::buildFrameTarget	(	$a_type,
		$a_child = `0`,
		$a_obj_id = `0`
	)

get frame target (may be overwritten by derived classes)

Reimplemented in ilLMMenuObjectSelector, ilSurveySkillExplorer, ilSolutionExplorer, ilWorkspaceFolderExplorer, ilRoleDesktopItemSelector, ilAdministrationExplorer, ilObjectSelector, ilRepositoryCopySelector, ilRepositoryExplorer, ilRepositoryLinkSelector, and ilSearchRootSelector.

Definition at line 1200 of file class.ilExplorer.php.

        {
                return $this->frame_target;
        }

Referenced by ilAICCExplorer\formatObject(), ilHACPExplorer\formatObject(), formatObject(), ilECSNodeMappingCmsExplorer\formatObject(), ilECSNodeMappingLocalExplorer\formatObject(), and ilSCORMExplorer\insertObject().

Here is the caller graph for this function:

◆ buildLinkTarget()

ilExplorer::buildLinkTarget	(	$a_node_id,
		$a_type
	)

get link target (may be overwritten by derived classes)

Reimplemented in ilLMMenuObjectSelector, ilGlossarySelectorGUI, ilAsyncContainerSelectionExplorer, ilSurveySkillExplorer, ilSolutionExplorer, ilWorkspaceFolderExplorer, ilRoleDesktopItemSelector, ilAdministrationExplorer, ilFileSelectorGUI, ilObjectSelector, ilShopRepositoryExplorer, ilWorkspaceExplorer, ilRepositoryCopySelector, ilRepositoryExplorer, ilRepositoryLinkSelector, and ilSearchRootSelector.

Definition at line 1156 of file class.ilExplorer.php.

        {
                $target = (strpos($this->target, "?") === false)
                        ? $this->target."?"
                        : $this->target."&";
                return $target.$this->target_get."=".$a_node_id.$this->params_get;
        }

References $target.

Referenced by ilAICCExplorer\formatObject(), ilHACPExplorer\formatObject(), formatObject(), ilECSNodeMappingCmsExplorer\formatObject(), and ilECSNodeMappingLocalExplorer\formatObject().

Here is the caller graph for this function:

◆ buildOnClick()

ilExplorer::buildOnClick	(	$a_node_id,
		$a_type,
		$a_title
	)

get onclick event handling (may be overwritten by derived classes)

Reimplemented in ilAsyncContainerSelectionExplorer.

Definition at line 1167 of file class.ilExplorer.php.

        {
                return "";
        }

Referenced by ilPasteIntoMultipleItemsExplorer\formatObject(), ilWorkspaceExplorer\formatObject(), formatObject(), ilECSNodeMappingCmsExplorer\formatObject(), and ilECSNodeMappingLocalExplorer\formatObject().

Here is the caller graph for this function:

◆ buildSelect()

ilExplorer::buildSelect	(	$a_node_id,
		$a_type
	)

standard implementation for adding an option select box between image and title

Reimplemented in ilCopyWizardExplorer.

Definition at line 1191 of file class.ilExplorer.php.

        {
                return "";
        }

Referenced by formatObject().

Here is the caller graph for this function:

◆ buildTitle()

ilExplorer::buildTitle	(	$a_title,
		$a_id,
		$a_type
	)

standard implementation for title, may be overwritten by derived classes

Reimplemented in ilSurveySkillExplorer, ilECSNodeMappingCmsExplorer, and ilECSNodeMappingLocalExplorer.

Definition at line 1175 of file class.ilExplorer.php.

        {
                return $a_title;
        }

Referenced by ilPasteIntoMultipleItemsExplorer\formatObject(), ilWorkspaceExplorer\formatObject(), and formatObject().

Here is the caller graph for this function:

◆ checkFilter()

ilExplorer::checkFilter ( $a_item )

check if item is in filter @access private

Parameters

string

Returns: integer

Definition at line 1482 of file class.ilExplorer.php.

        {
                if (is_array($this->filter))
                {
                        if (in_array($a_item, $this->filter))
                        {
                                $ret = true;
                        }
                        else
                        {
                                $ret = false;
                        }
                }
                else
                {
                        $ret = false;
                }
 
                if ($this->getFilterMode() == IL_FM_NEGATIVE )
                {
                        return $ret;
                }
                else
                {
                        return !$ret;
                }
        }

References $ret, getFilterMode(), and IL_FM_NEGATIVE.

Referenced by ilAICCExplorer\setOutput(), and setOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkPermissions()

ilExplorer::checkPermissions ( $a_check )

check permissions via rbac

Parameters

boolean $a_check check true/false

Definition at line 431 of file class.ilExplorer.php.

        {
                $this->rbac_check = $a_check;
        }

Referenced by ilContainerSelectionExplorer\__construct(), ilSurveySkillExplorer\__construct(), ilAICCExplorer\__construct(), ilSCORMExplorer\__construct(), and ilHACPExplorer\ilHACPExplorer().

Here is the caller graph for this function:

◆ createLines()

ilExplorer::createLines ( $a_depth )

Creates lines for explorer view @access private.

Parameters

integer

Definition at line 1264 of file class.ilExplorer.php.

        {
                for ($i = 0; $i < count($this->format_options); ++$i)
                {
                        if ($this->format_options[$i]["depth"] == $a_depth+1
                           and !$this->format_options[$i]["container"]
                                and $this->format_options[$i]["depth"] != 1)
                        {
                                $this->format_options[$i]["tab"]["$a_depth"] = "quer";
                        }
 
                        if ($this->format_options[$i]["depth"] == $a_depth+2)
                        {
                                if ($this->is_in_array($i+1,$this->format_options[$i]["depth"]))
                                {
                                        $this->format_options[$i]["tab"]["$a_depth"] = "winkel";
                                }
                                else
                                {
                                        $this->format_options[$i]["tab"]["$a_depth"] = "ecke";
                                }
                        }
 
                        if ($this->format_options[$i]["depth"] > $a_depth+2)
                        {
                                if ($this->is_in_array($i+1,$a_depth+2))
                                {
                                        $this->format_options[$i]["tab"]["$a_depth"] = "hoch";
                                }
                        }
                }
        }

References is_in_array().

Referenced by getOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createTarget()

ilExplorer::createTarget	(	$a_type,
		$a_node_id,
		$a_highlighted_subtree = `false`,
		$a_append_anch = `true`
	)

Creates Get Parameter @access private.

Parameters

string
integer

Returns: string

Definition at line 1213 of file class.ilExplorer.php.

        {
                if (!isset($a_type) or !is_string($a_type) or !isset($a_node_id))
                {
                        $this->ilias->raiseError(get_class($this)."::createTarget(): Missing parameter or wrong datatype! ".
                                                                        "type: ".$a_type." node_id:".$a_node_id,$this->ilias->error_obj->WARNING);
                }
 
                // SET expand parameter:
                //     positive if object is expanded
                //     negative if object is compressed
                $a_node_id = $a_type == '+' ? $a_node_id : -(int) $a_node_id;
 
                $sep = (is_int(strpos($this->expand_target, "?")))
                        ? "&"
                        : "?";
                
                // in current tree flag
                $ict_str = ($a_highlighted_subtree || $this->highlighted == "")
                        ? "&ict=1"
                        : "";
                if ($this->getAsynchExpanding())
                {
                        $ict_str.= "&cmdMode=asynch";
                }
                if ($a_append_anch)
                {
                        return $this->expand_target.$sep.$this->expand_variable."=".$a_node_id.$this->params_get.$ict_str."#".abs($a_node_id);
                }
                else
                {
                        return $this->expand_target.$sep.$this->expand_variable."=".$a_node_id.$this->params_get.$ict_str;
                }
        }

References getAsynchExpanding().

Referenced by ilPasteIntoMultipleItemsExplorer\formatObject(), ilWorkspaceExplorer\formatObject(), formatObject(), ilECSNodeMappingCmsExplorer\formatObject(), and ilECSNodeMappingLocalExplorer\formatObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delFilter()

ilExplorer::delFilter ( $a_item )

removes item from the filter @access public

Parameters

string object type to remove

Returns: boolean

Definition at line 1388 of file class.ilExplorer.php.

        {
                //check if a filter exists
                if (is_array($this->filter))
                {
                        //build copy of the existing filter without the given item
                        $tmp = array();
 
                        foreach ($this->filter as $item)
                    {
                                if ($item != $a_item)
                                {
                                    $tmp[] = $item;
                                }
                                else
                                {
                                        $deleted = 1;
                                }
                        }
 
                        $this->filter = $tmp;
                }
                else
                {
                        return false;
                }
 
                if ($deleted == 1)
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

◆ forceExpandAll()

ilExplorer::forceExpandAll	(	$a_mode,
		$a_show_minus = `true`
	)

force expandAll.

if true all nodes are expanded regardless of the values in $expanded (default: false) @access public

Parameters

boolean

Definition at line 1458 of file class.ilExplorer.php.

        {
                $this->expand_all = (bool) $a_mode;
                $this->show_minus = $a_show_minus;
        }

◆ forceExpanded()

ilExplorer::forceExpanded ( $a_obj_id )

force expansion of node

Reimplemented in ilRepositoryExplorer, ilSurveySkillExplorer, ilAdministrationExplorer, and ilFileSelectorGUI.

Definition at line 767 of file class.ilExplorer.php.

        {
                return false;
        }

Referenced by setOutput().

Here is the caller graph for this function:

◆ formatHeader()

ilExplorer::formatHeader	(	&	$tpl,
			$a_obj_id,
			$a_option
	)

Creates output for header (is empty here but can be overwritten in derived classes)

@access public

Parameters

integer	obj_id
integer	array options

Reimplemented in ilGlossarySelectorGUI, ilAdministrationExplorer, ilFileSelectorGUI, ilPasteIntoMultipleItemsExplorer, ilShopRepositoryExplorer, ilWorkspaceExplorer, ilRepositoryExplorer, ilECSNodeMappingCmsExplorer, and ilECSNodeMappingLocalExplorer.

Definition at line 971 of file class.ilExplorer.php.

972 {

973 }

Referenced by getOutput().

Here is the caller graph for this function:

◆ formatObject()

ilExplorer::formatObject	(	&	$tpl,
			$a_node_id,
			$a_option,
			$a_obj_id = `0`
	)

Creates output recursive method @access private.

Parameters

integer
array

Returns: string

Reimplemented in ilPasteIntoMultipleItemsExplorer, ilWorkspaceExplorer, ilECSNodeMappingCmsExplorer, and ilECSNodeMappingLocalExplorer.

Definition at line 983 of file class.ilExplorer.php.

        {
                global $lng;
                if (!isset($a_node_id) or !is_array($a_option))
                {
                        $this->ilias->raiseError(get_class($this)."::formatObject(): Missing parameter or wrong datatype! ".
                                                                        "node_id: ".$a_node_id." options:".var_dump($a_option),$this->ilias->error_obj->WARNING);
                }
 
                $pic = false;
                foreach ((array) $a_option["tab"] as $picture)
                {
                        if ($picture == 'plus')
                        {
                                $tpl->setCurrentBlock("expander");
                                $tpl->setVariable("EXP_DESC", $lng->txt("collapsed"));
                                $tpl->setVariable("LINK_NAME", $a_node_id);
                                if (!$this->getAsynchExpanding())
                                {
                                        $target = $this->createTarget('+',$a_node_id, $a_option["highlighted_subtree"]);
                                        $tpl->setVariable("LINK_TARGET_EXPANDER", $target);
                                }
                                else
                                {
                                        $target = $this->createTarget('+',$a_node_id, $a_option["highlighted_subtree"], false);
                                        $tpl->setVariable("ONCLICK_TARGET_EXPANDER", " onclick=\"return il.Explorer.refresh('tree_div', '".$target."');\"");
                                        $tpl->setVariable("LINK_TARGET_EXPANDER", "#");
                                }
                                $tpl->setVariable("IMGPATH", $this->getImage("browser/plus.png"));
                                $tpl->parseCurrentBlock();
                                $pic = true;
                        }
 
                        if ($picture == 'forceexp')
                        {
                                $tpl->setCurrentBlock("expander");
                                $tpl->setVariable("EXP_DESC", $lng->txt("expanded"));
                                $target = $this->createTarget('+',$a_node_id);
                                $tpl->setVariable("LINK_NAME", $a_node_id);
                                $tpl->setVariable("LINK_TARGET_EXPANDER", $target);
                                $tpl->setVariable("IMGPATH", $this->getImage("browser/forceexp.png"));
                                $tpl->parseCurrentBlock();
                                $pic = true;
                        }
 
                        if ($picture == 'minus' && $this->show_minus)
                        {
                                $tpl->setCurrentBlock("expander");
                                $tpl->setVariable("EXP_DESC", $lng->txt("expanded"));
                                $tpl->setVariable("LINK_NAME", $a_node_id);
                                if (!$this->getAsynchExpanding())
                                {
                                        $target = $this->createTarget('-',$a_node_id, $a_option["highlighted_subtree"]);
                                        $tpl->setVariable("LINK_TARGET_EXPANDER", $target);
                                }
                                else
                                {
                                        $target = $this->createTarget('-',$a_node_id, $a_option["highlighted_subtree"], false);
                                        $tpl->setVariable("ONCLICK_TARGET_EXPANDER", " onclick=\"return il.Explorer.refresh('tree_div', '".$target."');\"");
                                        $tpl->setVariable("LINK_TARGET_EXPANDER", "#");
                                }
                                $tpl->setVariable("IMGPATH", $this->getImage("browser/minus.png"));
                                $tpl->parseCurrentBlock();
                                $pic = true;
                        }
 
                }
                
                if (!$pic)
                {
                        $tpl->setCurrentBlock("blank");
                        $tpl->setVariable("BLANK_PATH", $this->getImage("browser/blank.png"));
                        $tpl->parseCurrentBlock();
                }
 
                if ($this->output_icons)
                {
                        $tpl->setCurrentBlock("icon");
                        $tpl->setVariable("ICON_IMAGE" , $this->getImage("icon_".$a_option["type"].".svg", $a_option["type"], $a_obj_id));
                        
                        $tpl->setVariable("TARGET_ID" , "iconid_".$a_node_id);
                        $this->iconList[] = "iconid_".$a_node_id;
                        $tpl->setVariable("TXT_ALT_IMG",
                                $this->getImageAlt($lng->txt("icon")." ".$lng->txt($a_option["desc"]), $a_option["type"], $a_obj_id));
                        $tpl->parseCurrentBlock();
                }
                
                if(strlen($sel = $this->buildSelect($a_node_id,$a_option['type'])))
                {
                        $tpl->setCurrentBlock('select');
                        $tpl->setVariable('OBJ_SEL',$sel);
                        $tpl->parseCurrentBlock();
                }
 
                if ($this->isClickable($a_option["type"], $a_node_id,$a_obj_id))        // output link
                {
                        $tpl->setCurrentBlock("link");
                        //$target = (strpos($this->target, "?") === false) ?
                        //      $this->target."?" : $this->target."&";
                        //$tpl->setVariable("LINK_TARGET", $target.$this->target_get."=".$a_node_id.$this->params_get);
                        $tpl->setVariable("LINK_TARGET", $this->buildLinkTarget($a_node_id, $a_option["type"]));
                                
                        $style_class = $this->getNodeStyleClass($a_node_id, $a_option["type"]);
                        
                        if ($style_class != "")
                        {
                                $tpl->setVariable("A_CLASS", ' class="'.$style_class.'" ' );
                        }
 
                        if (($onclick = $this->buildOnClick($a_node_id, $a_option["type"], $a_option["title"])) != "")
                        {
                                $tpl->setVariable("ONCLICK", "onClick=\"$onclick\"");
                        }
 
                        //$tpl->setVariable("LINK_NAME", $a_node_id);
                        $tpl->setVariable("TITLE", ilUtil::shortenText(
                                $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"]),
                                $this->textwidth, true));
                        $tpl->setVariable("DESC", ilUtil::shortenText(
                                $this->buildDescription($a_option["description"], $a_node_id, $a_option["type"]), $this->textwidth, true));
                        $frame_target = $this->buildFrameTarget($a_option["type"], $a_node_id, $a_option["obj_id"]);
                        if ($frame_target != "")
                        {
                                $tpl->setVariable("TARGET", " target=\"".$frame_target."\"");
                        }
                        $tpl->parseCurrentBlock();
                }
                else                    // output text only
                {
                        $tpl->setCurrentBlock("text");
                        $tpl->setVariable("OBJ_TITLE", ilUtil::shortenText(
                                $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"]), $this->textwidth, true));
                        $tpl->setVariable("OBJ_DESC", ilUtil::shortenText(
                                $this->buildDescription($a_option["desc"], $a_node_id, $a_option["type"]), $this->textwidth, true));                    
                        $tpl->parseCurrentBlock();
                }
 
                $tpl->setCurrentBlock("list_item");
                $tpl->parseCurrentBlock();
                $tpl->touchBlock("element");
        }

References $lng, $target, $tpl, buildDescription(), buildFrameTarget(), buildLinkTarget(), buildOnClick(), buildSelect(), buildTitle(), createTarget(), getAsynchExpanding(), getImage(), getImageAlt(), getNodeStyleClass(), isClickable(), and ilUtil\shortenText().

Referenced by getOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAsynchExpanding()

ilExplorer::getAsynchExpanding ( )

Get asynch expanding.

Returns: boolean

Definition at line 248 of file class.ilExplorer.php.

        {
                return $this->asnch_expanding;
        }

Referenced by createTarget(), and formatObject().

Here is the caller graph for this function:

◆ getChildsOfNode()

ilExplorer::getChildsOfNode ( $a_parent_id )

Get childs of node.

Parameters

int $a_parent_id parent id

Returns: array childs

Definition at line 590 of file class.ilExplorer.php.

        {
                return $this->tree->getChilds($a_parent_id, $this->order_column);
        }

Referenced by setOutput().

Here is the caller graph for this function:

◆ getFilterMode()

ilExplorer::getFilterMode ( )

get filter mode

Returns: int filter mode IL_FM_NEGATIVE | IL_FM_NEGATIVE

Definition at line 558 of file class.ilExplorer.php.

        {
                return $this->filter_mode;
        }

References $filter_mode.

Referenced by checkFilter().

Here is the caller graph for this function:

◆ getId()

ilExplorer::getId ( )

Get id.

Returns: string id

Definition at line 228 of file class.ilExplorer.php.

        {
                return $this->id;
        }

References $id.

Referenced by getOutput(), and ilAsyncContainerSelectionExplorer\initJs().

Here is the caller graph for this function:

◆ getImage()

ilExplorer::getImage	(	$a_name,
		$a_type = `""`,
		$a_obj_id = `""`
	)

get image path (may be overwritten by derived classes)

Reimplemented in ilSurveySkillExplorer, ilAdministrationExplorer, ilCopyWizardExplorer, and ilRepositoryExplorer.

Definition at line 1128 of file class.ilExplorer.php.

        {
                return ilUtil::getImagePath($a_name);
        }

References ilUtil\getImagePath().

Referenced by formatObject(), ilECSNodeMappingCmsExplorer\formatObject(), and ilECSNodeMappingLocalExplorer\formatObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImageAlt()

ilExplorer::getImageAlt	(	$a_default_text,
		$a_type = `""`,
		$a_obj_id = `""`
	)

get image alt text

Reimplemented in ilWorkspaceFolderExplorer.

Definition at line 1136 of file class.ilExplorer.php.

        {
                return $a_default_text;
        }

Referenced by formatObject().

Here is the caller graph for this function:

◆ getIndex()

ilExplorer::getIndex ( $a_data )

get index of format_options array from specific ref_id,parent_id @access private

Parameters

array object data

Returns: integer index

Definition at line 1327 of file class.ilExplorer.php.

        {
                if(!is_array($this->format_options))
                {
                        return -1;
                }
                
                foreach ($this->format_options as $key => $value)
                {
                        if (($value["child"] == $a_data["parent"]))
                        {
                                return $key;
                        }
                }
                
                return -1;
                // exit on error
                #$this->ilias->raiseError(get_class($this)."::getIndex(): Error in tree. No index found!",$this->ilias->error_obj->FATAL);
        }

Referenced by ilAICCExplorer\getParentIndex(), ilWorkspaceFolderExplorer\setOutput(), and setOutput().

Here is the caller graph for this function:

◆ getMaximumTreeDepth()

ilExplorer::getMaximumTreeDepth ( )

Get maximum tree depth.

Parameters

return

Definition at line 778 of file class.ilExplorer.php.

        {
                $this->tree->getMaximumDepth();
        }

Referenced by getOutput().

Here is the caller graph for this function:

◆ getNodeStyleClass()

ilExplorer::getNodeStyleClass	(	$a_id,
		$a_type
	)

get style class for node

Definition at line 1144 of file class.ilExplorer.php.

        {
                if ($a_id == $this->highlighted)
                {
                        return "il_HighlightedNode";
                }
                return "";
        }

Referenced by ilWorkspaceFolderExplorer\formatHeader(), ilPasteIntoMultipleItemsExplorer\formatObject(), ilWorkspaceExplorer\formatObject(), formatObject(), ilECSNodeMappingCmsExplorer\formatObject(), and ilECSNodeMappingLocalExplorer\formatObject().

Here is the caller graph for this function:

◆ getOutput()

ilExplorer::getOutput ( )

Creates output recursive method @access public.

Returns: string

Reimplemented in ilAsyncContainerSelectionExplorer, and ilWorkspaceFolderExplorer.

Definition at line 790 of file class.ilExplorer.php.

        {
                global $ilBench, $tpl, $lng;
 
                $ilBench->start("Explorer", "getOutput");
 
                $this->format_options[0]["tab"] = array();
 
                $depth = $this->getMaximumTreeDepth();
 
                for ($i=0;$i<$depth;++$i)
                {
                        $this->createLines($i);
                }
 
                include_once("./Services/YUI/classes/class.ilYuiUtil.php");
                ilYuiUtil::initConnection();
                $tpl->addJavaScript("./Services/UIComponent/Explorer/js/ilExplorer.js");
 
                $tpl->addBlockFile("EXPLORER_TOP", "exp_top", "tpl.explorer_top.html");
//echo "hh";
                // set global body class
//              $tpl->setBodyClass("il_Explorer");
                
                $tpl_tree = new ilTemplate("tpl.tree.html", true, true, "Services/UIComponent/Explorer");
                
                // updater
                if (($_GET["ict"] || $_POST["collapseAll"] != "" || $_POST["expandAll"] != "") && $this->up_frame != "")
                {
                        $tpl_tree->setCurrentBlock("updater");
                        $tpl_tree->setVariable("UPDATE_FRAME", $this->up_frame);
                        $tpl_tree->setVariable("UPDATE_SCRIPT", $this->up_script);
                        if (is_array($this->up_params))
                        {
                                $up_str = $lim = "";
                                foreach ($this->up_params as $p)
                                {
                                        $up_str.=  $lim."'".$p."'";
                                        $lim = ",";
                                }
                                $tpl_tree->setVariable("UPDATE_PARAMS", $up_str);
                        }
                        $tpl_tree->parseCurrentBlock();
                }
                
                $cur_depth = -1;
                foreach ($this->format_options as $key => $options)
                {
//echo "-".$options["depth"]."-";
                        if (!$options["visible"])
                        {
                                continue;
                        }
                        
                        // end tags
                        $this->handleListEndTags($tpl_tree, $cur_depth, $options["depth"]);
                        
                        // start tags
                        $this->handleListStartTags($tpl_tree, $cur_depth, $options["depth"]);
                        
                        $cur_depth = $options["depth"];
                        
                        if ($options["visible"] and $key != 0)
                        {
                                $this->formatObject($tpl_tree, $options["child"],$options,$options['obj_id']);
                        }
                        if ($key == 0)
                        {
                                $this->formatHeader($tpl_tree, $options["child"],$options);
                        }
                                                
                }
//if ($GLOBALS["ilUser"]->getLogin() == "alex") var_dump($this->format_options);
                $this->handleListEndTags($tpl_tree, $cur_depth, -1);
                
                $ilBench->stop("Explorer", "getOutput");
 
                $tpl_tree->setVariable("TREE_LEAD", "");
                if ($this->tree_lead != "")
                {
                        $tpl_tree->setCurrentBlock("tree_lead");
                        $tpl_tree->setVariable("TREE_LEAD", $this->tree_lead);
                        $tpl_tree->parseCurrentBlock();
                }
                if ($this->getId() != "")
                {
                        $tpl_tree->setVariable("TREE_ID", 'id="'.$this->getId().'_tree"');
                }
 
                $html = $tpl_tree->get();
                
                if ($this->getUseStandardFrame())
                {
                        $mtpl = new ilTemplate("tpl.main.html", true, true);
                        $mtpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
                        $mtpl->setVariable("BODY_CLASS", "il_Explorer");
                        $mtpl->addBlockFile("CONTENT", "content", "tpl.explorer.html");
                        if ($this->getTitle() != "")
                        {
                                $mtpl->setVariable("TXT_EXPLORER_HEADER", $this->getTitle());
                        }
                        if ($this->getId() != "")
                        {
                                $mtpl->setVariable("ID", 'id="'.$this->getId().'"');
                        }
                        $mtpl->setVariable("IMG_SPACE", ilUtil::getImagePath("spacer.png", false));
                        $mtpl->setCurrentBlock("content");
                        $mtpl->setVariable("EXPLORER", $html);
                        $mtpl->setVariable("EXP_REFRESH", $lng->txt("refresh"));
                        $mtpl->parseCurrentBlock();
                        $html = $mtpl->get();
                }
                
                return $html;
        }

References $_GET, $_POST, $html, $ilBench, $lng, $options, $tpl, createLines(), formatHeader(), formatObject(), getId(), ilUtil\getImagePath(), getMaximumTreeDepth(), ilUtil\getStyleSheetLocation(), getTitle(), getUseStandardFrame(), handleListEndTags(), handleListStartTags(), and ilYuiUtil\initConnection().

Here is the call graph for this function:

◆ getRoot()

ilExplorer::getRoot ( )

get root id

@access public

Parameters

Definition at line 324 of file class.ilExplorer.php.

        {
                return $this->root_id == null ?
                        $this->tree->getRootId() :
                        $this->root_id;
        }

References $root_id.

Referenced by ilECSNodeMappingCmsExplorer\formatHeader(), setExpand(), and setOutput().

Here is the caller graph for this function:

◆ getTitle()

ilExplorer::getTitle ( )

Get title.

Returns: title

Definition at line 299 of file class.ilExplorer.php.

        {
                return $this->title;
        }

Referenced by getOutput().

Here is the caller graph for this function:

◆ getTitleLength()

ilExplorer::getTitleLength ( )

Get max title length.

Returns

Definition at line 289 of file class.ilExplorer.php.

        {
                return $this->textwidth;
        }

◆ getTreeLead()

ilExplorer::getTreeLead ( )

Get tree leading content.

Returns: string tree leading content

Definition at line 506 of file class.ilExplorer.php.

        {
                return $this->tree_lead;
        }

◆ getUseStandardFrame()

ilExplorer::getUseStandardFrame ( )

Get use standard explorer frame.

Returns: boolean use standard explorer frame

Definition at line 579 of file class.ilExplorer.php.

        {
                return $this->use_standard_frame;
        }

References $use_standard_frame.

Referenced by getOutput().

Here is the caller graph for this function:

◆ handleListEndTags()

ilExplorer::handleListEndTags	(	&	$a_tpl_tree,
			$a_cur_depth,
			$a_item_depth
	)

handle list end tags ( and )

Definition at line 911 of file class.ilExplorer.php.

        {
                if ($a_item_depth < $a_cur_depth)
                {
                        // </li></ul> for ending lists
                        for ($i = 0; $i < ($a_cur_depth - $a_item_depth); $i++)
                        {
                                $a_tpl_tree->touchBlock("end_list_item");
                                $a_tpl_tree->touchBlock("element");
 
                                $a_tpl_tree->touchBlock("end_list");
                                $a_tpl_tree->touchBlock("element");
                        }
                }
                else if ($a_item_depth == $a_cur_depth)
                {
                        // </li> for ending list items
                        $a_tpl_tree->touchBlock("end_list_item");
                        $a_tpl_tree->touchBlock("element");
                }
        }

Referenced by getOutput().

Here is the caller graph for this function:

◆ handleListStartTags()

ilExplorer::handleListStartTags	(	&	$a_tpl_tree,
			$a_cur_depth,
			$a_item_depth
	)

handle list start tags (

)

Definition at line 936 of file class.ilExplorer.php.

        {
                // start tags
                if ($a_item_depth > $a_cur_depth)
                {
                        // <ul><li> for new lists
                        if ($a_item_depth > 1)
                        {
                                $a_tpl_tree->touchBlock("start_list");
                        }
                        else
                        {
                                $a_tpl_tree->touchBlock("start_list_no_indent");
                        }
                        $a_tpl_tree->touchBlock("element");
                        
                        $a_tpl_tree->touchBlock("start_list_item");
                        $a_tpl_tree->touchBlock("element");
                }
                else
                {
                        // <li> items
                        $a_tpl_tree->touchBlock("start_list_item");
                        $a_tpl_tree->touchBlock("element");
                }
        }

Referenced by getOutput().

Here is the caller graph for this function:

◆ highlightNode()

ilExplorer::highlightNode ( $a_id )

set highlighted node

Definition at line 421 of file class.ilExplorer.php.

        {
                $this->highlighted = $a_id;
        }

◆ ilExplorer()

ilExplorer::ilExplorer ( $a_target )

Constructor @access public.

Parameters

string scriptname

Definition at line 168 of file class.ilExplorer.php.

        {
                global $ilias, $objDefinition;
 
                if (!isset($a_target) or !is_string($a_target))
                {
                        $this->ilias->raiseError(get_class($this)."::Constructor(): No target given!",$this->ilias->error_obj->WARNING);
                }
 
                // autofilter object types in devmode
                $devtypes = $objDefinition->getDevModeAll();
 
                if (count($devtypes > 0))
                {
                        // activate filter if objects found in devmode
                        $this->setFiltered(true);
 
                        foreach ($devtypes as $type)
                        {
                                $this->addFilter($type);
                        }
                }
 
                $this->ilias =& $ilias;
                $this->output = array();
                $this->expanded = array();
                $this->target = $a_target;
                $this->target_get = 'ref_id';
                $this->frame_target = "content";
                $this->order_column = "title";
                $this->tree = new ilTree(ROOT_FOLDER_ID);
                $this->tree->initLangCode();
                $this->expand_target = $_SERVER["PATH_INFO"];
                $this->rbac_check = true;
                $this->output_icons = true;
                $this->expand_variable = "expand";
                $this->setTitleLength(50);
                $this->post_sort=true;
                $this->setFilterMode(IL_FM_NEGATIVE);
                $this->highlighted = "";
                $this->show_minus = true;
                $this->counter = 0;
                $this->asnch_expanding = false;
        }

References $_SERVER, $ilias, addFilter(), IL_FM_NEGATIVE, setFiltered(), setFilterMode(), and setTitleLength().

Here is the call graph for this function:

◆ initItemCounter()

ilExplorer::initItemCounter ( $a_number )

Init item counter.

@access public

Parameters

int number

Definition at line 260 of file class.ilExplorer.php.

        {
                $this->counter = $a_number;
        }

Referenced by ilCopyWizardExplorer\__construct().

Here is the caller graph for this function:

◆ is_in_array()

ilExplorer::is_in_array	(	$a_start,
		$a_depth
	)

DESCRIPTION MISSING @access private.

Parameters

integer
integer

Returns: boolean

Definition at line 1304 of file class.ilExplorer.php.

        {
                for ($i=$a_start;$i<count($this->format_options);++$i)
                {
                        if ($this->format_options[$i]["depth"] < $a_depth)
                        {
                                break;
                        }
 
                        if ($this->format_options[$i]["depth"] == $a_depth)
                        {
                                return true;
                        }
                }
                return false;
        }

Referenced by createLines().

Here is the caller graph for this function:

◆ isClickable()

ilExplorer::isClickable	(	$a_type,
		$a_ref_id = `0`
	)

check if links for certain object type are activated

Parameters

string $a_type object type

Returns: boolean true if linking is activated

Reimplemented in ilContainerSelectionExplorer, ilAICCExplorer, ilSurveySkillExplorer, ilLMMenuObjectSelector, ilGlossarySelectorGUI, ilSolutionExplorer, ilRoleDesktopItemSelector, ilAdministrationExplorer, ilFileSelectorGUI, ilObjectSelector, ilRepositoryCopySelector, ilRepositoryLinkSelector, ilCopyWizardExplorer, and ilSearchRootSelector.

Definition at line 518 of file class.ilExplorer.php.

        {
                // in this standard implementation
                // only the type determines, wether an object should be clickable or not
                // but this method can be overwritten and make $exp->setFilterMode(IL_FM_NEGATIVE);use of the ref id
                // (this happens e.g. in class ilRepositoryExplorerGUI)
                if ($this->is_clickable[$a_type] == "n")
                {
                        return false;
                }
                else
                {
                        return true;
                }
        }

Referenced by formatObject().

Here is the caller graph for this function:

◆ isVisible()

ilExplorer::isVisible	(	$a_ref_id,
		$a_type
	)

Reimplemented in ilSCORMExplorer, ilAdministrationExplorer, ilContainerSelectionExplorer, ilWorkspaceExplorer, and ilRepositoryExplorer.

Definition at line 475 of file class.ilExplorer.php.

        {
                global $rbacsystem, $ilBench;
                
                if (!$this->rbac_check)
                {
                        return true;
                }
                
                $ilBench->start("Explorer", "setOutput_isVisible");
                $visible = $rbacsystem->checkAccess('visible',$a_ref_id);
                $ilBench->stop("Explorer", "setOutput_isVisible");
 
                return $visible;
        }

References $ilBench.

Referenced by setOutput().

Here is the caller graph for this function:

◆ modifyChilds()

ilExplorer::modifyChilds	(	$a_parent_id,
		$a_objects
	)

Reimplemented in ilAdministrationExplorer.

Definition at line 749 of file class.ilExplorer.php.

        {
                return $a_objects;
        }

Referenced by setOutput().

Here is the caller graph for this function:

◆ outputIcons()

ilExplorer::outputIcons ( $a_icons )

output icons

Parameters

boolean $a_icons output icons true/false

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

        {
                $this->output_icons = $a_icons;
        }

Referenced by ilAICCExplorer\__construct(), ilSCORMExplorer\__construct(), and ilHACPExplorer\ilHACPExplorer().

Here is the caller graph for this function:

◆ setAsynchExpanding()

ilExplorer::setAsynchExpanding ( $a_val )

Set asynch expanding.

Parameters

boolean

Definition at line 238 of file class.ilExplorer.php.

        {
                $this->asnch_expanding = $a_val;
        }

◆ setClickable()

ilExplorer::setClickable	(	$a_type,
		$a_clickable
	)

(de-)activates links for a certain object type

Parameters

string	$a_type	object type
boolean	$a_clickable	true/false

Definition at line 463 of file class.ilExplorer.php.

        {
                if($a_clickable)
                {
                        $this->is_clickable[$a_type] = "";
                }
                else
                {
                        $this->is_clickable[$a_type] = "n";
                }
        }

◆ setExpand()

ilExplorer::setExpand ( $a_node_id )

set the expand option this value is stored in a SESSION variable to save it different view (lo view, frm view,...) @access private

Parameters

string pipe-separated integer

Reimplemented in ilWorkspaceFolderExplorer.

Definition at line 1431 of file class.ilExplorer.php.

        {
                // IF ISN'T SET CREATE SESSION VARIABLE
                if(!is_array($_SESSION[$this->expand_variable]))
                {
                        $_SESSION[$this->expand_variable] = array($this->getRoot());
                }
                // IF $_GET["expand"] is positive => expand this node
                if ($a_node_id > 0 && !in_array($a_node_id,$_SESSION[$this->expand_variable]))
                {
                        array_push($_SESSION[$this->expand_variable],$a_node_id);
                }
                // IF $_GET["expand"] is negative => compress this node
                if ($a_node_id < 0)
                {
                        $key = array_keys($_SESSION[$this->expand_variable],-(int) $a_node_id);
                        unset($_SESSION[$this->expand_variable][$key[0]]);
                }
                $this->expanded = $_SESSION[$this->expand_variable];
        }

References $_SESSION, $expand_variable, and getRoot().

Referenced by ilAICCExplorer\makeObjectNodeExpandable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setExpandTarget()

ilExplorer::setExpandTarget ( $a_exp_target )

target script for expand icons

Parameters

string $a_exp_target script name of target script(may include parameters) initially set to $_SERVER["PATH_INFO"]

Definition at line 400 of file class.ilExplorer.php.

        {
                $this->expand_target = $a_exp_target;
        }

◆ setFiltered()

ilExplorer::setFiltered ( $a_bool )

active/deactivate the filter @access public

Parameters

boolean

Returns: boolean

Definition at line 1470 of file class.ilExplorer.php.

        {
                $this->filtered = $a_bool;
                return true;
        }

Referenced by ilContainerSelectionExplorer\__construct(), ilECSNodeMappingLocalExplorer\__construct(), ilPasteIntoMultipleItemsExplorer\__construct(), ilWorkspaceExplorer\__construct(), ilExplorer(), ilObjectSelector\ilObjectSelector(), ilRepositoryCopySelector\ilRepositoryCopySelector(), ilRepositoryExplorer\ilRepositoryExplorer(), ilRepositoryLinkSelector\ilRepositoryLinkSelector(), ilRoleDesktopItemSelector\ilRoleDesktopItemSelector(), ilSearchRootSelector\ilSearchRootSelector(), and ilSolutionExplorer\ilSolutionExplorer().

Here is the caller graph for this function:

◆ setFilterMode()

ilExplorer::setFilterMode ( $a_mode = IL_FM_NEGATIVE )

set filter mode

Parameters

int $a_mode filter mode IL_FM_NEGATIVE | IL_FM_NEGATIVE

Definition at line 548 of file class.ilExplorer.php.

        {
                $this->filter_mode = $a_mode;
        }

Referenced by ilContainerSelectionExplorer\__construct(), ilECSNodeMappingLocalExplorer\__construct(), ilSurveySkillExplorer\__construct(), ilPasteIntoMultipleItemsExplorer\__construct(), ilWorkspaceExplorer\__construct(), ilExplorer(), ilRepositoryCopySelector\ilRepositoryCopySelector(), ilRepositoryExplorer\ilRepositoryExplorer(), ilRepositoryLinkSelector\ilRepositoryLinkSelector(), ilRoleDesktopItemSelector\ilRoleDesktopItemSelector(), ilSearchRootSelector\ilSearchRootSelector(), and ilSolutionExplorer\ilSolutionExplorer().

Here is the caller graph for this function:

◆ setFrameTarget()

ilExplorer::setFrameTarget ( $a_target )

set target frame or not frame?

Parameters

string @access public

Definition at line 1254 of file class.ilExplorer.php.

        {
                $this->frame_target = $a_target;
        }

Referenced by ilFileSelectorGUI\__construct().

Here is the caller graph for this function:

◆ setFrameUpdater()

ilExplorer::setFrameUpdater	(	$a_up_frame,
		$a_up_script,
		$a_params = `""`
	)

Set Explorer Updater.

Parameters

object $a_tree Tree Object

Definition at line 410 of file class.ilExplorer.php.

        {
                $this->up_frame = $a_up_frame;
                $this->up_script = $a_up_script;
                $this->up_params = $a_params;
        }

◆ setId()

ilExplorer::setId ( $a_val )

Set id.

Parameters

string $a_val id

Definition at line 218 of file class.ilExplorer.php.

        {
                $this->id = $a_val;
        }

Referenced by ilPasteIntoMultipleItemsExplorer\__construct().

Here is the caller graph for this function:

◆ setOrderColumn()

ilExplorer::setOrderColumn ( $a_column )

set the order column @access public

Parameters

string name of order column

Definition at line 336 of file class.ilExplorer.php.

        {
                $this->order_column = $a_column;
        }

Referenced by ilECSNodeMappingCmsExplorer\__construct(), ilECSNodeMappingLocalExplorer\__construct(), ilSurveySkillExplorer\__construct(), ilAICCExplorer\__construct(), ilSCORMExplorer\__construct(), and ilHACPExplorer\ilHACPExplorer().

Here is the caller graph for this function:

◆ setOrderDirection()

ilExplorer::setOrderDirection ( $a_direction )

set the order direction @access public

Parameters

string name of order column

Definition at line 346 of file class.ilExplorer.php.

        {
                if ($a_direction == "desc")
                {
                        $this->order_direction = $a_direction;
                }
                else
                {
                        $this->order_direction = "asc";
                }
        }

◆ setOutput()

ilExplorer::setOutput	(	$a_parent_id,
		$a_depth = `1`,
		$a_obj_id = `0`,
		$a_highlighted_subtree = `false`
	)

Creates output for explorer view in admin menue recursive method @access public.

Parameters

integer	parent_node_id where to start from (default=0, 'root')
integer	depth level where to start (default=1)

Returns: string

Definition at line 604 of file class.ilExplorer.php.

        {
                global $rbacadmin, $rbacsystem, $ilBench;
 
#echo 'ParentId: '.$a_parent_id.' depth: '.$a_depth.' obj_id: '.$a_obj_id;
 
                if (!isset($a_parent_id))
                {
                        $this->ilias->raiseError(get_class($this)."::setOutput(): No node_id given!",$this->ilias->error_obj->WARNING);
                }
 
                if ($this->showChilds($a_parent_id,$a_obj_id))
                {
                        $objects = $this->getChildsOfNode($a_parent_id);
                }
                else
                {
                        $objects = array();
                }
 
                $objects = $this->modifyChilds($a_parent_id, $objects);
 
                // force expansion (of single nodes)
                if ($this->forceExpanded($a_parent_id) && !in_array($a_parent_id, $this->expanded))
                {
                        $this->expanded[] = $a_parent_id;
                }
 
                if (count($objects) > 0)
                {
                        // Maybe call a lexical sort function for the child objects
                        $tab = ++$a_depth - 2;
                        if ($this->post_sort)
                        {
                                $objects = $this->sortNodes($objects,$a_obj_id);
                        }
                        $skip_rest = false;
                        foreach ($objects as $key => $object)
                        {
                                // skip childs, if parent is not expanded
                                if (!$this->forceExpanded($object["child"]) && $skip_rest)
                                {
                                        continue;
                                }
//echo "<br>-".$object["child"]."-".$this->forceExpanded($object["child"])."-";
                                //ask for FILTER
                                if ($this->filtered == false or $this->checkFilter($object["type"]) == false)
                                {
                                        if ($this->isVisible($object['child'],$object['type']))
                                        {
                                                $ilBench->start("Explorer", "setOutput_setFormatOptions");
                                                #echo 'CHILD getIndex() '.$object['child'].' parent: '.$this->getRoot();
                                                if ($object["child"] != $this->getRoot())
                                                {
                                                        $parent_index = $this->getIndex($object);
                                                }
                                                $this->format_options["$this->counter"]["parent"]               = $object["parent"];
                                                $this->format_options["$this->counter"]["child"]                = $object["child"];
                                                $this->format_options["$this->counter"]["title"]                = $object["title"];
                                                $this->format_options["$this->counter"]["type"]         = $object["type"];
                                                $this->format_options["$this->counter"]["obj_id"]               = $object["obj_id"];
                                                $this->format_options["$this->counter"]["desc"]                 = "obj_".$object["type"];
                                                $this->format_options["$this->counter"]["depth"]                = $tab;
                                                $this->format_options["$this->counter"]["container"]    = false;
                                                $this->format_options["$this->counter"]["visible"]      = true;
                                                $this->format_options["$this->counter"]["highlighted_subtree"] = $a_highlighted_subtree;
 
                                                // Create prefix array
                                                for ($i = 0; $i < $tab; ++$i)
                                                {
                                                         $this->format_options["$this->counter"]["tab"][] = 'blank';
                                                }
 
                                                // fix explorer (sometimes explorer disappears)
                                                if ($parent_index == 0)
                                                {
                                                        if (!$this->expand_all and !in_array($object["parent"], $this->expanded))
                                                        {
                                                                $this->expanded[] = $object["parent"];
                                                        }
                                                }
 
                                                // only if parent is expanded and visible, object is visible
                                                if ($object["child"] != $this->getRoot() and ((!$this->expand_all and !in_array($object["parent"],$this->expanded))
                                                   or !$this->format_options["$parent_index"]["visible"]))
                                                {
                                                        if (!$this->forceExpanded($object["child"]))
                                                        {
                                                                // if parent is not expanded, and one child is
                                                                // visible we don't need more information and
                                                                // can skip the rest of the childs
                                                                if ($this->format_options["$this->counter"]["visible"])
                                                                {
//echo "-setSkipping";
                                                                        $skip_rest = true;
                                                                }
                                                                $this->format_options["$this->counter"]["visible"] = false;
                                                        }
                                                }
 
                                                // if object exists parent is container
                                                if ($object["child"] != $this->getRoot())
                                                {
                                                        $this->format_options["$parent_index"]["container"] = true;
 
                                                        if ($this->expand_all or in_array($object["parent"],$this->expanded))
                                                        {
        //echo "<br>-".$object["child"]."-".$this->forceExpanded($object["child"])."-";
                                                                if ($this->forceExpanded($object["parent"]))
                                                                {
                                                                        $this->format_options["$parent_index"]["tab"][($tab-2)] = 'forceexp';
                                                                }
                                                                else
                                                                {
                                                                        $this->format_options["$parent_index"]["tab"][($tab-2)] = 'minus';
                                                                }
                                                        }
                                                        else
                                                        {
                                                                $this->format_options["$parent_index"]["tab"][($tab-2)] = 'plus';
                                                        }
                                                }
        //echo "-"."$parent_index"."-";
        //var_dump($this->format_options["$parent_index"]);
                                                ++$this->counter;
                                                $ilBench->stop("Explorer", "setOutput_setFormatOptions");
                                                
                                                // stop recursion if 2. level beyond expanded nodes is reached
                                                if ($this->expand_all or in_array($object["parent"],$this->expanded) or ($object["parent"] == 0)
                                                        or $this->forceExpanded($object["child"]))
                                                {
                                                        $highlighted_subtree = ($a_highlighted_subtree ||
                                                                ($object["child"] == $this->highlighted))
                                                                ? true
                                                                : false;
                                                        
                                                        // recursive
                                                        $this->setOutput($object["child"],$a_depth,$object['obj_id'], $highlighted_subtree);
                                                }
                                        } //if
                                } //if FILTER
                        } //foreach
                } //if
        } //function

References $ilBench, $tab, checkFilter(), forceExpanded(), getChildsOfNode(), getIndex(), getRoot(), isVisible(), modifyChilds(), setOutput(), showChilds(), and sortNodes().

Referenced by setOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setParamsGet()

ilExplorer::setParamsGet ( $a_params_get )

set additional params to be passed in Get-string @access public

Parameters

array

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

        {
                if (!isset($a_params_get) or !is_array($a_params_get))
                {
                        $this->ilias->raiseError(get_class($this)."::setTargetGet(): No target given!",$this->ilias->error_obj->WARNING);
                }
 
                foreach ($a_params_get as $key => $val)
                {
                        $str .= "&".$key."=".$val;
                }
 
                $this->params_get = $str;
        }

◆ setPostSort()

ilExplorer::setPostSort ( $a_sort )

process post sorting

Parameters

boolean $a_sort true / false

Definition at line 538 of file class.ilExplorer.php.

        {
                $this->post_sort = $a_sort;
        }

Referenced by ilSurveySkillExplorer\__construct().

Here is the caller graph for this function:

◆ setRoot()

ilExplorer::setRoot ( $a_root_id )

Set root node.

@access public

Parameters

int	ref id of root node

Definition at line 311 of file class.ilExplorer.php.

        {
                #$this->tree = new ilTree(ROOT_FOLDER_ID,$a_root_id);
                $this->root_id = $a_root_id;
        }

Referenced by ilECSNodeMappingLocalExplorer\__construct().

Here is the caller graph for this function:

◆ setSessionExpandVariable()

ilExplorer::setSessionExpandVariable ( $a_var_name = "expand" )

set name of expand session variable

Parameters

string $a_var_name variable name

Definition at line 441 of file class.ilExplorer.php.

        {
                $this->expand_variable = $a_var_name;
        }

Referenced by ilContainerSelectionExplorer\__construct(), ilSurveySkillExplorer\__construct(), ilPasteIntoMultipleItemsExplorer\__construct(), ilWorkspaceExplorer\__construct(), ilAdministrationExplorer\ilAdministrationExplorer(), ilLMMenuObjectSelector\ilLMMenuObjectSelector(), ilObjectSelector\ilObjectSelector(), ilRepositoryCopySelector\ilRepositoryCopySelector(), ilRepositoryExplorer\ilRepositoryExplorer(), ilRepositoryLinkSelector\ilRepositoryLinkSelector(), ilRoleDesktopItemSelector\ilRoleDesktopItemSelector(), ilSearchRootSelector\ilSearchRootSelector(), and ilSolutionExplorer\ilSolutionExplorer().

Here is the caller graph for this function:

◆ setTargetGet()

ilExplorer::setTargetGet ( $a_target_get )

set the varname in Get-string @access public

Parameters

string varname containing Ids to be used in GET-string

Definition at line 363 of file class.ilExplorer.php.

        {
                if (!isset($a_target_get) or !is_string($a_target_get))
                {
                        $this->ilias->raiseError(get_class($this)."::setTargetGet(): No target given!",$this->ilias->error_obj->WARNING);
                }
 
                $this->target_get = $a_target_get;
        }

◆ setTitle()

ilExplorer::setTitle ( $a_val )

Set title.

Parameters

title

Definition at line 270 of file class.ilExplorer.php.

        {
                $this->title = $a_val;
        }

Referenced by ilAdministrationExplorer\ilAdministrationExplorer(), and ilRepositoryExplorer\ilRepositoryExplorer().

Here is the caller graph for this function:

◆ setTitleLength()

ilExplorer::setTitleLength ( $a_length )

Set max title length.

Parameters

object $a_length

Returns

Definition at line 280 of file class.ilExplorer.php.

        {
                $this->textwidth = $a_length;
        }

Referenced by ilContainerSelectionExplorer\__construct(), ilCopyWizardExplorer\__construct(), ilECSNodeMappingCmsExplorer\__construct(), ilSurveySkillExplorer\__construct(), ilExplorer(), ilRepositoryCopySelector\ilRepositoryCopySelector(), ilRepositoryLinkSelector\ilRepositoryLinkSelector(), ilRoleDesktopItemSelector\ilRoleDesktopItemSelector(), and ilSearchRootSelector\ilSearchRootSelector().

Here is the caller graph for this function:

◆ setTreeLead()

ilExplorer::setTreeLead ( $a_val )

Set tree leading content.

Parameters

string $a_val tree leading content

Definition at line 496 of file class.ilExplorer.php.

        {
                $this->tree_lead = $a_val;
        }

◆ setUseStandardFrame()

ilExplorer::setUseStandardFrame ( $a_val )

Set use standard frame.

If true, the standard explorer frame (like in the repository) is put around the tree.

Parameters

boolean use standard explorer frame

Definition at line 569 of file class.ilExplorer.php.

        {
                $this->use_standard_frame = $a_val;
        }

◆ showChilds()

ilExplorer::showChilds ( $a_parent_id )

determines wether the childs of an object should be shown or not note: this standard implementation always returns true but it could be overwritten by derived classes (e.g.

ilRepositoryExplorerGUI)

Reimplemented in ilLMMenuObjectSelector, ilGlossarySelectorGUI, ilSolutionExplorer, ilRoleDesktopItemSelector, ilFileSelectorGUI, ilObjectSelector, ilRepositoryCopySelector, ilRepositoryLinkSelector, and ilSearchRootSelector.

Definition at line 759 of file class.ilExplorer.php.

        {
                return true;
        }

Referenced by ilSCORMExplorer\createOutputArray(), ilAICCExplorer\setOutput(), and setOutput().

Here is the caller graph for this function:

◆ sortNodes()

ilExplorer::sortNodes	(	$a_nodes,
		$a_parent_obj_id
	)

sort nodes and put adm object to the end of sorted array @access private

Parameters

array node list as returned by iltree::getChilds();

Returns: array sorted nodes

Reimplemented in ilWorkspaceExplorer, and ilRepositoryExplorer.

Definition at line 1516 of file class.ilExplorer.php.

        {
                foreach ($a_nodes as $key => $node)
                {
                        if ($node["type"] == "adm")
                        {
                                $match = $key;
                                $adm_node = $node;
                                break;
                        }
                }
 
                // cut off adm node
                isset($match) ? array_splice($a_nodes,$match,1) : "";
 
                $a_nodes = ilUtil::sortArray($a_nodes,$this->order_column,$this->order_direction);
 
                // append adm node to end of list
                isset ($match) ? array_push($a_nodes,$adm_node) : "";
 
                return $a_nodes;
        }

References ilUtil\sortArray().

Referenced by setOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $expand_all

ilExplorer::$expand_all = false

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

◆ $expand_target

ilExplorer::$expand_target

Definition at line 95 of file class.ilExplorer.php.

◆ $expand_variable

ilExplorer::$expand_variable

Definition at line 117 of file class.ilExplorer.php.

Referenced by ilWorkspaceFolderExplorer\setExpand(), and setExpand().

◆ $expanded

ilExplorer::$expanded

Definition at line 74 of file class.ilExplorer.php.

◆ $filter_mode

ilExplorer::$filter_mode

Definition at line 145 of file class.ilExplorer.php.

Referenced by getFilterMode().

◆ $filtered

ilExplorer::$filtered = false

Definition at line 138 of file class.ilExplorer.php.

◆ $format_options

ilExplorer::$format_options

Definition at line 39 of file class.ilExplorer.php.

◆ $id

ilExplorer::$id

Definition at line 18 of file class.ilExplorer.php.

Referenced by ilAsyncContainerSelectionExplorer\addOnLoadCode(), and getId().

◆ $ilias

ilExplorer::$ilias

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

Referenced by ilRepositoryExplorer\buildFrameTarget(), ilLMMenuObjectSelector\formatHeader(), ilSCORMExplorer\formatHeader(), ilRoleDesktopItemSelector\formatHeader(), ilContainerSelectionExplorer\formatHeader(), ilRepositoryCopySelector\formatHeader(), ilRepositoryLinkSelector\formatHeader(), ilGlossarySelectorGUI\formatHeader(), ilAdministrationExplorer\formatHeader(), ilFileSelectorGUI\formatHeader(), ilPasteIntoMultipleItemsExplorer\formatHeader(), ilRepositoryExplorer\formatHeader(), ilECSNodeMappingCmsExplorer\formatHeader(), ilECSNodeMappingLocalExplorer\formatHeader(), ilSearchRootSelector\formatHeader(), and ilExplorer().

◆ $is_clickable

ilExplorer::$is_clickable

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

◆ $order_column

ilExplorer::$order_column

Definition at line 81 of file class.ilExplorer.php.

◆ $order_direction

ilExplorer::$order_direction = "asc"

Definition at line 88 of file class.ilExplorer.php.

◆ $output

ilExplorer::$output

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

Referenced by ilSCORMExplorer\getOutput().

◆ $output_icons

ilExplorer::$output_icons

Definition at line 110 of file class.ilExplorer.php.

◆ $params_get

ilExplorer::$params_get

Definition at line 67 of file class.ilExplorer.php.

◆ $post_sort

ilExplorer::$post_sort

Definition at line 131 of file class.ilExplorer.php.

◆ $rbac_check

ilExplorer::$rbac_check

Definition at line 102 of file class.ilExplorer.php.

◆ $root_id

ilExplorer::$root_id = null

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

Referenced by getRoot().

◆ $target

ilExplorer::$target

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

Referenced by buildLinkTarget(), ilAICCExplorer\formatObject(), ilHACPExplorer\formatObject(), ilPasteIntoMultipleItemsExplorer\formatObject(), ilWorkspaceExplorer\formatObject(), formatObject(), ilECSNodeMappingCmsExplorer\formatObject(), and ilECSNodeMappingLocalExplorer\formatObject().

◆ $target_get

ilExplorer::$target_get

Definition at line 60 of file class.ilExplorer.php.

◆ $tree

ilExplorer::$tree

Definition at line 46 of file class.ilExplorer.php.

Referenced by ilContainerSelectionExplorer\__construct(), ilGlossarySelectorGUI\__construct(), ilFileSelectorGUI\__construct(), ilECSNodeMappingCmsExplorer\__construct(), ilECSNodeMappingLocalExplorer\__construct(), ilPasteIntoMultipleItemsExplorer\__construct(), ilPasteIntoMultipleItemsExplorer\formatHeader(), ilShopRepositoryExplorer\formatHeader(), ilRepositoryExplorer\formatHeader(), ilECSNodeMappingLocalExplorer\formatHeader(), ilAdministrationExplorer\ilAdministrationExplorer(), ilLMMenuObjectSelector\ilLMMenuObjectSelector(), ilObjectSelector\ilObjectSelector(), ilRepositoryCopySelector\ilRepositoryCopySelector(), ilRepositoryExplorer\ilRepositoryExplorer(), ilRepositoryLinkSelector\ilRepositoryLinkSelector(), ilRoleDesktopItemSelector\ilRoleDesktopItemSelector(), ilSearchRootSelector\ilSearchRootSelector(), ilSolutionExplorer\ilSolutionExplorer(), ilRepositoryExplorer\isClickable(), ilRepositoryExplorer\isVisible(), ilECSNodeMappingCmsExplorer\setTree(), and ilRepositoryExplorer\showChilds().

◆ $use_standard_frame

ilExplorer::$use_standard_frame = false

Definition at line 161 of file class.ilExplorer.php.

Referenced by getUseStandardFrame().

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

Services/UIComponent/Explorer/classes/class.ilExplorer.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ addFilter()

◆ buildDescription()

◆ buildFrameTarget()

◆ buildLinkTarget()

◆ buildOnClick()

◆ buildSelect()

◆ buildTitle()

◆ checkFilter()

◆ checkPermissions()

◆ createLines()

◆ createTarget()

◆ delFilter()

◆ forceExpandAll()

◆ forceExpanded()

◆ formatHeader()

◆ formatObject()

◆ getAsynchExpanding()

◆ getChildsOfNode()

◆ getFilterMode()

◆ getId()

◆ getImage()

◆ getImageAlt()

◆ getIndex()

◆ getMaximumTreeDepth()

◆ getNodeStyleClass()

◆ getOutput()

◆ getRoot()

◆ getTitle()

◆ getTitleLength()

◆ getTreeLead()

◆ getUseStandardFrame()

◆ handleListEndTags()

◆ handleListStartTags()

◆ highlightNode()

◆ ilExplorer()

◆ initItemCounter()

◆ is_in_array()

◆ isClickable()

◆ isVisible()

◆ modifyChilds()

◆ outputIcons()

◆ setAsynchExpanding()

◆ setClickable()

◆ setExpand()

◆ setExpandTarget()

◆ setFiltered()

◆ setFilterMode()

◆ setFrameTarget()

◆ setFrameUpdater()

◆ setId()

◆ setOrderColumn()

◆ setOrderDirection()

◆ setOutput()

◆ setParamsGet()

◆ setPostSort()

◆ setRoot()

◆ setSessionExpandVariable()

◆ setTargetGet()

◆ setTitle()

◆ setTitleLength()

◆ setTreeLead()

◆ setUseStandardFrame()

◆ showChilds()

◆ sortNodes()

Field Documentation

◆ $expand_all

◆ $expand_target

◆ $expand_variable

◆ $expanded

◆ $filter_mode

◆ $filtered

◆ $format_options

◆ $id

◆ $ilias

◆ $is_clickable

◆ $order_column