ilWorkspaceFolderExplorer Class Reference

Explorer View for Workspace Folders. More...

Inheritance diagram for ilWorkspaceFolderExplorer:

Collaboration diagram for ilWorkspaceFolderExplorer:

Public Member Functions
	__construct ($a_target, $a_user_id)
	Constructor public. More...
	setEnableSmallMode ($a_enablesmallmode)
	Set Enable Small Mode. More...
	getEnableSmallMode ()
	Get Enable Small Mode. More...
	setOutput ($a_parent, $a_depth=1, $a_obj_id=0, $a_highlighted_subtree=false)
	Overwritten method from class.Explorer.php to avoid checkAccess selects recursive method public. More...
	formatHeader ($tpl, $a_obj_id, $a_option)
	overwritten method from base class 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,...) private More...
	buildLinkTarget ($a_node_id, $a_type)
	overwritten method from base class get link target More...
	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	overwritten method from base class buid link target More...
	setAllowedTypes ($a_types)
	set the alowed object types private More...
	setShowDetails ($s_details)
	set details mode public More...
	buildDescription ($a_desc, $a_id, $a_type)
	overwritten method from base class buid decription More...
	getImageAlt ($a_def, $a_type="", $a_obj_id="")
	hasFolders ($a_node_id)
	getParentNode ($a_node_id)
	getOutput ()
Public Member Functions inherited from ilExplorer
	__construct ($a_target)
	Constructor 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 public More...
	setOrderDirection ($a_direction)
	set the order direction public More...
	setTargetGet ($a_target_get)
	set the varname in Get-string public More...
	setParamsGet ($a_params_get)
	set additional params to be passed in Get-string 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 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 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 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 private. More...
	setFrameTarget ($a_target)
	set target frame or not frame? More...
	createLines ($a_depth)
	Creates lines for explorer view private. More...
	is_in_array ($a_start, $a_depth)
	DESCRIPTION MISSING private. More...
	getIndex ($a_data)
	get index of format_options array from specific ref_id,parent_id private More...
	addFilter ($a_item)
	adds item to the filter public More...
	delFilter ($a_item)
	removes item from the filter 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,...) private More...
	forceExpandAll ($a_mode, $a_show_minus=true)
	force expandAll. More...
	setFiltered ($a_bool)
	active/deactivate the filter public More...
	checkFilter ($a_item)
	check if item is in filter private More...
	sortNodes ($a_nodes, $a_parent_obj_id)
	sort nodes and put adm object to the end of sorted array private More...

Data Fields
	$user_id
	$root_id
	$allowed_types
Data Fields inherited from ilExplorer
	$id
	$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
	$ctrl
Protected Attributes inherited from ilExplorer
	$obj_definition
	$error
	$rbacsystem
	$tpl
	$lng

Detailed Description

Explorer View for Workspace Folders.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 10 of file class.ilWorkspaceFolderExplorer.php.

Constructor & Destructor Documentation

__construct()

ilWorkspaceFolderExplorer::__construct	(		$a_target,
			$a_user_id
	)

Constructor public.

Parameters

string	scriptname
int	user_id

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

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC["tpl"];
        parent::__construct($a_target);
        $this->tree = new ilWorkspaceTree($a_user_id);
        $this->root_id = $this->tree->readRootId();
        $this->user_id = $a_user_id;
        $this->allowed_types = array('wfld', 'wsrt');
        $this->enablesmallmode = false;
    }

Here is the call graph for this function:

Member Function Documentation

buildDescription()

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

overwritten method from base class buid decription

Definition at line 257 of file class.ilWorkspaceFolderExplorer.php.

    {
        if ($this->show_details == 'y' && !empty($a_desc)) {
            return $a_desc;
        } else {
            return "";
        }
    }

buildFrameTarget()

ilWorkspaceFolderExplorer::buildFrameTarget	(		$a_type,
			$a_child = 0,
			$a_obj_id = 0
	)

overwritten method from base class buid link target

Definition at line 229 of file class.ilWorkspaceFolderExplorer.php.

    {
        return '';
    }

buildLinkTarget()

ilWorkspaceFolderExplorer::buildLinkTarget	(		$a_node_id,
			$a_type
	)

overwritten method from base class get link target

Definition at line 208 of file class.ilWorkspaceFolderExplorer.php.

References $a_type, $ctrl, and $ilCtrl.

Referenced by formatHeader().

    {
        $ilCtrl = $this->ctrl;
        
        switch ($a_type) {
            case "wsrt":
                $ilCtrl->setParameterByClass("ilobjworkspacerootfoldergui", "wsp_id", $a_node_id);
                return $ilCtrl->getLinkTargetByClass("ilobjworkspacerootfoldergui", "");
                
            case "wfld":
                $ilCtrl->setParameterByClass("ilobjworkspacefoldergui", "wsp_id", $a_node_id);
                return $ilCtrl->getLinkTargetByClass("ilobjworkspacefoldergui", "");
            
            default:
                return;
        }
    }

Here is the caller graph for this function:

formatHeader()

ilWorkspaceFolderExplorer::formatHeader	(		$tpl,
			$a_obj_id,
			$a_option
	)

overwritten method from base class public

Parameters

integer	obj_id
integer	array options

Returns

string

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

References $ctrl, $ilCtrl, ilExplorer\$lng, ilExplorer\$tpl, buildLinkTarget(), ilUtil\getImagePath(), and ilExplorer\getNodeStyleClass().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
    
        $title = $lng->txt("personal_resources");
        
        $tpl->setCurrentBlock("icon");
        $tpl->setVariable("ICON_IMAGE", ilUtil::getImagePath("icon_wsrt.svg"));
        $tpl->setVariable("TXT_ALT_IMG", $title);
        $tpl->parseCurrentBlock();
        
        $tpl->setCurrentBlock("link");
        $tpl->setVariable("LINK_TARGET", $this->buildLinkTarget($this->root_id, "wsrt"));
        $tpl->setVariable("TITLE", $title);
        
        // highlighting
        $style_class = $this->getNodeStyleClass($this->root_id, "wsrt");
        if ($style_class != "") {
            $tpl->setVariable("A_CLASS", ' class="' . $style_class . '" ');
        }
        
        $tpl->parseCurrentBlock();
    }

Here is the call graph for this function:

getEnableSmallMode()

ilWorkspaceFolderExplorer::getEnableSmallMode

(

)

Get Enable Small Mode.

Returns

boolean Enable Small Mode

Definition at line 74 of file class.ilWorkspaceFolderExplorer.php.

    {
        return $this->enablesmallmode;
    }

getImageAlt()

ilWorkspaceFolderExplorer::getImageAlt	(		$a_def,
			$a_type = "",
			$a_obj_id = ""
	)

Definition at line 266 of file class.ilWorkspaceFolderExplorer.php.

References $a_type, and ilExplorer\$lng.

    {
        $lng = $this->lng;
        
        return $lng->txt("icon") . " " . $lng->txt($a_type);
    }

getOutput()

ilWorkspaceFolderExplorer::getOutput

(

)

Definition at line 283 of file class.ilWorkspaceFolderExplorer.php.

References ilExplorer\$tpl.

    {
        $tpl = $this->tpl;
        
        $html = parent::getOutput();
        $tpl->setBodyClass("std");
        return $html;
    }

getParentNode()

ilWorkspaceFolderExplorer::getParentNode

(

$a_node_id

)

Definition at line 278 of file class.ilWorkspaceFolderExplorer.php.

    {
        return $this->tree->getParentId($a_node_id);
    }

hasFolders()

ilWorkspaceFolderExplorer::hasFolders

(

$a_node_id

)

Definition at line 273 of file class.ilWorkspaceFolderExplorer.php.

    {
        return sizeof($this->tree->getChildsByType($a_node_id, "wfld"));
    }

setAllowedTypes()

ilWorkspaceFolderExplorer::setAllowedTypes

(

$a_types

)

set the alowed object types private

Parameters

array

arraye of object types

Definition at line 239 of file class.ilWorkspaceFolderExplorer.php.

    {
        $this->allowed_types = $a_types;
    }

setEnableSmallMode()

ilWorkspaceFolderExplorer::setEnableSmallMode

(

$a_enablesmallmode

)

Set Enable Small Mode.

Parameters

boolean

$a_enablesmallmode

Enable Small Mode

Definition at line 64 of file class.ilWorkspaceFolderExplorer.php.

    {
        $this->enablesmallmode = $a_enablesmallmode;
    }

setExpand()

ilWorkspaceFolderExplorer::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

Parameters

string

pipe-separated integer

Definition at line 183 of file class.ilWorkspaceFolderExplorer.php.

References $_SESSION, ilExplorer\$expand_variable, and $root_id.

    {
        if ($a_node_id == "") {
            $a_node_id = $this->root_id;
        }

        // IF ISN'T SET CREATE SESSION VARIABLE
        if (!is_array($_SESSION[$this->expand_variable])) {
            $_SESSION[$this->expand_variable] = array();
        }
        // IF $_GET["expand"] is positive => expand this node
        if ($a_node_id > 0 && !in_array($a_node_id, $_SESSION[$this->expand_variable])) {
            array_push($_SESSION[$this->expand_variable], $a_node_id);
        }
        // IF $_GET["expand"] is negative => compress this node
        if ($a_node_id < 0) {
            $key = array_keys($_SESSION[$this->expand_variable], -(int) $a_node_id);
            unset($_SESSION[$this->expand_variable][$key[0]]);
        }
        $this->expanded = $_SESSION[$this->expand_variable];
    }

setOutput()

ilWorkspaceFolderExplorer::setOutput	(		$a_parent,
			$a_depth = 1,
			$a_obj_id = 0,
			$a_highlighted_subtree = false
	)

Overwritten method from class.Explorer.php to avoid checkAccess selects recursive method public.

Parameters

integer	parent_node_id where to start from (default=0, 'root')
integer	depth level where to start (default=1)

Returns

string

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

References $i, ilExplorer\$lng, $tab, and ilExplorer\getIndex().

    {
        $lng = $this->lng;
        static $counter = 0;

        if ($objects = $this->tree->getChilds($a_parent, "type DESC,title")) {
            $tab = ++$a_depth - 2;

            foreach ($objects as $key => $object) {
                if (!in_array($object["type"], $this->allowed_types)) {
                    continue;
                }

                //ask for FILTER
                if ($object["child"] != $this->root_id) {
                    //$data = $this->tree->getParentNodeData($object["child"]);
                    $parent_index = $this->getIndex($object);
                }
                
                $this->format_options["$counter"]["parent"] = $object["parent"];
                $this->format_options["$counter"]["child"] = $object["child"];
                $this->format_options["$counter"]["title"] = $object["title"];
                $this->format_options["$counter"]["description"] = $object["description"];
                $this->format_options["$counter"]["type"] = $object["type"];
                $this->format_options["$counter"]["depth"] = $tab;
                $this->format_options["$counter"]["container"] = false;
                $this->format_options["$counter"]["visible"] = true;

                // Create prefix array
                for ($i = 0; $i < $tab; ++$i) {
                    $this->format_options["$counter"]["tab"][] = 'blank';
                }
                // only if parent is expanded and visible, object is visible
                if ($object["child"] != $this->root_id and (!in_array($object["parent"], $this->expanded)
                                                          or !$this->format_options["$parent_index"]["visible"])) {
                    $this->format_options["$counter"]["visible"] = false;
                }

                // if object exists parent is container
                if ($object["child"] != $this->root_id) {
                    $this->format_options["$parent_index"]["container"] = true;

                    if (in_array($object["parent"], $this->expanded)) {
                        $this->format_options["$parent_index"]["tab"][($tab - 2)] = 'minus';
                    } else {
                        $this->format_options["$parent_index"]["tab"][($tab - 2)] = 'plus';
                    }
                }

                ++$counter;

                // Recursive
                $this->setOutput($object["child"], $a_depth);
            } //foreach
        } //if
    } //function

Here is the call graph for this function:

setShowDetails()

ilWorkspaceFolderExplorer::setShowDetails

(

$s_details

)

set details mode public

Parameters

string

y or n

Definition at line 248 of file class.ilWorkspaceFolderExplorer.php.

    {
        $this->show_details = $s_details;
    }

Field Documentation

$allowed_types

ilWorkspaceFolderExplorer::$allowed_types

Definition at line 36 of file class.ilWorkspaceFolderExplorer.php.

$ctrl

ilWorkspaceFolderExplorer::$ctrl

protected

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

Referenced by buildLinkTarget(), and formatHeader().

$root_id

ilWorkspaceFolderExplorer::$root_id

Definition at line 29 of file class.ilWorkspaceFolderExplorer.php.

Referenced by setExpand().

$user_id

ilWorkspaceFolderExplorer::$user_id

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

---

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

• Modules/WorkspaceFolder/classes/class.ilWorkspaceFolderExplorer.php