ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilPoolSelectorGUI Class Reference

Select media pool for adding objects into pages. More...

+ Inheritance diagram for ilPoolSelectorGUI:
+ Collaboration diagram for ilPoolSelectorGUI:

Public Member Functions

 __construct ( $a_parent_obj, $a_parent_cmd, $a_selection_gui=null, $a_selection_cmd="insert", $a_selection_subcmd="selectPool", $a_selection_par="pool_ref_id")
 Constructor. More...
 
 getNodeHref ($a_node)
 Get href for node. More...
 
 isNodeVisible ($a_node)
 Is node visible. More...
 
- Public Member Functions inherited from ilRepositorySelectorExplorerGUI
 __construct ( $a_parent_obj, $a_parent_cmd, $a_selection_gui=null, $a_selection_cmd="selectObject", $a_selection_par="sel_ref_id", $a_id="rep_exp_sel")
 Constructor. More...
 
 setNodeContentModifier (callable $a_val)
 Set node content modifier. More...
 
 getNodeContentModifier ()
 Get node content modifier. More...
 
 getNodeContent ($a_node)
 Get node content. More...
 
 getNodeIcon ($a_node)
 Get node icon. More...
 
 getNodeIconAlt ($a_node)
 Get node icon alt text. More...
 
 isNodeHighlighted ($a_node)
 Is node highlighted? More...
 
 getNodeHref ($a_node)
 Get href for node. More...
 
 isNodeVisible ($a_node)
 Is node visible. More...
 
 sortChilds ($a_childs, $a_parent_node_id)
 Sort childs. More...
 
 getChildsOfNode ($a_parent_node_id)
 Get childs of node. More...
 
 isNodeClickable ($a_node)
 Is node clickable? More...
 
 setHighlightedNode ($a_value)
 set an alternate highlighted node if $_GET["ref_id"] is not set or wrong More...
 
 getHighlightedNode ()
 get an alternate highlighted node if $_GET["ref_id"] is not set or wrong Returns null if not set More...
 
 setClickableTypes ($a_types)
 set Whitelist for clickable items More...
 
 getClickableTypes ()
 get whitelist for clickable items More...
 
 setSelectableTypes ($a_types)
 Get HTML. More...
 
 getSelectableTypes ()
 get whitelist for clickable items More...
 
- Public Member Functions inherited from ilTreeExplorerGUI
 __construct ($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree)
 Constructor. More...
 
 getTree ()
 Get tree. More...
 
 setOrderField ($a_val, $a_numeric=false)
 Set order field. More...
 
 getOrderField ()
 Get order field. More...
 
 setTypeWhiteList ($a_val)
 Set type white list. More...
 
 getTypeWhiteList ()
 Get type white list. More...
 
 setTypeBlackList ($a_val)
 Set type black list. More...
 
 getTypeBlackList ()
 Get type black list. More...
 
 setPreloadChilds ($a_val)
 Set preload childs. More...
 
 getPreloadChilds ()
 Get preload childs. More...
 
 getSuccessorNode ($a_node_id, $a_type="")
 Get successor node (currently only(!) based on lft/rgt tree values) More...
 
 getChildsOfNode ($a_parent_node_id)
 Get childs of node. More...
 
 getNodeId ($a_node)
 Get id for node. More...
 
 getNodeIconAlt ($a_node)
 Get node icon alt attribute. More...
 
 getRootNode ()
 Get root node. More...
 
 setRootId ($a_root)
 
 setPathOpen ($a_id)
 Set node path to be opened. More...
 
 getHTML ()
 Get HTML. More...
 
- Public Member Functions inherited from ilExplorerBaseGUI
 __construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
 Constructor. More...
 
 setChildLimit ($a_val)
 Set child limit. More...
 
 getChildLimit ()
 Get child limit. More...
 
 setSearchTerm ($a_val)
 Set search term. More...
 
 getSearchTerm ()
 Get search term. More...
 
 setMainTemplate (ilTemplate $a_main_tpl=null)
 Set main template (that is responsible for adding js/css) More...
 
 getRootNode ()
 Get root node. More...
 
 getChildsOfNode ($a_parent_node_id)
 Get childs of node. More...
 
 getNodeContent ($a_node)
 Get content of a node. More...
 
 getNodeId ($a_node)
 Get id of a node. More...
 
 getNodeHref ($a_node)
 Get href for node. More...
 
 nodeHasVisibleChilds ($a_node)
 Node has childs? More...
 
 sortChilds ($a_childs, $a_parent_node_id)
 Sort childs. More...
 
 getNodeIcon ($a_node)
 Get node icon path. More...
 
 getNodeIconAlt ($a_node)
 Get node icon alt attribute. More...
 
 getNodeTarget ($a_node)
 Get node target (frame) attribute. More...
 
 getNodeOnClick ($a_node)
 Get node onclick attribute. More...
 
 isNodeVisible ($a_node)
 Is node visible? More...
 
 isNodeHighlighted ($a_node)
 Is node highlighted? More...
 
 isNodeClickable ($a_node)
 Is node clickable? More...
 
 getId ()
 Get id of explorer element. More...
 
 setSkipRootNode ($a_val)
 Set skip root node. More...
 
 getSkipRootNode ()
 Get skip root node. More...
 
 setAjax ($a_val)
 Set ajax. More...
 
 getAjax ()
 Get ajax. More...
 
 setSecondaryHighlightedNodes ($a_val)
 Set secondary (background) highlighted nodes. More...
 
 getSecondaryHighlightedNodes ()
 Get secondary (background) highlighted nodes. More...
 
 setNodeOpen ($a_id)
 Set node to be opened (additional custom opened node, not standard expand behaviour) More...
 
 setSelectMode ($a_postvar, $a_multi=false)
 Set select mode (to deactivate, pass an empty string as postvar) More...
 
 setNodeSelected ($a_id)
 Set node to be opened (additional custom opened node, not standard expand behaviour) More...
 
 setOfflineMode ($a_val)
 Set offline mode. More...
 
 getOfflineMode ()
 Get offline mode. More...
 
 handleCommand ()
 Handle explorer internal command. More...
 
 getContainerId ()
 Get container id. More...
 
 openNode ()
 Open node. More...
 
 closeNode ()
 Close node. More...
 
 getNodeAsync ()
 Get node asynchronously. More...
 
 beforeRendering ()
 Before rendering. More...
 
 getOnLoadCode ()
 Get on load code. More...
 
 getHTML ()
 Get HTML. More...
 
 renderNode ($a_node, $tpl)
 Render node. More...
 
 renderChilds ($a_node_id, $tpl)
 Render childs. More...
 
 getDomNodeIdForNodeId ($a_node_id)
 Get DOM node id for node id. More...
 
 getNodeIdForDomNodeId ($a_dom_node_id)
 Get node id for dom node id. More...
 
 listItemStart ($tpl, $a_node)
 List item start. More...
 
 listItemEnd ($tpl)
 List item end. More...
 
 listStart ($tpl)
 List start. More...
 
 listEnd ($tpl)
 List end. More...
 
 isNodeOnclickEnabled ()
 
 setNodeOnclickEnabled ($nodeOnclickEnabled)
 
 isEnableDnd ()
 
 setEnableDnd ($enable_dnd)
 Enable Drag & Drop functionality. More...
 

Protected Attributes

 $clickable_types = array()
 
 $selection_subcmd = ""
 
- Protected Attributes inherited from ilRepositorySelectorExplorerGUI
 $obj_definition
 
 $lng
 
 $type_grps = array()
 
 $session_materials = array()
 
 $highlighted_node = null
 
 $clickable_types = array()
 
 $ctrl
 
 $access
 
 $nc_modifier = null
 
 $selection_gui = null
 
 $selection_par
 
 $selection_cmd
 
- Protected Attributes inherited from ilTreeExplorerGUI
 $lng
 
 $tree = null
 
 $order_field = ""
 
 $order_field_numeric = false
 
 $type_white_list = array()
 
 $type_black_list = array()
 
 $childs = array()
 
 $preloaded = false
 
 $preload_childs = false
 
 $root_node_data = null
 
 $all_childs = array()
 
- Protected Attributes inherited from ilExplorerBaseGUI
 $log
 
 $ctrl
 
 $tpl
 
 $skip_root_node = false
 
 $ajax = false
 
 $custom_open_nodes = array()
 
 $selected_nodes = array()
 
 $select_postvar = ""
 
 $offline_mode = false
 
 $sec_highl_nodes = array()
 
 $enable_dnd = false
 
 $search_term = ""
 
 $child_limit = 0
 

Additional Inherited Members

- Static Public Member Functions inherited from ilExplorerBaseGUI
static getLocalExplorerJsPath ()
 Get local path of explorer js. More...
 
static getLocalJsTreeJsPath ()
 Get local path of jsTree js. More...
 
static getLocalJsTreeCssPath ()
 Get local path of jsTree js. More...
 
static createHTMLExportDirs ($a_target_dir)
 Create html export directories. More...
 
static init ($a_main_tpl=null)
 Init JS. More...
 
- Protected Member Functions inherited from ilRepositorySelectorExplorerGUI
 isNodeSelectable ($a_node)
 Is node selectable? More...
 
- Protected Member Functions inherited from ilTreeExplorerGUI
 preloadChilds ()
 Preload childs. More...
 
 matches ($node)
 Does a node match a search term (or is search term empty) More...
 
 getRootId ()
 
- Protected Member Functions inherited from ilExplorerBaseGUI
 isNodeSelectable ($a_node)
 Is node selectable? More...
 
 getNodeToggleOnClick ($a_node)
 Get onclick attribute for node toggling. More...
 
 getSelectOnClick ($a_node)
 Get onclick attribute for selecting radio/checkbox. More...
 
 isNodeOpen ($node_id)
 Get all open nodes. More...
 
 getJSTreePlugins ()
 
- Static Protected Attributes inherited from ilExplorerBaseGUI
static $js_tree_path = "./libs/bower/bower_components/jstree/dist/jstree.js"
 
static $js_tree_path_css = "./libs/bower/bower_components/jstree/dist/themes/default/style.min.css"
 
static $js_expl_path = "./Services/UIComponent/Explorer2/js/Explorer2.js"
 

Detailed Description

Select media pool for adding objects into pages.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 15 of file class.ilPoolSelectorGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPoolSelectorGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
  $a_selection_gui = null,
  $a_selection_cmd = "insert",
  $a_selection_subcmd = "selectPool",
  $a_selection_par = "pool_ref_id" 
)

Constructor.

Parameters
object$a_parent_obj
string$a_parent_cmd
object$a_selection_gui
string$a_selection_cmd
string$a_selection_par

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

References $DIC, and ilExplorerBaseGUI\setAjax().

37  {
38  global $DIC;
39 
40  $this->ctrl = $DIC->ctrl();
41  if ($a_selection_gui == null) {
42  $a_selection_gui = $a_parent_obj;
43  }
44 
45  $this->selection_subcmd = $a_selection_subcmd;
46  parent::__construct(
47  $a_parent_obj,
48  $a_parent_cmd,
49  $a_selection_gui,
50  $a_selection_cmd,
51  $a_selection_par
52  );
53 
54  $this->setAjax(true);
55  }
global $DIC
Definition: saml.php:7
+ Here is the call graph for this function:

Member Function Documentation

◆ getNodeHref()

ilPoolSelectorGUI::getNodeHref (   $a_node)

Get href for node.

Parameters
mixed$a_nodenode object/array
Returns
string href attribute

Definition at line 63 of file class.ilPoolSelectorGUI.php.

References ilRepositorySelectorExplorerGUI\$ctrl, and $ilCtrl.

64  {
66 
67  $ilCtrl->setParameterByClass($this->selection_gui, "subCmd", $this->selection_subcmd);
68  $link = parent::getNodeHref($a_node);
69  $ilCtrl->setParameterByClass($this->selection_gui, "subCmd", "");
70  return $link;
71  }
global $ilCtrl
Definition: ilias.php:18

◆ isNodeVisible()

ilPoolSelectorGUI::isNodeVisible (   $a_node)

Is node visible.

Parameters
array$a_nodenode data
Returns
bool visible true/false

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

References ilObjQuestionPool\_lookupOnline(), ilRepositorySelectorExplorerGUI\getChildsOfNode(), and ilRepositorySelectorExplorerGUI\isNodeClickable().

80  {
81  if (parent::isNodeVisible($a_node)) {
82  //hide empty container
83  if (count($this->getChildsOfNode($a_node["child"])) > 0 || $this->isNodeClickable($a_node)) {
84  // #16523
85  if ($a_node["type"] == "qpl") {
86  include_once "Modules/TestQuestionPool/classes/class.ilObjQuestionPool.php";
87  return ilObjQuestionPool::_lookupOnline($a_node["obj_id"]);
88  }
89 
90  return true;
91  }
92  }
93 
94  return false;
95  }
static _lookupOnline($a_obj_id, $is_reference=false)
getChildsOfNode($a_parent_node_id)
Get childs of node.
+ Here is the call graph for this function:

Field Documentation

◆ $clickable_types

ilPoolSelectorGUI::$clickable_types = array()
protected

Definition at line 17 of file class.ilPoolSelectorGUI.php.

◆ $selection_subcmd

ilPoolSelectorGUI::$selection_subcmd = ""
protected

Definition at line 18 of file class.ilPoolSelectorGUI.php.


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