ilECSNodeMappingCmsExplorer Class Reference

Explorer for ILIAS tree. More...

Inheritance diagram for ilECSNodeMappingCmsExplorer:

Collaboration diagram for ilECSNodeMappingCmsExplorer:

Public Member Functions
	__construct ($a_target, $a_server_id, $a_mid, $a_tree_id)
	setTree (ilECSCmsTree $tree)
	Set cms tree. More...
	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())
	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)
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

Private Attributes
	$server_id
	$mid
	$tree_id
	$checked_items = array()
	$post_var = ''
	$form_items = array()
	$type = 0

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.ilECSNodeMappingCmsExplorer.php.

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, ilExplorer\$tree, addFormItemForType(), ilExplorer\setOrderColumn(), and ilExplorer\setTitleLength().

    {
        global $DIC;

        $tree = $DIC['tree'];
        
        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.

Parameters

<type>

$type

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

References $type.

Referenced by __construct().

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

Here is the caller graph for this function:

buildFormItem()

ilECSNodeMappingCmsExplorer::buildFormItem	(		$a_node_id,
			$a_type
	)

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

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

Referenced by formatHeader(), and formatObject().

    {
        if (!array_key_exists($a_type, $this->form_items) || !$this->form_items[$a_type]) {
            return '';
        }
        
        include_once './Services/WebServices/ECS/classes/Tree/class.ilECSCmsData.php';
        $status = ilECSCmsData::lookupStatusByObjId(
            $this->server_id,
            $this->mid,
            $this->tree_id,
            $a_node_id
        );
        
        if ($status == ilECSCmsData::MAPPING_DELETED) {
            return ilUtil::formCheckbox((int) $this->isItemChecked($a_node_id), $this->post_var, $a_node_id, true);
        }
        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);
                break;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildTitle()

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

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

References $title, 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().

    {
        if (strlen($title) >= 22) {
            #$title = substr($title, 0,22).'...';
        }
        
        include_once './Services/WebServices/ECS/classes/Tree/class.ilECSCmsData.php';
        $status = ilECSCmsData::lookupStatusByObjId(
            $this->server_id,
            $this->mid,
            $this->tree_id,
            $a_obj_id
        );
        
        

        switch ($status) {
            case ilECSCmsData::MAPPING_UNMAPPED:
                return '<font style="font-weight: bold">' . $title . '</font>';

            case ilECSCmsData::MAPPING_PENDING_DISCONNECTABLE:
                return '<font style="font-weight: bold;font-style: italic">' . $title . '</font>';

            case ilECSCmsData::MAPPING_PENDING_NOT_DISCONNECTABLE:
                return '<font style="font-style: italic">' . $title . '</font>';

            case ilECSCmsData::MAPPING_MAPPED:
                return $title;

            case ilECSCmsData::MAPPING_DELETED:
                return '<font class="warning">' . $title . '</font>';

            default:
                return $title;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

formatHeader()

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

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

References $DIC, ilExplorer\$lng, $nd, $path, $title, ilExplorer\$tpl, buildFormItem(), buildTitle(), and ilExplorer\getRoot().

    {
        global $DIC;

        $lng = $DIC['lng'];
        $ilias = $DIC['ilias'];

        // custom icons
        $path = ilObject::_getIcon($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 (strlen($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 128 of file class.ilECSNodeMappingCmsExplorer.php.

References $DIC, 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 $DIC;

        $lng = $DIC['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_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", $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", ilUtil::shortenText(
                $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"]),
                $this->textwidth,
                true
            ));
            $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", ilUtil::shortenText(
                $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"]),
                $this->textwidth,
                true
            ));
            $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:

getPostVar()

ilECSNodeMappingCmsExplorer::getPostVar

(

)

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

References $post_var.

    {
        return $this->post_var;
    }

isClickable()

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

Referenced by formatObject().

    {
        return false;
    }

Here is the caller graph for this function:

isItemChecked()

ilECSNodeMappingCmsExplorer::isItemChecked

(

$a_id

)

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

Referenced by buildFormItem().

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

Here is the caller graph for this function:

removeFormItemForType()

ilECSNodeMappingCmsExplorer::removeFormItemForType

(

$type

)

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

References $type.

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

setCheckedItems()

ilECSNodeMappingCmsExplorer::setCheckedItems

(

$a_checked_items = array()

)

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

    {
        $this->checked_items = $a_checked_items;
    }

setPostVar()

ilECSNodeMappingCmsExplorer::setPostVar

(

$a_post_var

)

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

    {
        $this->post_var = $a_post_var;
    }

setTree()

ilECSNodeMappingCmsExplorer::setTree

(

ilECSCmsTree

$tree

)

Set cms tree.

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

References ilExplorer\$tree.

    {
        $this->tree = $tree;
    }

Field Documentation

$checked_items

ilECSNodeMappingCmsExplorer::$checked_items = array()

private

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

$form_items

ilECSNodeMappingCmsExplorer::$form_items = array()

private

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

$mid

ilECSNodeMappingCmsExplorer::$mid

private

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

$post_var

ilECSNodeMappingCmsExplorer::$post_var = ''

private

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

Referenced by getPostVar().

$server_id

ilECSNodeMappingCmsExplorer::$server_id

private

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

$tree_id

ilECSNodeMappingCmsExplorer::$tree_id

private

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

$type

ilECSNodeMappingCmsExplorer::$type = 0

private

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

Referenced by addFormItemForType(), and removeFormItemForType().

SEL_TYPE_CHECK

const ilECSNodeMappingCmsExplorer::SEL_TYPE_CHECK = 1

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

SEL_TYPE_RADIO

const ilECSNodeMappingCmsExplorer::SEL_TYPE_RADIO = 2

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

---

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

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