ilFileSelectorGUI Class Reference

Select file for being added into file lists. More...

Inheritance diagram for ilFileSelectorGUI:

Collaboration diagram for ilFileSelectorGUI:

Public Member Functions
	__construct ($a_target, $a_par_class="ilpcfilelistgui")
	Constructor public.
	setSelectableTypes ($a_types)
	setRefId ($a_ref_id)
	buildLinkTarget ($a_node_id, $a_type)
	get link target (may be overwritten by derived classes)
	isClickable ($a_type, $a_ref_id)
	Item clickable?
	showChilds ($a_ref_id)
	Show childs y/n?
	formatHeader (&$tpl, $a_obj_id, $a_option)
	overwritten method from base class public
Public Member Functions inherited from ilExplorer
	ilExplorer ($a_target)
	Constructor public.
	initItemCounter ($a_number)
	Init item counter.
	setTitle ($a_val)
	Set title.
	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)
	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.
	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
	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
	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
	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	get frame target (may be overwritten by derived classes)
	createTarget ($a_type, $a_node_id, $a_highlighted_subtree=false)
	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

Additional Inherited Members
Data Fields inherited from ilExplorer
	$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

Select file for being added into file lists.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

ilFileSelectorGUI::__construct	(		$a_target,
			$a_par_class = "ilpcfilelistgui"
	)

Constructor public.

Parameters

string	scriptname
int	user_id

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

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

        {
                global $tree,$ilCtrl;

                $this->ctrl =& $ilCtrl;
                $this->parent_class = $a_par_class;
                parent::ilExplorer($a_target);
        }

Here is the call graph for this function:

Member Function Documentation

ilFileSelectorGUI::buildLinkTarget	(		$a_node_id,
			$a_type
	)

get link target (may be overwritten by derived classes)

Reimplemented from ilExplorer.

Definition at line 61 of file class.ilFileSelectorGUI.php.

References $_GET, and $ilCtrl.

        {
                global $ilCtrl;
                
                $ilCtrl->setParameterByClass($this->parent_class, "subCmd", "selectFile");
                $ilCtrl->setParameterByClass($this->parent_class, "file_ref_id", $a_node_id);
                $link = $ilCtrl->getLinkTargetByClass($this->parent_class, $_GET["cmd"]);

                return $link;
        }

ilFileSelectorGUI::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 118 of file class.ilFileSelectorGUI.php.

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

        {
                global $lng, $ilias;
                
                $tpl->setCurrentBlock("icon");
                $tpl->setVariable("ICON_IMAGE" , ilUtil::getImagePath("icon_root_s.gif"));
                $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:

ilFileSelectorGUI::isClickable	(		$a_type,
			$a_ref_id
	)

Item clickable?

Reimplemented from ilExplorer.

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

        {
                global $ilUser, $ilAccess;
                
                if ($a_type == "file" &&
                        $ilAccess->checkAccess("write", "", $a_ref_id))
                {
                        return true;
                }
                false;
        }

ilFileSelectorGUI::setRefId

(

$a_ref_id

)

Definition at line 56 of file class.ilFileSelectorGUI.php.

        {
                $this->ref_id = $a_ref_id;
        }

ilFileSelectorGUI::setSelectableTypes

(

$a_types

)

Definition at line 51 of file class.ilFileSelectorGUI.php.

        {
                $this->selectable_types  = $a_types;
        }

ilFileSelectorGUI::showChilds

(

$a_ref_id

)

Show childs y/n?

Reimplemented from ilExplorer.

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

        {
                global $ilAccess;

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

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

---

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

• Services/COPage/classes/class.ilFileSelectorGUI.php