ilSearchRootSelector Class Reference

Inheritance diagram for ilSearchRootSelector:

Collaboration diagram for ilSearchRootSelector:

Public Member Functions
	ilSearchRootSelector ($a_target)
	Constructor public.
	setClickableTypes ($a_types)
	isClickable ($a_type, $a_ref_id=0)
	check if links for certain object type are activated
	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)
	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	get frame target (may be overwritten by derived classes)
	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.
	formatHeader (&$tpl, $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)
	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
	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
	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
	$root_id
	$output
	$ctrl
	$selectable_type
	$ref_id
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

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

Member Function Documentation

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 '';
        }

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.

References getCmd(), and getTargetClass().

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

        }

Here is the call graph for this function:

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

overwritten method from base class public

Parameters

integer	obj_id
integer	array options

Returns

string

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

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

        {
                global $lng, $ilias;

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

                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;
        }

Here is the call graph for this function:

ilSearchRootSelector::getCmd

(

)

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

Referenced by buildLinkTarget(), and formatHeader().

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

Here is the caller graph for this function:

ilSearchRootSelector::getTargetClass

(

)

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

Referenced by buildLinkTarget(), and formatHeader().

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

Here is the caller graph for this function:

ilSearchRootSelector::ilSearchRootSelector

(

$a_target

)

Constructor public.

Parameters

string	scriptname
int	user_id

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

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

        {
                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);
        }

Here is the call graph for this function:

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;
        }

ilSearchRootSelector::setClickableTypes

(

$a_types

)

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

Referenced by ilSearchRootSelector().

        {
                $this->clickable_types = $a_types;
        }

Here is the caller graph for this function:

ilSearchRootSelector::setCmd

(

$a_cmd

)

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

        {
                $this->cmd = $a_cmd;
        }

ilSearchRootSelector::setRefId

(

$a_ref_id

)

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

        {
                $this->ref_id = $a_ref_id;
        }

ilSearchRootSelector::setSelectableType

(

$a_type

)

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

        {
                $this->selectable_type  = $a_type;
        }

ilSearchRootSelector::setTargetClass

(

$a_class

)

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

Referenced by ilLuceneSearchGUI\chooseRoot().

        {
                $this->target_class = $a_class;
        }

Here is the caller graph for this function:

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

ilSearchRootSelector::$ctrl

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

ilSearchRootSelector::$output

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

ilSearchRootSelector::$ref_id

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

ilSearchRootSelector::$root_id

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

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