ilTableOfContentsExplorer Class Reference

Inheritance diagram for ilTableOfContentsExplorer:

Collaboration diagram for ilTableOfContentsExplorer:

Public Member Functions
	ilTableOfContentsExplorer ($a_target, &$a_lm_obj, $a_export_format="")
	Constructor public.
	setOfflineMode ($a_offline=true)
	set offline mode
	offlineMode ()
	get offline mode
	buildTitle ($a_title, $a_id, $a_type)
	standard implementation for title, maybe overwritten by derived classes
	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	get target frame
	buildLinkTarget ($a_node_id, $a_type)
	build link target
	isClickable ($a_type, $a_node_id)
	check if links for certain object type are activated
	getImage ($a_name)
	get image path (may be overwritten by derived classes)
	forceExpanded ($a_obj_id)
	force expansion of node
	isVisible ($a_id, $a_type)
Public Member Functions inherited from ilLMExplorer
	ilLMExplorer ($a_target, &$a_lm_obj)
	Constructor public.
	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.
	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.
	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.
	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)
	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)
	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

Data Fields
	$root_id
	$output
	$offline
Data Fields inherited from ilLMExplorer
	$root_id
	$lm_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 35 of file class.ilLMTableOfContentsExplorer.php.

Member Function Documentation

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

get target frame

Reimplemented from ilExplorer.

Definition at line 151 of file class.ilLMTableOfContentsExplorer.php.

References ilFrameTargetInfo\_getFrame(), and offlineMode().

        {
                // Determine whether the view of a learning resource should
                // be shown in the frameset of ilias, or in a separate window.
                //$showViewInFrameset = $this->ilias->ini->readVariable("layout","view_target") == "frame";
                $showViewInFrameset = true;

                if ($this->offlineMode() &&
                        $this->export_format == "scorm")
                {
                        return "";
                }

                if ($showViewInFrameset && !$this->offlineMode())
                {
                        return ilFrameTargetInfo::_getFrame("MainContent");
                }
                else
                {
                        return "_top";
                }
        }

Here is the call graph for this function:

ilTableOfContentsExplorer::buildLinkTarget	(		$a_node_id,
			$a_type
	)

build link target

Reimplemented from ilExplorer.

Definition at line 177 of file class.ilLMTableOfContentsExplorer.php.

References ilPageObject\_lookupActive(), ilLMObject\_lookupNID(), and offlineMode().

        {
                if (!$this->offlineMode())
                {
                        return parent::buildLinkTarget($a_node_id, $a_type);
                }
                else
                {
                        if ($a_node_id < 1)
                        {
                                $a_node_id = $this->tree->getRootId();
                        }
                        if ($a_type != "pg")
                        {
                                // get next activated page
                                $found = false;
                                while (!$found)
                                {
                                        $a_node = $this->tree->fetchSuccessorNode($a_node_id, "pg");
                                        $a_node_id = $a_node["child"];
                                        include_once("./Services/COPage/classes/class.ilPageObject.php");
                                        $active = ilPageObject::_lookupActive($a_node_id, $this->lm_obj->getType(),
                                                $this->lm_set->get("time_scheduled_page_activation"));
                                        if ($a_node_id > 0 && !$active)
                                        {
                                                $found = false;
                                        }
                                        else
                                        {
                                                $found = true;
                                        }
                                }
                        }

                        if ($nid = ilLMObject::_lookupNID($this->lm_obj->getId(), $a_node_id, "pg"))
                        {
                                return "lm_pg_".$nid.".html";
                        }
                        else
                        {
                                return "lm_pg_".$a_node_id.".html";
                        }
                }
        }

Here is the call graph for this function:

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

standard implementation for title, maybe overwritten by derived classes

Reimplemented from ilExplorer.

Definition at line 114 of file class.ilLMTableOfContentsExplorer.php.

References $_GET, $lng, ilObjContentObject\_checkPreconditionsOfPage(), ilStructureObject\_getPresentationTitle(), ilLMPageObject\_getPresentationTitle(), and ilObject\_lookupObjId().

        {
                global $lng;

                include_once("./Modules/LearningModule/classes/class.ilObjContentObject.php");
                $access_str = "";
                if (!ilObjContentObject::_checkPreconditionsOfPage(
                        $_GET['ref_id'],ilObject::_lookupObjId($_GET["ref_id"]), $a_id))
                {
                        $access_str = " (".$lng->txt("cont_no_access").")";
                }
                
                if ($a_type == "st")
                {
                        return ilStructureObject::_getPresentationTitle($a_id,
                                $this->lm_obj->isActiveNumbering()).$access_str;
                }

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

Here is the call graph for this function:

ilTableOfContentsExplorer::forceExpanded

(

$a_obj_id

)

force expansion of node

Reimplemented from ilExplorer.

Definition at line 301 of file class.ilLMTableOfContentsExplorer.php.

References offlineMode().

        {
                if ($this->offlineMode())
                {
                        return true;
                }
                else
                {
                        return true;
                }
        }

Here is the call graph for this function:

ilTableOfContentsExplorer::getImage

(

$a_name

)

get image path (may be overwritten by derived classes)

Definition at line 293 of file class.ilLMTableOfContentsExplorer.php.

References ilUtil\getImagePath(), and offlineMode().

        {
                return ilUtil::getImagePath($a_name, false, "output", $this->offlineMode());
        }

Here is the call graph for this function:

ilTableOfContentsExplorer::ilTableOfContentsExplorer	(		$a_target,
		&	$a_lm_obj,
			$a_export_format = ""
	)

Constructor public.

Parameters

string	scriptname
int	user_id

Definition at line 53 of file class.ilLMTableOfContentsExplorer.php.

References ilFrameTargetInfo\_getFrame(), ilExplorer\addFilter(), IL_FM_POSITIVE, ilLMExplorer\ilLMExplorer(), ilExplorer\setFiltered(), ilExplorer\setFilterMode(), ilExplorer\setFrameTarget(), and ilExplorer\setSessionExpandVariable().

        {
                parent::ilLMExplorer($a_target, $a_lm_obj);
                $this->setSessionExpandVariable("lmtocexpand");
                $this->export_format = $a_export_format;
                $this->lm_obj =& $a_lm_obj;

                $this->addFilter("du");
                $this->addFilter("st");
                if ($a_lm_obj->getTOCMode() == "pages")
                {
                        $this->addFilter("pg");
                }
                $this->setFiltered(true);
                $this->setFilterMode(IL_FM_POSITIVE);
                $this->lm_set = new ilSetting("lm");

                // Determine whether the view of a learning resource should
                // be shown in the frameset of ilias, or in a separate window.
                //$showViewInFrameset = $this->ilias->ini->readVariable("layout","view_target") == "frame";
                $showViewInFrameset = true;

                if ($showViewInFrameset)
                {
                        $this->setFrameTarget(ilFrameTargetInfo::_getFrame("MainContent"));
                }
                else
                {
                        $this->setFrameTarget("_top");
                }

        }

Here is the call graph for this function:

ilTableOfContentsExplorer::isClickable	(		$a_type,
			$a_obj_id
	)

check if links for certain object type are activated

Parameters

string

$a_type

object type

Returns

boolean true if linking is activated

Reimplemented from ilLMExplorer.

Definition at line 222 of file class.ilLMTableOfContentsExplorer.php.

References $path, ilLMObject\_isPagePublic(), ilPageObject\_lookupActive(), ilPaymentObject\_requiresPurchaseToAccess(), and offlineMode().

        {
                global $ilUser;
                
                $orig_node_id = $a_node_id;
                
                if ($a_type == "st")
                {
                        if (!$this->offlineMode())
                        {
                                $a_node = $this->tree->fetchSuccessorNode($a_node_id, "pg");
                                $a_node_id = $a_node["child"];
                                if ($a_node_id == 0)
                                {
                                        return false;
                                }
                        }
                        else
                        {
                                // get next activated page
                                $found = false;
                                while (!$found)
                                {
                                        $a_node = $this->tree->fetchSuccessorNode($a_node_id, "pg");
                                        $a_node_id = $a_node["child"];
                                        include_once("./Services/COPage/classes/class.ilPageObject.php");
                                        $active = ilPageObject::_lookupActive($a_node_id, $this->lm_obj->getType(),
                                                $this->lm_set->get("time_scheduled_page_activation"));
                                        if ($a_node_id > 0 && !$active)
                                        {
                                                $found = false;
                                        }
                                        else
                                        {
                                                $found = true;
                                        }
                                }
                                if ($a_node_id <= 0)
                                {
                                        return false;
                                }
                                else
                                {
                                        $path = $this->tree->getPathId($a_node_id);
                                        if (!in_array($orig_node_id, $path))
                                        {
                                                return false;
                                        }
                                }
                        }
                }
                
                if ($a_type == "pg")
                {
                        // check public area mode
                        include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                        include_once 'Services/Payment/classes/class.ilPaymentObject.php';
                        if (($ilUser->getId() == ANONYMOUS_USER_ID || 
                                ilPaymentObject::_requiresPurchaseToAccess((int)$this->lm_obj->getRefId())) &&
                            !ilLMObject::_isPagePublic($a_node_id, true))
                        {
                                return false;
                        }
                }

                return true;
        }

Here is the call graph for this function:

ilTableOfContentsExplorer::isVisible	(		$a_id,
			$a_type
	)

Reimplemented from ilExplorer.

Definition at line 313 of file class.ilLMTableOfContentsExplorer.php.

References ilPageObject\_lookupActive().

        {
                include_once("./Services/COPage/classes/class.ilPageObject.php");
                $active = ilPageObject::_lookupActive($a_id, $this->lm_obj->getType(),
                        $this->lm_set->get("time_scheduled_page_activation"));

                if(!$active && $a_type == "pg")
                {
                        return false;
                }
                else
                {
                        return true;
                }
        }

Here is the call graph for this function:

ilTableOfContentsExplorer::offlineMode

(

)

get offline mode

Definition at line 106 of file class.ilLMTableOfContentsExplorer.php.

References $offline.

Referenced by buildFrameTarget(), buildLinkTarget(), forceExpanded(), getImage(), and isClickable().

        {
                return $this->offline;
        }

Here is the caller graph for this function:

ilTableOfContentsExplorer::setOfflineMode

(

$a_offline = true

)

set offline mode

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

References ilExplorer\setFrameTarget().

        {
                $this->offline = $a_offline;

                if ($a_offline)
                {
                        if ($this->export_format == "scorm")
                        {
                                $this->setFrameTarget("");
                        }
                }

        }

Here is the call graph for this function:

Field Documentation

ilTableOfContentsExplorer::$offline

Definition at line 45 of file class.ilLMTableOfContentsExplorer.php.

Referenced by offlineMode().

ilTableOfContentsExplorer::$output

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

ilTableOfContentsExplorer::$root_id

Definition at line 43 of file class.ilLMTableOfContentsExplorer.php.

---

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

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