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

Inheritance diagram for ilExplorer:

Collaboration diagram for ilExplorer:

Public Member Functions
	__construct ($a_target)
	Constructor 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 public More...

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

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

	setParamsGet ($a_params_get)
	set additional params to be passed in Get-string 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 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 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 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 private. More...

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

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

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

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

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

	delFilter ($a_item)
	removes item from the filter 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,...) private More...

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

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

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

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

Data Fields
	$id

	$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

Protected Attributes
	$obj_definition

	$error

	$rbacsystem

	$tpl

	$lng

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.

Constructor & Destructor Documentation

◆ __construct()

ilExplorer::__construct ( $a_target )

Constructor public.

Parameters

string scriptname

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

References $_SERVER, $DIC, $ilErr, $type, addFilter(), array, IL_FM_NEGATIVE, setFiltered(), setFilterMode(), and setTitleLength().

     {
         global $DIC;
 
         $this->obj_definition = $DIC["objDefinition"];
         $this->error = $DIC["ilErr"];
         $this->rbacsystem = $DIC->rbac()->system();
         $this->tpl = $DIC["tpl"];
         $this->lng = $DIC->language();
         $objDefinition = $DIC["objDefinition"];
         $ilErr = $DIC["ilErr"];
 
         if (!isset($a_target) or !is_string($a_target)) {
             $ilErr->raiseError(get_class($this) . "::Constructor(): No target given!", $ilErr->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 = $DIC["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;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addFilter()

ilExplorer::addFilter ( $a_item )

adds item to the filter public

Parameters

string object type to add

Returns: boolean

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

References array.

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

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

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

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

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

     {
         return "";
     }

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)

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

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

     {
         return $this->frame_target;
     }

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)

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

References $params_get, and $target.

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

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

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)

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

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

     {
         return "";
     }

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

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

Referenced by formatObject().

     {
         return "";
     }

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

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

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

     {
         return $a_title;
     }

Here is the caller graph for this function:

◆ checkFilter()

ilExplorer::checkFilter ( $a_item )

check if item is in filter private

Parameters

string

Returns: integer

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

References $ret, getFilterMode(), and IL_FM_NEGATIVE.

Referenced by setOutput().

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

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 452 of file class.ilExplorer.php.

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

     {
         $this->rbac_check = $a_check;
     }

Here is the caller graph for this function:

◆ createLines()

ilExplorer::createLines ( $a_depth )

Creates lines for explorer view private.

Parameters

integer

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

References $i, and is_in_array().

Referenced by getOutput().

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

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

Parameters

string
integer

Returns: string

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

References $a_type, $error, $ilErr, and getAsynchExpanding().

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

     {
         $ilErr = $this->error;
 
         if (!isset($a_type) or !is_string($a_type) or !isset($a_node_id)) {
             $ilErr->raiseError(get_class($this) . "::createTarget(): Missing parameter or wrong datatype! " .
                                     "type: " . $a_type . " node_id:" . $a_node_id, $ilErr->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;
         }
     }

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 public

Parameters

string object type to remove

Returns: boolean

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

References array.

     {
         //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) public

Parameters

boolean

Definition at line 1367 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

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

Referenced by setOutput().

     {
         return false;
     }

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)

public

Parameters

integer	obj_id
integer	array options

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

Referenced by getOutput().

926 {

927 }

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

Parameters

integer
array

Returns: string

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

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

Referenced by getOutput().

     {
         $lng = $this->lng;
         $ilErr = $this->error;
 
         if (!isset($a_node_id) or !is_array($a_option)) {
             $ilErr->raiseError(get_class($this) . "::formatObject(): Missing parameter or wrong datatype! " .
                                     "node_id: " . $a_node_id . " options:" . var_dump($a_option), $ilErr->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");
     }

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 271 of file class.ilExplorer.php.

Referenced by createTarget(), and formatObject().

     {
         return $this->asnch_expanding;
     }

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 602 of file class.ilExplorer.php.

Referenced by setOutput().

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

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 570 of file class.ilExplorer.php.

References $filter_mode.

Referenced by checkFilter().

     {
         return $this->filter_mode;
     }

Here is the caller graph for this function:

◆ getId()

ilExplorer::getId ( )

Get id.

Returns: string id

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

References $id.

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

     {
         return $this->id;
     }

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)

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

References ilUtil\getImagePath().

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

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

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

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

Referenced by formatObject().

     {
         return $a_default_text;
     }

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 private

Parameters

array object data

Returns: integer index

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

References $key.

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

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

Here is the caller graph for this function:

◆ getMaximumTreeDepth()

ilExplorer::getMaximumTreeDepth ( )

Get maximum tree depth.

Parameters

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

Referenced by getOutput().

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

Here is the caller graph for this function:

◆ getNodeStyleClass()

ilExplorer::getNodeStyleClass	(	$a_id,
		$a_type
	)

get style class for node

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

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

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

Here is the caller graph for this function:

◆ getOutput()

ilExplorer::getOutput ( )

Creates output recursive method public.

Returns: string

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

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

     {
         $tpl = $this->tpl;
         $lng = $this->lng;
 
         $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");
 
         //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);
             }
         }
 
         $this->handleListEndTags($tpl_tree, $cur_depth, -1);
         
         $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;
     }

Here is the call graph for this function:

◆ getRoot()

ilExplorer::getRoot ( )

get root id

public

Parameters

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

References $root_id.

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

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

Here is the caller graph for this function:

◆ getTitle()

ilExplorer::getTitle ( )

Get title.

Returns: title

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

References $title.

Referenced by getOutput().

     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getTitleLength()

ilExplorer::getTitleLength ( )

Get max title length.

Returns

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

     {
         return $this->textwidth;
     }

◆ getTreeLead()

ilExplorer::getTreeLead ( )

Get tree leading content.

Returns: string tree leading content

Definition at line 521 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 591 of file class.ilExplorer.php.

References $use_standard_frame.

Referenced by getOutput().

     {
         return $this->use_standard_frame;
     }

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 875 of file class.ilExplorer.php.

References $i.

Referenced by getOutput().

     {
         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");
             }
         } elseif ($a_item_depth == $a_cur_depth) {
             // </li> for ending list items
             $a_tpl_tree->touchBlock("end_list_item");
             $a_tpl_tree->touchBlock("element");
         }
     }

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 896 of file class.ilExplorer.php.

Referenced by getOutput().

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

Here is the caller graph for this function:

◆ highlightNode()

ilExplorer::highlightNode ( $a_id )

set highlighted node

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

     {
         $this->highlighted = $a_id;
     }

◆ initItemCounter()

ilExplorer::initItemCounter ( $a_number )

Init item counter.

public

Parameters

int number

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

     {
         $this->counter = $a_number;
     }

◆ is_in_array()

ilExplorer::is_in_array	(	$a_start,
		$a_depth
	)

DESCRIPTION MISSING private.

Parameters

integer
integer

Returns: boolean

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

References $i.

Referenced by createLines().

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

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

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

References $a_type.

Referenced by formatObject().

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

Here is the caller graph for this function:

◆ isVisible()

ilExplorer::isVisible	(	$a_ref_id,
		$a_type
	)

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

References $rbacsystem.

Referenced by setOutput().

     {
         $rbacsystem = $this->rbacsystem;
         
         if (!$this->rbac_check) {
             return true;
         }
         
         $visible = $rbacsystem->checkAccess('visible', $a_ref_id);
 
         return $visible;
     }

Here is the caller graph for this function:

◆ modifyChilds()

ilExplorer::modifyChilds	(	$a_parent_id,
		$a_objects
	)

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

Referenced by setOutput().

     {
         return $a_objects;
     }

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 472 of file class.ilExplorer.php.

Referenced by ilSCORMExplorer\__construct().

     {
         $this->output_icons = $a_icons;
     }

Here is the caller graph for this function:

◆ setAsynchExpanding()

ilExplorer::setAsynchExpanding ( $a_val )

Set asynch expanding.

Parameters

boolean

Definition at line 261 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 484 of file class.ilExplorer.php.

References $a_type.

     {
         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,...) private

Parameters

string pipe-separated integer

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

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

Referenced by assQuestionGUI\outSolutionExplorer(), ilBasicSkillGUI\selectLevelTrigger(), ilObjContentObjectGUI\showEntrySelector(), ilObjGlossaryGUI\showGlossarySelector(), and ilObjContentObjectGUI\showLMGlossarySelector().

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

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 421 of file class.ilExplorer.php.

     {
         $this->expand_target = $a_exp_target;
     }

◆ setFiltered()

ilExplorer::setFiltered ( $a_bool )

active/deactivate the filter public

Parameters

boolean

Returns: boolean

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

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

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

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 560 of file class.ilExplorer.php.

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

     {
         $this->filter_mode = $a_mode;
     }

Here is the caller graph for this function:

◆ setFrameTarget()

ilExplorer::setFrameTarget ( $a_target )

set target frame or not frame?

Parameters

string public

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

     {
         $this->frame_target = $a_target;
     }

◆ setFrameUpdater()

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

Set Explorer Updater.

Parameters

object $a_tree Tree Object

Definition at line 431 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 241 of file class.ilExplorer.php.

Referenced by ilPasteIntoMultipleItemsExplorer\__construct().

     {
         $this->id = $a_val;
     }

Here is the caller graph for this function:

◆ setOrderColumn()

ilExplorer::setOrderColumn ( $a_column )

set the order column public

Parameters

string name of order column

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

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

     {
         $this->order_column = $a_column;
     }

Here is the caller graph for this function:

◆ setOrderDirection()

ilExplorer::setOrderDirection ( $a_direction )

set the order direction public

Parameters

string name of order column

Definition at line 369 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 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 616 of file class.ilExplorer.php.

References $counter, $error, $i, $ilErr, $key, $tab, array, checkFilter(), forceExpanded(), getChildsOfNode(), getIndex(), getRoot(), isVisible(), modifyChilds(), showChilds(), and sortNodes().

     {
         $ilErr = $this->error;
 
         if (!isset($a_parent_id)) {
             $ilErr->raiseError(get_class($this) . "::setOutput(): No node_id given!", $ilErr->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'])) {
                         #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;
 
                         // 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

Here is the call graph for this function:

◆ setParamsGet()

ilExplorer::setParamsGet ( $a_params_get )

set additional params to be passed in Get-string public

Parameters

array

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

References $error, $ilErr, and $key.

     {
         $ilErr = $this->error;
 
         if (!isset($a_params_get) or !is_array($a_params_get)) {
             $ilErr->raiseError(get_class($this) . "::setTargetGet(): No target given!", $ilErr->WARNING);
         }
         $str = "";
         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 550 of file class.ilExplorer.php.

Referenced by ilSurveySkillExplorer\__construct().

     {
         $this->post_sort = $a_sort;
     }

Here is the caller graph for this function:

◆ setRoot()

ilExplorer::setRoot ( $a_root_id )

Set root node.

public

Parameters

int	ref id of root node

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

Referenced by ilECSNodeMappingLocalExplorer\__construct().

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

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 462 of file class.ilExplorer.php.

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

     {
         $this->expand_variable = $a_var_name;
     }

Here is the caller graph for this function:

◆ setTargetGet()

ilExplorer::setTargetGet ( $a_target_get )

set the varname in Get-string public

Parameters

string varname containing Ids to be used in GET-string

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

References $error, and $ilErr.

Referenced by ilSAHSPresentationGUI\explorer(), and ilSCORMPresentationGUI\explorer().

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

Here is the caller graph for this function:

◆ setTitle()

ilExplorer::setTitle ( $a_val )

Set title.

Parameters

title

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

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

     {
         $this->title = $a_val;
     }

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 303 of file class.ilExplorer.php.

Referenced by ilECSNodeMappingCmsExplorer\__construct(), ilRoleDesktopItemSelector\__construct(), ilSurveySkillExplorer\__construct(), ilContainerSelectionExplorer\__construct(), ilSearchRootSelector\__construct(), and __construct().

     {
         $this->textwidth = $a_length;
     }

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 511 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 581 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)

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

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

     {
         return true;
     }

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 private

Parameters

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

Returns: array sorted nodes

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

References $key, and ilUtil\sortArray().

Referenced by setOutput().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $error

ilExplorer::$error

protected

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

Referenced by createTarget(), formatObject(), setOutput(), setParamsGet(), and setTargetGet().

◆ $expand_all

ilExplorer::$expand_all = false

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

◆ $expand_target

ilExplorer::$expand_target

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

◆ $expand_variable

ilExplorer::$expand_variable

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

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

◆ $expanded

ilExplorer::$expanded

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

◆ $filter_mode

ilExplorer::$filter_mode

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

Referenced by getFilterMode().

◆ $filtered

ilExplorer::$filtered = false

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

◆ $format_options

ilExplorer::$format_options

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

◆ $id

ilExplorer::$id

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

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

◆ $is_clickable

ilExplorer::$is_clickable

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

◆ $lng

ilExplorer::$lng

protected

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

Referenced by ilSurveySkillExplorer\buildTitle(), ilSCORMExplorer\formatHeader(), ilRoleDesktopItemSelector\formatHeader(), ilLMMenuObjectSelector\formatHeader(), ilGlossarySelectorGUI\formatHeader(), ilSearchRootSelector\formatHeader(), ilWorkspaceFolderExplorer\formatHeader(), ilECSNodeMappingCmsExplorer\formatHeader(), ilECSNodeMappingLocalExplorer\formatHeader(), ilECSNodeMappingCmsExplorer\formatObject(), ilECSNodeMappingLocalExplorer\formatObject(), formatObject(), ilWorkspaceFolderExplorer\getImageAlt(), getOutput(), ilSCORMExplorer\getOutputIcons(), and ilWorkspaceFolderExplorer\setOutput().

◆ $obj_definition

ilExplorer::$obj_definition

protected

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

◆ $order_column

ilExplorer::$order_column

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

◆ $order_direction

ilExplorer::$order_direction = "asc"

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

◆ $output

ilExplorer::$output

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

Referenced by ilSCORMExplorer\getOutput().

◆ $output_icons

ilExplorer::$output_icons

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

◆ $params_get

ilExplorer::$params_get

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

Referenced by buildLinkTarget().

◆ $post_sort

ilExplorer::$post_sort

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

◆ $rbac_check

ilExplorer::$rbac_check

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

◆ $rbacsystem

ilExplorer::$rbacsystem

protected

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

Referenced by ilRoleDesktopItemSelector\isClickable(), isVisible(), ilRoleDesktopItemSelector\showChilds(), ilLMMenuObjectSelector\showChilds(), ilSolutionExplorer\showChilds(), and ilSearchRootSelector\showChilds().

◆ $root_id

ilExplorer::$root_id = null

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

Referenced by getRoot().

◆ $target

ilExplorer::$target

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

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

◆ $target_get

ilExplorer::$target_get

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

◆ $tpl

ilExplorer::$tpl

protected

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

◆ $tree

ilExplorer::$tree

◆ $use_standard_frame

ilExplorer::$use_standard_frame = false

Definition at line 179 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

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

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

◆ 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

◆ $error

◆ $expand_all

◆ $expand_target

◆ $expand_variable

◆ $expanded

◆ $filter_mode

◆ $filtered

◆ $format_options

◆ $id