Class ilExplorer class for explorer view in admin frame. More...

Inheritance diagram for ilExplorer:

Collaboration diagram for ilExplorer:

Public Member Functions
	ilExplorer ($a_target)
	Constructor public.
	initItemCounter ($a_number)
	Init item counter.
	setTitle ($a_val)
	Set title.
	setTitleLength ($a_length)
	Set max title length.
	getTitleLength ()
	Get max title length.
	getTitle ()
	Get title.
	setRoot ($a_root_id)
	Set root node.
	getRoot ()
	get root id
	setOrderColumn ($a_column)
	set the order column public
	setOrderDirection ($a_direction)
	set the order direction public
	setTargetGet ($a_target_get)
	set the varname in Get-string public
	setParamsGet ($a_params_get)
	set additional params to be passed in Get-string public
	setExpandTarget ($a_exp_target)
	target script for expand icons
	setFrameUpdater ($a_up_frame, $a_up_script, $a_params="")
	Set Explorer Updater.
	highlightNode ($a_id)
	set highlighted node
	checkPermissions ($a_check)
	check permissions via rbac
	setSessionExpandVariable ($a_var_name="expand")
	set name of expand session variable
	outputIcons ($a_icons)
	output icons
	setClickable ($a_type, $a_clickable)
	(de-)activates links for a certain object type
	isVisible ($a_ref_id, $a_type)
	setTreeLead ($a_val)
	Set tree leading content.
	getTreeLead ()
	Get tree leading content.
	isClickable ($a_type, $a_ref_id=0)
	check if links for certain object type are activated
	setPostSort ($a_sort)
	process post sorting
	setFilterMode ($a_mode=IL_FM_NEGATIVE)
	set filter mode
	getFilterMode ()
	get filter mode
	setUseStandardFrame ($a_val)
	Set use standard frame.
	getUseStandardFrame ()
	Get use standard explorer frame.
	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.
	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.
	forceExpanded ($a_obj_id)
	force expansion of node
	getOutput ()
	Creates output recursive method public.
	handleListEndTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list end tags ( and )
	handleListStartTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list start tags (
	formatHeader (&$tpl, $a_obj_id, $a_option)
	Creates output for header (is empty here but can be overwritten in derived classes)
	formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
	Creates output recursive method private.
	getImage ($a_name, $a_type="", $a_obj_id="")
	get image path (may be overwritten by derived classes)
	getImageAlt ($a_default_text, $a_type="", $a_obj_id="")
	get image alt text
	getNodeStyleClass ($a_id, $a_type)
	get style class for node
	buildLinkTarget ($a_node_id, $a_type)
	get link target (may be overwritten by derived classes)
	buildOnClick ($a_node_id, $a_type, $a_title)
	get onclick event handling (may be overwritten by derived classes)
	buildTitle ($a_title, $a_id, $a_type)
	standard implementation for title, may be overwritten by derived classes
	buildDescription ($a_desc, $a_id, $a_type)
	standard implementation for description, may be overwritten by derived classes
	buildSelect ($a_node_id, $a_type)
	standard implementation for adding an option select box between image and title
	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	get frame target (may be overwritten by derived classes)
	createTarget ($a_type, $a_node_id, $a_highlighted_subtree=false)
	Creates Get Parameter private.
	setFrameTarget ($a_target)
	set target frame or not frame?
	createLines ($a_depth)
	Creates lines for explorer view private.
	is_in_array ($a_start, $a_depth)
	DESCRIPTION MISSING private.
	getIndex ($a_data)
	get index of format_options array from specific ref_id,parent_id private
	addFilter ($a_item)
	adds item to the filter public
	delFilter ($a_item)
	removes item from the filter public
	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
	forceExpandAll ($a_mode, $a_show_minus=true)
	force expandAll.
	setFiltered ($a_bool)
	active/deactivate the filter public
	checkFilter ($a_item)
	check if item is in filter private
	sortNodes ($a_nodes, $a_parent_obj_id)
	sort nodes and put adm object to the end of sorted array private

Data Fields
	$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

Class ilExplorer class for explorer view in admin frame.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

Id:: class.ilExplorer.php 39655 2013-02-03 16:27:08Z akill

Definition at line 16 of file class.ilExplorer.php.

Member Function Documentation

ilExplorer::addFilter ( $a_item )

adds item to the filter public

Parameters

string object type to add

Returns: boolean

Definition at line 1269 of file class.ilExplorer.php.

Referenced by ilForumMoveTopicsExplorer\__construct(), ilPasteIntoMultipleItemsExplorer\__construct(), ilContainerSelectionExplorer\__construct(), ilConditionSelector\ilConditionSelector(), ilExplorer(), ilLMMenuObjectSelector\ilLMMenuObjectSelector(), ilMaterialExplorer\ilMaterialExplorer(), ilPaymentObjectSelector\ilPaymentObjectSelector(), ilRepositoryCopySelector\ilRepositoryCopySelector(), ilRepositoryExplorer\ilRepositoryExplorer(), ilRepositoryLinkSelector\ilRepositoryLinkSelector(), ilRoleDesktopItemSelector\ilRoleDesktopItemSelector(), ilSearchRootSelector\ilSearchRootSelector(), ilSolutionExplorer\ilSolutionExplorer(), and ilTableOfContentsExplorer\ilTableOfContentsExplorer().

        {
                $ispresent = 0;
                if (is_array($this->filter))
                {
                        //run through filter
                    foreach ($this->filter as $item)
                        {
                                if ($item == $a_item)
                                {
                                    $is_present = 1;
                                        return false;
                                }
                        }
                }
                else
                {
                        $this->filter = array();
                }
                if ($is_present == 0)
                {
                        $this->filter[] = $a_item;
                }
                return true;
        }

Here is the caller graph for this function:

ilExplorer::buildDescription	(	$a_desc,
		$a_id,
		$a_type
	)

standard implementation for description, may be overwritten by derived classes

Reimplemented in ilBookmarkExplorer, and ilIntLinkRepItemExplorer.

Definition at line 1110 of file class.ilExplorer.php.

Referenced by ilPasteIntoMultipleItemsExplorer\formatObject(), ilForumMoveTopicsExplorer\formatObject(), and formatObject().

        {
                return "";
        }

Here is the caller graph for this function:

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

get frame target (may be overwritten by derived classes)

Reimplemented in ilBookmarkExplorer, ilRepositoryExplorer, ilTableOfContentsExplorer, ilSearchRootSelector, ilAdministrationExplorer, ilMaterialExplorer, ilSolutionExplorer, ilRepositoryCopySelector, ilRepositoryLinkSelector, ilConditionSelector, ilIntLinkRepItemExplorer, ilLMMenuObjectSelector, ilPaymentObjectSelector, ilRoleDesktopItemSelector, ilObjectSelector, and ilShopPublicSectionSelector.

Definition at line 1127 of file class.ilExplorer.php.

Referenced by ilHACPExplorer\formatObject(), ilAICCExplorer\formatObject(), ilSCORMExplorer\formatObject(), and formatObject().

        {
                return $this->frame_target;
        }

Here is the caller graph for this function:

ilExplorer::buildLinkTarget	(	$a_node_id,
		$a_type
	)

get link target (may be overwritten by derived classes)

Reimplemented in ilBookmarkExplorer, ilTableOfContentsExplorer, ilLMTOCExplorer, ilScorm2004EditorExplorer, ilLMEditorExplorer, ilSearchRootSelector, ilMaterialExplorer, ilSolutionExplorer, ilRepositoryCopySelector, ilRepositoryLinkSelector, ilAdministrationExplorer, ilRepositoryExplorer, ilLMMenuObjectSelector, ilStyleScopeExplorer, ilConditionSelector, ilIntLinkRepItemExplorer, ilShopPublicSectionSelector, ilPoolSelectorGUI, ilRoleDesktopItemSelector, ilPaymentObjectSelector, ilObjectSelector, ilFileSelectorGUI, and ilGlossarySelectorGUI.

Definition at line 1083 of file class.ilExplorer.php.

References $target.

Referenced by ilLMExplorer\formatHeader(), ilHACPExplorer\formatObject(), ilAICCExplorer\formatObject(), and formatObject().

        {
                $target = (strpos($this->target, "?") === false)
                        ? $this->target."?"
                        : $this->target."&";
                return $target.$this->target_get."=".$a_node_id.$this->params_get;
        }

Here is the caller graph for this function:

ilExplorer::buildOnClick	(	$a_node_id,
		$a_type,
		$a_title
	)

get onclick event handling (may be overwritten by derived classes)

Reimplemented in ilIntLinkRepItemExplorer.

Definition at line 1094 of file class.ilExplorer.php.

Referenced by ilPasteIntoMultipleItemsExplorer\formatObject(), ilForumMoveTopicsExplorer\formatObject(), and formatObject().

        {
                return "";
        }

Here is the caller graph for this function:

ilExplorer::buildSelect	(	$a_node_id,
		$a_type
	)

standard implementation for adding an option select box between image and title

Reimplemented in ilCopyWizardExplorer.

Definition at line 1118 of file class.ilExplorer.php.

Referenced by formatObject().

        {
                return "";
        }

Here is the caller graph for this function:

ilExplorer::buildTitle	(	$a_title,
		$a_id,
		$a_type
	)

standard implementation for title, may be overwritten by derived classes

Reimplemented in ilIntLinkRepItemExplorer, ilTableOfContentsExplorer, ilLMEditorExplorer, and ilLMTOCExplorer.

Definition at line 1102 of file class.ilExplorer.php.

Referenced by ilPasteIntoMultipleItemsExplorer\formatObject(), ilForumMoveTopicsExplorer\formatObject(), and formatObject().

        {
                return $a_title;
        }

Here is the caller graph for this function:

ilExplorer::checkFilter ( $a_item )

check if item is in filter private

Parameters

string

Returns: integer

Definition at line 1398 of file class.ilExplorer.php.

References $ret, getFilterMode(), and IL_FM_NEGATIVE.

Referenced by ilSCORMExplorer\setOutput(), and setOutput().

        {
                if (is_array($this->filter))
                {
                        if (in_array($a_item, $this->filter))
                        {
                                $ret = true;
                        }
                        else
                        {
                                $ret = false;
                        }
                }
                else
                {
                        $ret = false;
                }
                if ($this->getFilterMode() == IL_FM_NEGATIVE )
                {
                        return $ret;
                }
                else
                {
                        return !$ret;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilExplorer::checkPermissions ( $a_check )

check permissions via rbac

Parameters

boolean $a_check check true/false

Definition at line 388 of file class.ilExplorer.php.

Referenced by ilAICCExplorer\ilAICCExplorer(), ilHACPExplorer\ilHACPExplorer(), ilLMExplorer\ilLMExplorer(), ilMediaPoolExplorer\ilMediaPoolExplorer(), ilScorm2004EditorExplorer\ilScorm2004EditorExplorer(), and ilSCORMExplorer\ilSCORMExplorer().

        {
                $this->rbac_check = $a_check;
        }

Here is the caller graph for this function:

ilExplorer::createLines ( $a_depth )

Creates lines for explorer view private.

Parameters

integer

Definition at line 1180 of file class.ilExplorer.php.

References is_in_array().

Referenced by ilMailExplorer\getOutput(), ilPublicSectionSelector\getOutput(), ilShopPublicSectionSelector\getOutput(), ilForumExplorer\getOutput(), ilSCORMExplorer\getOutput(), and getOutput().

        {
                for ($i = 0; $i < count($this->format_options); ++$i)
                {
                        if ($this->format_options[$i]["depth"] == $a_depth+1
                           and !$this->format_options[$i]["container"]
                                and $this->format_options[$i]["depth"] != 1)
                        {
                                $this->format_options[$i]["tab"]["$a_depth"] = "quer";
                        }
                        if ($this->format_options[$i]["depth"] == $a_depth+2)
                        {
                                if ($this->is_in_array($i+1,$this->format_options[$i]["depth"]))
                                {
                                        $this->format_options[$i]["tab"]["$a_depth"] = "winkel";
                                }
                                else
                                {
                                        $this->format_options[$i]["tab"]["$a_depth"] = "ecke";
                                }
                        }
                        if ($this->format_options[$i]["depth"] > $a_depth+2)
                        {
                                if ($this->is_in_array($i+1,$a_depth+2))
                                {
                                        $this->format_options[$i]["tab"]["$a_depth"] = "hoch";
                                }
                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilExplorer::createTarget	(	$a_type,
		$a_node_id,
		$a_highlighted_subtree = `false`
	)

Creates Get Parameter private.

Parameters

string
integer

Returns: string

Definition at line 1140 of file class.ilExplorer.php.

Referenced by ilPasteIntoMultipleItemsExplorer\formatObject(), ilForumMoveTopicsExplorer\formatObject(), and formatObject().

        {
                if (!isset($a_type) or !is_string($a_type) or !isset($a_node_id))
                {
                        $this->ilias->raiseError(get_class($this)."::createTarget(): Missing parameter or wrong datatype! ".
                                                                        "type: ".$a_type." node_id:".$a_node_id,$this->ilias->error_obj->WARNING);
                }
                // SET expand parameter:
                //     positive if object is expanded
                //     negative if object is compressed
                $a_node_id = $a_type == '+' ? $a_node_id : -(int) $a_node_id;
                $sep = (is_int(strpos($this->expand_target, "?")))
                        ? "&"
                        : "?";
                
                // in current tree flag
                $ict_str = ($a_highlighted_subtree || $this->highlighted == "")
                        ? "&ict=1"
                        : "";
                return $this->expand_target.$sep.$this->expand_variable."=".$a_node_id.$this->params_get.$ict_str."#".abs($a_node_id);
        }

Here is the caller graph for this function:

ilExplorer::delFilter ( $a_item )

removes item from the filter public

Parameters

string object type to remove

Returns: boolean

Definition at line 1304 of file class.ilExplorer.php.

        {
                //check if a filter exists
                if (is_array($this->filter))
                {
                        //build copy of the existing filter without the given item
                        $tmp = array();
                        foreach ($this->filter as $item)
                    {
                                if ($item != $a_item)
                                {
                                    $tmp[] = $item;
                                }
                                else
                                {
                                        $deleted = 1;
                                }
                        }
                        $this->filter = $tmp;
                }
                else
                {
                        return false;
                }
                if ($deleted == 1)
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

ilExplorer::forceExpandAll	(	$a_mode,
		$a_show_minus = `true`
	)

force expandAll.

if true all nodes are expanded regardless of the values in $expanded (default: false) public

Parameters

boolean

Definition at line 1374 of file class.ilExplorer.php.

Referenced by ilPublicSectionSelector\ilPublicSectionSelector().

        {
                $this->expand_all = (bool) $a_mode;
                $this->show_minus = $a_show_minus;
        }

Here is the caller graph for this function:

ilExplorer::forceExpanded ( $a_obj_id )

force expansion of node

Reimplemented in ilRepositoryExplorer, ilTableOfContentsExplorer, ilAdministrationExplorer, ilLMEditorExplorer, ilLMTOCExplorer, ilMaterialExplorer, ilScorm2004EditorExplorer, ilPoolSelectorGUI, and ilFileSelectorGUI.

Definition at line 716 of file class.ilExplorer.php.

Referenced by setOutput().

        {
                return false;
        }

Here is the caller graph for this function:

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

Creates output for header (is empty here but can be overwritten in derived classes)

public

Parameters

integer	obj_id
integer	array options

Reimplemented in ilRepositoryExplorer, ilForumMoveTopicsExplorer, ilPasteIntoMultipleItemsExplorer, ilIntLinkRepItemExplorer, ilPoolSelectorGUI, ilFileSelectorGUI, ilGlossarySelectorGUI, ilScorm2004EditorExplorer, ilLMEditorExplorer, ilLMExplorer, ilStyleScopeExplorer, ilMediaPoolExplorer, and ilAdministrationExplorer.

Definition at line 900 of file class.ilExplorer.php.

Referenced by getOutput().

{

}

Here is the caller graph for this function:

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

Creates output recursive method private.

Parameters

integer
array

Returns: string

Reimplemented in ilForumExplorer, ilPublicSectionSelector, ilForumMoveTopicsExplorer, ilPasteIntoMultipleItemsExplorer, and ilScorm2004EditorExplorer.

Definition at line 912 of file class.ilExplorer.php.

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

Referenced by ilMailExplorer\getOutput(), ilShopPublicSectionSelector\getOutput(), and getOutput().

        {
                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 ((array) $a_option["tab"] as $picture)
                {
                        if ($picture == 'plus')
                        {
                                $tpl->setCurrentBlock("exp_desc");
                                $tpl->setVariable("EXP_DESC", $lng->txt("collapsed"));
                                $tpl->parseCurrentBlock();
                                $target = $this->createTarget('+',$a_node_id, $a_option["highlighted_subtree"]);
                                $tpl->setCurrentBlock("expander");
                                $tpl->setVariable("LINK_NAME", $a_node_id);
                                $tpl->setVariable("LINK_TARGET_EXPANDER", $target);
                                $tpl->setVariable("IMGPATH", $this->getImage("browser/plus.gif"));
                                $tpl->parseCurrentBlock();
                                $pic = true;
                        }
                        if ($picture == 'forceexp')
                        {
                                $tpl->setCurrentBlock("exp_desc");
                                $tpl->setVariable("EXP_DESC", $lng->txt("expanded"));
                                $tpl->parseCurrentBlock();
                                $target = $this->createTarget('+',$a_node_id);
                                $tpl->setCurrentBlock("expander");
                                $tpl->setVariable("LINK_NAME", $a_node_id);
                                $tpl->setVariable("LINK_TARGET_EXPANDER", $target);
                                $tpl->setVariable("IMGPATH", $this->getImage("browser/forceexp.gif"));
                                $tpl->parseCurrentBlock();
                                $pic = true;
                        }
                        if ($picture == 'minus' && $this->show_minus)
                        {
                                $tpl->setCurrentBlock("exp_desc");
                                $tpl->setVariable("EXP_DESC", $lng->txt("expanded"));
                                $tpl->parseCurrentBlock();
                                $target = $this->createTarget('-',$a_node_id, $a_option["highlighted_subtree"]);
                                $tpl->setCurrentBlock("expander");
                                $tpl->setVariable("LINK_NAME", $a_node_id);
                                $tpl->setVariable("LINK_TARGET_EXPANDER", $target);
                                $tpl->setVariable("IMGPATH", $this->getImage("browser/minus.gif"));
                                $tpl->parseCurrentBlock();
                                $pic = true;
                        }
                        /*
                        if ($picture == 'blank' or $picture == 'winkel'
                           or $picture == 'hoch' or $picture == 'quer' or $picture == 'ecke')
                        {
                                $picture = "blank";
                                $tpl->setCurrentBlock("lines");
                                $tpl->setVariable("IMGPATH_LINES", $this->getImage("browser/".$picture.".gif"));
                                $tpl->parseCurrentBlock();
                        }
                        */
                }
                
                if (!$pic)
                {
                        $tpl->setCurrentBlock("blank");
                        $tpl->setVariable("BLANK_PATH", $this->getImage("browser/blank.gif"));
                        $tpl->parseCurrentBlock();
                }
                if ($this->output_icons)
                {
                        $tpl->setCurrentBlock("icon");
                        $tpl->setVariable("ICON_IMAGE" , $this->getImage("icon_".$a_option["type"]."_s.gif", $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->getImageAlt($lng->txt("icon")." ".$lng->txt($a_option["desc"]), $a_option["type"], $a_obj_id));
                        $tpl->parseCurrentBlock();
                }
                
                if(strlen($sel = $this->buildSelect($a_node_id,$a_option['type'])))
                {
                        $tpl->setCurrentBlock('select');
                        $tpl->setVariable('OBJ_SEL',$sel);
                        $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:

Here is the caller graph for this function:

ilExplorer::getFilterMode ( )

get filter mode

Returns: int filter mode IL_FM_NEGATIVE | IL_FM_NEGATIVE

Definition at line 515 of file class.ilExplorer.php.

References $filter_mode.

Referenced by checkFilter().

        {
                return $this->filter_mode;
        }

Here is the caller graph for this function:

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

get image path (may be overwritten by derived classes)

Reimplemented in ilMailExplorer, ilRepositoryExplorer, ilLMEditorExplorer, ilAdministrationExplorer, and ilCopyWizardExplorer.

Definition at line 1055 of file class.ilExplorer.php.

References ilUtil\getImagePath().

Referenced by ilScorm2004EditorExplorer\formatObject(), and formatObject().

        {
                return ilUtil::getImagePath($a_name);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilExplorer::getImageAlt	(	$a_default_text,
		$a_type = `""`,
		$a_obj_id = `""`
	)

get image alt text

Reimplemented in ilBookmarkExplorer, and ilLMEditorExplorer.

Definition at line 1063 of file class.ilExplorer.php.

Referenced by formatObject().

        {
                return $a_default_text;
        }

Here is the caller graph for this function:

ilExplorer::getIndex ( $a_data )

get index of format_options array from specific ref_id,parent_id private

Parameters

array object data

Returns: integer index

Definition at line 1243 of file class.ilExplorer.php.

Referenced by ilForumExplorer\setOutput(), ilBookmarkExplorer\setOutput(), ilSCORMExplorer\setOutput(), ilMailExplorer\setOutput(), and setOutput().

        {
                if(!is_array($this->format_options))
                {
                        return -1;
                }
                
                foreach ($this->format_options as $key => $value)
                {
                        if (($value["child"] == $a_data["parent"]))
                        {
                                return $key;
                        }
                }
                
                return -1;
                // exit on error
                #$this->ilias->raiseError(get_class($this)."::getIndex(): Error in tree. No index found!",$this->ilias->error_obj->FATAL);
        }

Here is the caller graph for this function:

ilExplorer::getNodeStyleClass	(	$a_id,
		$a_type
	)

get style class for node

Definition at line 1071 of file class.ilExplorer.php.

Referenced by ilPasteIntoMultipleItemsExplorer\formatObject(), ilForumMoveTopicsExplorer\formatObject(), and formatObject().

        {
                if ($a_id == $this->highlighted)
                {
                        return "il_HighlightedNode";
                }
                return "";
        }

Here is the caller graph for this function:

ilExplorer::getOutput ( )

Creates output recursive method public.

Returns: string

Reimplemented in ilForumExplorer, ilShopPublicSectionSelector, ilPublicSectionSelector, and ilMailExplorer.

Definition at line 727 of file class.ilExplorer.php.

References $_GET, $_POST, $ilBench, $lng, $tpl, createLines(), formatHeader(), formatObject(), ilUtil\getImagePath(), ilUtil\getStyleSheetLocation(), getTitle(), getUseStandardFrame(), handleListEndTags(), handleListStartTags(), and ilYuiUtil\initConnection().

        {
                global $ilBench, $tpl, $lng;
                $ilBench->start("Explorer", "getOutput");
                $this->format_options[0]["tab"] = array();
                $depth = $this->tree->getMaximumDepth();
                for ($i=0;$i<$depth;++$i)
                {
                        $this->createLines($i);
                }
                include_once("./Services/YUI/classes/class.ilYuiUtil.php");
                ilYuiUtil::initConnection();
                $tpl->addJavaScript("./Services/Explorer/js/ilexplorercallback.js");
                $tpl->addBlockFile("EXPLORER_TOP", "exp_top", "tpl.explorer_top.html");
//echo "hh";
                // set global body class
                $tpl->setBodyClass("il_Explorer");
                
                $tpl_tree = new ilTemplate("tpl.tree.html", true, true);
                
                // updater
                if (($_GET["ict"] || $_POST["collapseAll"] != "" || $_POST["expandAll"] != "") && $this->up_frame != "")
                {
                        $tpl_tree->setCurrentBlock("updater");
                        $tpl_tree->setVariable("UPDATE_FRAME", $this->up_frame);
                        $tpl_tree->setVariable("UPDATE_SCRIPT", $this->up_script);
                        if (is_array($this->up_params))
                        {
                                $up_str = $lim = "";
                                foreach ($this->up_params as $p)
                                {
                                        $up_str.=  $lim."'".$p."'";
                                        $lim = ",";
                                }
                                $tpl_tree->setVariable("UPDATE_PARAMS", $up_str);
                        }
                        $tpl_tree->parseCurrentBlock();
                }
                
                $cur_depth = -1;
                foreach ($this->format_options as $key => $options)
                {
//echo "-".$options["depth"]."-";
                        if (!$options["visible"])
                        {
                                continue;
                        }
                        
                        // end tags
                        $this->handleListEndTags($tpl_tree, $cur_depth, $options["depth"]);
                        
                        // start tags
                        $this->handleListStartTags($tpl_tree, $cur_depth, $options["depth"]);
                        
                        $cur_depth = $options["depth"];
                        
                        if ($options["visible"] and $key != 0)
                        {
                                $this->formatObject($tpl_tree, $options["child"],$options,$options['obj_id']);
                        }
                        if ($key == 0)
                        {
                                $this->formatHeader($tpl_tree, $options["child"],$options);
                        }
                                                
                }
//if ($GLOBALS["ilUser"]->getLogin() == "alex") var_dump($this->format_options);
                $this->handleListEndTags($tpl_tree, $cur_depth, -1);
                
                $ilBench->stop("Explorer", "getOutput");
                $tpl_tree->setVariable("TREE_LEAD", "");
                if ($this->tree_lead != "")
                {
                        $tpl_tree->setCurrentBlock("tree_lead");
                        $tpl_tree->setVariable("TREE_LEAD", $this->tree_lead);
                        $tpl_tree->parseCurrentBlock();
                }
                $html = $tpl_tree->get();
                
                if ($this->getUseStandardFrame())
                {
                        $mtpl = new ilTemplate("tpl.main.html", true, true);
                        $mtpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
                        $mtpl->setVariable("BODY_CLASS", "il_Explorer");
                        $mtpl->addBlockFile("CONTENT", "content", "tpl.explorer.html");
                        if ($this->getTitle() != "")
                        {
                                $mtpl->setVariable("TXT_EXPLORER_HEADER", $this->getTitle());
                        }
                        $mtpl->setVariable("IMG_SPACE", ilUtil::getImagePath("spacer.gif", false));
                        $mtpl->setCurrentBlock("content");
                        $mtpl->setVariable("EXPLORER", $html);
                        $mtpl->setVariable("EXP_REFRESH", $lng->txt("refresh"));
                        $mtpl->parseCurrentBlock();
                        $html = $mtpl->get();
                }
                
                return $html;
        }

Here is the call graph for this function:

ilExplorer::getRoot ( )

get root id

public

Parameters

Definition at line 281 of file class.ilExplorer.php.

References $root_id.

Referenced by setExpand(), and setOutput().

        {
                return $this->root_id == null ?
                        $this->tree->getRootId() :
                        $this->root_id;
        }

Here is the caller graph for this function:

ilExplorer::getTitle ( )

Get title.

Returns: title

Definition at line 256 of file class.ilExplorer.php.

References $title.

Referenced by getOutput().

        {
                return $this->title;
        }

Here is the caller graph for this function:

ilExplorer::getTitleLength ( )

Get max title length.

Returns

Definition at line 246 of file class.ilExplorer.php.

        {
                return $this->textwidth;
        }

ilExplorer::getTreeLead ( )

Get tree leading content.

Returns: string tree leading content

Definition at line 463 of file class.ilExplorer.php.

        {
                return $this->tree_lead;
        }

ilExplorer::getUseStandardFrame ( )

Get use standard explorer frame.

Returns: boolean use standard explorer frame

Definition at line 536 of file class.ilExplorer.php.

References $use_standard_frame.

Referenced by getOutput().

        {
                return $this->use_standard_frame;
        }

Here is the caller graph for this function:

ilExplorer::handleListEndTags	(	&	$a_tpl_tree,
			$a_cur_depth,
			$a_item_depth
	)

handle list end tags ( and )

Definition at line 840 of file class.ilExplorer.php.

Referenced by ilMailExplorer\getOutput(), ilPublicSectionSelector\getOutput(), ilShopPublicSectionSelector\getOutput(), ilForumExplorer\getOutput(), and getOutput().

        {
                if ($a_item_depth < $a_cur_depth)
                {
                        // </li></ul> for ending lists
                        for ($i = 0; $i < ($a_cur_depth - $a_item_depth); $i++)
                        {
                                $a_tpl_tree->touchBlock("end_list_item");
                                $a_tpl_tree->touchBlock("element");
                                $a_tpl_tree->touchBlock("end_list");
                                $a_tpl_tree->touchBlock("element");
                        }
                }
                else if ($a_item_depth == $a_cur_depth)
                {
                        // </li> for ending list items
                        $a_tpl_tree->touchBlock("end_list_item");
                        $a_tpl_tree->touchBlock("element");
                }
        }

Here is the caller graph for this function:

ilExplorer::handleListStartTags	(	&	$a_tpl_tree,
			$a_cur_depth,
			$a_item_depth
	)

handle list start tags (

)

Definition at line 865 of file class.ilExplorer.php.

Referenced by ilMailExplorer\getOutput(), ilPublicSectionSelector\getOutput(), ilShopPublicSectionSelector\getOutput(), ilForumExplorer\getOutput(), and getOutput().

        {
                // start tags
                if ($a_item_depth > $a_cur_depth)
                {
                        // <ul><li> for new lists
                        if ($a_item_depth > 1)
                        {
                                $a_tpl_tree->touchBlock("start_list");
                        }
                        else
                        {
                                $a_tpl_tree->touchBlock("start_list_no_indent");
                        }
                        $a_tpl_tree->touchBlock("element");
                        
                        $a_tpl_tree->touchBlock("start_list_item");
                        $a_tpl_tree->touchBlock("element");
                }
                else
                {
                        // <li> items
                        $a_tpl_tree->touchBlock("start_list_item");
                        $a_tpl_tree->touchBlock("element");
                }
        }

Here is the caller graph for this function:

ilExplorer::highlightNode ( $a_id )

set highlighted node

Definition at line 378 of file class.ilExplorer.php.

        {
                $this->highlighted = $a_id;
        }

ilExplorer::ilExplorer ( $a_target )

Constructor public.

Parameters

string scriptname

Definition at line 166 of file class.ilExplorer.php.

References $ilias, addFilter(), IL_FM_NEGATIVE, setFiltered(), setFilterMode(), and setTitleLength().

Referenced by ilGlossarySelectorGUI\__construct(), ilFileSelectorGUI\__construct(), ilPoolSelectorGUI\__construct(), ilCopyWizardExplorer\__construct(), ilAdministrationExplorer\ilAdministrationExplorer(), ilAICCExplorer\ilAICCExplorer(), ilBookmarkExplorer\ilBookmarkExplorer(), ilConditionSelector\ilConditionSelector(), ilForumExplorer\ilForumExplorer(), ilHACPExplorer\ilHACPExplorer(), ilLMExplorer\ilLMExplorer(), ilIntLinkRepItemExplorer\ilLMMenuObjectSelector(), ilLMMenuObjectSelector\ilLMMenuObjectSelector(), ilMailExplorer\ilMailExplorer(), ilMaterialExplorer\ilMaterialExplorer(), ilMediaPoolExplorer\ilMediaPoolExplorer(), ilObjectSelector\ilObjectSelector(), ilPaymentObjectSelector\ilPaymentObjectSelector(), ilRepositoryCopySelector\ilRepositoryCopySelector(), ilRepositoryExplorer\ilRepositoryExplorer(), ilRepositoryLinkSelector\ilRepositoryLinkSelector(), ilRoleDesktopItemSelector\ilRoleDesktopItemSelector(), ilScorm2004EditorExplorer\ilScorm2004EditorExplorer(), ilSCORMExplorer\ilSCORMExplorer(), ilSearchRootSelector\ilSearchRootSelector(), ilSolutionExplorer\ilSolutionExplorer(), and ilStyleScopeExplorer\ilStyleScopeExplorer().

        {
                global $ilias, $objDefinition;
                if (!isset($a_target) or !is_string($a_target))
                {
                        $this->ilias->raiseError(get_class($this)."::Constructor(): No target given!",$this->ilias->error_obj->WARNING);
                }
                // autofilter object types in devmode
                $devtypes = $objDefinition->getDevModeAll();
                if (count($devtypes > 0))
                {
                        // activate filter if objects found in devmode
                        $this->setFiltered(true);
                        foreach ($devtypes as $type)
                        {
                                $this->addFilter($type);
                        }
                }
                $this->ilias =& $ilias;
                $this->output = array();
                $this->expanded = array();
                $this->target = $a_target;
                $this->target_get = 'ref_id';
                $this->frame_target = "content";
                $this->order_column = "title";
                $this->tree = new ilTree(ROOT_FOLDER_ID);
                $this->tree->initLangCode();
                $this->expand_target = $_SERVER["PATH_INFO"];
                $this->rbac_check = true;
                $this->output_icons = true;
                $this->expand_variable = "expand";
                $this->setTitleLength(50);
                $this->post_sort=true;
                $this->setFilterMode(IL_FM_NEGATIVE);
                $this->highlighted = "";
                $this->show_minus = true;
                $this->counter = 0;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilExplorer::initItemCounter ( $a_number )

Init item counter.

public

Parameters

int number

Definition at line 217 of file class.ilExplorer.php.

Referenced by ilCopyWizardExplorer\__construct().

        {
                $this->counter = $a_number;
        }

Here is the caller graph for this function:

ilExplorer::is_in_array	(	$a_start,
		$a_depth
	)

DESCRIPTION MISSING private.

Parameters

integer
integer

Returns: boolean

Definition at line 1220 of file class.ilExplorer.php.

Referenced by createLines().

        {
                for ($i=$a_start;$i<count($this->format_options);++$i)
                {
                        if ($this->format_options[$i]["depth"] < $a_depth)
                        {
                                break;
                        }
                        if ($this->format_options[$i]["depth"] == $a_depth)
                        {
                                return true;
                        }
                }
                return false;
        }

Here is the caller graph for this function:

ilExplorer::isClickable	(	$a_type,
		$a_ref_id = `0`
	)

check if links for certain object type are activated

Parameters

string $a_type object type

Returns: boolean true if linking is activated

Reimplemented in ilTableOfContentsExplorer, ilAdministrationExplorer, ilScorm2004EditorExplorer, ilMaterialExplorer, ilSolutionExplorer, ilRepositoryCopySelector, ilRepositoryLinkSelector, ilIntLinkRepItemExplorer, ilConditionSelector, ilShopPublicSectionSelector, ilLMMenuObjectSelector, ilLMTOCExplorer, ilContainerSelectionExplorer, ilPaymentObjectSelector, ilSearchRootSelector, ilPoolSelectorGUI, ilLMExplorer, ilRoleDesktopItemSelector, ilObjectSelector, ilAICCExplorer, ilFileSelectorGUI, ilCopyWizardExplorer, and ilGlossarySelectorGUI.

Definition at line 475 of file class.ilExplorer.php.

Referenced by formatObject().

        {
                // in this standard implementation
                // only the type determines, wether an object should be clickable or not
                // but this method can be overwritten and make $exp->setFilterMode(IL_FM_NEGATIVE);use of the ref id
                // (this happens e.g. in class ilRepositoryExplorerGUI)
                if ($this->is_clickable[$a_type] == "n")
                {
                        return false;
                }
                else
                {
                        return true;
                }
        }

Here is the caller graph for this function:

ilExplorer::isVisible	(	$a_ref_id,
		$a_type
	)

Reimplemented in ilRepositoryExplorer, ilTableOfContentsExplorer, ilSCORMExplorer, ilLMTOCExplorer, and ilAdministrationExplorer.

Definition at line 432 of file class.ilExplorer.php.

References $ilBench.

Referenced by setOutput().

        {
                global $rbacsystem, $ilBench;
                
                if (!$this->rbac_check)
                {
                        return true;
                }
                
                $ilBench->start("Explorer", "setOutput_isVisible");
                $visible = $rbacsystem->checkAccess('visible',$a_ref_id);
                $ilBench->stop("Explorer", "setOutput_isVisible");
                return $visible;
        }

Here is the caller graph for this function:

ilExplorer::modifyChilds	(	$a_parent_id,
		$a_objects
	)

Reimplemented in ilAdministrationExplorer.

Definition at line 698 of file class.ilExplorer.php.

Referenced by setOutput().

        {
                return $a_objects;
        }

Here is the caller graph for this function:

ilExplorer::outputIcons ( $a_icons )

output icons

Parameters

boolean $a_icons output icons true/false

Definition at line 408 of file class.ilExplorer.php.

Referenced by ilScorm2004EditorExplorer\formatObject(), ilAICCExplorer\ilAICCExplorer(), ilHACPExplorer\ilHACPExplorer(), and ilSCORMExplorer\ilSCORMExplorer().

        {
                $this->output_icons = $a_icons;
        }

Here is the caller graph for this function:

ilExplorer::setClickable	(	$a_type,
		$a_clickable
	)

(de-)activates links for a certain object type

Parameters

string	$a_type	object type
boolean	$a_clickable	true/false

Definition at line 420 of file class.ilExplorer.php.

        {
                if($a_clickable)
                {
                        $this->is_clickable[$a_type] = "";
                }
                else
                {
                        $this->is_clickable[$a_type] = "n";
                }
        }

ilExplorer::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

Parameters

string pipe-separated integer

Reimplemented in ilForumExplorer, ilMailExplorer, and ilBookmarkExplorer.

Definition at line 1347 of file class.ilExplorer.php.

References $_SESSION, $expand_variable, and getRoot().

Referenced by ilShopPublicSectionSelector\__construct(), assQuestionGUI\outSolutionExplorer(), ilConditionHandlerInterface\selector(), ilSCORMExplorer\setOutput(), ilObjContentObjectGUI\showEntrySelector(), ilPaymentStatisticGUI\showObjectSelector(), ilPaymentObjectGUI\showObjectSelector(), ilObjPaymentSettingsGUI\showObjectSelectorObject(), ilRepositorySelectorInputGUI\showRepositorySelection(), ilSearchGUI\showSelectRoot(), and ilContainerReferenceGUI\showTargetSelectionTreeObject().

        {
                // IF ISN'T SET CREATE SESSION VARIABLE
                if(!is_array($_SESSION[$this->expand_variable]))
                {
                        $_SESSION[$this->expand_variable] = array($this->getRoot());
                }
                // IF $_GET["expand"] is positive => expand this node
                if ($a_node_id > 0 && !in_array($a_node_id,$_SESSION[$this->expand_variable]))
                {
                        array_push($_SESSION[$this->expand_variable],$a_node_id);
                }
                // IF $_GET["expand"] is negative => compress this node
                if ($a_node_id < 0)
                {
                        $key = array_keys($_SESSION[$this->expand_variable],-(int) $a_node_id);
                        unset($_SESSION[$this->expand_variable][$key[0]]);
                }
                $this->expanded = $_SESSION[$this->expand_variable];
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilExplorer::setExpandTarget ( $a_exp_target )

target script for expand icons

Parameters

string $a_exp_target script name of target script(may include parameters) initially set to $_SERVER["PATH_INFO"]

Definition at line 357 of file class.ilExplorer.php.

Referenced by ilShopPublicSectionSelector\__construct(), ilObjForumGUI\moveThreadsObject(), and ilLMPresentationGUI\showTableOfContents().

        {
                $this->expand_target = $a_exp_target;
        }

Here is the caller graph for this function:

ilExplorer::setFiltered ( $a_bool )

active/deactivate the filter public

Parameters

boolean

Returns: boolean

Definition at line 1386 of file class.ilExplorer.php.

Referenced by ilForumMoveTopicsExplorer\__construct(), ilPasteIntoMultipleItemsExplorer\__construct(), ilContainerSelectionExplorer\__construct(), ilConditionSelector\ilConditionSelector(), ilExplorer(), ilMaterialExplorer\ilMaterialExplorer(), ilObjectSelector\ilObjectSelector(), ilPaymentObjectSelector\ilPaymentObjectSelector(), ilRepositoryCopySelector\ilRepositoryCopySelector(), ilRepositoryExplorer\ilRepositoryExplorer(), ilRepositoryLinkSelector\ilRepositoryLinkSelector(), ilRoleDesktopItemSelector\ilRoleDesktopItemSelector(), ilSearchRootSelector\ilSearchRootSelector(), ilSolutionExplorer\ilSolutionExplorer(), and ilTableOfContentsExplorer\ilTableOfContentsExplorer().

        {
                $this->filtered = $a_bool;
                return true;
        }

Here is the caller graph for this function:

ilExplorer::setFilterMode ( $a_mode = IL_FM_NEGATIVE )

set filter mode

Parameters

int $a_mode filter mode IL_FM_NEGATIVE | IL_FM_NEGATIVE

Definition at line 505 of file class.ilExplorer.php.

Referenced by ilForumMoveTopicsExplorer\__construct(), ilPasteIntoMultipleItemsExplorer\__construct(), ilContainerSelectionExplorer\__construct(), ilConditionSelector\ilConditionSelector(), ilExplorer(), ilMaterialExplorer\ilMaterialExplorer(), ilPaymentObjectSelector\ilPaymentObjectSelector(), ilRepositoryCopySelector\ilRepositoryCopySelector(), ilRepositoryExplorer\ilRepositoryExplorer(), ilRepositoryLinkSelector\ilRepositoryLinkSelector(), ilRoleDesktopItemSelector\ilRoleDesktopItemSelector(), ilSearchRootSelector\ilSearchRootSelector(), ilSolutionExplorer\ilSolutionExplorer(), and ilTableOfContentsExplorer\ilTableOfContentsExplorer().

        {
                $this->filter_mode = $a_mode;
        }

Here is the caller graph for this function:

ilExplorer::setFrameTarget ( $a_target )

set target frame or not frame?

Parameters

string public

Definition at line 1170 of file class.ilExplorer.php.

Referenced by ilPoolSelectorGUI\__construct(), ilTableOfContentsExplorer\ilTableOfContentsExplorer(), and ilTableOfContentsExplorer\setOfflineMode().

        {
                $this->frame_target = $a_target;
        }

Here is the caller graph for this function:

ilExplorer::setFrameUpdater	(	$a_up_frame,
		$a_up_script,
		$a_params = `""`
	)

Set Explorer Updater.

Parameters

object $a_tree Tree Object

Definition at line 367 of file class.ilExplorer.php.

        {
                $this->up_frame = $a_up_frame;
                $this->up_script = $a_up_script;
                $this->up_params = $a_params;
        }

ilExplorer::setOrderColumn ( $a_column )

set the order column public

Parameters

string name of order column

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

Referenced by ilAICCExplorer\ilAICCExplorer(), ilHACPExplorer\ilHACPExplorer(), and ilSCORMExplorer\ilSCORMExplorer().

        {
                $this->order_column = $a_column;
        }

Here is the caller graph for this function:

ilExplorer::setOrderDirection ( $a_direction )

set the order direction public

Parameters

string name of order column

Definition at line 303 of file class.ilExplorer.php.

        {
                if ($a_direction == "desc")
                {
                        $this->order_direction = $a_direction;
                }
                else
                {
                        $this->order_direction = "asc";
                }
        }

ilExplorer::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.

Parameters

integer	parent_node_id where to start from (default=0, 'root')
integer	depth level where to start (default=1)

Returns: string

Definition at line 549 of file class.ilExplorer.php.

References $ilBench, $tab, checkFilter(), forceExpanded(), getIndex(), getRoot(), isVisible(), modifyChilds(), showChilds(), and sortNodes().

        {
                global $rbacadmin, $rbacsystem, $ilBench;
#echo 'ParentId: '.$a_parent_id.' depth: '.$a_depth.' obj_id: '.$a_obj_id;
                if (!isset($a_parent_id))
                {
                        $this->ilias->raiseError(get_class($this)."::setOutput(): No node_id given!",$this->ilias->error_obj->WARNING);
                }
                if ($this->showChilds($a_parent_id,$a_obj_id))
                {
                        $objects = $this->tree->getChilds($a_parent_id, $this->order_column);
                }
                else
                {
                        $objects = array();
                }
                $objects = $this->modifyChilds($a_parent_id, $objects);
                // force expansion (of single nodes)
//              if ($this->forceExpanded($a_obj_id) && !in_array($a_obj_id, $this->expanded))
//              {
//                      $this->expanded[] = $a_obj_id;
//              }
if ($this->forceExpanded($a_parent_id) && !in_array($a_parent_id, $this->expanded))
{
        $this->expanded[] = $a_parent_id;
}
                if (count($objects) > 0)
                {
                        // Maybe call a lexical sort function for the child objects
                        $tab = ++$a_depth - 2;
                        if ($this->post_sort)
                        {
                                $objects = $this->sortNodes($objects,$a_obj_id);
                        }
                        $skip_rest = false;
                        foreach ($objects as $key => $object)
                        {
                                // skip childs, if parent is not expanded
                                if (!$this->forceExpanded($object["child"]) && $skip_rest)
                                {
                                        continue;
                                }
//echo "<br>-".$object["child"]."-".$this->forceExpanded($object["child"])."-";
                                //ask for FILTER
                                if ($this->filtered == false or $this->checkFilter($object["type"]) == false)
                                {
                                        if ($this->isVisible($object['child'],$object['type']))
                                        {
                                                $ilBench->start("Explorer", "setOutput_setFormatOptions");
                                                #echo 'CHILD getIndex() '.$object['child'].' parent: '.$this->getRoot();
                                                if ($object["child"] != $this->getRoot())
                                                {
                                                        $parent_index = $this->getIndex($object);
                                                }
                                                $this->format_options["$this->counter"]["parent"]               = $object["parent"];
                                                $this->format_options["$this->counter"]["child"]                = $object["child"];
                                                $this->format_options["$this->counter"]["title"]                = $object["title"];
                                                $this->format_options["$this->counter"]["type"]         = $object["type"];
                                                $this->format_options["$this->counter"]["obj_id"]               = $object["obj_id"];
                                                $this->format_options["$this->counter"]["desc"]                 = "obj_".$object["type"];
                                                $this->format_options["$this->counter"]["depth"]                = $tab;
                                                $this->format_options["$this->counter"]["container"]    = false;
                                                $this->format_options["$this->counter"]["visible"]      = true;
                                                $this->format_options["$this->counter"]["highlighted_subtree"] = $a_highlighted_subtree;
                                                // Create prefix array
                                                for ($i = 0; $i < $tab; ++$i)
                                                {
                                                         $this->format_options["$this->counter"]["tab"][] = 'blank';
                                                }
                                                // fix explorer (sometimes explorer disappears)
                                                if ($parent_index == 0)
                                                {
                                                        if (!$this->expand_all and !in_array($object["parent"], $this->expanded))
                                                        {
                                                                $this->expanded[] = $object["parent"];
                                                        }
                                                }
                                                // only if parent is expanded and visible, object is visible
                                                if ($object["child"] != $this->getRoot() and ((!$this->expand_all and !in_array($object["parent"],$this->expanded))
                                                   or !$this->format_options["$parent_index"]["visible"]))
                                                {
                                                        if (!$this->forceExpanded($object["child"]))
                                                        {
                                                                // if parent is not expanded, and one child is
                                                                // visible we don't need more information and
                                                                // can skip the rest of the childs
                                                                if ($this->format_options["$this->counter"]["visible"])
                                                                {
//echo "-setSkipping";
                                                                        $skip_rest = true;
                                                                }
                                                                $this->format_options["$this->counter"]["visible"] = false;
                                                        }
                                                }
                                                // if object exists parent is container
                                                if ($object["child"] != $this->getRoot())
                                                {
                                                        $this->format_options["$parent_index"]["container"] = true;
                                                        if ($this->expand_all or in_array($object["parent"],$this->expanded))
                                                        {
        //echo "<br>-".$object["child"]."-".$this->forceExpanded($object["child"])."-";
                                                                if ($this->forceExpanded($object["parent"]))
                                                                {
                                                                        $this->format_options["$parent_index"]["tab"][($tab-2)] = 'forceexp';
                                                                }
                                                                else
                                                                {
                                                                        $this->format_options["$parent_index"]["tab"][($tab-2)] = 'minus';
                                                                }
                                                        }
                                                        else
                                                        {
                                                                $this->format_options["$parent_index"]["tab"][($tab-2)] = 'plus';
                                                        }
                                                }
        //echo "-"."$parent_index"."-";
        //var_dump($this->format_options["$parent_index"]);
                                                ++$this->counter;
                                                $ilBench->stop("Explorer", "setOutput_setFormatOptions");
                                                
                                                // stop recursion if 2. level beyond expanded nodes is reached
                                                if ($this->expand_all or in_array($object["parent"],$this->expanded) or ($object["parent"] == 0)
                                                        or $this->forceExpanded($object["child"]))
                                                {
                                                        $highlighted_subtree = ($a_highlighted_subtree ||
                                                                ($object["child"] == $this->highlighted))
                                                                ? true
                                                                : false;
                                                        
                                                        // recursive
                                                        $this->setOutput($object["child"],$a_depth,$object['obj_id'], $highlighted_subtree);
                                                }
                                        } //if
                                } //if FILTER
                        } //foreach
                } //if
        } //function

Here is the call graph for this function:

ilExplorer::setParamsGet ( $a_params_get )

set additional params to be passed in Get-string public

Parameters

array

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

        {
                if (!isset($a_params_get) or !is_array($a_params_get))
                {
                        $this->ilias->raiseError(get_class($this)."::setTargetGet(): No target given!",$this->ilias->error_obj->WARNING);
                }
                foreach ($a_params_get as $key => $val)
                {
                        $str .= "&".$key."=".$val;
                }
                $this->params_get = $str;
        }

ilExplorer::setPostSort ( $a_sort )

process post sorting

Parameters

boolean $a_sort true / false

Definition at line 495 of file class.ilExplorer.php.

Referenced by ilLMExplorer\ilLMExplorer(), ilMediaPoolExplorer\ilMediaPoolExplorer(), and ilScorm2004EditorExplorer\ilScorm2004EditorExplorer().

        {
                $this->post_sort = $a_sort;
        }

Here is the caller graph for this function:

ilExplorer::setRoot ( $a_root_id )

Set root node.

public

Parameters

int	ref id of root node

Definition at line 268 of file class.ilExplorer.php.

        {
                #$this->tree = new ilTree(ROOT_FOLDER_ID,$a_root_id);
                $this->root_id = $a_root_id;
        }

ilExplorer::setSessionExpandVariable ( $a_var_name = "expand" )

set name of expand session variable

Parameters

string $a_var_name variable name

Definition at line 398 of file class.ilExplorer.php.

Referenced by ilForumMoveTopicsExplorer\__construct(), ilPasteIntoMultipleItemsExplorer\__construct(), ilContainerSelectionExplorer\__construct(), ilShopPublicSectionSelector\__construct(), ilAdministrationExplorer\ilAdministrationExplorer(), ilConditionSelector\ilConditionSelector(), ilLMExplorer\ilLMExplorer(), ilLMMenuObjectSelector\ilLMMenuObjectSelector(), ilMaterialExplorer\ilMaterialExplorer(), ilMediaPoolExplorer\ilMediaPoolExplorer(), ilObjectSelector\ilObjectSelector(), ilPaymentObjectSelector\ilPaymentObjectSelector(), ilPublicSectionSelector\ilPublicSectionSelector(), ilRepositoryCopySelector\ilRepositoryCopySelector(), ilRepositoryExplorer\ilRepositoryExplorer(), ilRepositoryLinkSelector\ilRepositoryLinkSelector(), ilRoleDesktopItemSelector\ilRoleDesktopItemSelector(), ilScorm2004EditorExplorer\ilScorm2004EditorExplorer(), ilSearchRootSelector\ilSearchRootSelector(), ilSolutionExplorer\ilSolutionExplorer(), and ilTableOfContentsExplorer\ilTableOfContentsExplorer().

        {
                $this->expand_variable = $a_var_name;
        }

Here is the caller graph for this function:

ilExplorer::setTargetGet ( $a_target_get )

set the varname in Get-string public

Parameters

string varname containing Ids to be used in GET-string

Definition at line 320 of file class.ilExplorer.php.

Referenced by ilObjContentObjectGUI\editPublicSection(), ilHACPPresentationGUI\explorer(), ilAICCPresentationGUI\explorer(), ilSAHSPresentationGUI\explorer(), ilSCORMPresentationGUI\explorer(), ilObjContentObjectGUI\explorer(), ilShopPurchaseGUI\showDemoVersion(), and ilMailGUI\showMenu().

        {
                if (!isset($a_target_get) or !is_string($a_target_get))
                {
                        $this->ilias->raiseError(get_class($this)."::setTargetGet(): No target given!",$this->ilias->error_obj->WARNING);
                }
                $this->target_get = $a_target_get;
        }

Here is the caller graph for this function:

ilExplorer::setTitle ( $a_val )

Set title.

Parameters

title

Definition at line 227 of file class.ilExplorer.php.

Referenced by ilAdministrationExplorer\ilAdministrationExplorer(), and ilRepositoryExplorer\ilRepositoryExplorer().

        {
                $this->title = $a_val;
        }

Here is the caller graph for this function:

ilExplorer::setTitleLength ( $a_length )

Set max title length.

Parameters

object $a_length

Returns

Definition at line 237 of file class.ilExplorer.php.

Referenced by ilCopyWizardExplorer\__construct(), ilContainerSelectionExplorer\__construct(), ilConditionSelector\ilConditionSelector(), ilExplorer(), ilRepositoryCopySelector\ilRepositoryCopySelector(), ilRepositoryLinkSelector\ilRepositoryLinkSelector(), ilRoleDesktopItemSelector\ilRoleDesktopItemSelector(), and ilSearchRootSelector\ilSearchRootSelector().

        {
                $this->textwidth = $a_length;
        }

Here is the caller graph for this function:

ilExplorer::setTreeLead ( $a_val )

Set tree leading content.

Parameters

string $a_val tree leading content

Definition at line 453 of file class.ilExplorer.php.

        {
                $this->tree_lead = $a_val;
        }

ilExplorer::setUseStandardFrame ( $a_val )

Set use standard frame.

If true, the standard explorer frame (like in the repository) is put around the tree.

Parameters

boolean use standard explorer frame

Definition at line 526 of file class.ilExplorer.php.

Referenced by ilObjMediaPoolGUI\explorer().

        {
                $this->use_standard_frame = $a_val;
        }

Here is the caller graph for this function:

ilExplorer::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.

ilRepositoryExplorerGUI)

Reimplemented in ilIntLinkRepItemExplorer, ilPaymentObjectSelector, ilSearchRootSelector, ilRepositoryLinkSelector, ilMaterialExplorer, ilSolutionExplorer, ilRepositoryCopySelector, ilConditionSelector, ilLMMenuObjectSelector, ilPoolSelectorGUI, ilRoleDesktopItemSelector, ilObjectSelector, ilFileSelectorGUI, and ilGlossarySelectorGUI.

Definition at line 708 of file class.ilExplorer.php.

Referenced by ilSCORMExplorer\setOutput(), and setOutput().

        {
                return true;
        }

Here is the caller graph for this function:

ilExplorer::sortNodes	(	$a_nodes,
		$a_parent_obj_id
	)

sort nodes and put adm object to the end of sorted array private

Parameters

array node list as returned by iltree::getChilds();

Returns: array sorted nodes

Reimplemented in ilRepositoryExplorer.

Definition at line 1432 of file class.ilExplorer.php.

References ilUtil\sortArray().

Referenced by setOutput().

        {
                foreach ($a_nodes as $key => $node)
                {
                        if ($node["type"] == "adm")
                        {
                                $match = $key;
                                $adm_node = $node;
                                break;
                        }
                }
                // cut off adm node
                isset($match) ? array_splice($a_nodes,$match,1) : "";
                $a_nodes = ilUtil::sortArray($a_nodes,$this->order_column,$this->order_direction);
                // append adm node to end of list
                isset ($match) ? array_push($a_nodes,$adm_node) : "";
                return $a_nodes;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

ilExplorer::$expand_all = false

Definition at line 150 of file class.ilExplorer.php.

ilExplorer::$expand_target

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

ilExplorer::$expand_variable

Definition at line 115 of file class.ilExplorer.php.

Referenced by setExpand().

ilExplorer::$expanded

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

ilExplorer::$filter_mode

Definition at line 143 of file class.ilExplorer.php.

Referenced by getFilterMode().

ilExplorer::$filtered = false

Definition at line 136 of file class.ilExplorer.php.

ilExplorer::$format_options

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

ilExplorer::$ilias

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

ilExplorer::$is_clickable

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

ilExplorer::$order_column

Definition at line 79 of file class.ilExplorer.php.

ilExplorer::$order_direction = "asc"

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

ilExplorer::$output

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

ilExplorer::$output_icons

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

ilExplorer::$params_get

Definition at line 65 of file class.ilExplorer.php.

ilExplorer::$post_sort

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

ilExplorer::$rbac_check

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

ilExplorer::$root_id = null

Definition at line 157 of file class.ilExplorer.php.

Referenced by getRoot().

ilExplorer::$target

Definition at line 51 of file class.ilExplorer.php.

Referenced by ilBookmarkExplorer\buildLinkTarget(), buildLinkTarget(), ilHACPExplorer\formatObject(), ilPasteIntoMultipleItemsExplorer\formatObject(), ilForumMoveTopicsExplorer\formatObject(), ilAICCExplorer\formatObject(), ilSCORMExplorer\formatObject(), and formatObject().

ilExplorer::$target_get

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

ilExplorer::$tree

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

Referenced by ilGlossarySelectorGUI\__construct(), ilFileSelectorGUI\__construct(), ilPoolSelectorGUI\__construct(), ilForumMoveTopicsExplorer\__construct(), ilPasteIntoMultipleItemsExplorer\__construct(), ilContainerSelectionExplorer\__construct(), ilPasteIntoMultipleItemsExplorer\formatHeader(), ilForumMoveTopicsExplorer\formatHeader(), ilRepositoryExplorer\formatHeader(), ilAdministrationExplorer\ilAdministrationExplorer(), ilConditionSelector\ilConditionSelector(), ilIntLinkRepItemExplorer\ilLMMenuObjectSelector(), ilLMMenuObjectSelector\ilLMMenuObjectSelector(), ilMaterialExplorer\ilMaterialExplorer(), ilObjectSelector\ilObjectSelector(), ilPaymentObjectSelector\ilPaymentObjectSelector(), ilRepositoryCopySelector\ilRepositoryCopySelector(), ilRepositoryExplorer\ilRepositoryExplorer(), ilRepositoryLinkSelector\ilRepositoryLinkSelector(), ilRoleDesktopItemSelector\ilRoleDesktopItemSelector(), ilSearchRootSelector\ilSearchRootSelector(), ilSolutionExplorer\ilSolutionExplorer(), ilRepositoryExplorer\isClickable(), ilRepositoryExplorer\isVisible(), and ilRepositoryExplorer\showChilds().

ilExplorer::$use_standard_frame = false

Definition at line 159 of file class.ilExplorer.php.

Referenced by getUseStandardFrame().

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

classes/class.ilExplorer.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation