ilWorkspaceExplorer Class Reference

Inheritance diagram for ilWorkspaceExplorer:

Collaboration diagram for ilWorkspaceExplorer:

Public Member Functions
	__construct ($a_type, $a_target, $a_session_variable, ilWorkspaceTree $a_tree, ilWorkspaceAccessHandler $a_access_handler)
	Constructor public.
	showChilds ($a_ref_id, $a_obj_id=0)
	isVisible ($a_ref_id, $a_type)
	sortNodes ($a_nodes, $a_parent_obj_id)
	sort nodes
	isClickable ($a_type, $a_ref_id, $a_obj_id=0)
	addFormItemForType ($type)
	removeFormItemForType ($type)
	removeAllFormItemTypes ()
	setCheckedItems ($a_checked_items=array())
	isItemChecked ($a_id)
	setPostVar ($a_post_var)
	getPostVar ()
	buildFormItem ($a_node_id, $a_type)
	formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
	Creates output recursive method private.
	formatHeader (&$tpl, $a_obj_id, $a_option)
	overwritten method from base class public
	setTypeClickable ($a_type)
	setCustomLinkTarget ($a_target)
	buildLinkTarget ($a_node_id, $a_type)
	note: most of this stuff is used by ilCourseContentInterface too
Public Member Functions inherited from ilRepositoryExplorer
	ilRepositoryExplorer ($a_target, $a_top_node=0)
	Constructor public.
	setForceOpenPath ($a_path)
	set force open path
	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	STATIC, do not use $this inside!
	getImage ($a_name, $a_type="", $a_obj_id="")
	get image path
	forceExpanded ($a_node)
	Force expansion of node.
	buildTitle ($a_title, $a_id, $a_type)
	standard implementation for title, may be overwritten by derived classes
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
	setTreeLead ($a_val)
	Set tree leading content.
	getTreeLead ()
	Get tree leading content.
	isClickable ($a_type, $a_ref_id=0)
	check if links for certain object type are activated
	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)
	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.
	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 (
	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)
	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

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

Protected Attributes
	$clickable = array()
	$custom_link_target

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

Detailed Description

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

Constructor & Destructor Documentation

ilWorkspaceExplorer::__construct	(		$a_type,
			$a_target,
			$a_session_variable,
		ilWorkspaceTree	$a_tree,
		ilWorkspaceAccessHandler	$a_access_handler
	)

Constructor public.

Parameters

string	$a_target	scriptname
string	$a_session_variable	session_variable
ilWorkspaceTree	$a_tree	workspace tree
ilWorkspaceAccessHandler	$a_access_handler	workspace access handler

Definition at line 38 of file class.ilWorkspaceExplorer.php.

References $ilCtrl, $root_id, ilExplorer\addFilter(), addFormItemForType(), ilTree\addTree(), ilWorkspaceTree\createReference(), ilObjectFactory\getClassByType(), ilTree\getTreeId(), IL_FM_POSITIVE, ilTree\readRootId(), ilExplorer\setFiltered(), ilExplorer\setFilterMode(), ilTree\setRootId(), and ilExplorer\setSessionExpandVariable().

        {
                global $ilCtrl;

                $this->ctrl = $ilCtrl;
                $this->type = $a_type;
                $this->access = $a_access_handler;

                parent::__construct($a_target);
                
                // #11173
                if(!$a_tree->readRootId())
                {
                        // create (workspace) root folder
                        $root = ilObjectFactory::getClassByType("wsrt");
                        $root = new $root(null);
                        $root->create();

                        $root_id = $a_tree->createReference($root->getId());
                        $a_tree->addTree($a_tree->getTreeId(), $root_id);
                        $a_tree->setRootId($root_id);
                }               
                
                $this->tree = $a_tree;
                $this->root_id = $this->tree->readRootId();
                $this->order_column = 'title';
                $this->setSessionExpandVariable($a_session_variable);
                
                // reset filter
                $this->filter = array();
                
                $this->addFilter('wsrt');
                $this->addFilter('wfld');
                
                $this->addFormItemForType('wsrt');
                $this->addFormItemForType('wfld');
                
                $this->setFiltered(true);
                $this->setFilterMode(IL_FM_POSITIVE);
        }

Here is the call graph for this function:

Member Function Documentation

ilWorkspaceExplorer::addFormItemForType

(

$type

)

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

References $type.

Referenced by __construct().

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

Here is the caller graph for this function:

ilWorkspaceExplorer::buildFormItem	(		$a_node_id,
			$a_type
	)

Definition at line 138 of file class.ilWorkspaceExplorer.php.

References ilUtil\formCheckbox(), ilUtil\formRadioButton(), and isItemChecked().

Referenced by formatHeader(), and formatObject().

        {
                if(!array_key_exists($a_type, $this->form_items) || !$this->form_items[$a_type])
                {
                        return;
                }

                switch($this->type)
                {
                        case self::SEL_TYPE_CHECK:
                                return ilUtil::formCheckbox((int)$this->isItemChecked($a_node_id), $this->post_var, $a_node_id);
                                
                        case self::SEL_TYPE_RADIO:
                                return ilUtil::formRadioButton((int)$this->isItemChecked($a_node_id), $this->post_var, $a_node_id);
                }       
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilWorkspaceExplorer::buildLinkTarget	(		$a_node_id,
			$a_type
	)

note: most of this stuff is used by ilCourseContentInterface too

Reimplemented from ilRepositoryExplorer.

Definition at line 316 of file class.ilWorkspaceExplorer.php.

Referenced by formatObject().

        {
                if(!$this->custom_link_target)
                {
                        return parent::buildLinkTarget($a_node_id, $a_type);
                }
                
                $link = $this->custom_link_target."&".$this->target_get."=".$a_node_id;
                return $link;           
        }

Here is the caller graph for this function:

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

overwritten method from base class public

Parameters

integer	obj_id
integer	array options

Returns

string

Reimplemented from ilRepositoryExplorer.

Definition at line 277 of file class.ilWorkspaceExplorer.php.

References $lng, $path, $title, $tpl, ilObject\_getIcon(), and buildFormItem().

        {
                global $lng;
                
                // custom icons
                $path = ilObject::_getIcon($a_obj_id, "small", "wsrt");
                
                $tpl->setCurrentBlock("icon");
                $title = $this->tree->getNodeData($this->root_id);
                $title = $title["title"];
                if(!$title)
                {
                        $title = $lng->txt("personal_workspace");
                }

                $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);
        }

Here is the call graph for this function:

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

Creates output recursive method private.

Parameters

integer
array

Returns

string

Reimplemented from ilExplorer.

Definition at line 155 of file class.ilWorkspaceExplorer.php.

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

        {               
                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("exp_desc");
                                $tpl->setVariable("EXP_DESC", $lng->txt("expand"));
                                $tpl->parseCurrentBlock();
                                $target = $this->createTarget('+',$a_node_id);
                                $tpl->setCurrentBlock("expander");
                                $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("exp_desc");
                                $tpl->setVariable("EXP_DESC", $lng->txt("collapse"));
                                $tpl->parseCurrentBlock();
                                $target = $this->createTarget('-',$a_node_id);
                                $tpl->setCurrentBlock("expander");
                                $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");
                        $tpl->setVariable("ICON_IMAGE" , $this->getImage("icon_".$a_option["type"].".png", $a_option["type"], $a_obj_id));
                        
                        $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", ilUtil::shortenText(
                                $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"]),
                                $this->textwidth, true));
                        $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
                {
                        $tpl->setCurrentBlock("text");
                        $tpl->setVariable("OBJ_TITLE", ilUtil::shortenText(
                                $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"]), $this->textwidth, true));
                        $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");
        }

Here is the call graph for this function:

ilWorkspaceExplorer::getPostVar

(

)

Definition at line 133 of file class.ilWorkspaceExplorer.php.

References $post_var.

        {
                return $this->post_var;
        }

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

Reimplemented from ilRepositoryExplorer.

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

Referenced by formatObject().

        {
                if(is_array($this->clickable) && in_array($a_type, $this->clickable) &&
                        $a_ref_id)
                {
                        return true;
                }
                return false;
        }       

Here is the caller graph for this function:

ilWorkspaceExplorer::isItemChecked

(

$a_id

)

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

Referenced by buildFormItem().

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

Here is the caller graph for this function:

ilWorkspaceExplorer::isVisible	(		$a_ref_id,
			$a_type
	)

Reimplemented from ilRepositoryExplorer.

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

        {
                return true;
        }

ilWorkspaceExplorer::removeAllFormItemTypes

(

)

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

        {
                $this->form_items = array();
        }

ilWorkspaceExplorer::removeFormItemForType

(

$type

)

Definition at line 113 of file class.ilWorkspaceExplorer.php.

References $type.

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

ilWorkspaceExplorer::setCheckedItems

(

$a_checked_items = array()

)

Definition at line 121 of file class.ilWorkspaceExplorer.php.

        {
                $this->checked_items = $a_checked_items;
        }       

ilWorkspaceExplorer::setCustomLinkTarget

(

$a_target

)

Definition at line 311 of file class.ilWorkspaceExplorer.php.

        {
                $this->custom_link_target = $a_target;          
        }

ilWorkspaceExplorer::setPostVar

(

$a_post_var

)

Definition at line 129 of file class.ilWorkspaceExplorer.php.

        {
                $this->post_var = $a_post_var;
        }

ilWorkspaceExplorer::setTypeClickable

(

$a_type

)

Definition at line 306 of file class.ilWorkspaceExplorer.php.

        {
                $this->clickable[] = $a_type;
        }

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

Reimplemented from ilRepositoryExplorer.

Definition at line 79 of file class.ilWorkspaceExplorer.php.

        {
                if ($a_ref_id == 0 ||
                        $this->access->checkAccess('read', '', $a_ref_id))
                {
                        return true;
                }
                return false;
        }

ilWorkspaceExplorer::sortNodes	(		$a_nodes,
			$a_parent_obj_id
	)

sort nodes

public

Parameters

@return

Reimplemented from ilRepositoryExplorer.

Definition at line 94 of file class.ilWorkspaceExplorer.php.

        {
                return $a_nodes;
        }

Field Documentation

ilWorkspaceExplorer::$access = null

Definition at line 20 of file class.ilWorkspaceExplorer.php.

ilWorkspaceExplorer::$checked_items = array()

private

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

ilWorkspaceExplorer::$clickable = array()

protected

Definition at line 27 of file class.ilWorkspaceExplorer.php.

ilWorkspaceExplorer::$ctrl = null

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

ilWorkspaceExplorer::$custom_link_target

protected

Definition at line 28 of file class.ilWorkspaceExplorer.php.

ilWorkspaceExplorer::$form_items = array()

private

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

ilWorkspaceExplorer::$output = ''

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

ilWorkspaceExplorer::$post_var = ''

private

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

Referenced by getPostVar().

ilWorkspaceExplorer::$root_id = 0

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

Referenced by __construct().

ilWorkspaceExplorer::$type = 0

private

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

Referenced by addFormItemForType(), and removeFormItemForType().

const ilWorkspaceExplorer::SEL_TYPE_CHECK = 1

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

Referenced by ilPersonalSkillsGUI\assignMaterial().

const ilWorkspaceExplorer::SEL_TYPE_RADIO = 2

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

Referenced by ilPCFileListGUI\insertFromWorkspace(), ilPCFileItemGUI\insertFromWorkspace(), ilObjExerciseGUI\renderWorkspaceExplorer(), and ilObjWorkspaceFolderGUI\showMoveIntoObjectTree().

---

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

• Services/PersonalWorkspace/classes/class.ilWorkspaceExplorer.php