ilLMEditorExplorer Class Reference

Inheritance diagram for ilLMEditorExplorer:

Collaboration diagram for ilLMEditorExplorer:

Public Member Functions
	ilLMEditorExplorer ($a_target, &$a_lm_obj, $a_gui_class)
	Constructor public.
	setForceOpenPath ($a_path)
	set force open path
	formatHeader (&$tpl, $a_obj_id, $a_option)
	overwritten method from base class public
	buildTitle ($a_title, $a_id, $a_type)
	standard implementation for title, maybe overwritten by derived classes
	buildLinkTarget ($a_node_id, $a_type)
	build link target
	getImage ($a_name, $a_type="", $a_id="")
	get style class for node
	getImageAlt ($a_default_text, $a_type="", $a_id="")
	get image alt text
	forceExpanded ($a_obj_id)
	force expansion of node
Public Member Functions inherited from ilLMExplorer
	ilLMExplorer ($a_target, &$a_lm_obj)
	Constructor public.
	isClickable ($a_type, $a_obj_id=0)
	check if links for certain object type are activated
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 (
	formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
	Creates output recursive method private.
	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
	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

Additional Inherited Members
Data Fields inherited from ilLMExplorer
	$root_id
	$lm_obj
	$output

Detailed Description

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

Member Function Documentation

ilLMEditorExplorer::buildLinkTarget	(		$a_node_id,
			$a_type
	)

build link target

Reimplemented from ilExplorer.

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

        {
                switch($a_type)
                {
                        case "pg":
                                $this->ctrl->setParameterByClass("ilLMPageObjectGUI", "obj_id", $a_node_id);
                                return $this->ctrl->getLinkTargetByClass("ilLMPageObjectGUI",
                                        "edit", array($this->gui_class));
                                break;

                        case "st":
                                $this->ctrl->setParameterByClass("ilStructureObjectGUI", "obj_id", $a_node_id);
                                return $this->ctrl->getLinkTargetByClass("ilStructureObjectGUI",
                                        "view", array($this->gui_class));
                                break;
                }
        }

ilLMEditorExplorer::buildTitle	(		$a_title,
			$a_id,
			$a_type
	)

standard implementation for title, maybe overwritten by derived classes

Reimplemented from ilExplorer.

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

References ilStructureObject\_getPresentationTitle().

        {
//echo "<br>-$a_title-$a_type-$a_id-";
                if ($a_type == "st")
                {
                        return ilStructureObject::_getPresentationTitle($a_id,
                                $this->lm_obj->isActiveNumbering());
                }

                return $a_title;
                /*
                if ($this->lm_obj->getTOCMode() == "chapters" || $a_type != "pg")
                {
                        return $a_title;
                }
                else
                {
                        if ($a_type == "pg")
                        {
                                return ilLMPageObject::_getPresentationTitle($a_id,
                                        $this->lm_obj->getPageHeader(), $this->lm_obj->isActiveNumbering());
                        }
                }*/
        }

Here is the call graph for this function:

ilLMEditorExplorer::forceExpanded

(

$a_obj_id

)

force expansion of node

Reimplemented from ilExplorer.

Definition at line 234 of file class.ilLMEditorExplorer.php.

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

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

overwritten method from base class public

Parameters

integer	obj_id
integer	array options

Returns

string

Reimplemented from ilLMExplorer.

Definition at line 68 of file class.ilLMEditorExplorer.php.

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

        {
                global $lng, $ilias;
                
                $tpl->setCurrentBlock("icon");
                $tpl->setVariable("ICON_IMAGE" , ilUtil::getImagePath("icon_lm_s.gif"));
                $tpl->setVariable("TXT_ALT_IMG", $lng->txt("obj_".$this->lm_obj->getType()));
                $tpl->parseCurrentBlock();


                $tpl->setCurrentBlock("link");
                $tpl->setVariable("TITLE", ilUtil::shortenText($this->lm_obj->getTitle(), $this->textwidth, true));

                if ($this->lm_obj->getType() == "lm")
                {
                        $this->ctrl->setParameterByClass("ilObjLearningModuleGUI",
                                "obj_id", "");
                        $link = $this->ctrl->getLinkTargetByClass("ilObjLearningModuleGUI",
                                "chapters");
                }
                else
                {
                        $this->ctrl->setParameterByClass("ilObjDlBookGUI",
                                "obj_id", "");
                        $link = $this->ctrl->getLinkTargetByClass("ilObjDlBookGUI",
                                "chapters");
                }
                $tpl->setVariable("LINK_TARGET", $link);

                $tpl->setVariable("TARGET", " target=\"".$this->frame_target."\"");
                $tpl->parseCurrentBlock();

                //$tpl->setCurrentBlock("row");
                //$tpl->parseCurrentBlock();

                $tpl->touchBlock("element");
        }

Here is the call graph for this function:

ilLMEditorExplorer::getImage	(		$a_name,
			$a_type = "",
			$a_id = ""
	)

get style class for node

Reimplemented from ilExplorer.

Definition at line 160 of file class.ilLMEditorExplorer.php.

References ilPageObject\_isScheduledActivation(), ilPageObject\_lookupActive(), ilPageObject\_lookupContainsDeactivatedElements(), and ilUtil\getImagePath().

        {
                include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                
                if ($a_type == "pg")
                {
                        include_once("./Services/COPage/classes/class.ilPageObject.php");
                        $lm_set = new ilSetting("lm");
                        $active = ilPageObject::_lookupActive($a_id, $this->lm_obj->getType(),
                                $lm_set->get("time_scheduled_page_activation"));
                        
                        // is page scheduled?
                        $img_sc = ($lm_set->get("time_scheduled_page_activation") &&
                                ilPageObject::_isScheduledActivation($a_id, $this->lm_obj->getType()))
                                ? "_sc"
                                : "";
                                
                        $a_name = "icon_pg".$img_sc."_s.gif";

                        if (!$active)
                        {
                                $a_name = "icon_pg_d".$img_sc."_s.gif";
                        }
                        else
                        {
                                include_once("./Services/COPage/classes/class.ilPageObject.php");
                                $contains_dis = ilPageObject::_lookupContainsDeactivatedElements($a_id,
                                        $this->lm_obj->getType());
                                if ($contains_dis)
                                {
                                        $a_name = "icon_pg_del".$img_sc."_s.gif";
                                }
                        }
                }
                return ilUtil::getImagePath($a_name);
        }

Here is the call graph for this function:

ilLMEditorExplorer::getImageAlt	(		$a_default_text,
			$a_type = "",
			$a_id = ""
	)

get image alt text

Reimplemented from ilExplorer.

Definition at line 200 of file class.ilLMEditorExplorer.php.

References $lng, ilPageObject\_lookupActive(), and ilPageObject\_lookupContainsDeactivatedElements().

        {
                global $lng;
                
                include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                
                if ($a_type == "pg")
                {
                        include_once("./Services/COPage/classes/class.ilPageObject.php");
                        $lm_set = new ilSetting("lm");
                        $active = ilPageObject::_lookupActive($a_id, $this->lm_obj->getType(),
                                $lm_set->get("time_scheduled_page_activation"));

                        if (!$active)
                        {
                                return $lng->txt("cont_page_deactivated");
                        }
                        else
                        {
                                include_once("./Services/COPage/classes/class.ilPageObject.php");
                                $contains_dis = ilPageObject::_lookupContainsDeactivatedElements($a_id,
                                        $this->lm_obj->getType());
                                if ($contains_dis)
                                {
                                        return $lng->txt("cont_page_deactivated_elements");
                                }
                        }
                }
                return $a_default_text;
        }

Here is the call graph for this function:

ilLMEditorExplorer::ilLMEditorExplorer	(		$a_target,
		&	$a_lm_obj,
			$a_gui_class
	)

Constructor public.

Parameters

string	scriptname
int	user_id

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

References $ilCtrl, and ilLMExplorer\ilLMExplorer().

        {
                global $ilCtrl;

                $this->ctrl =& $ilCtrl;
                $this->gui_class = $a_gui_class;
                $this->force_open_path = array();

                parent::ilLMExplorer($a_target, $a_lm_obj);
        }

Here is the call graph for this function:

ilLMEditorExplorer::setForceOpenPath

(

$a_path

)

set force open path

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

        {
                $this->force_open_path = $a_path;
        }

---

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

• Modules/LearningModule/classes/class.ilLMEditorExplorer.php