ILIAS  release_8 Revision v8.23
ilSolutionExplorer Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

+ Inheritance diagram for ilSolutionExplorer:
+ Collaboration diagram for ilSolutionExplorer:

Public Member Functions

 __construct ($a_target, $a_target_class)
 Constructor public. More...
 
 setSelectableType ($a_type)
 
 setRefId ($a_ref_id)
 
 buildLinkTarget ($a_node_id, string $a_type)
 
 buildFrameTarget (string $a_type, $a_child=0, $a_obj_id=0)
 
 isClickable (string $type, int $ref_id=0)
 
 showChilds ($a_parent_id)
 
- 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...
 

Data Fields

 $root_id
 
 $ctrl
 
 $selectable_type
 
 $ref_id
 
 $target_class
 
- 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
 

Additional Inherited Members

- Protected Member Functions inherited from ilExplorer
 requestStr (string $key)
 
- 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
 

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Constructor & Destructor Documentation

◆ __construct()

ilSolutionExplorer::__construct (   $a_target,
  $a_target_class 
)

Constructor public.

Parameters
stringtarget

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

References $DIC, $path, $ref_id, ilExplorer\$tree, ILIAS\GlobalScreen\Provider\__construct(), ilExplorer\addFilter(), ILIAS\Repository\ctrl(), ilSession\get(), ilTree\getPathId(), IL_FM_POSITIVE, ilTree\readRootId(), ilSession\set(), ilExplorer\setFiltered(), ilExplorer\setFilterMode(), and ilExplorer\setSessionExpandVariable().

50  {
51  global $DIC;
52  $tree = $DIC['tree'];
53  $ilCtrl = $DIC['ilCtrl'];
54 
55  $this->ctrl = $ilCtrl;
56  $this->target_class = $a_target_class;
57  parent::__construct($a_target);
58  $this->tree = $tree;
59  $this->root_id = $this->tree->readRootId();
60  $this->order_column = "title";
61 
62  $this->setSessionExpandVariable("expand_sol");
63 
64  // add here all container objects
65  $this->addFilter("root");
66  $this->addFilter("cat");
67  $this->addFilter("grp");
68  $this->addFilter("fold");
69  $this->addFilter("crs");
70 
72  $this->setFiltered(true);
73  }
setSessionExpandVariable(string $a_var_name="expand")
setFiltered(bool $a_bool)
const IL_FM_POSITIVE
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
global $DIC
Definition: feed.php:28
__construct(Container $dic, ilPlugin $plugin)
addFilter(string $a_item)
setFilterMode(int $a_mode=IL_FM_NEGATIVE)
+ Here is the call graph for this function:

Member Function Documentation

◆ buildFrameTarget()

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

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

123  : string
124  {
125  return '';
126  }

◆ buildLinkTarget()

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

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

References ILIAS\Repository\ctrl().

112  : string
113  {
114  if ($a_type == $this->selectable_type) {
115  $this->ctrl->setParameterByClass($this->target_class, 'source_id', $a_node_id);
116  return $this->ctrl->getLinkTargetByClass($this->target_class, 'linkChilds');
117  } else {
118  $this->ctrl->setParameterByClass($this->target_class, "ref_id", $this->ref_id);
119  return $this->ctrl->getLinkTargetByClass($this->target_class, 'addSolutionHint');
120  }
121  }
+ Here is the call graph for this function:

◆ isClickable()

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

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

References $ref_id.

128  : bool
129  {
130  return $type == $this->selectable_type && $ref_id !== $this->ref_id;
131  }
$type

◆ setRefId()

ilSolutionExplorer::setRefId (   $a_ref_id)

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

106  : void
107  {
108  $this->ref_id = $a_ref_id;
109  }

◆ setSelectableType()

ilSolutionExplorer::setSelectableType (   $a_type)

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

102  : void
103  {
104  $this->selectable_type = $a_type;
105  }

◆ showChilds()

ilSolutionExplorer::showChilds (   $a_parent_id)

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

References $DIC, ilExplorer\$rbacsystem, and ilRbacSystem\checkAccess().

133  : bool
134  {
135  global $DIC;
136  $rbacsystem = $DIC['rbacsystem'];
137 
138  if ($a_parent_id == 0) {
139  return true;
140  }
141 
142  if ($rbacsystem->checkAccess("read", $a_parent_id)) {
143  return true;
144  } else {
145  return false;
146  }
147  }
ilRbacSystem $rbacsystem
global $DIC
Definition: feed.php:28
checkAccess(string $a_operations, int $a_ref_id, string $a_type="")
checkAccess represents the main method of the RBAC-system in ILIAS3 developers want to use With this ...
+ Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilSolutionExplorer::$ctrl

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

◆ $ref_id

ilSolutionExplorer::$ref_id

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

Referenced by __construct(), and isClickable().

◆ $root_id

ilSolutionExplorer::$root_id

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

◆ $selectable_type

ilSolutionExplorer::$selectable_type

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

◆ $target_class

ilSolutionExplorer::$target_class

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


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