ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilSearchRootSelector Class Reference
+ Inheritance diagram for ilSearchRootSelector:
+ Collaboration diagram for ilSearchRootSelector:

Public Member Functions

 __construct ($a_target)
 Constructor public. More...
 
 setClickableTypes ($a_types)
 
 isClickable ($a_type, $a_ref_id=0)
 
 setTargetClass ($a_class)
 
 getTargetClass ()
 
 setCmd ($a_cmd)
 
 getCmd ()
 
 setSelectableType ($a_type)
 
 setRefId ($a_ref_id)
 
 buildLinkTarget ($a_node_id, $a_type)
 
 buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
 
 showChilds ($a_ref_id)
 
 formatHeader ($tpl, $a_obj_id, $a_option)
 overwritten method from base class public More...
 
- Public Member Functions inherited from ilExplorer
 __construct ($a_target)
 Constructor 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 public More...
 
 setOrderDirection ($a_direction)
 set the order direction public More...
 
 setTargetGet ($a_target_get)
 set the varname in Get-string public More...
 
 setParamsGet ($a_params_get)
 set additional params to be passed in Get-string 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 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 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 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 private. More...
 
 setFrameTarget ($a_target)
 set target frame or not frame? More...
 
 createLines ($a_depth)
 Creates lines for explorer view private. More...
 
 is_in_array ($a_start, $a_depth)
 DESCRIPTION MISSING private. More...
 
 getIndex ($a_data)
 get index of format_options array from specific ref_id,parent_id private More...
 
 addFilter ($a_item)
 adds item to the filter public More...
 
 delFilter ($a_item)
 removes item from the filter 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,...) private More...
 
 forceExpandAll ($a_mode, $a_show_minus=true)
 force expandAll. More...
 
 setFiltered ($a_bool)
 active/deactivate the filter public More...
 
 checkFilter ($a_item)
 check if item is in filter private More...
 
 sortNodes ($a_nodes, $a_parent_obj_id)
 sort nodes and put adm object to the end of sorted array private More...
 

Data Fields

 $root_id
 
 $output
 
 $ctrl
 
 $selectable_type
 
 $ref_id
 
- Data Fields inherited from ilExplorer
 $id
 
 $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
 

Additional Inherited Members

- Protected Attributes inherited from ilExplorer
 $obj_definition
 
 $error
 
 $rbacsystem
 
 $tpl
 
 $lng
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilSearchRootSelector::__construct (   $a_target)

Constructor public.

Parameters
stringscriptname
intuser_id

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

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

56  {
57  global $tree,$ilCtrl;
58 
59  $this->ctrl = $ilCtrl;
60 
61  parent::__construct($a_target);
62  $this->tree = $tree;
63  $this->root_id = $this->tree->readRootId();
64  $this->order_column = "title";
65 
66  $this->setSessionExpandVariable("search_root_expand");
67 
68  // add here all container objects
69  $this->addFilter("root");
70  $this->addFilter("cat");
71  $this->addFilter("grp");
72  $this->addFilter("fold");
73  $this->addFilter("crs");
74  $this->setClickableTypes(array("root", "cat", "grp", "fold", "crs"));
75 
76  $this->setFiltered(true);
78 
80  }
setFilterMode($a_mode=IL_FM_NEGATIVE)
set filter mode
const TITLE_LENGTH
max length of object title
setTitleLength($a_length)
Set max title length.
const IL_FM_POSITIVE
setFiltered($a_bool)
active/deactivate the filter public
global $ilCtrl
Definition: ilias.php:18
Create styles array
The data for the language used.
setSessionExpandVariable($a_var_name="expand")
set name of expand session variable
addFilter($a_item)
adds item to the filter public
+ Here is the call graph for this function:

Member Function Documentation

◆ buildFrameTarget()

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

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

130  {
131  return '';
132  }

◆ buildLinkTarget()

ilSearchRootSelector::buildLinkTarget (   $a_node_id,
  $a_type 
)

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

References getCmd(), and getTargetClass().

123  {
124  $this->ctrl->setParameterByClass($this->getTargetClass(), "root_id", $a_node_id);
125 
126  return $this->ctrl->getLinkTargetByClass($this->getTargetClass(), $this->getCmd());
127  }
+ Here is the call graph for this function:

◆ formatHeader()

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

overwritten method from base class public

Parameters
integerobj_id
integerarray options
Returns
string

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

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

158  {
159  global $lng, $ilias;
160 
161  #$tpl = new ilTemplate("tpl.tree.html", true, true, "Services/UIComponent/Explorer");
162 
163  if (in_array("root", $this->clickable_types)) {
164  $tpl->setCurrentBlock("link");
165  //$tpl->setVariable("LINK_NAME",$lng->txt('repository'));
166 
167  $this->ctrl->setParameterByClass($this->getTargetClass(), 'root_id', ROOT_FOLDER_ID);
168  $tpl->setVariable("LINK_TARGET", $this->ctrl->getLinkTargetByClass($this->getTargetClass(), $this->getCmd()));
169  $tpl->setVariable("TITLE", $lng->txt("repository"));
170 
171  $tpl->parseCurrentBlock();
172  }
173 
174  #$this->output[] = $tpl->get();
175 
176  return true;
177  }
+ Here is the call graph for this function:

◆ getCmd()

ilSearchRootSelector::getCmd ( )

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

Referenced by buildLinkTarget(), and formatHeader().

108  {
109  return $this->cmd ? $this->cmd : 'selectRoot';
110  }
+ Here is the caller graph for this function:

◆ getTargetClass()

ilSearchRootSelector::getTargetClass ( )

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

Referenced by buildLinkTarget(), and formatHeader().

100  {
101  return $this->target_class ? $this->target_class : 'ilsearchgui';
102  }
+ Here is the caller graph for this function:

◆ isClickable()

ilSearchRootSelector::isClickable (   $a_type,
  $a_ref_id = 0 
)

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

References $a_type.

88  {
89  if (in_array($a_type, $this->clickable_types)) {
90  return true;
91  }
92  return false;
93  }
$a_type
Definition: workflow.php:92

◆ setClickableTypes()

ilSearchRootSelector::setClickableTypes (   $a_types)

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

Referenced by __construct().

83  {
84  $this->clickable_types = $a_types;
85  }
+ Here is the caller graph for this function:

◆ setCmd()

ilSearchRootSelector::setCmd (   $a_cmd)

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

104  {
105  $this->cmd = $a_cmd;
106  }

◆ setRefId()

ilSearchRootSelector::setRefId (   $a_ref_id)

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

117  {
118  $this->ref_id = $a_ref_id;
119  }

◆ setSelectableType()

ilSearchRootSelector::setSelectableType (   $a_type)

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

References $a_type.

113  {
114  $this->selectable_type = $a_type;
115  }
$a_type
Definition: workflow.php:92

◆ setTargetClass()

ilSearchRootSelector::setTargetClass (   $a_class)

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

96  {
97  $this->target_class = $a_class;
98  }

◆ showChilds()

ilSearchRootSelector::showChilds (   $a_ref_id)

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

References ilExplorer\$rbacsystem.

135  {
136  global $rbacsystem;
137 
138  if ($a_ref_id == 0) {
139  return true;
140  }
141 
142  if ($rbacsystem->checkAccess("read", $a_ref_id)) {
143  return true;
144  } else {
145  return false;
146  }
147  }

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: