Inheritance diagram for ilAdministrationExplorer:

Collaboration diagram for ilAdministrationExplorer:

Public Member Functions
	ilAdministrationExplorer ($a_target)
	Constructor public. More...

	formatHeader (&$tpl, $a_obj_id, $a_option)
	overwritten method from base class public More...

	buildLinkTarget ($a_node_id, $a_type)
	build link target More...

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

	getImage ($a_name, $a_type="", $a_obj_id="")
	get image path More...

	isClickable ($a_type, $a_ref_id)

	isVisible ($a_ref_id, $a_type)

	modifyChilds ($a_parent_id, $a_objects)
	modify children of parent () More...

	showChilds ($a_parent_id, $a_obj_id)

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

Public Member Functions inherited from ilExplorer
	ilExplorer ($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
	$root_id

	$output

	$ctrl

Data Fields inherited from ilExplorer
	$id

	$ilias

	$output

	$format_options

	$tree

	$target

	$target_get

	$params_get

	$expanded

	$order_column

	$order_direction = "asc"

	$expand_target

	$rbac_check

	$output_icons

	$expand_variable

	$is_clickable

	$post_sort

	$filtered = false

	$filter_mode

	$expand_all = false

	$root_id = null

	$use_standard_frame = false

Detailed Description

Definition at line 14 of file class.ilAdministrationExplorer.php.

Member Function Documentation

◆ buildFrameTarget()

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

get frame target (may be overwritten by derived classes)

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

References $_GET, and ilFrameTargetInfo\_getFrame().

         {
                 if ($_GET["admin_mode"] == "settings" && $a_child == ROOT_FOLDER_ID)
                 {
                         return ilFrameTargetInfo::_getFrame("MainContent");
                 }
                 else
                 {
                         return $this->frame_target;
                 }
         }

Here is the call graph for this function:

◆ buildLinkTarget()

ilAdministrationExplorer::buildLinkTarget	(	$a_node_id,
		$a_type
	)

build link target

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

References $_GET, and $ilCtrl.

         {
                 global $ilCtrl, $objDefinition;
 
                 if ($a_type == "" || $a_type == "xxx")
                 {
                         return;
                 }
                 if ($_GET["admin_mode"] == "settings" && $a_node_id == ROOT_FOLDER_ID)
                 {
                         $this->ctrl->setParameterByClass("iladministrationgui", "ref_id", ROOT_FOLDER_ID);
                         $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "repository");
                         $link = $this->ctrl->getLinkTargetByClass("iladministrationgui", "frameset");
                         $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "settings");
                 }
                 else
                 {
                         $class_name = $objDefinition->getClassName($a_type);
                         $class = strtolower("ilObj".$class_name."GUI");
                         $this->ctrl->setParameterByClass($class, "ref_id", $a_node_id);
                         $link = $this->ctrl->getLinkTargetByClass($class, "view");
                 }
                 return $link;
         }

◆ forceExpanded()

ilAdministrationExplorer::forceExpanded ( $a_obj_id )

force expansion of node

Definition at line 234 of file class.ilAdministrationExplorer.php.

         {
                 if ($a_obj_id == SYSTEM_FOLDER_ID)
                 {
                         return true;
                 }
                 else
                 {
                         return false;
                 }
         }

◆ formatHeader()

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

overwritten method from base class public

Parameters

integer	obj_id
integer	array options

Returns: string

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

References $_GET, ilExplorer\$ilias, $lng, $tpl, and ilUtil\getImagePath().

         {
                 global $lng, $ilias, $objDefinition;
                 
                 if ($_GET["admin_mode"] == "settings")
                 {
                         return;
                 }
 
                 $tpl->setCurrentBlock("icon");
                 $tpl->setVariable("ICON_IMAGE" , ilUtil::getImagePath("icon_root.svg"));
                 $tpl->setVariable("TXT_ALT_IMG", $lng->txt("repository"));
                 $tpl->parseCurrentBlock();
 
                 $class_name = $objDefinition->getClassName("root");
                 $class = strtolower("ilObj".$class_name."GUI");
                 $this->ctrl->setParameterByClass($class, "ref_id", ROOT_FOLDER_ID);
                 $link = $this->ctrl->getLinkTargetByClass($class, "view");
 
                 $tpl->setCurrentBlock("link");
                 $tpl->setVariable("TITLE", $lng->txt("repository"));
                 $tpl->setVariable("LINK_TARGET", $link);
                 $tpl->setVariable("TARGET", " target=\"content\"");
                 $tpl->parseCurrentBlock();
 
                 $tpl->setCurrentBlock("element");
                 $tpl->parseCurrentBlock();
 
         }

Here is the call graph for this function:

◆ getImage()

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

get image path

Definition at line 129 of file class.ilAdministrationExplorer.php.

References ilObject\_getIcon().

         {
                 if ($a_type != "")
                 {
                         return ilObject::_getIcon($a_obj_id, "tiny", $a_type);
                 }
         
                 return parent::getImage($a_name);
         }

Here is the call graph for this function:

◆ ilAdministrationExplorer()

ilAdministrationExplorer::ilAdministrationExplorer ( $a_target )

Constructor public.

Parameters

string	scriptname
int	user_id

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

References $ilCtrl, $lng, ilExplorer\$tree, ilExplorer\setSessionExpandVariable(), and ilExplorer\setTitle().

         {
                 global $tree,$ilCtrl,$lng;
 
                 $this->ctrl = $ilCtrl;
 
                 parent::ilExplorer($a_target);
                 $this->tree = $tree;
                 $this->root_id = $this->tree->readRootId();
                 $this->order_column = "title";
                 $this->setSessionExpandVariable("expand");
                 $this->setTitle($lng->txt("overview"));
         }

Here is the call graph for this function:

◆ isClickable()

ilAdministrationExplorer::isClickable	(	$a_type,
		$a_ref_id
	)

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

         {
                 global $rbacsystem;
 
                 return $rbacsystem->checkAccess('read',$a_ref_id);
         }

◆ isVisible()

ilAdministrationExplorer::isVisible	(	$a_ref_id,
		$a_type
	)

Definition at line 146 of file class.ilAdministrationExplorer.php.

References $_GET, and $ilBench.

         {
                 global $rbacsystem, $ilBench;
 
                 if ($this->tree->getParentId($a_ref_id) == ROOT_FOLDER_ID && $a_type != "adm" &&
                         $_GET["admin_mode"] != "repository")
                 {
                         return false;
                 }
 
                 // these objects may exist due to test cases that didnt clear
                 // data properly
                 if ($a_type == "" || $a_type == "xxx")
                 {
                         return false;
                 }
                 
                 $ilBench->start("Explorer", "setOutput_isVisible");
                 $visible = $rbacsystem->checkAccess('visible',$a_ref_id);
                 if ($a_type == "rolf" && $a_ref_id != ROLE_FOLDER_ID)
                 {
                         return false;
                 }
 
                 $ilBench->stop("Explorer", "setOutput_isVisible");
                 return $visible;
         }

◆ modifyChilds()

ilAdministrationExplorer::modifyChilds	(	$a_parent_id,
		$a_objects
	)

modify children of parent ()

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

References $lng.

         {
                 global $lng,$rbacsystem;
                 
                 if ($a_parent_id == SYSTEM_FOLDER_ID)
                 {
                         $new_objects = array();
                         foreach($a_objects as $object)
                         {
                                 $new_objects[$object["title"].":".$object["child"]]
                                         = $object;
                         }
 
                         // add entry for switching to repository admin
                         // note: please see showChilds methods which prevents infinite look
                         if($rbacsystem->checkAccess('write',SYSTEM_FOLDER_ID))
                         {
                                 $new_objects[$lng->txt("repository_admin").":".ROOT_FOLDER_ID] =
                                         array(
                                         "tree" => 1,
                                         "child" => ROOT_FOLDER_ID,
                                         "ref_id" => ROOT_FOLDER_ID,
                                         "depth" => 3,
                                         "type" => "root",
                                         "title" => $lng->txt("repository_admin"),
                                         "description" => $lng->txt("repository_admin_desc"),
                                         "desc" => $lng->txt("repository_admin_desc"),
                                         );
                         }
                         ksort($new_objects);
                         
                         return $new_objects;
                 }
 
                 return $a_objects;
         }

◆ showChilds()

ilAdministrationExplorer::showChilds	(	$a_parent_id,
		$a_obj_id
	)

Definition at line 214 of file class.ilAdministrationExplorer.php.

         {
                 
                 // prevent infinite loop due to (root folder tree) node
                 // that is inserted under system admin folder
                 if ($a_parent_id == ROOT_FOLDER_ID)
                 {
                         if ($this->rootfolder_shown == true)
                         {
                                 return false;
                         }
                         $this->rootfolder_shown = true;
                 }
 
                 return true;
         }

Field Documentation

◆ $ctrl

ilAdministrationExplorer::$ctrl

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

◆ $output

ilAdministrationExplorer::$output

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

◆ $root_id

ilAdministrationExplorer::$root_id

Definition at line 22 of file class.ilAdministrationExplorer.php.

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

Services/Administration/classes/class.ilAdministrationExplorer.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ buildFrameTarget()

◆ buildLinkTarget()

◆ forceExpanded()

◆ formatHeader()

◆ getImage()

◆ ilAdministrationExplorer()

◆ isClickable()

◆ isVisible()

◆ modifyChilds()

◆ showChilds()

Field Documentation

◆ $ctrl

◆ $output

◆ $root_id