ilPasteIntoMultipleItemsExplorer Class Reference

Inheritance diagram for ilPasteIntoMultipleItemsExplorer:

Collaboration diagram for ilPasteIntoMultipleItemsExplorer:

Public Member Functions
	__construct ($a_type, $a_target, $a_session_variable)
	Constructor @access public. More...
	isClickable ($a_type, $a_ref_id, $a_obj_id=0)
	addFormItemForType ($type)
	removeFormItemForType ($type)
	setCheckedItems ($a_checked_items=array())
	isItemChecked ($a_id)
	setPostVar ($a_post_var)
	getPostVar ()
	setRequiredFormItemPermission ($a_form_item_permission)
	Set required perission for form item visibility. More...
	getRequiredFormItemPermission ()
	Get required permission. More...
	buildFormItem ($a_node_id, $a_type)
	formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
	Creates output recursive method @access private. More...
	formatHeader (&$tpl, $a_obj_id, $a_option)
	overwritten method from base class @access public More...
	showChilds ($a_ref_id, $a_obj_id=0)
Public Member Functions inherited from ilRepositoryExplorer
	ilRepositoryExplorer ($a_target, $a_top_node=0)
	Constructor @access public. More...
	setForceOpenPath ($a_path)
	set force open path More...
	buildLinkTarget ($a_node_id, $a_type)
	note: most of this stuff is used by ilCourseContentInterface too More...
	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	STATIC, do not use $this inside! More...
	getImage ($a_name, $a_type="", $a_obj_id="")
	get image path More...
	isClickable ($a_type, $a_ref_id, $a_obj_id=0)
	showChilds ($a_ref_id, $a_obj_id=0)
	isVisible ($a_ref_id, $a_type)
	formatHeader (&$tpl, $a_obj_id, $a_option)
	overwritten method from base class @access public More...
	sortNodes ($a_nodes, $a_parent_obj_id)
	sort nodes More...
	forceExpanded ($a_node)
	Force expansion of node. 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...

Data Fields
const	SEL_TYPE_CHECK = 1
const	SEL_TYPE_RADIO = 2
	$root_id = 0
	$output = ''
	$ctrl = null
Data Fields inherited from ilRepositoryExplorer
	$root_id
	$output
	$ctrl
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

Private Attributes
	$checked_items = array()
	$post_var = ''
	$form_items = array()
	$form_item_permission = 'read'
	$type = 0

Detailed Description

Definition at line 12 of file class.ilPasteIntoMultipleItemsExplorer.php.

Constructor & Destructor Documentation

__construct()

ilPasteIntoMultipleItemsExplorer::__construct	(		$a_type,
			$a_target,
			$a_session_variable
	)

Constructor @access public.

Parameters

string	$a_target	scriptname
string	$a_session_variable	session_variable

Definition at line 33 of file class.ilPasteIntoMultipleItemsExplorer.php.

        {
                global $tree, $ilCtrl;
 
                $this->setId("cont_paste_explorer");
                
                $this->ctrl = $ilCtrl;
                $this->type = $a_type;
 
                parent::__construct($a_target);
                $this->tree = $tree;
                $this->root_id = $this->tree->readRootId();
                $this->order_column = 'title';
                $this->setSessionExpandVariable($a_session_variable);
                
                // reset filter
                $this->filter = array();
                
                $this->addFilter('root');
                $this->addFilter('crs');                                
                $this->addFilter('grp');
                $this->addFilter('cat');                
                $this->addFilter('fold');
                
                $this->addFormItemForType('root');
                $this->addFormItemForType('crs');
                $this->addFormItemForType('grp');
                $this->addFormItemForType('cat');
                $this->addFormItemForType('fold');
                
                $this->setFiltered(true);
                $this->setFilterMode(IL_FM_POSITIVE);
        }

References $ilCtrl, ilExplorer\$tree, ilExplorer\addFilter(), addFormItemForType(), IL_FM_POSITIVE, ilExplorer\setFiltered(), ilExplorer\setFilterMode(), ilExplorer\setId(), and ilExplorer\setSessionExpandVariable().

Here is the call graph for this function:

Member Function Documentation

addFormItemForType()

ilPasteIntoMultipleItemsExplorer::addFormItemForType

(

$type

)

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

        {
                $this->form_items[$type] = true;
        }

References $type.

Referenced by __construct().

Here is the caller graph for this function:

buildFormItem()

ilPasteIntoMultipleItemsExplorer::buildFormItem	(		$a_node_id,
			$a_type
	)

Definition at line 117 of file class.ilPasteIntoMultipleItemsExplorer.php.

        {
                // permission check 
                if(!$GLOBALS['ilAccess']->checkAccess($this->getRequiredFormItemPermission(),'',$a_node_id))
                {
                        return '';
                }
                
                if(
                                !array_key_exists($a_type, $this->form_items) || 
                                !$this->form_items[$a_type]
                )
                {
                        return '';
                }
                
                $disabled = false;
                if(is_array($_SESSION["clipboard"]["ref_ids"]))
                {
                        $disabled = in_array($a_node_id, $_SESSION["clipboard"]["ref_ids"]);
                }
                else if((int)$_SESSION["clipboard"]["ref_ids"])
                {
                        $disabled = $a_node_id == $_SESSION["clipboard"]["ref_ids"];
                }
                else if($_SESSION["clipboard"]["cmd"] == 'copy' && $a_node_id == $_SESSION["clipboard"]["parent"])
                {
                        $disabled = true;       
                }
 
                switch($this->type)
                {
                        case self::SEL_TYPE_CHECK:
                                return ilUtil::formCheckbox((int)$this->isItemChecked($a_node_id), $this->post_var, $a_node_id, $disabled);
                                break;
                                
                        case self::SEL_TYPE_RADIO:
                                return ilUtil::formRadioButton((int)$this->isItemChecked($a_node_id), $this->post_var, $a_node_id, '', $disabled);
                                break;
                }       
        }

References $_SESSION, $GLOBALS, ilUtil\formCheckbox(), ilUtil\formRadioButton(), getRequiredFormItemPermission(), isItemChecked(), SEL_TYPE_CHECK, and SEL_TYPE_RADIO.

Referenced by formatHeader(), and formatObject().

Here is the call graph for this function:

Here is the caller graph for this function:

formatHeader()

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

overwritten method from base class @access public

Parameters

integer	obj_id
integer	array options

Returns

string

Reimplemented from ilRepositoryExplorer.

Definition at line 284 of file class.ilPasteIntoMultipleItemsExplorer.php.

        {
                global $lng, $ilias, $tree;
 
                // custom icons
                $path = ilObject::_getIcon($a_obj_id, "tiny", "root");
                
 
                $tpl->setCurrentBlock("icon");
                $nd = $tree->getNodeData(ROOT_FOLDER_ID);
                $title = $nd["title"];
                if ($title == "ILIAS")
                {
                        $title = $lng->txt("repository");
                }
 
                $tpl->setVariable("ICON_IMAGE", $path);
                $tpl->setVariable("TXT_ALT_IMG", $title);
                $tpl->parseCurrentBlock();              
 
                if(strlen($formItem = $this->buildFormItem($a_obj_id, $a_option['type'])))
                {
                        $tpl->setCurrentBlock('check');
                        $tpl->setVariable('OBJ_CHECK', $formItem);
                        $tpl->parseCurrentBlock();
                }
                
                $tpl->setVariable('OBJ_TITLE', $title);
        }

References ilExplorer\$ilias, $lng, $nd, $path, $tpl, ilExplorer\$tree, ilObject\_getIcon(), and buildFormItem().

Here is the call graph for this function:

formatObject()

ilPasteIntoMultipleItemsExplorer::formatObject	(	&	$tpl,
			$a_node_id,
			$a_option,
			$a_obj_id = 0
	)

Creates output recursive method @access private.

Parameters

integer
array

Returns

string

Reimplemented from ilExplorer.

Definition at line 159 of file class.ilPasteIntoMultipleItemsExplorer.php.

        {               
                global $lng;
                
                if (!isset($a_node_id) or !is_array($a_option))
                {
                        $this->ilias->raiseError(get_class($this)."::formatObject(): Missing parameter or wrong datatype! ".
                                                                        "node_id: ".$a_node_id." options:".var_dump($a_option),$this->ilias->error_obj->WARNING);
                }
 
                $pic = false;
                foreach ($a_option["tab"] as $picture)
                {
                        if ($picture == 'plus')
                        {
                                $tpl->setCurrentBlock("expander");
                                $tpl->setVariable("EXP_DESC", $lng->txt("expand"));
                                $target = $this->createTarget('+',$a_node_id);
                                $tpl->setVariable("LINK_NAME", $a_node_id);
                                $tpl->setVariable("LINK_TARGET_EXPANDER", $target);
                                $tpl->setVariable("IMGPATH", $this->getImage("browser/plus.png"));
                                $tpl->parseCurrentBlock();
                                $pic = true;
                        }
 
                        if ($picture == 'minus' && $this->show_minus)
                        {
                                $tpl->setCurrentBlock("expander");
                                $tpl->setVariable("EXP_DESC", $lng->txt("collapse"));
                                $target = $this->createTarget('-',$a_node_id);
                                $tpl->setVariable("LINK_NAME", $a_node_id);
                                $tpl->setVariable("LINK_TARGET_EXPANDER", $target);
                                $tpl->setVariable("IMGPATH", $this->getImage("browser/minus.png"));
                                $tpl->parseCurrentBlock();
                                $pic = true;
                        }
                }
                
                if (!$pic)
                {
                        $tpl->setCurrentBlock("blank");
                        $tpl->setVariable("BLANK_PATH", $this->getImage("browser/blank.png"));
                        $tpl->parseCurrentBlock();
                }
 
                if ($this->output_icons)
                {
                        $tpl->setCurrentBlock("icon");
                        
                        $path = ilObject::_getIcon($a_obj_id, "tiny", $a_option["type"]);
                        $tpl->setVariable("ICON_IMAGE", $path);
                        
                        $tpl->setVariable("TARGET_ID" , "iconid_".$a_node_id);
                        $this->iconList[] = "iconid_".$a_node_id;
                        $tpl->setVariable("TXT_ALT_IMG", $lng->txt($a_option["desc"]));
                        $tpl->parseCurrentBlock();
                }               
                
                if(strlen($formItem = $this->buildFormItem($a_node_id, $a_option['type'])))
                {
                        $tpl->setCurrentBlock('check');
                        $tpl->setVariable('OBJ_CHECK', $formItem);
                        $tpl->parseCurrentBlock();
                }
 
                if ($this->isClickable($a_option["type"], $a_node_id,$a_obj_id))        // output link
                {
                        $tpl->setCurrentBlock("link");
                        //$target = (strpos($this->target, "?") === false) ?
                        //      $this->target."?" : $this->target."&";
                        //$tpl->setVariable("LINK_TARGET", $target.$this->target_get."=".$a_node_id.$this->params_get);
                        $tpl->setVariable("LINK_TARGET", $this->buildLinkTarget($a_node_id, $a_option["type"]));
                                
                        $style_class = $this->getNodeStyleClass($a_node_id, $a_option["type"]);
                        
                        if ($style_class != "")
                        {
                                $tpl->setVariable("A_CLASS", ' class="'.$style_class.'" ' );
                        }
 
                        if (($onclick = $this->buildOnClick($a_node_id, $a_option["type"], $a_option["title"])) != "")
                        {
                                $tpl->setVariable("ONCLICK", "onClick=\"$onclick\"");
                        }
 
                        $tpl->setVariable("LINK_NAME", $a_node_id);
                        $tpl->setVariable("TITLE", $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"]));
                        $tpl->setVariable("DESC", ilUtil::shortenText(
                                $this->buildDescription($a_option["description"], $a_node_id, $a_option["type"]), $this->textwidth, true));
                        $frame_target = $this->buildFrameTarget($a_option["type"], $a_node_id, $a_option["obj_id"]);
                        if ($frame_target != "")
                        {
                                $tpl->setVariable("TARGET", " target=\"".$frame_target."\"");
                        }
                        $tpl->parseCurrentBlock();
                }
                else                    // output text only
                {
                        $obj_title = $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"]);
                        
                        // highlight current node
                        if($a_node_id == $this->highlighted)
                        {
                                $obj_title = "<span class=\"ilHighlighted\">".$obj_title."</span>";
                        }
                        
                        $tpl->setCurrentBlock("text");
                        $tpl->setVariable("OBJ_TITLE", $obj_title);
                        $tpl->setVariable("OBJ_DESC", ilUtil::shortenText(
                                $this->buildDescription($a_option["desc"], $a_node_id, $a_option["type"]), $this->textwidth, true));                    
                        $tpl->parseCurrentBlock();
                }
 
                $tpl->setCurrentBlock("list_item");
                $tpl->parseCurrentBlock();
                $tpl->touchBlock("element");
        }

References $lng, $path, ilExplorer\$target, $tpl, ilObject\_getIcon(), ilExplorer\buildDescription(), buildFormItem(), ilRepositoryExplorer\buildFrameTarget(), ilRepositoryExplorer\buildLinkTarget(), ilExplorer\buildOnClick(), ilExplorer\buildTitle(), ilExplorer\createTarget(), ilRepositoryExplorer\getImage(), ilExplorer\getNodeStyleClass(), isClickable(), and ilUtil\shortenText().

Here is the call graph for this function:

getPostVar()

ilPasteIntoMultipleItemsExplorer::getPostVar

(

)

Definition at line 92 of file class.ilPasteIntoMultipleItemsExplorer.php.

        {
                return $this->post_var;
        }

References $post_var.

getRequiredFormItemPermission()

ilPasteIntoMultipleItemsExplorer::getRequiredFormItemPermission

(

)

Get required permission.

Returns

string

Definition at line 112 of file class.ilPasteIntoMultipleItemsExplorer.php.

        {
                return $this->form_item_permission;
        }

References $form_item_permission.

Referenced by buildFormItem().

Here is the caller graph for this function:

isClickable()

ilPasteIntoMultipleItemsExplorer::isClickable	(		$a_type,
			$a_ref_id,
			$a_obj_id = 0
	)

Reimplemented from ilRepositoryExplorer.

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

        {
                return false;
        }       

Referenced by formatObject().

Here is the caller graph for this function:

isItemChecked()

ilPasteIntoMultipleItemsExplorer::isItemChecked

(

$a_id

)

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

        {
                return in_array($a_id, $this->checked_items) ? true : false;
        }

Referenced by buildFormItem().

Here is the caller graph for this function:

removeFormItemForType()

ilPasteIntoMultipleItemsExplorer::removeFormItemForType

(

$type

)

Definition at line 76 of file class.ilPasteIntoMultipleItemsExplorer.php.

        {
                $this->form_items[$type] = false;
        }

References $type.

setCheckedItems()

ilPasteIntoMultipleItemsExplorer::setCheckedItems

(

$a_checked_items = array()

)

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

        {
                $this->checked_items = $a_checked_items;
        }       

setPostVar()

ilPasteIntoMultipleItemsExplorer::setPostVar

(

$a_post_var

)

Definition at line 88 of file class.ilPasteIntoMultipleItemsExplorer.php.

        {
                $this->post_var = $a_post_var;
        }

setRequiredFormItemPermission()

ilPasteIntoMultipleItemsExplorer::setRequiredFormItemPermission

(

$a_form_item_permission

)

Set required perission for form item visibility.

Parameters

type	$a_node_id
type	$a_type

Returns

string

Definition at line 103 of file class.ilPasteIntoMultipleItemsExplorer.php.

        {
                $this->form_item_permission = $a_form_item_permission;
        }

showChilds()

ilPasteIntoMultipleItemsExplorer::showChilds	(		$a_ref_id,
			$a_obj_id = 0
	)

Reimplemented from ilRepositoryExplorer.

Definition at line 314 of file class.ilPasteIntoMultipleItemsExplorer.php.

        {
                global $ilAccess;
 
                if ($a_ref_id == 0)
                {
                        return true;
                }
                // #11778 - ilAccessHandler::doConditionCheck()
                if ($ilAccess->checkAccess("read", "", $a_ref_id))
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

Field Documentation

$checked_items

ilPasteIntoMultipleItemsExplorer::$checked_items = array()

private

Definition at line 21 of file class.ilPasteIntoMultipleItemsExplorer.php.

$ctrl

ilPasteIntoMultipleItemsExplorer::$ctrl = null

Definition at line 19 of file class.ilPasteIntoMultipleItemsExplorer.php.

$form_item_permission

ilPasteIntoMultipleItemsExplorer::$form_item_permission = 'read'

private

Definition at line 24 of file class.ilPasteIntoMultipleItemsExplorer.php.

Referenced by getRequiredFormItemPermission().

$form_items

ilPasteIntoMultipleItemsExplorer::$form_items = array()

private

Definition at line 23 of file class.ilPasteIntoMultipleItemsExplorer.php.

$output

ilPasteIntoMultipleItemsExplorer::$output = ''

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

$post_var

ilPasteIntoMultipleItemsExplorer::$post_var = ''

private

Definition at line 22 of file class.ilPasteIntoMultipleItemsExplorer.php.

Referenced by getPostVar().

$root_id

ilPasteIntoMultipleItemsExplorer::$root_id = 0

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

$type

ilPasteIntoMultipleItemsExplorer::$type = 0

private

Definition at line 25 of file class.ilPasteIntoMultipleItemsExplorer.php.

Referenced by addFormItemForType(), and removeFormItemForType().

SEL_TYPE_CHECK

const ilPasteIntoMultipleItemsExplorer::SEL_TYPE_CHECK = 1

Definition at line 14 of file class.ilPasteIntoMultipleItemsExplorer.php.

Referenced by buildFormItem().

SEL_TYPE_RADIO

const ilPasteIntoMultipleItemsExplorer::SEL_TYPE_RADIO = 2

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

Referenced by buildFormItem(), ilObjWorkspaceFolderGUI\showMoveIntoObjectTree(), and ilObjectCopyGUI\showSourceSelectionTree().

---

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

• Services/Object/classes/class.ilPasteIntoMultipleItemsExplorer.php