Explorer for ILIAS tree. More...

Inheritance diagram for ilECSNodeMappingCmsExplorer:

Collaboration diagram for ilECSNodeMappingCmsExplorer:

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

	setTree (ilECSCmsTree $tree)
	Set cms tree. More...

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

	isItemChecked ($a_id)

	setPostVar ($a_post_var)

	getPostVar ()

	buildFormItem ($a_node_id, $a_type)

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

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

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

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

Private Attributes
int	$server_id

int	$mid

int	$tree_id

array	$checked_items = array()

string	$post_var = ''

array	$form_items = array()

int	$type

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

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 25 of file class.ilECSNodeMappingCmsExplorer.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSNodeMappingCmsExplorer::__construct	(	string	$a_target,
		int	$a_server_id,
		int	$a_mid,
		int	$a_tree_id
	)

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

References ILIAS\GlobalScreen\Provider\__construct(), addFormItemForType(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilExplorer\setOrderColumn(), and ilExplorer\setTitleLength().

     {
         parent::__construct($a_target);
 
         $this->type = self::SEL_TYPE_CHECK;
         $this->setOrderColumn('title');
         $this->setTitleLength(1024);
 
         // reset filter
         $this->filter = array();
         $this->addFormItemForType('');
 
         $this->server_id = $a_server_id;
         $this->mid = $a_mid;
         $this->tree_id = $a_tree_id;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addFormItemForType()

ilECSNodeMappingCmsExplorer::addFormItemForType ( $type )

Add form item.

Definition at line 75 of file class.ilECSNodeMappingCmsExplorer.php.

References $type.

Referenced by __construct().

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

Here is the caller graph for this function:

◆ buildFormItem()

ilECSNodeMappingCmsExplorer::buildFormItem	(	$a_node_id,
		$a_type
	)

Definition at line 104 of file class.ilECSNodeMappingCmsExplorer.php.

References ilLegacyFormElementsUtil\formCheckbox(), ilLegacyFormElementsUtil\formRadioButton(), isItemChecked(), ilECSCmsData\lookupStatusByObjId(), and ilECSCmsData\MAPPING_DELETED.

Referenced by formatHeader(), and formatObject().

                                                       : string
     {
         if (!array_key_exists($a_type, $this->form_items) || !$this->form_items[$a_type]) {
             return '';
         }
 
         $status = ilECSCmsData::lookupStatusByObjId(
             $this->server_id,
             $this->mid,
             $this->tree_id,
             $a_node_id
         );
 
         if ($status === ilECSCmsData::MAPPING_DELETED) {
             return ilLegacyFormElementsUtil::formCheckbox(
                 $this->isItemChecked($a_node_id),
                 $this->post_var,
                 $a_node_id,
                 true
             );
         }
         switch ($this->type) {
             case self::SEL_TYPE_CHECK:
                 return ilLegacyFormElementsUtil::formCheckbox(
                     $this->isItemChecked($a_node_id),
                     $this->post_var,
                     $a_node_id
                 );
                 break;
 
             case self::SEL_TYPE_RADIO:
                 return ilLegacyFormElementsUtil::formRadioButton(
                     $this->isItemChecked($a_node_id),
                     $this->post_var,
                     $a_node_id
                 );
                 break;
         }
 
         return '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTitle()

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

Definition at line 298 of file class.ilECSNodeMappingCmsExplorer.php.

References ilECSCmsData\lookupStatusByObjId(), ilECSCmsData\MAPPING_DELETED, ilECSCmsData\MAPPING_MAPPED, ilECSCmsData\MAPPING_PENDING_DISCONNECTABLE, ilECSCmsData\MAPPING_PENDING_NOT_DISCONNECTABLE, and ilECSCmsData\MAPPING_UNMAPPED.

Referenced by formatHeader(), and formatObject().

                                                                       : string
     {
         $status = ilECSCmsData::lookupStatusByObjId(
             $this->server_id,
             $this->mid,
             $this->tree_id,
             $a_id
         );
 
 
 
         switch ($status) {
             case ilECSCmsData::MAPPING_UNMAPPED:
                 return '<font style="font-weight: bold">' . $a_title . '</font>';
 
             case ilECSCmsData::MAPPING_PENDING_DISCONNECTABLE:
                 return '<font style="font-weight: bold;font-style: italic">' . $a_title . '</font>';
 
             case ilECSCmsData::MAPPING_PENDING_NOT_DISCONNECTABLE:
                 return '<font style="font-style: italic">' . $a_title . '</font>';
 
             case ilECSCmsData::MAPPING_DELETED:
                 return '<font class="warning">' . $a_title . '</font>';
 
             case ilECSCmsData::MAPPING_MAPPED:
             default:
                 return $a_title;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ formatHeader()

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

Definition at line 274 of file class.ilECSNodeMappingCmsExplorer.php.

References $nd, $path, ilExplorer\$title, ilObject\_getIcon(), buildFormItem(), buildTitle(), ilExplorer\getRoot(), ilTemplate\parseCurrentBlock(), 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($this->getRoot());
 
         $title = $nd["title"];
 
         $tpl->setVariable("ICON_IMAGE", $path);
         $tpl->setVariable("TXT_ALT_IMG", $title);
         $tpl->parseCurrentBlock();
 
         if ($formItem = ($this->buildFormItem($a_obj_id, $a_option['type']) !== '')) {
             $tpl->setCurrentBlock('check');
             $tpl->setVariable('OBJ_CHECK', $formItem);
             $tpl->parseCurrentBlock();
         }
 
         $tpl->setVariable('OBJ_TITLE', $this->buildTitle($title, $a_obj_id, ''));
     }

Here is the call graph for this function:

◆ formatObject()

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

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

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

                                                                             : void
     {
         global $DIC;
         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"));
                 $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"));
                 $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("icon_cat.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($a_node_id, $a_option['type']) !== '')) {
             $tpl->setCurrentBlock('check');
             $tpl->setVariable('OBJ_CHECK', $formItem);
             $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:

◆ getPostVar()

ilECSNodeMappingCmsExplorer::getPostVar ( )

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

References $post_var.

                                 : string
     {
         return $this->post_var;
     }

◆ isClickable()

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

no item is clickable

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

Referenced by formatObject().

                                                               : bool
     {
         return false;
     }

Here is the caller graph for this function:

◆ isItemChecked()

ilECSNodeMappingCmsExplorer::isItemChecked ( $a_id )

Definition at line 90 of file class.ilECSNodeMappingCmsExplorer.php.

Referenced by buildFormItem().

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

Here is the caller graph for this function:

◆ removeFormItemForType()

ilECSNodeMappingCmsExplorer::removeFormItemForType ( $type )

Definition at line 80 of file class.ilECSNodeMappingCmsExplorer.php.

References $type.

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

◆ setCheckedItems()

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

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

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

◆ setPostVar()

ilECSNodeMappingCmsExplorer::setPostVar ( $a_post_var )

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

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

◆ setTree()

ilECSNodeMappingCmsExplorer::setTree ( ilECSCmsTree $tree )

Set cms tree.

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

References ilExplorer\$tree.

                                                : void
     {
         $this->tree = $tree;
     }

Field Documentation

◆ $checked_items

array ilECSNodeMappingCmsExplorer::$checked_items = array()

private

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

◆ $form_items

array ilECSNodeMappingCmsExplorer::$form_items = array()

private

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

◆ $mid

int ilECSNodeMappingCmsExplorer::$mid

private

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

◆ $post_var

string ilECSNodeMappingCmsExplorer::$post_var = ''

private

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

Referenced by getPostVar().

◆ $server_id

int ilECSNodeMappingCmsExplorer::$server_id

private

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

◆ $tree_id

int ilECSNodeMappingCmsExplorer::$tree_id

private

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

◆ $type

int ilECSNodeMappingCmsExplorer::$type

private

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

Referenced by addFormItemForType(), and removeFormItemForType().

◆ SEL_TYPE_CHECK

const ilECSNodeMappingCmsExplorer::SEL_TYPE_CHECK = 1

Definition at line 27 of file class.ilECSNodeMappingCmsExplorer.php.

◆ SEL_TYPE_RADIO

const ilECSNodeMappingCmsExplorer::SEL_TYPE_RADIO = 2

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

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

Services/WebServices/ECS/classes/Mapping/class.ilECSNodeMappingCmsExplorer.php

Public Member Functions

Data Fields

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFormItemForType()

◆ buildFormItem()

◆ buildTitle()

◆ formatHeader()

◆ formatObject()

◆ getPostVar()

◆ isClickable()

◆ isItemChecked()

◆ removeFormItemForType()

◆ setCheckedItems()

◆ setPostVar()

◆ setTree()

Field Documentation

◆ $checked_items

◆ $form_items

◆ $mid

◆ $post_var

◆ $server_id

◆ $tree_id

◆ $type

◆ SEL_TYPE_CHECK

◆ SEL_TYPE_RADIO