ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilSolutionExplorer Class Reference
+ Inheritance diagram for ilSolutionExplorer:
+ Collaboration diagram for ilSolutionExplorer:

Public Member Functions

 __construct ($a_target, $a_target_class)
 Constructor @access public. More...
 
 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...
 
 isClickable ($a_type, $a_ref_id=0)
 check if links for certain object type are activated 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...
 
- Public Member Functions inherited from ilExplorer
 __construct ($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
 
 $target_class
 
- 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 16 of file class.ilSolutionExplorer.php.

Constructor & Destructor Documentation

◆ __construct()

ilSolutionExplorer::__construct (   $a_target,
  $a_target_class 
)

Constructor @access public.

Parameters
stringtarget

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

38 {
39 global $DIC;
40 $tree = $DIC['tree'];
41 $ilCtrl = $DIC['ilCtrl'];
42
43 $this->ctrl = $ilCtrl;
44 $this->target_class = $a_target_class;
45 parent::__construct($a_target);
46 $this->tree = $tree;
47 $this->root_id = $this->tree->readRootId();
48 $this->order_column = "title";
49
50 $this->setSessionExpandVariable("expand_sol");
51
52 // add here all container objects
53 $this->addFilter("root");
54 $this->addFilter("cat");
55 $this->addFilter("grp");
56 $this->addFilter("fold");
57 $this->addFilter("crs");
58
60 $this->setFiltered(true);
61 }
const IL_FM_POSITIVE
setSessionExpandVariable($a_var_name="expand")
set name of expand session variable
addFilter($a_item)
adds item to the filter @access public
setFilterMode($a_mode=IL_FM_NEGATIVE)
set filter mode
setFiltered($a_bool)
active/deactivate the filter @access public
global $ilCtrl
Definition: ilias.php:18
global $DIC
Definition: saml.php:7

References $DIC, $ilCtrl, ilExplorer\$tree, ilExplorer\addFilter(), IL_FM_POSITIVE, ilExplorer\setFiltered(), ilExplorer\setFilterMode(), and ilExplorer\setSessionExpandVariable().

+ Here is the call graph for this function:

Member Function Documentation

◆ buildFrameTarget()

ilSolutionExplorer::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 109 of file class.ilSolutionExplorer.php.

110 {
111 return '';
112 }

◆ buildLinkTarget()

ilSolutionExplorer::buildLinkTarget (   $a_node_id,
  $a_type 
)

get link target (may be overwritten by derived classes)

Reimplemented from ilExplorer.

Definition at line 98 of file class.ilSolutionExplorer.php.

99 {
100 if ($a_type == $this->selectable_type) {
101 $this->ctrl->setParameterByClass($this->target_class, 'source_id', $a_node_id);
102 return $this->ctrl->getLinkTargetByClass($this->target_class, 'linkChilds');
103 } else {
104 $this->ctrl->setParameterByClass($this->target_class, "ref_id", $this->ref_id);
105 return $this->ctrl->getLinkTargetByClass($this->target_class, 'addSolutionHint');
106 }
107 }
$a_type
Definition: workflow.php:92

References $a_type.

◆ isClickable()

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

check if links for certain object type are activated

Parameters
string$a_typeobject type
Returns
boolean true if linking is activated

Reimplemented from ilExplorer.

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

115 {
116 return $a_type == $this->selectable_type and $a_ref_id != $this->ref_id;
117 }

References $a_type, and $ref_id.

◆ setRefId()

ilSolutionExplorer::setRefId (   $a_ref_id)

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

93 {
94 $this->ref_id = $a_ref_id;
95 }

◆ setSelectableType()

ilSolutionExplorer::setSelectableType (   $a_type)

Definition at line 88 of file class.ilSolutionExplorer.php.

89 {
90 $this->selectable_type = $a_type;
91 }

References $a_type.

◆ showChilds()

ilSolutionExplorer::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 119 of file class.ilSolutionExplorer.php.

120 {
121 global $DIC;
122 $rbacsystem = $DIC['rbacsystem'];
123
124 if ($a_ref_id == 0) {
125 return true;
126 }
127
128 if ($rbacsystem->checkAccess("read", $a_ref_id)) {
129 return true;
130 } else {
131 return false;
132 }
133 }

References $DIC, and ilExplorer\$rbacsystem.

Field Documentation

◆ $ctrl

ilSolutionExplorer::$ctrl

Definition at line 26 of file class.ilSolutionExplorer.php.

◆ $output

ilSolutionExplorer::$output

Definition at line 25 of file class.ilSolutionExplorer.php.

◆ $ref_id

ilSolutionExplorer::$ref_id

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

Referenced by isClickable().

◆ $root_id

ilSolutionExplorer::$root_id

Definition at line 24 of file class.ilSolutionExplorer.php.

◆ $selectable_type

ilSolutionExplorer::$selectable_type

Definition at line 28 of file class.ilSolutionExplorer.php.

◆ $target_class

ilSolutionExplorer::$target_class

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


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