Class ilAsyncContainerSelectionExplorer A class for a async ilContainerSelectionExplorer which triggers a "async_explorer-add_reference" event on the body when clicking a node. More...

Inheritance diagram for ilAsyncContainerSelectionExplorer:

Collaboration diagram for ilAsyncContainerSelectionExplorer:

Public Member Functions
	__construct ($a_target)

	buildOnClick ($a_node_id, $a_type, $a_title)
	Creates the onclick function call. More...

	buildLinkTarget ($a_node_id, $a_type)
	Sets the href-value to a void js call. More...

	getOutput ()
	Returns the explorer html and adds the javascripts to the template. More...

	initJs ()

	addJsConf ($key, $value)
	Adds additional js to the onload code of the async explorer. More...

	getJsConf ($key)
	Returns a certain setting of the additional configuration. More...

Public Member Functions inherited from ilContainerSelectionExplorer
	__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 @access public More...

Public Member Functions inherited from ilExplorer
	ilExplorer ($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...

Static Public Member Functions
static	addJavascript ()
	Adds the javascript to template. More...

Protected Member Functions
	addOnLoadCode ($id, $content)
	Adds onload code to the template. More...

Protected Attributes
	$tpl

Protected Attributes inherited from ilContainerSelectionExplorer
	$target_type

Static Protected Attributes
static	$js_conf

static	$js_on_load_added = array()

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

Class ilAsyncContainerSelectionExplorer A class for a async ilContainerSelectionExplorer which triggers a "async_explorer-add_reference" event on the body when clicking a node.

Author: Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: 1.0.0

Definition at line 11 of file class.ilAsyncContainerSelectionExplorer.php.

Constructor & Destructor Documentation

◆ __construct()

ilAsyncContainerSelectionExplorer::__construct ( $a_target )

Parameters

$a_target url for the onclick event of a node

Reimplemented from ilContainerSelectionExplorer.

Definition at line 32 of file class.ilAsyncContainerSelectionExplorer.php.

                                               {
                parent::__construct($a_target);
 
                global $tpl;
                $this->tpl = $tpl;
 
                $this->addJsConf('save_explorer_url', $a_target);
        }

References $tpl, and addJsConf().

Here is the call graph for this function:

Member Function Documentation

◆ addJavascript()

static ilAsyncContainerSelectionExplorer::addJavascript ( )

static

Adds the javascript to template.

Definition at line 45 of file class.ilAsyncContainerSelectionExplorer.php.

                                               {
                global $tpl;
 
                $tpl->addJavaScript("./Services/UIComponent/Explorer/js/ilExplorer.js");
        }

References $tpl.

Referenced by ilObjStudyProgrammeTreeGUI\initAsyncUIElements().

Here is the caller graph for this function:

◆ addJsConf()

ilAsyncContainerSelectionExplorer::addJsConf	(	$key,
		$value
	)

Adds additional js to the onload code of the async explorer.

Parameters

array $js_conf

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

                                                {
                $this->js_conf[$key] = $value;
        }

Referenced by __construct().

Here is the caller graph for this function:

◆ addOnLoadCode()

ilAsyncContainerSelectionExplorer::addOnLoadCode	(	$id,
		$content
	)

protected

Adds onload code to the template.

Parameters

$id
$content

Definition at line 109 of file class.ilAsyncContainerSelectionExplorer.php.

                                                        {
                global $tpl;
 
                if(!isset(self::$js_on_load_added[$id])) {
                        $tpl->addOnLoadCode($content);
                        self::$js_on_load_added[$id] = $content;
                }
        }

References ilExplorer\$id, and $tpl.

Referenced by initJs().

Here is the caller graph for this function:

◆ buildLinkTarget()

ilAsyncContainerSelectionExplorer::buildLinkTarget	(	$a_node_id,
		$a_type
	)

Sets the href-value to a void js call.

Parameters

$a_node_id
$a_type

Returns: string

Reimplemented from ilExplorer.

Definition at line 78 of file class.ilAsyncContainerSelectionExplorer.php.

        {
                return "javascript:void(0);";
        }

◆ buildOnClick()

ilAsyncContainerSelectionExplorer::buildOnClick	(	$a_node_id,
		$a_type,
		$a_title
	)

Creates the onclick function call.

Parameters

$a_node_id
$a_type
$a_title

Returns: string

Reimplemented from ilExplorer.

Definition at line 61 of file class.ilAsyncContainerSelectionExplorer.php.

        {
                $ref_id = (int) $_GET['ref_id'];
                if($ref_id) {
                        return "$('body').trigger('async_explorer-add_reference', {target_id: '".$a_node_id."', type: '".$a_type."', parent_id: '".$ref_id."'});";
                }
        }

References $_GET, and $ref_id.

◆ getJsConf()

ilAsyncContainerSelectionExplorer::getJsConf ( $key )

Returns a certain setting of the additional configuration.

Returns: string

Definition at line 132 of file class.ilAsyncContainerSelectionExplorer.php.

                                        {
                return $this->js_conf[$key];
        }

◆ getOutput()

ilAsyncContainerSelectionExplorer::getOutput ( )

Returns the explorer html and adds the javascripts to the template.

Returns: string

Reimplemented from ilExplorer.

Definition at line 89 of file class.ilAsyncContainerSelectionExplorer.php.

                                    {
                self::initJs();
 
                return parent::getOutput();
        }

References initJs().

Here is the call graph for this function:

◆ initJs()

ilAsyncContainerSelectionExplorer::initJs ( )

Definition at line 99 of file class.ilAsyncContainerSelectionExplorer.php.

                                 {
                self::addOnLoadCode('explorer', '$("#'.$this->getId().'").study_programme_async_explorer('.json_encode($this->js_conf).');');
        }