Inheritance diagram for ilSearchRootSelector:

Collaboration diagram for ilSearchRootSelector:

Public Member Functions
	ilSearchRootSelector ($a_target)
	Constructor @access public. More...

	setClickableTypes ($a_types)

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

	setTargetClass ($a_class)

	getTargetClass ()

	setCmd ($a_cmd)

	getCmd ()

	setSelectableType ($a_type)

	setRefId ($a_ref_id)

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

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

	showChilds ($a_ref_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...

	formatHeader (&$tpl, $a_option)
	overwritten method from base class @access public More...

Public Member Functions inherited from ilExplorer
	ilExplorer ($a_target)
	Constructor @access 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 @access public More...

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

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

	setParamsGet ($a_params_get)
	set additional params to be passed in Get-string @access 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 @access 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 @access 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 @access 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 @access private. More...

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

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

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

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

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

	delFilter ($a_item)
	removes item from the filter @access 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,...) @access private More...

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

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

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

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

Data Fields
	$root_id

	$output

	$ctrl

	$selectable_type

	$ref_id

Data Fields inherited from ilExplorer
	$id

	$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

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

Member Function Documentation

◆ buildFrameTarget()

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

get frame target (may be overwritten by derived classes)

Reimplemented from ilExplorer.

Definition at line 131 of file class.ilSearchRootSelector.php.

        {
                return '';
        }

◆ buildLinkTarget()

ilSearchRootSelector::buildLinkTarget	(	$a_node_id,
		$a_type
	)

get link target (may be overwritten by derived classes)

Reimplemented from ilExplorer.

Definition at line 123 of file class.ilSearchRootSelector.php.

        {
                $this->ctrl->setParameterByClass($this->getTargetClass(),"root_id",$a_node_id);
                
                return $this->ctrl->getLinkTargetByClass($this->getTargetClass(),$this->getCmd());
 
        }

References getCmd(), and getTargetClass().

Here is the call graph for this function:

◆ formatHeader()

ilSearchRootSelector::formatHeader	(	&	$tpl,
			$a_option
	)

overwritten method from base class @access public

Parameters

integer	obj_id
integer	array options

Returns: string

Definition at line 163 of file class.ilSearchRootSelector.php.

        {
                global $lng, $ilias;
 
                #$tpl = new ilTemplate("tpl.tree.html", true, true, "Services/UIComponent/Explorer");
 
                if (in_array("root", $this->clickable_types))
                {
                        $tpl->setCurrentBlock("link");
                        //$tpl->setVariable("LINK_NAME",$lng->txt('repository'));
                        
                        $this->ctrl->setParameterByClass($this->getTargetClass(),'root_id',ROOT_FOLDER_ID);
                        $tpl->setVariable("LINK_TARGET",$this->ctrl->getLinkTargetByClass($this->getTargetClass(),$this->getCmd()));
                        $tpl->setVariable("TITLE", $lng->txt("repository"));
                        
                        $tpl->parseCurrentBlock();
                }
 
                #$this->output[] = $tpl->get();
 
                return true;
        }

References ilExplorer\$ilias, $lng, $tpl, and getTargetClass().

Here is the call graph for this function:

◆ getCmd()

ilSearchRootSelector::getCmd ( )

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

        {
                return $this->cmd ? $this->cmd : 'selectRoot';
        }

Referenced by buildLinkTarget().

Here is the caller graph for this function:

◆ getTargetClass()

ilSearchRootSelector::getTargetClass ( )

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

        {
                return $this->target_class ? $this->target_class : 'ilsearchgui';
        }

Referenced by buildLinkTarget(), and formatHeader().

Here is the caller graph for this function:

◆ ilSearchRootSelector()

ilSearchRootSelector::ilSearchRootSelector ( $a_target )

Constructor @access public.

Parameters

string	scriptname
int	user_id

Definition at line 55 of file class.ilSearchRootSelector.php.

        {
                global $tree,$ilCtrl;
 
                $this->ctrl = $ilCtrl;
 
                parent::ilExplorer($a_target);
                $this->tree = $tree;
                $this->root_id = $this->tree->readRootId();
                $this->order_column = "title";
 
                $this->setSessionExpandVariable("search_root_expand");
 
                // add here all container objects
                $this->addFilter("root");
                $this->addFilter("cat");
                $this->addFilter("grp");
                $this->addFilter("fold");
                $this->addFilter("crs");
                $this->setClickableTypes(array("root", "cat", "grp", "fold", "crs"));
 
                $this->setFiltered(true);
                $this->setFilterMode(IL_FM_POSITIVE);
                
                $this->setTitleLength(ilObject::TITLE_LENGTH);
        }

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

Here is the call graph for this function:

◆ isClickable()

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

Definition at line 87 of file class.ilSearchRootSelector.php.

        {
                if (in_array($a_type, $this->clickable_types))
                {
                        return true;
                }
                return false;
        }

◆ setClickableTypes()

ilSearchRootSelector::setClickableTypes ( $a_types )

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

        {
                $this->clickable_types = $a_types;
        }

Referenced by ilSearchRootSelector().

Here is the caller graph for this function:

◆ setCmd()

ilSearchRootSelector::setCmd ( $a_cmd )

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

        {
                $this->cmd = $a_cmd;
        }

◆ setRefId()

ilSearchRootSelector::setRefId ( $a_ref_id )

Definition at line 117 of file class.ilSearchRootSelector.php.

        {
                $this->ref_id = $a_ref_id;
        }

◆ setSelectableType()

ilSearchRootSelector::setSelectableType ( $a_type )

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

        {
                $this->selectable_type  = $a_type;
        }

◆ setTargetClass()

ilSearchRootSelector::setTargetClass ( $a_class )

Definition at line 96 of file class.ilSearchRootSelector.php.

        {
                $this->target_class = $a_class;
        }

◆ showChilds()

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

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

        {
                global $rbacsystem;
 
                if ($a_ref_id == 0)
                {
                        return true;
                }
 
                if ($rbacsystem->checkAccess("read", $a_ref_id))
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

Field Documentation

◆ $ctrl

ilSearchRootSelector::$ctrl

Definition at line 45 of file class.ilSearchRootSelector.php.

◆ $output

ilSearchRootSelector::$output

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

◆ $ref_id

ilSearchRootSelector::$ref_id

Definition at line 48 of file class.ilSearchRootSelector.php.

◆ $root_id

ilSearchRootSelector::$root_id

Definition at line 43 of file class.ilSearchRootSelector.php.

◆ $selectable_type

ilSearchRootSelector::$selectable_type

Definition at line 47 of file class.ilSearchRootSelector.php.

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

Services/Search/classes/class.ilSearchRootSelector.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ buildFrameTarget()

◆ buildLinkTarget()

◆ formatHeader()

◆ getCmd()

◆ getTargetClass()

◆ ilSearchRootSelector()

◆ isClickable()

◆ setClickableTypes()

◆ setCmd()

◆ setRefId()

◆ setSelectableType()

◆ setTargetClass()

◆ showChilds()

Field Documentation

◆ $ctrl

◆ $output

◆ $ref_id

◆ $root_id

◆ $selectable_type