ilContainerSelectionExplorer Class Reference

Inheritance diagram for ilContainerSelectionExplorer:

Collaboration diagram for ilContainerSelectionExplorer:

Public Member Functions
	__construct ($a_target)
	Constructor.
	setTargetType ($a_type)
	set target type
	getTargetType ()
	get target type
	isClickable ($a_type, $a_id)
	check if item is clickable
	formatHeader ($a_obj_id, $a_option)
	overwritten method from base class public
Public Member Functions inherited from ilExplorer
	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.
	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

Protected Attributes
	$target_type

Additional Inherited Members
Data Fields inherited from ilExplorer
	$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

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

ilContainerSelectionExplorer::__construct

(

$a_target

)

Constructor.

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

References ilExplorer\$tree, ilExplorer\addFilter(), IL_FM_POSITIVE, ilExplorer\setFiltered(), ilExplorer\setFilterMode(), ilExplorer\setSessionExpandVariable(), ilExplorer\setTitleLength(), and ilObject\TITLE_LENGTH.

        {
                global $tree;
                
                parent::__construct($a_target);
                 
                $this->tree = $tree;
                $this->root_id = $this->tree->readRootId();
                $this->order_column = "title";

                $this->setSessionExpandVariable("ref_repexpand");
                 
                 
                $this->addFilter("root");
                $this->addFilter("cat");
                #$this->addFilter("grp");
                #$this->addFilter("fold");
                $this->addFilter("crs");

                $this->setFilterMode(IL_FM_POSITIVE);
                $this->setFiltered(true);
                $this->setTitleLength(ilObject::TITLE_LENGTH);
                 
        }

Here is the call graph for this function:

Member Function Documentation

ilContainerSelectionExplorer::formatHeader	(		$a_obj_id,
			$a_option
	)

overwritten method from base class public

Parameters

integer	obj_id
integer	array options

Returns

string

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

References ilExplorer\$ilias, $lng, and $tpl.

        {
                global $lng, $ilias;

                $tpl = new ilTemplate("tpl.tree.html", true, true);

                $tpl->setCurrentBlock("text");
                $tpl->setVariable("OBJ_TITLE", $lng->txt("repository"));
                $tpl->parseCurrentBlock();

                $tpl->setCurrentBlock("row");
                $tpl->parseCurrentBlock();

                $this->output[] = $tpl->get();
        }

ilContainerSelectionExplorer::getTargetType

(

)

get target type

Parameters

@return

Definition at line 82 of file class.ilContainerSelectionExplorer.php.

References $target_type.

Referenced by isClickable().

        {
                return $this->target_type;
        }

Here is the caller graph for this function:

ilContainerSelectionExplorer::isClickable	(		$a_type,
			$a_id
	)

check if item is clickable

Parameters

@return

Reimplemented from ilExplorer.

Definition at line 92 of file class.ilContainerSelectionExplorer.php.

References getTargetType().

        {
                if($this->getTargetType() == $a_type)
                {
                        // TODO: check permission
                        return true;
                }
                return FALSE;
        }

Here is the call graph for this function:

ilContainerSelectionExplorer::setTargetType

(

$a_type

)

set target type

Parameters

@return

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

        {
                $this->target_type = $a_type;
        }

Field Documentation

ilContainerSelectionExplorer::$target_type

protected

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

Referenced by getTargetType().

---

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

• Services/ContainerReference/classes/class.ilContainerSelectionExplorer.php