ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
ilContainerSelectionExplorer Class Reference
+ Inheritance diagram for ilContainerSelectionExplorer:
+ Collaboration diagram for ilContainerSelectionExplorer:

Public Member Functions

 __construct ($a_target)
 Constructor. More...
 
 setTargetType ($a_type)
 set target type More...
 
 getTargetType ()
 get target type More...
 
 isClickable ($a_type, $a_id)
 check if item is clickable More...
 
 isVisible ($a_ref_id, $a_type)
 Visible permission is sufficient. More...
 
 formatHeader ($a_obj_id, $a_option)
 overwritten method from base class public More...
 
- Public Member Functions inherited from ilExplorer
 ilExplorer ($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...
 

Protected Attributes

 $target_type
 

Additional Inherited Members

- Data Fields inherited from ilExplorer
 $id
 
 $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

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilContainerSelectionExplorer::__construct (   $a_target)

Constructor.

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

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

43  {
44  global $tree;
45 
46  parent::__construct($a_target);
47 
48  $this->tree = $tree;
49  $this->root_id = $this->tree->readRootId();
50  $this->order_column = "title";
51 
52  $this->setSessionExpandVariable("ref_repexpand");
53 
54 
55  $this->addFilter("root");
56  $this->addFilter("cat");
57  #$this->addFilter("grp");
58  #$this->addFilter("fold");
59  $this->addFilter("crs");
60 
62  $this->setFiltered(true);
64 
65  $this->checkPermissions(true);
66 
67  }
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
checkPermissions($a_check)
check permissions via rbac
setFiltered($a_bool)
active/deactivate the filter public
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

◆ formatHeader()

ilContainerSelectionExplorer::formatHeader (   $a_obj_id,
  $a_option 
)

overwritten method from base class public

Parameters
integerobj_id
integerarray options
Returns
string

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

References ilExplorer\$ilias, $lng, and $tpl.

129  {
130  global $lng, $ilias;
131 
132  $tpl = new ilTemplate("tpl.tree.html", true, true, "Services/UIComponent/Explorer");
133 
134  $tpl->setCurrentBlock("text");
135  $tpl->setVariable("OBJ_TITLE", $lng->txt("repository"));
136  $tpl->parseCurrentBlock();
137 
138  /*
139  $tpl->setCurrentBlock("row");
140  $tpl->parseCurrentBlock();
141  */
142 
143  $this->output[] = $tpl->get();
144  }
global $tpl
Definition: ilias.php:8
special template class to simplify handling of ITX/PEAR
global $lng
Definition: privfeed.php:40

◆ getTargetType()

ilContainerSelectionExplorer::getTargetType ( )

get target type

Parameters

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

References $target_type.

Referenced by isClickable().

+ Here is the caller graph for this function:

◆ isClickable()

ilContainerSelectionExplorer::isClickable (   $a_type,
  $a_id 
)

check if item is clickable

Parameters

Definition at line 94 of file class.ilContainerSelectionExplorer.php.

References getTargetType().

95  {
96  global $ilAccess;
97 
98  if($this->getTargetType() == $a_type)
99  {
100  if($ilAccess->checkAccess('visible','',$a_id))
101  {
102  return true;
103  }
104  }
105  return FALSE;
106  }
+ Here is the call graph for this function:

◆ isVisible()

ilContainerSelectionExplorer::isVisible (   $a_ref_id,
  $a_type 
)

Visible permission is sufficient.

Parameters
type$a_ref_id
type$a_type
Returns
type

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

115  {
116  global $ilAccess;
117 
118  return $ilAccess->checkAccess('visible','',$a_ref_id);
119  }

◆ setTargetType()

ilContainerSelectionExplorer::setTargetType (   $a_type)

set target type

Parameters

Definition at line 74 of file class.ilContainerSelectionExplorer.php.

75  {
76  $this->target_type = $a_type;
77  }

Field Documentation

◆ $target_type

ilContainerSelectionExplorer::$target_type
protected

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

Referenced by getTargetType().


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