Internal Link: Repository Item Selector Explorer. More...

Inheritance diagram for ilIntLinkRepItemExplorer:

Collaboration diagram for ilIntLinkRepItemExplorer:

Public Member Functions
	ilLMMenuObjectSelector ($a_target)
	Constructor public.
	setSelectableTypes ($a_types)
	setMode ($a_mode)
	setSetLinkTargetScript ($a_script)
	Set "set link target" script.
	getSetLinkTargetScript ()
	Get "set link target" script.
	setRefId ($a_ref_id)
	buildLinkTarget ($a_node_id, $a_type)
	get link target (may be overwritten by derived classes)
	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	get frame target (may be overwritten by derived classes)
	isClickable ($a_type, $a_ref_id)
	return if item is clickable
	buildTitle ($a_title, $a_id, $a_type)
	build item title
	buildDescription ($a_desc, $a_id, $a_type)
	standard implementation for description, may be overwritten by derived classes
	buildOnClick ($a_node_id, $a_type, $a_title)
	get onclick event handling
	showChilds ($a_ref_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.
	formatHeader (&$tpl, $a_obj_id, $a_option)
	overwritten method from base class public
Public Member Functions inherited from ilExplorer
	ilExplorer ($a_target)
	Constructor public.
	setId ($a_val)
	Set id.
	getId ()
	Get id.
	setAsynchExpanding ($a_val)
	Set asynch expanding.
	getAsynchExpanding ()
	Get asynch expanding.
	initItemCounter ($a_number)
	Init item counter.
	setTitle ($a_val)
	Set title.
	setTitleLength ($a_length)
	Set max title length.
	getTitleLength ()
	Get max title length.
	getTitle ()
	Get title.
	setRoot ($a_root_id)
	Set root node.
	getRoot ()
	get root id
	setOrderColumn ($a_column)
	set the order column public
	setOrderDirection ($a_direction)
	set the order direction public
	setTargetGet ($a_target_get)
	set the varname in Get-string public
	setParamsGet ($a_params_get)
	set additional params to be passed in Get-string public
	setExpandTarget ($a_exp_target)
	target script for expand icons
	setFrameUpdater ($a_up_frame, $a_up_script, $a_params="")
	Set Explorer Updater.
	highlightNode ($a_id)
	set highlighted node
	checkPermissions ($a_check)
	check permissions via rbac
	setSessionExpandVariable ($a_var_name="expand")
	set name of expand session variable
	outputIcons ($a_icons)
	output icons
	setClickable ($a_type, $a_clickable)
	(de-)activates links for a certain object type
	isVisible ($a_ref_id, $a_type)
	setTreeLead ($a_val)
	Set tree leading content.
	getTreeLead ()
	Get tree leading content.
	setPostSort ($a_sort)
	process post sorting
	setFilterMode ($a_mode=IL_FM_NEGATIVE)
	set filter mode
	getFilterMode ()
	get filter mode
	setUseStandardFrame ($a_val)
	Set use standard frame.
	getUseStandardFrame ()
	Get use standard explorer frame.
	getChildsOfNode ($a_parent_id)
	Get childs of node.
	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.
	modifyChilds ($a_parent_id, $a_objects)
	forceExpanded ($a_obj_id)
	force expansion of node
	getMaximumTreeDepth ()
	Get maximum tree depth.
	getOutput ()
	Creates output recursive method public.
	handleListEndTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list end tags ( and )
	handleListStartTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list start tags (
	formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
	Creates output recursive method private.
	getImage ($a_name, $a_type="", $a_obj_id="")
	get image path (may be overwritten by derived classes)
	getImageAlt ($a_default_text, $a_type="", $a_obj_id="")
	get image alt text
	getNodeStyleClass ($a_id, $a_type)
	get style class for node
	buildSelect ($a_node_id, $a_type)
	standard implementation for adding an option select box between image and title
	createTarget ($a_type, $a_node_id, $a_highlighted_subtree=false, $a_append_anch=true)
	Creates Get Parameter private.
	setFrameTarget ($a_target)
	set target frame or not frame?
	createLines ($a_depth)
	Creates lines for explorer view private.
	is_in_array ($a_start, $a_depth)
	DESCRIPTION MISSING private.
	getIndex ($a_data)
	get index of format_options array from specific ref_id,parent_id private
	addFilter ($a_item)
	adds item to the filter public
	delFilter ($a_item)
	removes item from the filter public
	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
	forceExpandAll ($a_mode, $a_show_minus=true)
	force expandAll.
	setFiltered ($a_bool)
	active/deactivate the filter public
	checkFilter ($a_item)
	check if item is in filter private
	sortNodes ($a_nodes, $a_parent_obj_id)
	sort nodes and put adm object to the end of sorted array private

Data Fields
	$mode = "text"
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

Internal Link: Repository Item Selector Explorer.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

Id:: class.ilIntLinkRepItemExplorer.php 37171 2012-09-25 20:30:02Z akill

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

Member Function Documentation

ilIntLinkRepItemExplorer::buildDescription	(	$a_desc,
		$a_id,
		$a_type
	)

standard implementation for description, may be overwritten by derived classes

Reimplemented from ilExplorer.

Definition at line 152 of file class.ilIntLinkRepItemExplorer.php.

References $ilUser.

        {
                global $ilUser;
                
                if ($ilUser->getPref("ilPageEditor_JavaScript") != "enable" &&
                        $this->mode != "asynch")
                {
                        if (in_array($a_type,$this->selectable_types))
                        {
                                if ($this->mode != "link")
                                {
                                        return "[iln ".$a_type."=\"$a_id\"] [/iln]";
                                }
                        }
                }
                return "";
        }

ilIntLinkRepItemExplorer::buildFrameTarget	(	$a_type,
		$a_child = `0`,
		$a_obj_id = `0`
	)

get frame target (may be overwritten by derived classes)

Reimplemented from ilExplorer.

Definition at line 110 of file class.ilIntLinkRepItemExplorer.php.

        {
                if ($this->mode == "link")
                {
//                      return "content";
                }
                else
                {
                        return '';
                }
        }

ilIntLinkRepItemExplorer::buildLinkTarget	(	$a_node_id,
		$a_type
	)

get link target (may be overwritten by derived classes)

Reimplemented from ilExplorer.

Definition at line 91 of file class.ilIntLinkRepItemExplorer.php.

References ilUtil\appendUrlParameterString(), and getSetLinkTargetScript().

        {
                if ($this->getSetLinkTargetScript() == "")
                {
                        return "#";
                }
                else
                {
                        //$tpl->setVariable("LINK_TARGET", "content");
                        $link =
                                ilUtil::appendUrlParameterString($this->getSetLinkTargetScript(),
                                "linktype=RepositoryItem".
                                "&linktarget=il__".$a_type."_".$a_node_id);
                        return ($link);
                }
        }

Here is the call graph for this function:

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

get onclick event handling

Reimplemented from ilExplorer.

Definition at line 173 of file class.ilIntLinkRepItemExplorer.php.

References getSetLinkTargetScript().

        {
                if ($this->getSetLinkTargetScript() == "")
                {
                        return "return il.IntLink.addInternalLink('[iln ".$a_type."=&quot;".$a_node_id."&quot;]','[/iln]', event);";
                }
//              else
//              {
//                      return "parent.content.addInternalLink('[iln ".$a_type."=&quot;".$a_node_id."&quot;] [/iln]','".$a_title."');setTimeout('window.close()',300);return(false);";
//              }
        }

Here is the call graph for this function:

ilIntLinkRepItemExplorer::buildTitle	(	$a_title,
		$a_id,
		$a_type
	)

build item title

Reimplemented from ilExplorer.

Definition at line 144 of file class.ilIntLinkRepItemExplorer.php.

        {
                return $a_title;
        }

ilIntLinkRepItemExplorer::formatHeader	(	&	$tpl,
			$a_obj_id,
			$a_option
	)

overwritten method from base class public

Parameters

integer	obj_id
integer	array options

Returns: string

Reimplemented from ilExplorer.

Definition at line 214 of file class.ilIntLinkRepItemExplorer.php.

References ilExplorer\$ilias, $lng, $tpl, and ilUtil\getImagePath().

        {
                global $lng, $ilias;
                
                $tpl->setCurrentBlock("icon");
                $tpl->setVariable("ICON_IMAGE" , ilUtil::getImagePath("icon_root_s.png"));
                $tpl->setVariable("TXT_ALT_IMG", $lng->txt("repository"));
                $tpl->parseCurrentBlock();
                $tpl->setCurrentBlock("text");
                $tpl->setVariable("OBJ_TITLE", $lng->txt("repository"));
                $tpl->parseCurrentBlock();
                //$tpl->setCurrentBlock("row");
                //$tpl->parseCurrentBlock();
                
                $tpl->touchBlock("element");
                
        }

Here is the call graph for this function:

ilIntLinkRepItemExplorer::getSetLinkTargetScript ( )

Get "set link target" script.

Definition at line 80 of file class.ilIntLinkRepItemExplorer.php.

Referenced by buildLinkTarget(), and buildOnClick().

        {
                return $this->link_target_script;
        }

Here is the caller graph for this function:

ilIntLinkRepItemExplorer::ilLMMenuObjectSelector ( $a_target )

Constructor public.

Parameters

string	scriptname
int	user_id

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

References $ilCtrl, ilExplorer\$tree, and ilExplorer\ilExplorer().

        {
                global $tree,$ilCtrl;
                $this->ctrl =& $ilCtrl;
                parent::ilExplorer($a_target);
        }

Here is the call graph for this function:

ilIntLinkRepItemExplorer::isClickable	(	$a_type,
		$a_ref_id
	)

return if item is clickable

Reimplemented from ilExplorer.

Definition at line 125 of file class.ilIntLinkRepItemExplorer.php.

References $ilUser.

        {
                global $ilUser;
                if ($ilUser->getPref("ilPageEditor_JavaScript") != "enable"
                        && $this->mode != "link" && $this->mode != "asynch")
                {
                        return false;
                }
                else
                {
                        return in_array($a_type,$this->selectable_types);
                }
        }

ilIntLinkRepItemExplorer::setMode ( $a_mode )

Definition at line 58 of file class.ilIntLinkRepItemExplorer.php.

References ilExplorer\setAsynchExpanding().

        {
                $this->mode  = $a_mode;
                if ($this->mode == "asynch")
                {
                        $this->setAsynchExpanding(true);
                }
        }

Here is the call graph for this function:

ilIntLinkRepItemExplorer::setRefId ( $a_ref_id )

Definition at line 86 of file class.ilIntLinkRepItemExplorer.php.

        {
                $this->ref_id = $a_ref_id;
        }

ilIntLinkRepItemExplorer::setSelectableTypes ( $a_types )

Definition at line 53 of file class.ilIntLinkRepItemExplorer.php.

        {
                $this->selectable_types  = $a_types;
        }

ilIntLinkRepItemExplorer::setSetLinkTargetScript ( $a_script )

Set "set link target" script.

Parameters

<type> $a_script

Definition at line 72 of file class.ilIntLinkRepItemExplorer.php.

        {
                $this->link_target_script = $a_script;
        }

ilIntLinkRepItemExplorer::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.

ilRepositoryExplorerGUI)

Reimplemented from ilExplorer.

Definition at line 187 of file class.ilIntLinkRepItemExplorer.php.

        {
                global $rbacsystem;
                if ($a_ref_id == 0)
                {
                        return true;
                }
                if ($rbacsystem->checkAccess("read", $a_ref_id))
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

Field Documentation

ilIntLinkRepItemExplorer::$mode = "text"

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

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

Modules/LearningModule/classes/class.ilIntLinkRepItemExplorer.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation