ilScorm2004EditorExplorer Class Reference

Inheritance diagram for ilScorm2004EditorExplorer:

Collaboration diagram for ilScorm2004EditorExplorer:

Public Member Functions
	ilScorm2004EditorExplorer ($a_target, $a_slm_obj)
	Constructor public.
	setForceOpenPath ($a_path)
	set force open path
	formatHeader (&$tpl, $a_obj_id, $a_option)
	overwritten method from base class public
	formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
	overwritten method from base class private
	isClickable ($a_type, $a_obj_id=0)
	check if links for certain object type are activated
	buildLinkTarget ($a_node_id, $a_type)
	build link target
	forceExpanded ($a_obj_id)
	force expansion of node
Public Member Functions inherited from ilExplorer
	ilExplorer ($a_target)
	Constructor public.
	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.
	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.
	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 (
	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 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
	$slm_obj
	$output
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

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

Member Function Documentation

ilScorm2004EditorExplorer::buildLinkTarget	(		$a_node_id,
			$a_type
	)

build link target

Reimplemented from ilExplorer.

Definition at line 140 of file class.ilSCORM2004EditorExplorer.php.

References $ilCtrl.

        {
                global $ilCtrl;
                
                switch($a_type)
                {
                        case "chap":
                                $ilCtrl->setParameterByClass("ilScorm2004ChapterGUI", "obj_id", $a_node_id);
                                return $ilCtrl->getLinkTargetByClass("ilScorm2004ChapterGUI", "showOrganization");
                                break;
                                
                        case "seqc":
                                $ilCtrl->setParameterByClass("ilScorm2004SeqChapterGUI", "obj_id", $a_node_id);
                                return $ilCtrl->getLinkTargetByClass("ilScorm2004SeqChapterGUI", "showOrganization");
                                break;

                        case "page":
                                $ilCtrl->setParameterByClass("ilScorm2004PageNodeGUI", "obj_id", $a_node_id);
                                return $ilCtrl->getLinkTargetByClass("ilScorm2004PageNodeGUI", "edit");
                                break;

                        case "sco":
                                $ilCtrl->setParameterByClass("ilScorm2004ScoGUI", "obj_id", $a_node_id);
                                return $ilCtrl->getLinkTargetByClass("ilScorm2004ScoGUI", "showOrganization");
                                break;
                }
        }

ilScorm2004EditorExplorer::forceExpanded

(

$a_obj_id

)

force expansion of node

Reimplemented from ilExplorer.

Definition at line 171 of file class.ilSCORM2004EditorExplorer.php.

        {
                if (in_array($a_obj_id, $this->force_open_path))
                {
                        return true;
                }
                return false;
        }

ilScorm2004EditorExplorer::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 82 of file class.ilSCORM2004EditorExplorer.php.

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

        {
                global $lng, $ilias, $ilCtrl;
                
                $tpl->setCurrentBlock("icon");
                $tpl->setVariable("ICON_IMAGE" , ilUtil::getImagePath("icon_sahs_s.gif"));
                $tpl->setVariable("TXT_ALT_IMG", $this->slm_obj->getTitle());
                $tpl->parseCurrentBlock();

                $tpl->setCurrentBlock("link");
                $tpl->setVariable("TITLE", ilUtil::shortenText($this->slm_obj->getTitle()."",
                        $this->textwidth, true));
                $tpl->setVariable("LINK_TARGET",
                        $ilCtrl->getLinkTargetByClass("ilobjscorm2004learningmodulegui", "showOrganization"));
                $tpl->setVariable("TARGET", " target=\"".$this->frame_target."\"");
                $tpl->parseCurrentBlock();
                
                $tpl->touchBlock("element");
        }

Here is the call graph for this function:

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

overwritten method from base class private

Parameters

integer
array

Returns

string

Reimplemented from ilExplorer.

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

References $lng, $tpl, ilExplorer\getImage(), and ilExplorer\outputIcons().

        {
                global $lng;
                
                $tpl->setCurrentBlock("icon");
                $tpl->setVariable("ICON_IMAGE" , $this->getImage("icon_".$a_option["type"]."_s.gif", $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();
                
                $this->outputIcons(false);
                parent::formatObject($tpl, $a_node_id,$a_option,$a_obj_id);
        }

Here is the call graph for this function:

ilScorm2004EditorExplorer::ilScorm2004EditorExplorer	(		$a_target,
			$a_slm_obj
	)

Constructor public.

Parameters

string	scriptname
int	user_id

Definition at line 50 of file class.ilSCORM2004EditorExplorer.php.

References ilExplorer\checkPermissions(), ilExplorer\ilExplorer(), ilExplorer\setPostSort(), ilExplorer\setSessionExpandVariable(), and ilTree\setTableNames().

        {
                parent::ilExplorer($a_target);
                $this->tree = new ilTree($a_slm_obj->getId());
                $this->tree->setTableNames('sahs_sc13_tree','sahs_sc13_tree_node');
                $this->tree->setTreeTablePK("slm_id");
                $this->root_id = $this->tree->readRootId();
                $this->slm_obj = $a_slm_obj;
                $this->order_column = "";
                $this->setSessionExpandVariable("scexpand");
                $this->checkPermissions(false);
                $this->setPostSort(false);
                $this->textwidth = 200;

                $this->force_open_path = array();
        }

Here is the call graph for this function:

ilScorm2004EditorExplorer::isClickable	(		$a_type,
			$a_obj_id = 0
	)

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 131 of file class.ilSCORM2004EditorExplorer.php.

        {
                global $ilUser;
                return true;
        }

ilScorm2004EditorExplorer::setForceOpenPath

(

$a_path

)

set force open path

Definition at line 70 of file class.ilSCORM2004EditorExplorer.php.

        {
                $this->force_open_path = $a_path;
        }

Field Documentation

ilScorm2004EditorExplorer::$output

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

ilScorm2004EditorExplorer::$root_id

Definition at line 40 of file class.ilSCORM2004EditorExplorer.php.

ilScorm2004EditorExplorer::$slm_obj

Definition at line 41 of file class.ilSCORM2004EditorExplorer.php.

---

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

• Modules/Scorm2004/classes/class.ilSCORM2004EditorExplorer.php