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.
	getNodeHref ($a_node)
	Get href for node.
	isNodeVisible ($a_node)
	Is node visible.
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")
	Constructor.
	getNodeContent ($a_node)
	Get node content.
	getNodeIcon ($a_node)
	Get node icon.
	getNodeIconAlt ($a_node)
	Get node icon alt text.
	isNodeHighlighted ($a_node)
	Is node highlighted?
	sortChilds ($a_childs, $a_parent_node_id)
	Sort childs.
	getChildsOfNode ($a_parent_node_id)
	Get childs of node.
	isNodeClickable ($a_node)
	Is node clickable?
	setHighlightedNode ($a_value)
	set an alternate highlighted node if $_GET["ref_id"] is not set or wrong
	getHighlightedNode ()
	get an alternate highlighted node if $_GET["ref_id"] is not set or wrong Returns null if not set
	setClickableTypes ($a_types)
	set Whitelist for clickable items
	getClickableTypes ()
	get whitelist for clickable items
Public Member Functions inherited from ilTreeExplorerGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree)
	Constructor.
	getTree ()
	Get tree.
	setOrderField ($a_val, $a_numeric=false)
	Set order field.
	getOrderField ()
	Get order field.
	setTypeWhiteList ($a_val)
	Set type white list.
	getTypeWhiteList ()
	Get type white list.
	setTypeBlackList ($a_val)
	Set type black list.
	getTypeBlackList ()
	Get type black list.
	setPreloadChilds ($a_val)
	Set preload childs.
	getPreloadChilds ()
	Get preload childs.
	getSuccessorNode ($a_node_id, $a_type="")
	Get successor node (currently only(!) based on lft/rgt tree values)
	getNodeId ($a_node)
	Get id for node.
	getRootNode ()
	Get root node.
	setPathOpen ($a_id)
	Set node path to be opened.
	getHTML ()
	Get HTML.
Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor.
	nodeHasVisibleChilds ($a_node)
	Node has childs?
	getNodeTarget ($a_node)
	Get node target (frame) attribute.
	getNodeOnClick ($a_node)
	Get node onclick attribute.
	getId ()
	Get id of explorer element.
	setSkipRootNode ($a_val)
	Set skip root node.
	getSkipRootNode ()
	Get skip root node.
	setAjax ($a_val)
	Set ajax.
	getAjax ()
	Get ajax.
	setSecondaryHighlightedNodes ($a_val)
	Set secondary (background) highlighted nodes.
	getSecondaryHighlightedNodes ()
	Get secondary (background) highlighted nodes.
	setNodeOpen ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour)
	setSelectMode ($a_postvar, $a_multi=false)
	Set select mode (to deactivate, pass an empty string as postvar)
	setNodeSelected ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour)
	setOfflineMode ($a_val)
	Set offline mode.
	getOfflineMode ()
	Get offline mode.
	handleCommand ()
	Handle explorer internal command.
	getContainerId ()
	Get container id.
	openNode ()
	Open node.
	closeNode ()
	Close node.
	getNodeAsync ()
	Get node asynchronously.
	beforeRendering ()
	Before rendering.
	getOnLoadCode ()
	Get on load code.
	renderNode ($a_node, $tpl)
	Render node.
	renderChilds ($a_node_id, $tpl)
	Render childs.
	getDomNodeIdForNodeId ($a_node_id)
	Get DOM node id for node id.
	getNodeIdForDomNodeId ($a_dom_node_id)
	Get node id for dom node id.
	listItemStart ($tpl, $a_node)
	List item start.
	listItemEnd ($tpl)
	List item end.
	listStart ($tpl)
	List start.
	listEnd ($tpl)
	List end.

Protected Attributes
	$clickable_types = array()
	$selection_subcmd = ""
Protected Attributes inherited from ilRepositorySelectorExplorerGUI
	$type_grps = array()
	$session_materials = array()
	$highlighted_node = null
	$clickable_types = array()
Protected Attributes inherited from ilTreeExplorerGUI
	$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
	$skip_root_node = false
	$ajax = false
	$custom_open_nodes = array()
	$selected_nodes = array()
	$select_postvar = ""
	$offline_mode = false
	$sec_highl_nodes = array()

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()
	Get local path of explorer js.
static	getLocalJsTreeJsPath ()
	Get local path of jsTree js.
static	createHTMLExportDirs ($a_target_dir)
	Create html export directories.
static	init ()
	Init JS.
Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()
	Preload childs.
Static Protected Attributes inherited from ilExplorerBaseGUI
static	$js_tree_path = "./Services/UIComponent/Explorer2/lib/jstree-v.pre1.0/jquery.jstree.js"
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

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 ilExplorerBaseGUI\setAjax().

        {
                if($a_selection_gui == null)
                {
                        $a_selection_gui = $a_parent_obj;
                }

                $this->selection_subcmd = $a_selection_subcmd;
                parent::__construct($a_parent_obj, $a_parent_cmd, $a_selection_gui, $a_selection_cmd,
                        $a_selection_par);

                $this->setAjax(true);
        }

Here is the call graph for this function:

Member Function Documentation

ilPoolSelectorGUI::getNodeHref

(

$a_node

)

Get href for node.

Parameters

mixed

$a_node

node object/array

Returns

string href attribute

Reimplemented from ilRepositorySelectorExplorerGUI.

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

References $ilCtrl.

        {
                global $ilCtrl;
                
                $ilCtrl->setParameterByClass($this->selection_gui, "subCmd", $this->selection_subcmd);
                $link = parent::getNodeHref($a_node);
                $ilCtrl->setParameterByClass($this->selection_gui, "subCmd", "");
                return $link;
        }

ilPoolSelectorGUI::isNodeVisible

(

$a_node

)

Is node visible.

Parameters

array

$a_node

node data

Returns

bool visible true/false

Reimplemented from ilRepositorySelectorExplorerGUI.

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

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

        {
                if(parent::isNodeVisible($a_node))
                {                       
                        //hide empty container
                        if(count($this->getChildsOfNode($a_node["child"]))>0 || $this->isNodeClickable($a_node))
                        {
                                // #16523
                                if($a_node["type"] == "qpl")
                                {
                                        include_once "Modules/TestQuestionPool/classes/class.ilObjQuestionPool.php";
                                        return ilObjQuestionPool::_lookupOnline($a_node["obj_id"]);
                                }

                                return true;
                        }
                }
                
                return false;
                
        }

Here is the call graph for this function:

Field Documentation

ilPoolSelectorGUI::$clickable_types = array()

protected

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

ilPoolSelectorGUI::$selection_subcmd = ""

protected

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

---

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

• Services/COPage/classes/class.ilPoolSelectorGUI.php