Inheritance diagram for ilSearchRootSelector:

Collaboration diagram for ilSearchRootSelector:

Public Member Functions
	__construct ($a_target)
	Constructor public. More...

	setPathOpen (int $ref_id)

	setClickableTypes (array $a_types)

	isClickable (string $type, int $ref_id=0)

	setTargetClass (string $a_class)

	getTargetClass ()

	setCmd (string $a_cmd)

	getCmd ()

	setSelectableType (string $a_type)

	getSelectableType ()

	setRefId (int $a_ref_id)

	getRefId ()

	buildLinkTarget ($a_node_id, string $a_type)

	buildFrameTarget (string $a_type, $a_child=0, $a_obj_id=0)

	showChilds ($a_parent_id)

	formatHeader (ilTemplate $tpl, $a_obj_id, array $a_option)

Public Member Functions inherited from ilExplorer
	setId (string $a_val)

	getId ()

	setAsynchExpanding (bool $a_val)

	getAsynchExpanding ()

	initItemCounter (int $a_number)

	setTitle (string $a_val)

	setTitleLength (int $a_length)

	getTitleLength ()

	getTitle ()

	setRoot ($a_root_id)

	getRoot ()

	setOrderColumn (string $a_column)

	setOrderDirection (string $a_direction)

	setTargetGet (string $a_target_get)

	setParamsGet (array $a_params_get)

	setExpandTarget (string $a_exp_target)
	target script for expand icons More...

	setFrameUpdater (string $a_up_frame, string $a_up_script, string $a_params="")

	highlightNode (string $a_id)

	checkPermissions (bool $a_check)

	setSessionExpandVariable (string $a_var_name="expand")

	outputIcons (bool $a_icons)

	setClickable (string $a_type, bool $a_clickable)

	isVisible ( $a_ref_id, string $a_type)

	setTreeLead (string $a_val)

	getTreeLead ()

	isClickable (string $type, int $ref_id=0)

	setPostSort (bool $a_sort)

	setFilterMode (int $a_mode=IL_FM_NEGATIVE)

	getFilterMode ()

	setUseStandardFrame (bool $a_val)
	Set use standard frame. More...

	getUseStandardFrame ()

	getChildsOfNode ($a_parent_id)

	setOutput ( $a_parent_id, int $a_depth=1, int $a_obj_id=0, bool $a_highlighted_subtree=false)
	Creates output for explorer view in admin menue recursive method. More...

	modifyChilds ( $a_parent_id, array $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 ()

	getOutput ()

	handleListEndTags (ilTemplate $a_tpl_tree, int $a_cur_depth, int $a_item_depth)
	handle list end tags ( and ) More...

	handleListStartTags (ilTemplate $a_tpl_tree, int $a_cur_depth, int $a_item_depth)
	handle list start tags ( More...

	formatHeader (ilTemplate $tpl, $a_obj_id, array $a_option)

	formatObject (ilTemplate $tpl, $a_node_id, array $a_option, $a_obj_id=0)

	getImage (string $a_name, string $a_type="", $a_obj_id="")

	getImageAlt (string $a_default_text, string $a_type="", $a_obj_id="")

	getNodeStyleClass ( $a_id, string $a_type)

	buildLinkTarget ( $a_node_id, string $a_type)

	buildOnClick ( $a_node_id, string $a_type, string $a_title)

	buildTitle (string $a_title, $a_id, string $a_type)

	buildDescription (string $a_desc, $a_id, string $a_type)

	buildSelect ($a_node_id, string $a_type)
	standard implementation for adding an option select box between image and title More...

	buildFrameTarget (string $a_type, $a_child=0, $a_obj_id=0)

	createTarget (string $a_type, $a_node_id, bool $a_highlighted_subtree=false, bool $a_append_anch=true)

	setFrameTarget (string $a_target)

	createLines (int $a_depth)

	is_in_array (int $a_start, int $a_depth)

	getIndex (array $a_data)

	addFilter (string $a_item)

	delFilter (string $a_item)

	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,...) More...

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

	setFiltered (bool $a_bool)

	checkFilter (string $a_item)

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

Protected Attributes
ilCtrl	$ctrl

ilRbacSystem	$system

Protected Attributes inherited from ilExplorer
ilObjectDefinition	$obj_definition

ilErrorHandling	$error

ilRbacSystem	$rbacsystem

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

	$filter = []

string	$highlighted = ""

bool	$show_minus = true

int	$counter = 0

bool	$asnch_expanding = false

int	$textwidth = 0

string	$title = ""

string	$up_frame = ""

string	$a_up_script = ""

string	$up_params = ""

string	$frame_target = ""

string	$up_script = ""

string	$tree_lead = ""

array	$iconList = []

ILIAS Refinery Factory	$refinery

ILIAS HTTP Wrapper WrapperFactory	$wrapper

Private Attributes
string	$selectable_type = ''

int	$ref_id = 0

string	$target_class = ''

array	$clickable_types = []

string	$cmd = ''

Additional Inherited Members
Data Fields inherited from ilExplorer
string	$id = ""

string	$output = ""

array	$format_options = []

ilTree	$tree

string	$target = ""

string	$target_get = ""

string	$params_get = ""

array	$expanded = []

string	$order_column = ""

string	$order_direction = "asc"

string	$expand_target = null

bool	$rbac_check = false

bool	$output_icons = false

string	$expand_variable = ""

array	$is_clickable = []

bool	$post_sort = false

bool	$filtered = false

bool	$filter_mode

bool	$expand_all = false

	$root_id = null

bool	$use_standard_frame = false

Protected Member Functions inherited from ilExplorer
	requestStr (string $key)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilSearchRootSelector::__construct ( $a_target )

Constructor public.

Parameters

string	scriptname
int	user_id

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilExplorer\addFilter(), ILIAS\Repository\ctrl(), IL_FM_POSITIVE, setClickableTypes(), ilExplorer\setFiltered(), ilExplorer\setFilterMode(), ilExplorer\setSessionExpandVariable(), ilExplorer\setTitleLength(), and ilObject\TITLE_LENGTH.

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->system = $DIC->rbac()->system();
 
         parent::__construct($a_target);
         $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:

Member Function Documentation

◆ buildFrameTarget()

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

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

◆ buildLinkTarget()

ilSearchRootSelector::buildLinkTarget	(		$a_node_id,
		string	$a_type
	)

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

References ILIAS\Repository\ctrl(), getCmd(), and getTargetClass().

                                                                : string
     {
         $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:

◆ formatHeader()

ilSearchRootSelector::formatHeader	(	ilTemplate	$tpl,
			$a_obj_id,
		array	$a_option
	)

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

References ILIAS\Repository\ctrl(), getCmd(), getTargetClass(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ROOT_FOLDER_ID, ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                                                              : void
     {
         #$tpl = new ilTemplate("tpl.tree.html", true, true, "components/ILIAS/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", $this->lng->txt("repository"));
 
             $tpl->parseCurrentBlock();
         }
     }

Here is the call graph for this function:

◆ getCmd()

ilSearchRootSelector::getCmd ( )

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

Referenced by buildLinkTarget(), and formatHeader().

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

Here is the caller graph for this function:

◆ getRefId()

ilSearchRootSelector::getRefId ( )

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

References $ref_id.

                               : int
     {
         return $this->ref_id;
     }

◆ getSelectableType()

ilSearchRootSelector::getSelectableType ( )

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

References $selectable_type.

                                        : string
     {
         return $this->selectable_type;
     }

◆ getTargetClass()

ilSearchRootSelector::getTargetClass ( )

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

Referenced by buildLinkTarget(), and formatHeader().

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

Here is the caller graph for this function:

◆ isClickable()

ilSearchRootSelector::isClickable	(	string	$type,
		int	$ref_id = `0`
	)

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

                                                               : bool
     {
         return (in_array($type, $this->clickable_types));
     }

◆ setClickableTypes()

ilSearchRootSelector::setClickableTypes ( array $a_types )

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

Referenced by __construct().

                                                      : void
     {
         $this->clickable_types = $a_types;
     }

Here is the caller graph for this function:

◆ setCmd()

ilSearchRootSelector::setCmd ( string $a_cmd )

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

                                          : void
     {
         $this->cmd = $a_cmd;
     }

◆ setPathOpen()

ilSearchRootSelector::setPathOpen ( int $ref_id )

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

References ilExplorer\$id, and ilExplorer\setExpand().

                                             : void
     {
         if (count($this->expanded) <= 1) {
             foreach ($this->tree->getPathId($ref_id) as $id) {
                 $this->setExpand($id);
             }
         }
     }

Here is the call graph for this function:

◆ setRefId()

ilSearchRootSelector::setRefId ( int $a_ref_id )

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

                                            : void
     {
         $this->ref_id = $a_ref_id;
     }

◆ setSelectableType()

ilSearchRootSelector::setSelectableType ( string $a_type )

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

                                                      : void
     {
         $this->selectable_type = $a_type;
     }

◆ setTargetClass()

ilSearchRootSelector::setTargetClass ( string $a_class )

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

                                                    : void
     {
         $this->target_class = $a_class;
     }

◆ showChilds()

ilSearchRootSelector::showChilds ( $a_parent_id )

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

                                             : bool
     {
         if ($a_parent_id == 0) {
             return true;
         }
 
         if ($this->system->checkAccess("read", (int) $a_parent_id)) {
             return true;
         } else {
             return false;
         }
     }

Field Documentation

◆ $clickable_types

array ilSearchRootSelector::$clickable_types = []

private

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

◆ $cmd

string ilSearchRootSelector::$cmd = ''

private

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

◆ $ctrl

ilCtrl ilSearchRootSelector::$ctrl

protected

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

◆ $ref_id

int ilSearchRootSelector::$ref_id = 0

private

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

Referenced by getRefId().

◆ $selectable_type

string ilSearchRootSelector::$selectable_type = ''

private

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

Referenced by getSelectableType().

◆ $system

ilRbacSystem ilSearchRootSelector::$system

protected

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

◆ $target_class

string ilSearchRootSelector::$target_class = ''

private

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

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

components/ILIAS/Search/classes/class.ilSearchRootSelector.php

Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildFrameTarget()

◆ buildLinkTarget()

◆ formatHeader()

◆ getCmd()

◆ getRefId()

◆ getSelectableType()

◆ getTargetClass()

◆ isClickable()

◆ setClickableTypes()

◆ setCmd()

◆ setPathOpen()

◆ setRefId()

◆ setSelectableType()

◆ setTargetClass()

◆ showChilds()

Field Documentation

◆ $clickable_types

◆ $cmd

◆ $ctrl

◆ $ref_id

◆ $selectable_type

◆ $system

◆ $target_class