Explorer for ILIAS tree. More...

Inheritance diagram for ilECSNodeMappingLocalExplorer:

Collaboration diagram for ilECSNodeMappingLocalExplorer:

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

	getSid ()

	getMid ()

	isClickable ($a_type, $a_ref_id=0, $a_obj_id=0)
	no item is clickable More...

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

	removeFormItemForType ($type)

	setCheckedItems ($a_checked_items=array())

	getCheckedItems ()

	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 ($tpl, $a_obj_id, $a_option)

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

Public Member Functions inherited from ilExplorer
	__construct ($a_target)
	Constructor public. More...

	setId ($a_val)
	Set id. More...

	getId ()
	Get id. More...

	setAsynchExpanding ($a_val)
	Set asynch expanding. More...

	getAsynchExpanding ()
	Get asynch expanding. More...

	initItemCounter ($a_number)
	Init item counter. More...

	setTitle ($a_val)
	Set title. More...

	setTitleLength ($a_length)
	Set max title length. More...

	getTitleLength ()
	Get max title length. More...

	getTitle ()
	Get title. More...

	setRoot ($a_root_id)
	Set root node. More...

	getRoot ()
	get root id More...

	setOrderColumn ($a_column)
	set the order column public More...

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

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

	setParamsGet ($a_params_get)
	set additional params to be passed in Get-string public More...

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

	setFrameUpdater ($a_up_frame, $a_up_script, $a_params="")
	Set Explorer Updater. More...

	highlightNode ($a_id)
	set highlighted node More...

	checkPermissions ($a_check)
	check permissions via rbac More...

	setSessionExpandVariable ($a_var_name="expand")
	set name of expand session variable More...

	outputIcons ($a_icons)
	output icons More...

	setClickable ($a_type, $a_clickable)
	(de-)activates links for a certain object type More...

	isVisible ($a_ref_id, $a_type)

	setTreeLead ($a_val)
	Set tree leading content. More...

	getTreeLead ()
	Get tree leading content. More...

	isClickable ($a_type, $a_ref_id=0)
	check if links for certain object type are activated More...

	setPostSort ($a_sort)
	process post sorting More...

	setFilterMode ($a_mode=IL_FM_NEGATIVE)
	set filter mode More...

	getFilterMode ()
	get filter mode More...

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

	getUseStandardFrame ()
	Get use standard explorer frame. More...

	getChildsOfNode ($a_parent_id)
	Get childs of node. More...

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

	modifyChilds ($a_parent_id, $a_objects)

	showChilds ($a_parent_id)
	determines wether the childs of an object should be shown or not note: this standard implementation always returns true but it could be overwritten by derived classes (e.g. More...

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

	getMaximumTreeDepth ()
	Get maximum tree depth. More...

	getOutput ()
	Creates output recursive method public. More...

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

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

	formatHeader ($tpl, $a_obj_id, $a_option)
	Creates output for header (is empty here but can be overwritten in derived classes) More...

	formatObject ($tpl, $a_node_id, $a_option, $a_obj_id=0)
	Creates output recursive method private. More...

	getImage ($a_name, $a_type="", $a_obj_id="")
	get image path (may be overwritten by derived classes) More...

	getImageAlt ($a_default_text, $a_type="", $a_obj_id="")
	get image alt text More...

	getNodeStyleClass ($a_id, $a_type)
	get style class for node More...

	buildLinkTarget ($a_node_id, $a_type)
	get link target (may be overwritten by derived classes) More...

	buildOnClick ($a_node_id, $a_type, $a_title)
	get onclick event handling (may be overwritten by derived classes) More...

	buildTitle ($a_title, $a_id, $a_type)
	standard implementation for title, may be overwritten by derived classes More...

	buildDescription ($a_desc, $a_id, $a_type)
	standard implementation for description, may be overwritten by derived classes More...

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

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

	createTarget ($a_type, $a_node_id, $a_highlighted_subtree=false, $a_append_anch=true)
	Creates Get Parameter private. More...

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

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

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

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

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

	delFilter ($a_item)
	removes item from the filter public More...

	setExpand ($a_node_id)
	set the expand option this value is stored in a SESSION variable to save it different view (lo view, frm view,...) private More...

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

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

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

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

Data Fields
const	SEL_TYPE_CHECK = 1

const	SEL_TYPE_RADIO = 2

Data Fields inherited from ilExplorer
	$id

	$output

	$format_options

	$tree

	$target

	$target_get

	$params_get

	$expanded

	$order_column

	$order_direction = "asc"

	$expand_target

	$rbac_check

	$output_icons

	$expand_variable

	$is_clickable

	$post_sort

	$filtered = false

	$filter_mode

	$expand_all = false

	$root_id = null

	$use_standard_frame = false

Protected Member Functions
	initMappings ()
	Init (read) current mappings. More...

	isMapped ($a_ref_id)

	hasParentMapping ($a_ref_id)

Private Attributes
	$checked_items = array()

	$post_var = ''

	$form_items = array()

	$type = 0

	$sid = 0

	$mid = 0

	$mappings = array()

Additional Inherited Members
Protected Attributes inherited from ilExplorer
	$obj_definition

	$error

	$rbacsystem

	$tpl

	$lng

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 $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References ilExplorer\$tree, ilExplorer\addFilter(), addFormItemForType(), array, IL_FM_POSITIVE, initMappings(), ilExplorer\setFiltered(), ilExplorer\setFilterMode(), ilExplorer\setOrderColumn(), and ilExplorer\setRoot().

     {
         global $tree;
         
         parent::__construct($a_target);
         
         $this->sid = $a_sid;
         $this->mid = $a_mid;
 
         $this->type = self::SEL_TYPE_RADIO;
         
         $this->tree = $tree;
         $this->setRoot($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.

Parameters

<type> $type

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

References $type.

Referenced by __construct().

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

Here is the caller graph for this function:

◆ buildFormItem()

ilECSNodeMappingLocalExplorer::buildFormItem	(	$a_node_id,
		$a_type
	)

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

References $a_type, ilUtil\formCheckbox(), ilUtil\formRadioButton(), and isItemChecked().

Referenced by formatHeader(), and formatObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTitle()

ilECSNodeMappingLocalExplorer::buildTitle	(	$title,
		$a_obj_id,
		$a_type
	)

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

Parameters

type	$title
type	$a_obj_id
type	$a_type

Returns: type

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

References $title, hasParentMapping(), and isMapped().

Referenced by formatObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ formatHeader()

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

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

References ilExplorer\$lng, $nd, $path, $title, ilExplorer\$tpl, ilExplorer\$tree, ilObject\_getIcon(), buildFormItem(), and isMapped().

     {
         global $lng, $ilias, $tree;
 
         // custom icons
         $path = ilObject::_getIcon($a_obj_id, "tiny", "root");
 
 
         $tpl->setCurrentBlock("icon");
         $nd = $tree->getNodeData(ROOT_FOLDER_ID);
         $title = $nd["title"];
         if ($title == "ILIAS") {
             $title = $lng->txt("repository");
         }
 
         $tpl->setVariable("ICON_IMAGE", $path);
         $tpl->setVariable("TXT_ALT_IMG", $title);
         $tpl->parseCurrentBlock();
 
         if (strlen($formItem = $this->buildFormItem($a_obj_id, $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	(	$tpl,
		$a_node_id,
		$a_option,
		$a_obj_id = `0`
	)

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

References ilExplorer\$lng, ilExplorer\$target, ilExplorer\$tpl, ilExplorer\buildDescription(), buildFormItem(), ilExplorer\buildFrameTarget(), ilExplorer\buildLinkTarget(), ilExplorer\buildOnClick(), buildTitle(), ilExplorer\createTarget(), ilExplorer\getImage(), ilExplorer\getNodeStyleClass(), isClickable(), and ilUtil\shortenText().

     {
         global $lng;
 
         if (!isset($a_node_id) or !is_array($a_option)) {
             $this->ilias->raiseError(get_class($this) . "::formatObject(): Missing parameter or wrong datatype! " .
                                     "node_id: " . $a_node_id . " options:" . var_dump($a_option), $this->ilias->error_obj->WARNING);
         }
 
         $pic = false;
         foreach ($a_option["tab"] as $picture) {
             if ($picture == 'plus') {
                 $tpl->setCurrentBlock("expander");
                 $tpl->setVariable("EXP_DESC", $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", $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_" . $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", $lng->txt($a_option["desc"]));
             $tpl->parseCurrentBlock();
         }
 
         if (strlen($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, $a_obj_id)) {     // output link
             $tpl->setCurrentBlock("link");
             //$target = (strpos($this->target, "?") === false) ?
             //  $this->target."?" : $this->target."&";
             //$tpl->setVariable("LINK_TARGET", $target.$this->target_get."=".$a_node_id.$this->params_get);
             $tpl->setVariable("LINK_TARGET", $this->buildLinkTarget($a_node_id, $a_option["type"]));
 
             $style_class = $this->getNodeStyleClass($a_node_id, $a_option["type"]);
 
             if ($style_class != "") {
                 $tpl->setVariable("A_CLASS", ' class="' . $style_class . '" ');
             }
 
             if (($onclick = $this->buildOnClick($a_node_id, $a_option["type"], $a_option["title"])) != "") {
                 $tpl->setVariable("ONCLICK", "onClick=\"$onclick\"");
             }
 
             $tpl->setVariable("LINK_NAME", $a_node_id);
             $tpl->setVariable(
                 "TITLE",
                 $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"])
             );
             $tpl->setVariable("DESC", ilUtil::shortenText(
                 $this->buildDescription($a_option["description"], $a_node_id, $a_option["type"]),
                 $this->textwidth,
                 true
             ));
             $frame_target = $this->buildFrameTarget($a_option["type"], $a_node_id, $a_option["obj_id"]);
             if ($frame_target != "") {
                 $tpl->setVariable("TARGET", " target=\"" . $frame_target . "\"");
             }
             $tpl->parseCurrentBlock();
         } else {                        // output text only
             $tpl->setCurrentBlock("text");
             $tpl->setVariable(
                 "OBJ_TITLE",
                 $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"])
             );
             $tpl->setVariable("OBJ_DESC", ilUtil::shortenText(
                 $this->buildDescription($a_option["desc"], $a_node_id, $a_option["type"]),
                 $this->textwidth,
                 true
             ));
             $tpl->parseCurrentBlock();
         }
 
         $tpl->setCurrentBlock("list_item");
         $tpl->parseCurrentBlock();
         $tpl->touchBlock("element");
     }

Here is the call graph for this function:

◆ getCheckedItems()

ilECSNodeMappingLocalExplorer::getCheckedItems ( )

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

References $checked_items, and array.

     {
         return (array) $this->checked_items;
     }

◆ getMid()

ilECSNodeMappingLocalExplorer::getMid ( )

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

References $mid.

Referenced by initMappings().

     {
         return $this->mid;
     }

Here is the caller graph for this function:

◆ getPostVar()

ilECSNodeMappingLocalExplorer::getPostVar ( )

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

References $post_var.

     {
         return $this->post_var;
     }

◆ getSid()

ilECSNodeMappingLocalExplorer::getSid ( )

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

References $sid.

Referenced by initMappings().

     {
         return $this->sid;
     }

Here is the caller graph for this function:

◆ hasParentMapping()

ilECSNodeMappingLocalExplorer::hasParentMapping ( $a_ref_id )

protected

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

Referenced by buildTitle().

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

Here is the caller graph for this function:

◆ initMappings()

ilECSNodeMappingLocalExplorer::initMappings ( )

protected

Init (read) current mappings.

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

References $GLOBALS, $mappings, array, getMid(), ilECSCourseMappingRule\getRuleRefIds(), and getSid().

Referenced by __construct().

     {
         include_once './Services/WebServices/ECS/classes/Course/class.ilECSCourseMappingRule.php';
         $mappings = array();
         foreach (ilECSCourseMappingRule::getRuleRefIds($this->getSid(), $this->getMid()) as $ref_id) {
             $mappings[$ref_id] = array();
         }
         
         foreach ($mappings as $ref_id => $tmp) {
             $this->mappings[$ref_id] = $GLOBALS['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	(	$a_type,
		$a_ref_id = `0`,
		$a_obj_id = `0`
	)

no item is clickable

Parameters

<type>	$a_type
<type>	$a_ref_id
<type>	$a_obj_id

Returns: <type>

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

Referenced by formatObject().

     {
         return false;
     }

Here is the caller graph for this function:

◆ isItemChecked()

ilECSNodeMappingLocalExplorer::isItemChecked ( $a_id )

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

Referenced by buildFormItem().

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

Here is the caller graph for this function:

◆ isMapped()

ilECSNodeMappingLocalExplorer::isMapped ( $a_ref_id )

protected

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

Referenced by buildTitle(), and formatHeader().

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

Here is the caller graph for this function:

◆ removeFormItemForType()

ilECSNodeMappingLocalExplorer::removeFormItemForType ( $type )

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

References $type.

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

◆ setCheckedItems()

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

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

     {
         $this->checked_items = $a_checked_items;
     }

◆ setPostVar()

ilECSNodeMappingLocalExplorer::setPostVar ( $a_post_var )

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

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

     {
         $this->post_var = $a_post_var;
     }

Here is the caller graph for this function:

Field Documentation

◆ $checked_items

ilECSNodeMappingLocalExplorer::$checked_items = array()

private

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

Referenced by getCheckedItems().

◆ $form_items

ilECSNodeMappingLocalExplorer::$form_items = array()

private

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

◆ $mappings

ilECSNodeMappingLocalExplorer::$mappings = array()

private

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

Referenced by initMappings().

◆ $mid

ilECSNodeMappingLocalExplorer::$mid = 0

private

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

Referenced by getMid().

◆ $post_var

ilECSNodeMappingLocalExplorer::$post_var = ''

private

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

Referenced by getPostVar().

◆ $sid

ilECSNodeMappingLocalExplorer::$sid = 0

private

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

Referenced by getSid().

◆ $type

ilECSNodeMappingLocalExplorer::$type = 0

private

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

Referenced by addFormItemForType(), and removeFormItemForType().

◆ SEL_TYPE_CHECK

const ilECSNodeMappingLocalExplorer::SEL_TYPE_CHECK = 1

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

◆ SEL_TYPE_RADIO

const ilECSNodeMappingLocalExplorer::SEL_TYPE_RADIO = 2

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

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

Services/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