ilRepositoryCopySelector Class Reference

Inheritance diagram for ilRepositoryCopySelector:

Collaboration diagram for ilRepositoryCopySelector:

Public Member Functions
	ilRepositoryCopySelector ($a_target)
	Constructor public.
	setSelectableType ($a_type)
	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)
	check if links for certain object type are activated
	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 ($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 (
	formatHeader (&$tpl, $a_obj_id, $a_option)
	Creates output for header (is empty here but can be overwritten in derived classes)
	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
	buildOnClick ($a_node_id, $a_type, $a_title)
	get onclick event handling (may be overwritten by derived classes)
	buildTitle ($a_title, $a_id, $a_type)
	standard implementation for title, may be overwritten by derived classes
	buildDescription ($a_desc, $a_id, $a_type)
	standard implementation for description, may be overwritten by derived classes
	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
	$root_id
	$output
	$ctrl
	$selectable_type
	$ref_id
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

Definition at line 34 of file class.ilRepositoryCopySelector.php.

Member Function Documentation

ilRepositoryCopySelector::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 105 of file class.ilRepositoryCopySelector.php.

        {
                return '';
        }

ilRepositoryCopySelector::buildLinkTarget	(		$a_node_id,
			$a_type
	)

get link target (may be overwritten by derived classes)

Reimplemented from ilExplorer.

Definition at line 90 of file class.ilRepositoryCopySelector.php.

        {
                if($a_type == $this->selectable_type)
                {
                        $this->ctrl->setParameterByClass('ilrepositorygui','source_id',$a_node_id);
                        return $this->ctrl->getLinkTargetByClass('ilrepositorygui','copyChilds');
                }
                else
                {
                        $this->ctrl->setParameterByClass('ilrepositorygui',"ref_id",$this->ref_id);
                        return $this->ctrl->getLinkTargetByClass('ilrepositorygui','copySelector');
                }

        }

ilRepositoryCopySelector::formatHeader	(		$a_obj_id,
			$a_option
	)

overwritten method from base class public

Parameters

integer	obj_id
integer	array options

Returns

string

Definition at line 142 of file class.ilRepositoryCopySelector.php.

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

        {
                global $lng, $ilias;

                $tpl = new ilTemplate("tpl.tree.html", true, true, "Services/UIComponent/Explorer");

                $tpl->setCurrentBlock("text");
                $tpl->setVariable("OBJ_TITLE", $lng->txt("repository"));
                $tpl->parseCurrentBlock();

                $tpl->setCurrentBlock("row");
                $tpl->parseCurrentBlock();

                $this->output[] = $tpl->get();
        }

ilRepositoryCopySelector::ilRepositoryCopySelector

(

$a_target

)

Constructor public.

Parameters

string	scriptname
int	user_id

Definition at line 54 of file class.ilRepositoryCopySelector.php.

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

        {
                global $tree,$ilCtrl;

                $this->ctrl = $ilCtrl;

                parent::ilExplorer($a_target);
                $this->tree = $tree;
                $this->root_id = $this->tree->readRootId();
                $this->order_column = "title";

                $this->setSessionExpandVariable("rep_copy_expand");

                // add here all container objects
                $this->addFilter("root");
                $this->addFilter("cat");
                $this->addFilter("grp");
                $this->addFilter("fold");
                $this->addFilter("crs");

                $this->setFilterMode(IL_FM_POSITIVE);
                $this->setFiltered(true);
                
                $this->setTitleLength(ilObject::TITLE_LENGTH);
        }

Here is the call graph for this function:

ilRepositoryCopySelector::isClickable	(		$a_type,
			$a_ref_id
	)

check if links for certain object type are activated

Parameters

string

$a_type

object type

Returns

boolean true if linking is activated

Reimplemented from ilExplorer.

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

References $ref_id.

        {
                return $a_type == $this->selectable_type and $a_ref_id != $this->ref_id;
        }

ilRepositoryCopySelector::setRefId

(

$a_ref_id

)

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

        {
                $this->ref_id = $a_ref_id;
        }

ilRepositoryCopySelector::setSelectableType

(

$a_type

)

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

        {
                $this->selectable_type  = $a_type;
        }

ilRepositoryCopySelector::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 115 of file class.ilRepositoryCopySelector.php.

        {
                global $rbacsystem;

                if ($a_ref_id == 0)
                {
                        return true;
                }

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

Field Documentation

ilRepositoryCopySelector::$ctrl

Definition at line 44 of file class.ilRepositoryCopySelector.php.

ilRepositoryCopySelector::$output

Definition at line 43 of file class.ilRepositoryCopySelector.php.

ilRepositoryCopySelector::$ref_id

Definition at line 47 of file class.ilRepositoryCopySelector.php.

Referenced by isClickable().

ilRepositoryCopySelector::$root_id

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

ilRepositoryCopySelector::$selectable_type

Definition at line 46 of file class.ilRepositoryCopySelector.php.

---

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

• Services/Repository/classes/class.ilRepositoryCopySelector.php