class for explorer view in admin frame More...

Inheritance diagram for ilExplorer:

Collaboration diagram for ilExplorer:

Public Member Functions
	setId (string $a_val)

	getId ()

	setAsynchExpanding (bool $a_val)

	getAsynchExpanding ()

	initItemCounter (int $a_number)

	setTitle (string $a_val)

	setTitleLength (int $a_length)

	getTitleLength ()

	getTitle ()

	setRoot ($a_root_id)

	getRoot ()

	setOrderColumn (string $a_column)

	setOrderDirection (string $a_direction)

	setTargetGet (string $a_target_get)

	setParamsGet (array $a_params_get)

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

	setFrameUpdater (string $a_up_frame, string $a_up_script, string $a_params="")

	highlightNode (string $a_id)

	checkPermissions (bool $a_check)

	setSessionExpandVariable (string $a_var_name="expand")

	outputIcons (bool $a_icons)

	setClickable (string $a_type, bool $a_clickable)

	isVisible ( $a_ref_id, string $a_type)

	setTreeLead (string $a_val)

	getTreeLead ()

	isClickable (string $type, int $ref_id=0)

	setPostSort (bool $a_sort)

	setFilterMode (int $a_mode=IL_FM_NEGATIVE)

	getFilterMode ()

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

	getUseStandardFrame ()

	getChildsOfNode ($a_parent_id)

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

	modifyChilds ( $a_parent_id, array $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 ()

	getOutput ()

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

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

	formatHeader (ilTemplate $tpl, $a_obj_id, array $a_option)

	formatObject (ilTemplate $tpl, $a_node_id, array $a_option, $a_obj_id=0)

	getImage (string $a_name, string $a_type="", $a_obj_id="")

	getImageAlt (string $a_default_text, string $a_type="", $a_obj_id="")

	getNodeStyleClass ( $a_id, string $a_type)

	buildLinkTarget ( $a_node_id, string $a_type)

	buildOnClick ( $a_node_id, string $a_type, string $a_title)

	buildTitle (string $a_title, $a_id, string $a_type)

	buildDescription (string $a_desc, $a_id, string $a_type)

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

	buildFrameTarget (string $a_type, $a_child=0, $a_obj_id=0)

	createTarget (string $a_type, $a_node_id, bool $a_highlighted_subtree=false, bool $a_append_anch=true)

	setFrameTarget (string $a_target)

	createLines (int $a_depth)

	is_in_array (int $a_start, int $a_depth)

	getIndex (array $a_data)

	addFilter (string $a_item)

	delFilter (string $a_item)

	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,...) More...

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

	setFiltered (bool $a_bool)

	checkFilter (string $a_item)

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

Data Fields
string	$id = ""

string	$output = ""

array	$format_options = []

ilTree	$tree

string	$target = ""

string	$target_get = ""

string	$params_get = ""

array	$expanded = []

string	$order_column = ""

string	$order_direction = "asc"

string	$expand_target = null

bool	$rbac_check = false

bool	$output_icons = false

string	$expand_variable = ""

array	$is_clickable = []

bool	$post_sort = false

bool	$filtered = false

bool	$filter_mode

bool	$expand_all = false

	$root_id = null

bool	$use_standard_frame = false

Protected Member Functions
	requestStr (string $key)

Protected Attributes
ilObjectDefinition	$obj_definition

ilErrorHandling	$error

ilRbacSystem	$rbacsystem

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

	$filter = []

string	$highlighted = ""

bool	$show_minus = true

int	$counter = 0

bool	$asnch_expanding = false

int	$textwidth = 0

string	$title = ""

string	$up_frame = ""

string	$a_up_script = ""

string	$up_params = ""

string	$frame_target = ""

string	$up_script = ""

string	$tree_lead = ""

array	$iconList = []

ILIAS Refinery Factory	$refinery

ILIAS HTTP Wrapper WrapperFactory	$wrapper

Detailed Description

class for explorer view in admin frame

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

Deprecated:

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

Member Function Documentation

◆ addFilter()

ilExplorer::addFilter ( string $a_item )

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

References ILIAS\UI\examples\Symbol\Glyph\Filter\filter().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildDescription()

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

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

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

      : string {
         return "";
     }

Here is the caller graph for this function:

◆ buildFrameTarget()

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

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

References $frame_target.

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

      : string {
         return $this->frame_target;
     }

Here is the caller graph for this function:

◆ buildLinkTarget()

ilExplorer::buildLinkTarget	(		$a_node_id,
		string	$a_type
	)

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

References $params_get.

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

      : string {
         $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,
		string	$a_type,
		string	$a_title
	)

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

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

      : string {
         return "";
     }

Here is the caller graph for this function:

◆ buildSelect()

ilExplorer::buildSelect	(		$a_node_id,
		string	$a_type
	)

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

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

Referenced by formatObject().

Here is the caller graph for this function:

◆ buildTitle()

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

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

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

      : string {
         return $a_title;
     }

Here is the caller graph for this function:

◆ checkFilter()

ilExplorer::checkFilter ( string $a_item )

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

References ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), getFilterMode(), and IL_FM_NEGATIVE.

Referenced by setOutput().

                                                : bool
     {
         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 ( bool $a_check )

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

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

                                                    : void
     {
         $this->rbac_check = $a_check;
     }

Here is the caller graph for this function:

◆ createLines()

ilExplorer::createLines ( int $a_depth )

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

References $i, and is_in_array().

Referenced by getOutput().

                                              : void
     {
         for ($i = 0, $iMax = count($this->format_options); $i < $iMax; ++$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"][(string) $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"][(string) $a_depth] = "winkel";
                 } else {
                     $this->format_options[$i]["tab"][(string) $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"][(string) $a_depth] = "hoch";
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createTarget()

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

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

References $error, $ilErr, getAsynchExpanding(), and ILIAS\Repository\int().

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

      : string {
         $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 ( string $a_item )

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

References ILIAS\UI\examples\Symbol\Glyph\Filter\filter().

                                              : bool
     {
         $deleted = 0;
         //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;
         }
 
         return $deleted === 1;
     }

Here is the call graph for this function:

◆ forceExpandAll()

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

force expandAll.

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

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

      : void {
         $this->expand_all = $a_mode;
         $this->show_minus = $a_show_minus;
     }

◆ forceExpanded()

ilExplorer::forceExpanded ( $a_obj_id )

force expansion of node

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

Referenced by setOutput().

                                             : bool
     {
         return false;
     }

Here is the caller graph for this function:

◆ formatHeader()

ilExplorer::formatHeader	(	ilTemplate	$tpl,
			$a_obj_id,
		array	$a_option
	)

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

Referenced by getOutput().

670 : void {

671 }

Here is the caller graph for this function:

◆ formatObject()

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

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

References $error, $ilErr, $lng, buildDescription(), buildFrameTarget(), buildLinkTarget(), buildOnClick(), buildSelect(), buildTitle(), createTarget(), getAsynchExpanding(), getImage(), getImageAlt(), getNodeStyleClass(), isClickable(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), ilStr\shortenTextExtended(), ilTemplate\touchBlock(), and ilLanguage\txt().

Referenced by getOutput().

      : void {
         $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_export($a_option, true), $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 (($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)) {        // 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",
                 ilStr::shortenTextExtended(
                     $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"]),
                     $this->textwidth,
                     true
                 )
             );
             $tpl->setVariable(
                 "DESC",
                 ilStr::shortenTextExtended(
                     $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 . "\"");
             }
         } else {                        // output text only
             $tpl->setCurrentBlock("text");
             $tpl->setVariable(
                 "OBJ_TITLE",
                 ilStr::shortenTextExtended(
                     $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"]),
                     $this->textwidth,
                     true
                 )
             );
             $tpl->setVariable(
                 "OBJ_DESC",
                 ilStr::shortenTextExtended(
                     $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 ( )

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

References $asnch_expanding.

Referenced by createTarget(), and formatObject().

                                         : bool
     {
         return $this->asnch_expanding;
     }

Here is the caller graph for this function:

◆ getChildsOfNode()

ilExplorer::getChildsOfNode ( $a_parent_id )

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

Referenced by setOutput().

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

Here is the caller graph for this function:

◆ getFilterMode()

ilExplorer::getFilterMode ( )

Returns: int filter mode IL_FM_NEGATIVE | IL_FM_NEGATIVE

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

References $filter_mode.

Referenced by checkFilter().

                                    : int
     {
         return $this->filter_mode;
     }

Here is the caller graph for this function:

◆ getId()

ilExplorer::getId ( )

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

References $id.

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

                            : string
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getImage()

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

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

References ilUtil\getImagePath().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImageAlt()

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

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

Referenced by formatObject().

      : string {
         return $a_default_text;
     }

Here is the caller graph for this function:

◆ getIndex()

ilExplorer::getIndex ( array $a_data )

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

References ILIAS\LTI\ToolProvider\$key.

Referenced by setOutput().

                                            : int
     {
         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 ( )

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

Referenced by getOutput().

                                          : int
     {
         $this->tree->getMaximumDepth();
         return 0;   // seems to not return the value...
     }

Here is the caller graph for this function:

◆ getNodeStyleClass()

ilExplorer::getNodeStyleClass	(		$a_id,
		string	$a_type
	)

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

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

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

Here is the caller graph for this function:

◆ getOutput()

ilExplorer::getOutput ( )

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

References $i, ILIAS\LTI\ToolProvider\$key, $lng, $tpl, ilGlobalTemplateInterface\addJavaScript(), createLines(), formatHeader(), formatObject(), getId(), ilUtil\getImagePath(), getMaximumTreeDepth(), ilUtil\getStyleSheetLocation(), getTitle(), getUseStandardFrame(), handleListEndTags(), handleListStartTags(), ilYuiUtil\initConnection(), requestStr(), and ilLanguage\txt().

                                : string
     {
         $tpl = $this->tpl;
         $lng = $this->lng;
 
         $this->format_options[0]["tab"] = array();
 
         $depth = $this->getMaximumTreeDepth();
 
         for ($i = 0;$i < $depth;++$i) {
             $this->createLines($i);
         }
 
         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 (($this->requestStr("ict") !== "" ||
             $this->requestStr("collapseAll") !== "" ||
             $this->requestStr("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"] ?? false)) {
                 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 ilGlobalTemplate("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 ( )

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

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

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

Here is the caller graph for this function:

◆ getTitle()

ilExplorer::getTitle ( )

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

References $title.

Referenced by getOutput().

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getTitleLength()

ilExplorer::getTitleLength ( )

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

References $textwidth.

                                     : int
     {
         return $this->textwidth;
     }

◆ getTreeLead()

ilExplorer::getTreeLead ( )

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

References $tree_lead.

                                  : string
     {
         return $this->tree_lead;
     }

◆ getUseStandardFrame()

ilExplorer::getUseStandardFrame ( )

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

References $use_standard_frame.

Referenced by getOutput().

                                          : bool
     {
         return $this->use_standard_frame;
     }

Here is the caller graph for this function:

◆ handleListEndTags()

ilExplorer::handleListEndTags	(	ilTemplate	$a_tpl_tree,
		int	$a_cur_depth,
		int	$a_item_depth
	)

handle list end tags ( and )

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

References $i, and ilTemplate\touchBlock().

Referenced by getOutput().

      : void {
         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 call graph for this function:

Here is the caller graph for this function:

◆ handleListStartTags()

ilExplorer::handleListStartTags	(	ilTemplate	$a_tpl_tree,
		int	$a_cur_depth,
		int	$a_item_depth
	)

handle list start tags (

)

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

References ilTemplate\touchBlock().

Referenced by getOutput().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ highlightNode()

ilExplorer::highlightNode ( string $a_id )

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

                                                : void
     {
         $this->highlighted = $a_id;
     }

◆ initItemCounter()

ilExplorer::initItemCounter ( int $a_number )

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

                                                   : void
     {
         $this->counter = $a_number;
     }

◆ is_in_array()

ilExplorer::is_in_array	(	int	$a_start,
		int	$a_depth
	)

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

References $i.

Referenced by createLines().

      : bool {
         for ($i = $a_start, $iMax = count($this->format_options); $i < $iMax; ++$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	(	string	$type,
		int	$ref_id = `0`
	)

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

References $type.

Referenced by formatObject().

      : bool {
         // 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)
         return $this->is_clickable[$type] !== "n";
     }

Here is the caller graph for this function:

◆ isVisible()

ilExplorer::isVisible	(		$a_ref_id,
		string	$a_type
	)

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

References $rbacsystem, and ilRbacSystem\checkAccess().

Referenced by setOutput().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modifyChilds()

ilExplorer::modifyChilds	(		$a_parent_id,
		array	$a_objects
	)

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

Referenced by setOutput().

      : array {
         return $a_objects;
     }

Here is the caller graph for this function:

◆ outputIcons()

ilExplorer::outputIcons ( bool $a_icons )

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

Referenced by ilSCORMExplorer\__construct().

                                               : void
     {
         $this->output_icons = $a_icons;
     }

Here is the caller graph for this function:

◆ requestStr()

ilExplorer::requestStr ( string $key )

protected

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

References ILIAS\Repository\refinery().

Referenced by getOutput().

                                               : string
     {
         $str = $this->refinery->kindlyTo()->string();
         if ($this->wrapper->post()->has($key)) {
             return $this->wrapper->post()->retrieve($key, $str);
         }
         if ($this->wrapper->query()->has($key)) {
             return $this->wrapper->query()->retrieve($key, $str);
         }
         return "";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAsynchExpanding()

ilExplorer::setAsynchExpanding ( bool $a_val )

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

                                                    : void
     {
         $this->asnch_expanding = $a_val;
     }

◆ setClickable()

ilExplorer::setClickable	(	string	$a_type,
		bool	$a_clickable
	)

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

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

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

References ILIAS\LTI\ToolProvider\$key, ilSession\get(), getRoot(), and ilSession\set().

Referenced by assQuestionGUI\outSolutionExplorer(), ilSearchRootSelector\setPathOpen(), ilObjGlossaryGUI\showGlossarySelector(), and ilObjContentObjectGUI\showLMGlossarySelector().

                                          : void
     {
         // IF ISN'T SET CREATE SESSION VARIABLE
         if (!is_array(ilSession::get($this->expand_variable))) {
             ilSession::set($this->expand_variable, [$this->getRoot()]);
         }
         if ($a_node_id > 0 && !in_array($a_node_id, ilSession::get($this->expand_variable))) {
             $exp = ilSession::get($this->expand_variable);
             $exp[] = $a_node_id;
             ilSession::set($this->expand_variable, $exp);
         }
         if ($a_node_id < 0) {
             $key = array_keys(ilSession::get($this->expand_variable), -(int) $a_node_id);
             $exp = ilSession::get($this->expand_variable);
             if (isset($key[0]) && isset($exp[$key[0]])) {
                 unset($exp[$key[0]]);
             }
             ilSession::set($this->expand_variable, $exp);
         }
         $this->expanded = (array) ilSession::get($this->expand_variable);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setExpandTarget()

ilExplorer::setExpandTarget ( string $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 244 of file class.ilExplorer.php.

                                                          : void
     {
         $this->expand_target = $a_exp_target;
     }

◆ setFiltered()

ilExplorer::setFiltered ( bool $a_bool )

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

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

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

Here is the caller graph for this function:

◆ setFilterMode()

ilExplorer::setFilterMode ( int $a_mode = IL_FM_NEGATIVE )

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

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

                                                                : void
     {
         $this->filter_mode = $a_mode;
     }

Here is the caller graph for this function:

◆ setFrameTarget()

ilExplorer::setFrameTarget ( string $a_target )

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

                                                     : void
     {
         $this->frame_target = $a_target;
     }

◆ setFrameUpdater()

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

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

References $a_up_script.

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

◆ setId()

ilExplorer::setId ( string $a_val )

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

Referenced by ilPasteIntoMultipleItemsExplorer\__construct(), and ilObjStudyProgrammeTreeGUI\getContainerSelectionExplorer().

                                         : void
     {
         $this->id = $a_val;
     }

Here is the caller graph for this function:

◆ setOrderColumn()

ilExplorer::setOrderColumn ( string $a_column )

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

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

                                                     : void
     {
         $this->order_column = $a_column;
     }

Here is the caller graph for this function:

◆ setOrderDirection()

ilExplorer::setOrderDirection ( string $a_direction )

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

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

◆ setOutput()

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

Creates output for explorer view in admin menue recursive method.

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

References $counter, $error, $highlighted, $i, $ilErr, ILIAS\LTI\ToolProvider\$key, checkFilter(), forceExpanded(), getChildsOfNode(), getIndex(), getRoot(), isVisible(), modifyChilds(), showChilds(), and sortNodes().

      : void {
         $ilErr = $this->error;
 
         $parent_index = 0;
 
         if (!isset($a_parent_id)) {
             $ilErr->raiseError(get_class($this) . "::setOutput(): No node_id given!", $ilErr->WARNING);
         }
 
         if ($this->showChilds($a_parent_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 || $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[(string) $this->counter]["parent"] = $object["parent"];
                         $this->format_options[(string) $this->counter]["child"] = $object["child"];
                         $this->format_options[(string) $this->counter]["title"] = $object["title"];
                         $this->format_options[(string) $this->counter]["type"] = $object["type"];
                         $this->format_options[(string) $this->counter]["obj_id"] = $object["obj_id"];
                         $this->format_options[(string) $this->counter]["desc"] = "obj_" . $object["type"];
                         $this->format_options[(string) $this->counter]["depth"] = $tab;
                         $this->format_options[(string) $this->counter]["container"] = false;
                         $this->format_options[(string) $this->counter]["visible"] = true;
                         $this->format_options[(string) $this->counter]["highlighted_subtree"] = $a_highlighted_subtree;
 
                         // Create prefix array
                         for ($i = 0; $i < $tab; ++$i) {
                             $this->format_options[(string) $this->counter]["tab"][] = 'blank';
                         }
 
                         // fix explorer (sometimes explorer disappears)
                         if ($parent_index === 0) {
                             if (!$this->expand_all && !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() && ((!$this->expand_all && !in_array($object["parent"], $this->expanded))
                            or !$this->format_options[(string) $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[(string) $this->counter]["visible"]) {
                                     //echo "-setSkipping";
                                     $skip_rest = true;
                                 }
                                 $this->format_options[(string) $this->counter]["visible"] = false;
                             }
                         }
 
                         // if object exists parent is container
                         if ($object["child"] != $this->getRoot()) {
                             $this->format_options[(string) $parent_index]["container"] = true;
 
                             if ($this->expand_all || in_array($object["parent"], $this->expanded)) {
                                 //echo "<br>-".$object["child"]."-".$this->forceExpanded($object["child"])."-";
                                 if ($this->forceExpanded($object["parent"])) {
                                     $this->format_options[(string) $parent_index]["tab"][($tab - 2)] = 'forceexp';
                                 } else {
                                     $this->format_options[(string) $parent_index]["tab"][($tab - 2)] = 'minus';
                                 }
                             } else {
                                 $this->format_options[(string) $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 || in_array($object["parent"], $this->expanded) or ($object["parent"] == 0)
                             or $this->forceExpanded($object["child"])) {
                             $highlighted_subtree = $a_highlighted_subtree ||
                                 ($object["child"] == $this->highlighted);
 
                             // 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 ( array $a_params_get )

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

References $error, $ilErr, and ILIAS\LTI\ToolProvider\$key.

Referenced by ilECSNodeMappingLocalExplorer\formatObject().

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

Here is the caller graph for this function:

◆ setPostSort()

ilExplorer::setPostSort ( bool $a_sort )

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

                                              : void
     {
         $this->post_sort = $a_sort;
     }

◆ setRoot()

ilExplorer::setRoot ( $a_root_id )

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

Referenced by ilECSNodeMappingLocalExplorer\__construct().

                                        : void
     {
         #$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 ( string $a_var_name = "expand" )

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

Referenced by ilContainerSelectionExplorer\__construct(), ilPasteIntoMultipleItemsExplorer\__construct(), ilSolutionExplorer\__construct(), and ilSearchRootSelector\__construct().

                                                                            : void
     {
         $this->expand_variable = $a_var_name;
     }

Here is the caller graph for this function:

◆ setTargetGet()

ilExplorer::setTargetGet ( string $a_target_get )

Parameters

string $a_target_get varname containing Ids to be used in GET-string

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

References $error, and $ilErr.

Referenced by ilSCORMPresentationGUI\explorer().

                                                       : void
     {
         $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 ( string $a_val )

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

                                            : void
     {
         $this->title = $a_val;
     }

◆ setTitleLength()

ilExplorer::setTitleLength ( int $a_length )

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

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

                                                  : void
     {
         $this->textwidth = $a_length;
     }

Here is the caller graph for this function:

◆ setTreeLead()

ilExplorer::setTreeLead ( string $a_val )

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

                                               : void
     {
         $this->tree_lead = $a_val;
     }

◆ setUseStandardFrame()

ilExplorer::setUseStandardFrame ( bool $a_val )

Set use standard frame.

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

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

                                                     : void
     {
         $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 500 of file class.ilExplorer.php.

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

                                             : bool
     {
         return true;
     }

Here is the caller graph for this function:

◆ sortNodes()

ilExplorer::sortNodes	(	array	$a_nodes,
			$a_parent_obj_id
	)

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

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

References ILIAS\LTI\ToolProvider\$key, and ilArrayUtil\sortArray().

Referenced by setOutput().

                                                                : array
     {
         $adm_node = null;
         foreach ($a_nodes as $key => $node) {
             if ($node["type"] === "adm") {
                 $match = $key;
                 $adm_node = $node;
                 break;
             }
         }
 
         // cut off adm node
         if (isset($match)) {
             array_splice($a_nodes, $match, 1);
         }
 
         $a_nodes = ilArrayUtil::sortArray($a_nodes, $this->order_column, $this->order_direction);
 
         // append adm node to end of list
         if (isset($match)) {
             $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

◆ $a_up_script

string ilExplorer::$a_up_script = ""

protected

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

Referenced by setFrameUpdater().

◆ $asnch_expanding

bool ilExplorer::$asnch_expanding = false

protected

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

Referenced by getAsynchExpanding().

◆ $counter

int ilExplorer::$counter = 0

protected

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

Referenced by setOutput().

◆ $error

ilErrorHandling ilExplorer::$error

protected

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

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

◆ $expand_all

bool ilExplorer::$expand_all = false

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

◆ $expand_target

string ilExplorer::$expand_target = null

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

◆ $expand_variable

string ilExplorer::$expand_variable = ""

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

◆ $expanded

array ilExplorer::$expanded = []

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

◆ $filter

ilExplorer::$filter = []

protected

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

◆ $filter_mode

bool ilExplorer::$filter_mode

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

Referenced by getFilterMode().

◆ $filtered

bool ilExplorer::$filtered = false

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

◆ $format_options

array ilExplorer::$format_options = []

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

◆ $frame_target

string ilExplorer::$frame_target = ""

protected

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

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

◆ $highlighted

string ilExplorer::$highlighted = ""

protected

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

Referenced by setOutput().

◆ $iconList

array ilExplorer::$iconList = []

protected

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

◆ $id

string ilExplorer::$id = ""

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

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

◆ $is_clickable

array ilExplorer::$is_clickable = []

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

◆ $lng

ilLanguage ilExplorer::$lng

protected

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

Referenced by ilSCORMExplorer\formatHeader(), ilContainerSelectionExplorer\formatHeader(), ilRepositoryExplorer\formatHeader(), formatObject(), getOutput(), and ilSCORMExplorer\getOutputIcons().

◆ $obj_definition

ilObjectDefinition ilExplorer::$obj_definition

protected

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

Referenced by ilRepositoryExplorer\sortNodes().

◆ $order_column

string ilExplorer::$order_column = ""

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

◆ $order_direction

string ilExplorer::$order_direction = "asc"

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

◆ $output

string ilExplorer::$output = ""

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

◆ $output_icons

bool ilExplorer::$output_icons = false

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

◆ $params_get

string ilExplorer::$params_get = ""

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

Referenced by buildLinkTarget().

◆ $post_sort

bool ilExplorer::$post_sort = false

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

◆ $rbac_check

bool ilExplorer::$rbac_check = false

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

◆ $rbacsystem

ilRbacSystem ilExplorer::$rbacsystem

protected

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

Referenced by ilRepositoryExplorer\isClickable(), isVisible(), ilSolutionExplorer\showChilds(), and ilRepositoryExplorer\showChilds().

◆ $refinery

ILIAS Refinery Factory ilExplorer::$refinery

protected

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

Referenced by ilAsyncContainerSelectionExplorer\__construct().

◆ $root_id

ilExplorer::$root_id = null

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

◆ $show_minus

bool ilExplorer::$show_minus = true

protected

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

◆ $target

string ilExplorer::$target = ""

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

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

◆ $target_get

string ilExplorer::$target_get = ""

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

◆ $textwidth

int ilExplorer::$textwidth = 0

protected

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

Referenced by getTitleLength().

◆ $title

string ilExplorer::$title = ""

protected

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

Referenced by ilECSNodeMappingLocalExplorer\formatHeader(), ilECSNodeMappingCmsExplorer\formatHeader(), ilPasteIntoMultipleItemsExplorer\formatHeader(), ilRepositoryExplorer\formatHeader(), and getTitle().

◆ $tpl

ilGlobalTemplateInterface ilExplorer::$tpl

protected

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

Referenced by ilAsyncContainerSelectionExplorer\addJavascript(), ilSCORMExplorer\createOutput(), ilECSNodeMappingCmsExplorer\formatObject(), getOutput(), and ilSCORMExplorer\insertObject().

◆ $tree

ilTree ilExplorer::$tree

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

Referenced by ilContainerSelectionExplorer\__construct(), ilSolutionExplorer\__construct(), ilRepositoryExplorer\formatHeader(), ilRepositoryExplorer\isVisible(), and ilECSNodeMappingCmsExplorer\setTree().

◆ $tree_lead

string ilExplorer::$tree_lead = ""

protected

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

Referenced by getTreeLead().

◆ $up_frame

string ilExplorer::$up_frame = ""

protected

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

◆ $up_params

string ilExplorer::$up_params = ""

protected

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

◆ $up_script

string ilExplorer::$up_script = ""

protected

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

◆ $use_standard_frame

bool ilExplorer::$use_standard_frame = false

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

Referenced by getUseStandardFrame().

◆ $wrapper

ILIAS HTTP Wrapper WrapperFactory ilExplorer::$wrapper

protected

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

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

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

◆ initItemCounter()

◆ is_in_array()

◆ isClickable()

◆ isVisible()

◆ modifyChilds()

◆ outputIcons()

◆ requestStr()

◆ 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

◆ $a_up_script

◆ $asnch_expanding

◆ $counter

◆ $error

◆ $expand_all

◆ $expand_target

◆ $expand_variable

◆ $expanded

◆ $filter