Explorer for ILIAS tree. More...

Inheritance diagram for ilECSNodeMappingLocalExplorer:

Collaboration diagram for ilECSNodeMappingLocalExplorer:

Public Member Functions
	__construct (string $a_target, int $a_sid, int $a_mid)

	getSid ()

	getMid ()

	isClickable (string $type, int $ref_id=0)
	no item is clickable More...

	addFormItemForType ($type)
	Add form item. More...

	removeFormItemForType ($type)

	setCheckedItems ($a_checked_items=array())

	getCheckedItems ()

	isItemChecked (int $a_id)

	setPostVar (string $a_post_var)

	getPostVar ()

	buildFormItem ($a_node_id, string $a_type)

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

	formatHeader (ilTemplate $tpl, $a_obj_id, array $a_option)
	overwritten method from base class More...

	buildTitle (string $a_title, $a_id, string $a_type)
	Format title (bold for direct mappings, italic for child mappings) More...

Public Member Functions inherited from ilExplorer
	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
const	SEL_TYPE_CHECK = 1

const	SEL_TYPE_RADIO = 2

Data Fields inherited from ilExplorer
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
	initMappings ()
	Init (read) current mappings. More...

	isMapped ($a_ref_id)

	hasParentMapping ($a_ref_id)

Protected Member Functions inherited from ilExplorer
	requestStr (string $key)

Private Attributes
array	$checked_items = []

string	$post_var = ''

array	$form_items = []

int	$type

int	$sid

int	$mid

array	$mappings = []

Additional Inherited Members
Protected Attributes inherited from ilExplorer
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

Explorer for ILIAS tree.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilECSNodeMappingLocalExplorer::__construct	(	string	$a_target,
		int	$a_sid,
		int	$a_mid
	)

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

References ILIAS\GlobalScreen\Provider\__construct(), ilExplorer\addFilter(), addFormItemForType(), ILIAS\Repository\filter(), IL_FM_POSITIVE, initMappings(), ilExplorer\setFiltered(), ilExplorer\setFilterMode(), ilExplorer\setOrderColumn(), and ilExplorer\setRoot().

     {
         parent::__construct($a_target);
 
         $this->sid = $a_sid;
         $this->mid = $a_mid;
 
         $this->type = self::SEL_TYPE_RADIO;
 
         $this->setRoot($this->tree->readRootId());
         $this->setOrderColumn('title');
 
 
         // reset filter
         $this->filter = array();
 
         $this->addFilter('root');
         $this->addFilter('cat');
 
         $this->addFormItemForType('root');
         $this->addFormItemForType('cat');
 
         $this->setFiltered(true);
         $this->setFilterMode(IL_FM_POSITIVE);
 
         $this->initMappings();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addFormItemForType()

ilECSNodeMappingLocalExplorer::addFormItemForType ( $type )

Add form item.

Definition at line 93 of file class.ilECSNodeMappingLocalExplorer.php.

References $type.

Referenced by __construct().

                                              : void
     {
         $this->form_items[$type] = true;
     }

Here is the caller graph for this function:

◆ buildFormItem()

ilECSNodeMappingLocalExplorer::buildFormItem	(		$a_node_id,
		string	$a_type
	)

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

References ilLegacyFormElementsUtil\formCheckbox(), ilLegacyFormElementsUtil\formRadioButton(), and isItemChecked().

Referenced by formatHeader(), and formatObject().

                                                              : string
     {
         if (!array_key_exists($a_type, $this->form_items) || !$this->form_items[$a_type]) {
             return '';
         }
 
         switch ($this->type) {
             case self::SEL_TYPE_CHECK:
                 return ilLegacyFormElementsUtil::formCheckbox(
                     $this->isItemChecked($a_node_id),
                     $this->post_var,
                     (string) $a_node_id
                 );
             case self::SEL_TYPE_RADIO:
                 return ilLegacyFormElementsUtil::formRadioButton(
                     $this->isItemChecked($a_node_id),
                     $this->post_var,
                     (string) $a_node_id,
                     "document.getElementById('map').submit(); return false;"
                 );
         }
         return '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTitle()

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

Format title (bold for direct mappings, italic for child mappings)

Definition at line 308 of file class.ilECSNodeMappingLocalExplorer.php.

References hasParentMapping(), and isMapped().

Referenced by formatObject().

                                                                       : string
     {
         if ($this->isMapped($a_id)) {
             return '<font style="font-weight: bold">' . $a_title . '</font>';
         }
         if ($this->hasParentMapping($a_id)) {
             return '<font style="font-style: italic">' . $a_title . '</font>';
         }
         return $a_title;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ formatHeader()

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

overwritten method from base class

Definition at line 272 of file class.ilECSNodeMappingLocalExplorer.php.

References $nd, $path, ilExplorer\$title, ilObject\_getIcon(), buildFormItem(), isMapped(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ROOT_FOLDER_ID, ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                                                              : void
     {
         // custom icons
         $path = ilObject::_getIcon((int) $a_obj_id, "tiny", "root");
 
 
         $tpl->setCurrentBlock("icon");
         $nd = $this->tree->getNodeData(ROOT_FOLDER_ID);
         $title = $nd["title"];
         if ($title === "ILIAS") {
             $title = $this->lng->txt("repository");
         }
 
         $tpl->setVariable("ICON_IMAGE", $path);
         $tpl->setVariable("TXT_ALT_IMG", $title);
         $tpl->parseCurrentBlock();
 
         if (($formItem = $this->buildFormItem((int) $a_obj_id, (string) $a_option['type'])) !== '') {
             $tpl->setCurrentBlock('check');
             $tpl->setVariable('OBJ_CHECK', $formItem);
             $tpl->parseCurrentBlock();
         }
 
         if ($this->isMapped(ROOT_FOLDER_ID)) {
             $tpl->setVariable(
                 'OBJ_TITLE',
                 '<font style="font-weight: bold">' . $title . '</font>'
             );
         } else {
             $tpl->setVariable('OBJ_TITLE', $title);
         }
     }

Here is the call graph for this function:

◆ formatObject()

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

Parameters

int | string $a_node_id

Exceptions

ilTemplateException

Definition at line 155 of file class.ilECSNodeMappingLocalExplorer.php.

References ilExplorer\$frame_target, ilExplorer\$target, ilExplorer\buildDescription(), buildFormItem(), ilExplorer\buildFrameTarget(), ilExplorer\buildLinkTarget(), ilExplorer\buildOnClick(), buildTitle(), ilExplorer\createTarget(), ilExplorer\getImage(), ilExplorer\getNodeStyleClass(), isClickable(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), ilExplorer\setParamsGet(), HTML_Template_IT\setVariable(), ilStr\shortenTextExtended(), and ilTemplate\touchBlock().

                                                                                              : void
     {
         if (!isset($a_node_id) || !is_array($a_option)) {
             $this->error->raiseError(get_class($this) . "::formatObject(): Missing parameter or wrong datatype! " .
                                     "node_id: " . $a_node_id . " options:" . print_r($a_option, true), $this->error->WARNING);
         }
 
         $pic = false;
         foreach ($a_option["tab"] as $picture) {
             if ($picture === 'plus') {
                 $tpl->setCurrentBlock("expander");
                 $tpl->setVariable("EXP_DESC", $this->lng->txt("expand"));
                 $this->setParamsGet([]);
                 $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/plus.png"));
                 $tpl->parseCurrentBlock();
                 $pic = true;
             }
 
             if ($picture === 'minus' && $this->show_minus) {
                 $tpl->setCurrentBlock("expander");
                 $tpl->setVariable("EXP_DESC", $this->lng->txt("collapse"));
                 $this->setParamsGet([]);
                 $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/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("standard/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->lng->txt($a_option["desc"]));
             $tpl->parseCurrentBlock();
         }
 
         if (($formItem = $this->buildFormItem((int) $a_node_id, (string) $a_option['type'])) !== '') {
             $tpl->setCurrentBlock('check');
             $tpl->setVariable('OBJ_CHECK', $formItem);
             $tpl->parseCurrentBlock();
         }
 
         if ($this->isClickable($a_option["type"], (int) $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",
                 $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"])
             );
             $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",
                 $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"])
             );
             $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:

◆ getCheckedItems()

ilECSNodeMappingLocalExplorer::getCheckedItems ( )

Definition at line 108 of file class.ilECSNodeMappingLocalExplorer.php.

References $checked_items.

                                      : array
     {
         return $this->checked_items;
     }

◆ getMid()

ilECSNodeMappingLocalExplorer::getMid ( )

Definition at line 77 of file class.ilECSNodeMappingLocalExplorer.php.

References $mid.

Referenced by initMappings().

                             : int
     {
         return $this->mid;
     }

Here is the caller graph for this function:

◆ getPostVar()

ilECSNodeMappingLocalExplorer::getPostVar ( )

Definition at line 122 of file class.ilECSNodeMappingLocalExplorer.php.

References $post_var.

                                 : string
     {
         return $this->post_var;
     }

◆ getSid()

ilECSNodeMappingLocalExplorer::getSid ( )

Definition at line 72 of file class.ilECSNodeMappingLocalExplorer.php.

References $sid.

Referenced by initMappings().

                             : int
     {
         return $this->sid;
     }

Here is the caller graph for this function:

◆ hasParentMapping()

ilECSNodeMappingLocalExplorer::hasParentMapping ( $a_ref_id )

protected

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

Referenced by buildTitle().

                                                   : bool
     {
         foreach ($this->mappings as $parent_nodes) {
             if (in_array($a_ref_id, $parent_nodes, true)) {
                 return true;
             }
         }
         return false;
     }

Here is the caller graph for this function:

◆ initMappings()

ilECSNodeMappingLocalExplorer::initMappings ( )

protected

Init (read) current mappings.

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

References $ref_id, getMid(), ilECSCourseMappingRule\getRuleRefIds(), and getSid().

Referenced by __construct().

                                      : bool
     {
         $mappings = array();
         foreach (ilECSCourseMappingRule::getRuleRefIds($this->getSid(), $this->getMid()) as $ref_id) {
             $mappings[$ref_id] = [];
         }
 
         foreach (array_keys($mappings) as $ref_id) {
             $this->mappings[$ref_id] = $this->tree->getPathId($ref_id, 1);
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isClickable()

ilECSNodeMappingLocalExplorer::isClickable	(	string	$type,
		int	$ref_id = `0`
	)

no item is clickable

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

Referenced by formatObject().

                                                               : bool
     {
         return false;
     }

Here is the caller graph for this function:

◆ isItemChecked()

ilECSNodeMappingLocalExplorer::isItemChecked ( int $a_id )

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

Referenced by buildFormItem().

                                             : bool
     {
         return in_array($a_id, $this->checked_items, true);
     }

Here is the caller graph for this function:

◆ isMapped()

ilECSNodeMappingLocalExplorer::isMapped ( $a_ref_id )

protected

Definition at line 335 of file class.ilECSNodeMappingLocalExplorer.php.

Referenced by buildTitle(), and formatHeader().

                                           : bool
     {
         return array_key_exists($a_ref_id, $this->mappings);
     }

Here is the caller graph for this function:

◆ removeFormItemForType()

ilECSNodeMappingLocalExplorer::removeFormItemForType ( $type )

Definition at line 98 of file class.ilECSNodeMappingLocalExplorer.php.

References $type.

                                                 : void
     {
         $this->form_items[$type] = false;
     }

◆ setCheckedItems()

ilECSNodeMappingLocalExplorer::setCheckedItems ( $a_checked_items = array() )

Definition at line 103 of file class.ilECSNodeMappingLocalExplorer.php.

                                                                : void
     {
         $this->checked_items = $a_checked_items;
     }

◆ setPostVar()

ilECSNodeMappingLocalExplorer::setPostVar ( string $a_post_var )

Definition at line 118 of file class.ilECSNodeMappingLocalExplorer.php.

Referenced by ilECSMappingSettingsGUI\cShowLocalExplorer(), and ilECSMappingSettingsGUI\dShowLocalExplorer().

                                                   : void
     {
         $this->post_var = $a_post_var;
     }

Here is the caller graph for this function:

Field Documentation

◆ $checked_items

array ilECSNodeMappingLocalExplorer::$checked_items = []

private

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

Referenced by getCheckedItems().

◆ $form_items

array ilECSNodeMappingLocalExplorer::$form_items = []

private

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

◆ $mappings

array ilECSNodeMappingLocalExplorer::$mappings = []

private

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

◆ $mid

int ilECSNodeMappingLocalExplorer::$mid

private

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

Referenced by getMid().

◆ $post_var

string ilECSNodeMappingLocalExplorer::$post_var = ''

private

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

Referenced by getPostVar().

◆ $sid

int ilECSNodeMappingLocalExplorer::$sid

private

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

Referenced by getSid().

◆ $type

int ilECSNodeMappingLocalExplorer::$type

private

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

Referenced by addFormItemForType(), and removeFormItemForType().

◆ SEL_TYPE_CHECK

const ilECSNodeMappingLocalExplorer::SEL_TYPE_CHECK = 1

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

◆ SEL_TYPE_RADIO

const ilECSNodeMappingLocalExplorer::SEL_TYPE_RADIO = 2

Definition at line 29 of file class.ilECSNodeMappingLocalExplorer.php.

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

components/ILIAS/WebServices/ECS/classes/Mapping/class.ilECSNodeMappingLocalExplorer.php

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFormItemForType()

◆ buildFormItem()

◆ buildTitle()

◆ formatHeader()

◆ formatObject()

◆ getCheckedItems()

◆ getMid()

◆ getPostVar()

◆ getSid()

◆ hasParentMapping()

◆ initMappings()

◆ isClickable()

◆ isItemChecked()

◆ isMapped()

◆ removeFormItemForType()

◆ setCheckedItems()

◆ setPostVar()

Field Documentation

◆ $checked_items

◆ $form_items

◆ $mappings

◆ $mid

◆ $post_var

◆ $sid

◆ $type

◆ SEL_TYPE_CHECK

◆ SEL_TYPE_RADIO