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
	getImage ($a_name)
	get image path (may be overwritten by derived classes)
	forceExpanded ($a_obj_id)
	force expansion of node
Data Fields
	$root_id
	$output
	$offline

Detailed Description

Definition at line 36 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 149 of file class.ilLMTableOfContentsExplorer.php.

References 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";

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


                if ($showViewInFrameset)
                {
                        return "bottom";
                }
                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 175 of file class.ilLMTableOfContentsExplorer.php.

References 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")
                        {
                                $a_node = $this->tree->fetchSuccessorNode($a_node_id, "pg");
                                $a_node_id = $a_node["child"];
                        }
                        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 113 of file class.ilLMTableOfContentsExplorer.php.

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

        {
                global $lng;

                include_once("content/classes/class.ilObjContentObject.php");
                $access_str = "";
                if (!ilObjContentObject::_checkPreconditionsOfPage(
                        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()).$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 212 of file class.ilLMTableOfContentsExplorer.php.

References offlineMode().

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

Here is the call graph for this function:

ilTableOfContentsExplorer::getImage ( $ a_name )

get image path (may be overwritten by derived classes)

Reimplemented from ilExplorer.

Definition at line 204 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 54 of file class.ilLMTableOfContentsExplorer.php.

References $_GET, ilExplorer::addFilter(), ilLMExplorer::ilLMExplorer(), ilExplorer::setExpandTarget(), ilExplorer::setFiltered(), ilExplorer::setFilterMode(), ilExplorer::setFrameTarget(), and ilExplorer::setSessionExpandVariable().

        {
                parent::ilLMExplorer($a_target, $a_lm_obj);
                $this->setExpandTarget("lm_presentation.php?cmd=".$_GET["cmd"]."&ref_id=".$this->lm_obj->getRefId());
                $this->setSessionExpandVariable("lmtocexpand");
                $this->export_format = $a_export_format;

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

                // 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";

                if ($showViewInFrameset)
                {
                        $this->setFrameTarget("bottom");
                }
                else
                {
                        $this->setFrameTarget("_top");
                }

        }

Here is the call graph for this function:

ilTableOfContentsExplorer::offlineMode ( )

get offline mode

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

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

        {
                return $this->offline;
        }

Here is the caller graph for this function:

ilTableOfContentsExplorer::setOfflineMode ( $ a_offline = true )

set offline mode

Definition at line 88 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: