ilLMPresentationGUI Class Reference

Class ilLMPresentationGUI. More...

Collaboration diagram for ilLMPresentationGUI:

Public Member Functions
	initByRequest ($query_params, bool $embed_mode=false)
	Init services and this class by request params. More...
	getService ()
	Get service. More...
	injectTemplate ($tpl)
	Inject template. More...
	executeCommand ()
	offlineMode ()
	checks wether offline content generation is activated More...
	getExportFormat ()
	get export format More...
	nop ()
	this dummy function is needed for offline package creation More...
	attrib2arr ($a_attributes)
	getCurrentFrameSet ()
	get frames of current frame set More...
	determineLayout ()
	Determine layout. More...
	resume ()
	layout ($a_xml="main.xml", $doShow=true)
	generates frame layout More...
	saveFrameUrl ()
	Save frame url. More...
	fullscreen ()
	media ()
	glossary ()
	page ()
	ilMainMenu ()
	output main menu More...
	ilTOC ($a_get_explorer=false)
	table of contents More...
	getLMPresentationTitle ()
	Get lm presentationtitle. More...
	ilLMMenu ()
	output learning module menu More...
	setHeader ()
	output lm header More...
	ilLMSubMenu ()
	output learning module submenu More...
	redrawHeaderAction ()
	Redraw header action. More...
	addHeaderAction ()
	Add header action. More...
	getHeaderAction ($a_redraw=false)
	Add header action. More...
	ilLMNotes ()
	output notes of page More...
	ilLocator ($a_std_templ_loaded=false)
	locator More...
	getCurrentPageId ()
	Get the current page id. More...
	getLayoutLinkTargets ()
	getContent ($skip_nav=false)
	process <ilPage> content tag More...
	updatePageRating ()
	basicPageGuiInit (\ilLMPageGUI $a_page_gui)
	Basic page gui initialisation. More...
	ilGlossary ()
	show glossary term More...
	ilMedia ()
	output media More...
	ilJavaScript ($a_inline="", $a_file="", $a_location="")
	Puts JS into template. More...
	getSuccessorPage ()
	Get successor page. More...
	processNodes (&$a_content, &$a_node)
	buildTag ($type, $name, $attr="")
	generate a tag with given name and attributes More...
	infoScreen ()
	this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed More...
	showInfoScreen ()
	info screen call from inside learning module More...
	outputInfoScreen ($a_standard_locator=false)
	info screen More...
	showPrintViewSelection ()
	show selection screen for print view More...
	initPrintViewSelectionForm ()
	Init print view selection form. More...
	showPrintView ()
	show print view More...
	downloadFile ()
	download file of file lists More...
	showDownloadList ()
	show download list More...
	downloadExportFile ()
	send download file (xml/html) More...
	getFocusLink ($a_ref_id, $a_obj_id, $a_return_ref_id)
	Get focused link (used in learning objectives courses) More...
	showMessageScreen ($a_content)
	Show message screen. More...
	showNoPublicAccess ()
	Show info message, if page is not accessible in public area. More...
	showNoPageAccess ()
	Show info message, if page is not accessible in public area. More...
	showNavRestrictionDueToQuestions ()
	Show message if navigation to page is not allowed due to unanswered questions. More...
	getSourcecodeDownloadLink ()
	getOfflineDirectory ()
	get offline directory More...
	handleCodeParagraph ($page_id, $paragraph_id, $title, $text)
	store paragraph into file directory files/codefile_$pg_id_$paragraph_id/downloadtitle More...
	getLMPageGUI ($a_id)
	Get lm page gui object. More...
	getLMPage ($a_id, $a_type="")
	Get lm page object. More...
	refreshToc ()
	Refresh toc (called if questions have been answered correctly) More...
	observeNoteAction ($a_lm_id, $a_page_id, $a_type, $a_action, $a_note_id)
	Generate new ilNote and send Notifications to the users informing that there are new comments in the LM. More...
	getHTML ($pars)
	Get HTML (called by kios mode through ilCtrl) More...

Data Fields
	$tpl
	$lng
	$layout_doc
	$offline
	$offline_directory
	$chapter_has_no_active_page = false
	$deactivated_page = false

Protected Member Functions
	getTracker ()
	Get tracker. More...
	addResourceFiles ()
	Add resource files. More...
	setContentStyles ()
	Set content style. More...
	setSystemStyle ()
	Set system style. More...
	getPageContent ()
	Get page content. More...
	renderRating ()
	Render rating. More...
	initScreenHead ($a_active_tab="info")
	filterNonAccessibleNode ($nodes)
	renderPageTitle ()
	renderTabs ($active_tab, $current_page_id)
	Render tabs. More...

Protected Attributes
	$user
	$rbacsystem
	$ctrl
	$error
	$nav_history
	$access
	$settings
	$main_menu
	$locator
	$tree
	$help
	$lm
	$embed_mode = false
	$current_page_id = 0
	$focus_id = 0
	$export_all_languages = false
	$requested_back_pg
	$requested_search_string
	$requested_focus_return
	$requested_ref_id
	$requested_obj_id
	$requested_obj_type
	$requested_transl
	$requested_frame
	$linker
	$service
	$ui
	$toolbar
	$additional_content = []
	$ot

Detailed Description

Class ilLMPresentationGUI.

GUI class for learning module presentation

Author

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

Version

$Id$

ilLMPresentationGUI: ilNoteGUI, ilInfoScreenGUI ilLMPresentationGUI: ilLMPageGUI, ilGlossaryDefPageGUI, ilCommonActionDispatcherGUI ilLMPresentationGUI: ilLearningProgressGUI, ilAssGenFeedbackPageGUI ilLMPresentationGUI: ilRatingGUI

Definition at line 21 of file class.ilLMPresentationGUI.php.

Member Function Documentation

addHeaderAction()

ilLMPresentationGUI::addHeaderAction

(

)

Add header action.

Definition at line 1020 of file class.ilLMPresentationGUI.php.

References getHeaderAction().

Referenced by layout().

    {
        $this->tpl->setVariable("HEAD_ACTION", $this->getHeaderAction());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addResourceFiles()

ilLMPresentationGUI::addResourceFiles ( )

protected

Add resource files.

Definition at line 730 of file class.ilLMPresentationGUI.php.

References $store, ilAccordionGUI\addCss(), ilAccordionGUI\addJavaScript(), ilGlyphGUI\CLOSE, ilGlyphGUI\get(), ilUIFramework\init(), ilYuiUtil\initConnection(), iljQueryUtil\initjQuery(), iljQueryUtil\initjQueryUI(), and offlineMode().

Referenced by getHTML(), and layout().

    {
        iljQueryUtil::initjQuery($this->tpl);
        iljQueryUtil::initjQueryUI($this->tpl);
        ilUIFramework::init($this->tpl);

        if (!$this->offlineMode()) {
            ilAccordionGUI::addJavaScript();
            ilAccordionGUI::addCss();

            $this->tpl->addJavascript("./Modules/LearningModule/js/LearningModule.js");
            $close_call = "il.LearningModule.setCloseHTML('" . ilGlyphGUI::get(ilGlyphGUI::CLOSE) . "');";
            $this->tpl->addOnLoadCode($close_call);

            //$store->set("cf_".$this->lm->getId());

            // handle initial content
            if ($this->requested_frame == "") {
                $store = new ilSessionIStorage("lm");
                $last_frame_url = $store->get("cf_" . $this->lm->getId());
                if ($last_frame_url != "") {
                    $this->tpl->addOnLoadCode("il.LearningModule.setLastFrameUrl('" . $last_frame_url . "', 'center_bottom');");
                }

                if (true) {
                    $this->tpl->addOnLoadCode("il.LearningModule.setSaveUrl('" .
                        $this->ctrl->getLinkTarget($this, "saveFrameUrl", "", false, false) . "');
                            il.LearningModule.openInitFrames();
                            ");
                }
                $this->tpl->addOnLoadCode("il.LearningModule.setTocRefreshUrl('" .
                    $this->ctrl->getLinkTarget($this, "refreshToc", "", false, false) . "');
                        ");
            }

            // from main menu
            //                          $this->tpl->addJavascript("./Services/JavaScript/js/Basic.js");
            $this->tpl->addJavascript("./Services/Navigation/js/ServiceNavigation.js");
            ilYuiUtil::initConnection($this->tpl);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

attrib2arr()

ilLMPresentationGUI::attrib2arr

(

$a_attributes

)

Definition at line 483 of file class.ilLMPresentationGUI.php.

Referenced by layout(), and processNodes().

    {
        $attr = array();
        if (!is_array($a_attributes)) {
            return $attr;
        }
        foreach ($a_attributes as $attribute) {
            $attr[$attribute->name()] = $attribute->value();
        }
        return $attr;
    }

Here is the caller graph for this function:

basicPageGuiInit()

ilLMPresentationGUI::basicPageGuiInit

(

\ilLMPageGUI

$a_page_gui

)

Basic page gui initialisation.

Parameters

Definition at line 1608 of file class.ilLMPresentationGUI.php.

References getCurrentPageId(), ilObjStyleSheet\getEffectiveContentStyleId(), getOfflineDirectory(), offlineMode(), ilPageObjectGUI\setFileDownloadLink(), ilPageObjectGUI\setFullscreenLink(), ilPageObjectGUI\setOfflineDirectory(), ilPageObjectGUI\setOutputMode(), ilPageObjectGUI\setSourcecodeDownloadScript(), and ilPageObjectGUI\setStyleId().

Referenced by executeCommand().

    {
        $a_page_gui->setStyleId(ilObjStyleSheet::getEffectiveContentStyleId(
            $this->lm->getStyleSheetId(),
            "lm"
        ));
        if (!$this->offlineMode()) {
            $a_page_gui->setOutputMode("presentation");
            $this->fill_on_load_code = true;
        } else {
            $a_page_gui->setOutputMode("offline");
            $a_page_gui->setOfflineDirectory($this->getOfflineDirectory());
            $this->fill_on_load_code = false;
        }
        if (!$this->offlineMode()) {
            $this->ctrl->setParameter($this, "obj_id", $this->getCurrentPageId());              // see #22403
        }
        $a_page_gui->setFileDownloadLink($this->linker->getLink("downloadFile"));
        $a_page_gui->setSourcecodeDownloadScript($this->linker->getLink(
            "sourcecodeDownload",
            $this->getCurrentPageId()
        ));
        if (!$this->offlineMode()) {
            $this->ctrl->setParameter($this, "obj_id", $this->requested_obj_id);
        }
        $a_page_gui->setFullscreenLink($this->linker->getLink("fullscreen"));
        $a_page_gui->setSourcecodeDownloadScript($this->linker->getLink("download_paragraph"));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildTag()

ilLMPresentationGUI::buildTag	(		$type,
			$name,
			$attr = ""
	)

generate a tag with given name and attributes

Parameters

string	"start" | "end" | "" for starting or ending tag or complete tag
string	element/tag name
array	array of attributes

Definition at line 1878 of file class.ilLMPresentationGUI.php.

References $name, and $type.

Referenced by processNodes().

    {
        $tag = "<";

        if ($type == "end") {
            $tag .= "/";
        }

        $tag .= $name;

        if (is_array($attr)) {
            foreach ($attr as $k => $v) {
                $tag .= " " . $k . "=\"$v\"";
            }
        }

        if ($type == "") {
            $tag .= "/";
        }

        $tag .= ">\n";

        return $tag;
    }

Here is the caller graph for this function:

determineLayout()

ilLMPresentationGUI::determineLayout

(

)

Determine layout.

Returns

string

Definition at line 507 of file class.ilLMPresentationGUI.php.

Referenced by layout().

                                      : string
    {
        return "standard";
    }

Here is the caller graph for this function:

downloadExportFile()

ilLMPresentationGUI::downloadExportFile

(

)

send download file (xml/html)

Definition at line 2872 of file class.ilLMPresentationGUI.php.

References $_GET, ilUtil\deliverFile(), and exit.

    {
        if (!$this->lm->isActiveDownloads() || !$this->lm->isActiveLMMenu()) {
            return;
        }

        $base_type = explode("_", $_GET["type"]);
        $base_type = $base_type[0];
        $file = $this->lm->getPublicExportFile($base_type);
        if ($this->lm->getPublicExportFile($base_type) != "") {
            $dir = $this->lm->getExportDirectory($_GET["type"]);
            if (is_file($dir . "/" . $file)) {
                ilUtil::deliverFile($dir . "/" . $file, $file);
                exit;
            }
        }
    }

Here is the call graph for this function:

downloadFile()

ilLMPresentationGUI::downloadFile

(

)

download file of file lists

Definition at line 2810 of file class.ilLMPresentationGUI.php.

References getCurrentPageId(), and getLMPageGUI().

    {
        $page_gui = $this->getLMPageGUI($this->getCurrentPageId());
        $page_gui->downloadFile();
    }

Here is the call graph for this function:

executeCommand()

ilLMPresentationGUI::executeCommand

(

)

Exceptions

ilCtrlException
ilLMPresentationException

Definition at line 354 of file class.ilLMPresentationGUI.php.

References $_GET, $access, $ctrl, $error, $ilErr, $ilUser, $lng, $nav_history, $requested_obj_id, $ret, $user, basicPageGuiInit(), getCurrentPageId(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getLMPageGUI(), initScreenHead(), layout(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, outputInfoScreen(), ilNotification\setNotification(), ilNotification\TYPE_LM, ilNotification\TYPE_LM_PAGE, and user().

    {
        $ilNavigationHistory = $this->nav_history;
        $ilAccess = $this->access;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        $ilErr = $this->error;

        // check read permission and parent conditions
        // todo: replace all this by ilAccess call
        if (!$ilAccess->checkAccess("read", "", $this->requested_ref_id) &&
            (!(($this->ctrl->getCmd() == "infoScreen" || $this->ctrl->getNextClass() == "ilinfoscreengui")
            && $ilAccess->checkAccess("visible", "", $this->requested_ref_id)))) {
            $ilErr->raiseError($lng->txt("permission_denied"), $ilErr->WARNING);
        }
        
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd("layout", array("showPrintView"));


        $obj_id = $this->requested_obj_id;
        $this->ctrl->setParameter($this, "obj_id", $this->requested_obj_id);
        $ilNavigationHistory->addItem($this->requested_ref_id, $this->ctrl->getLinkTarget($this), "lm");
        $this->ctrl->setParameter($this, "obj_id", $obj_id);

        switch ($next_class) {
            case "ilnotegui":
                $ret = $this->layout();
                break;
                
            case "ilinfoscreengui":
                $ret = $this->outputInfoScreen();
                break;
                
            case "ilcommonactiondispatchergui":
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $gui->enableCommentsSettings(false);
                $this->ctrl->forwardCommand($gui);
                break;

            case "illmpagegui":
                $page_gui = $this->getLMPageGUI($this->requested_obj_id);
                $this->basicPageGuiInit($page_gui);
                $ret = $ilCtrl->forwardCommand($page_gui);
                break;
                
            case "ilassgenfeedbackpagegui":
                $page_gui = new ilAssGenFeedbackPageGUI($_GET["pg_id"]);
                //$this->basicPageGuiInit($page_gui);
                $ret = $ilCtrl->forwardCommand($page_gui);
                break;

            case "ilglossarydefpagegui":
                $page_gui = new ilGlossaryDefPageGUI($this->requested_obj_id);
                $this->basicPageGuiInit($page_gui);
                $ret = $ilCtrl->forwardCommand($page_gui);
                break;
                
            case "illearningprogressgui":
                $this->initScreenHead("learning_progress");
                $new_gui = new ilLearningProgressGUI(
                    ilLearningProgressGUI::LP_CONTEXT_REPOSITORY,
                    $this->requested_ref_id,
                    $ilUser->getId()
                );
                $this->ctrl->forwardCommand($new_gui);
                break;
            
            case "ilratinggui":
                $rating_gui = new ilRatingGUI();
                $rating_gui->setObject($this->lm->getId(), "lm", $this->requested_obj_id, "lm");
                $this->ctrl->forwardCommand($rating_gui);
                break;

            default:
                if ($_GET["ntf"]) {
                    switch ($_GET["ntf"]) {
                        case 1:
                            ilNotification::setNotification(ilNotification::TYPE_LM, $this->user->getId(), $this->lm->getId(), false);
                            break;

                        case 2:
                            ilNotification::setNotification(ilNotification::TYPE_LM, $this->user->getId(), $this->lm->getId(), true);
                            break;

                        case 3:
                            ilNotification::setNotification(ilNotification::TYPE_LM_PAGE, $this->user->getId(), $this->getCurrentPageId(), false);
                            break;

                        case 4:
                            ilNotification::setNotification(ilNotification::TYPE_LM_PAGE, $this->user->getId(), $this->getCurrentPageId(), true);
                            break;
                    }
                    $ilCtrl->redirect($this, "layout");
                }
                $ret = $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

filterNonAccessibleNode()

ilLMPresentationGUI::filterNonAccessibleNode (   $nodes )

protected

Parameters

array

$nodes

Returns

array

Definition at line 2229 of file class.ilLMPresentationGUI.php.

References getTracker(), and offlineMode().

Referenced by showPrintViewSelection().

    {
        $tracker = $this->getTracker();
        // if navigation is restricted based on correct answered questions
        // check if we have preceeding pages including unsanswered/incorrect answered questions
        if (!$this->offlineMode()) {
            if ($this->lm->getRestrictForwardNavigation()) {
                $nodes = array_filter($nodes, function ($node) use ($tracker) {
                    return !$tracker->hasPredIncorrectAnswers($node["child"]);
                });
            }
        }
        return $nodes;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fullscreen()

ilLMPresentationGUI::fullscreen

(

)

Definition at line 789 of file class.ilLMPresentationGUI.php.

References media().

    {
        return $this->media();
    }

Here is the call graph for this function:

getContent()

ilLMPresentationGUI::getContent

(

$skip_nav = false

)

process <ilPage> content tag

Parameters

	$a_page_node	page node
int	$a_page_id	header / footer page id

Returns

string

Definition at line 1478 of file class.ilLMPresentationGUI.php.

References $tpl, getPageContent(), renderRating(), setContentStyles(), and user().

Referenced by getHTML(), and layout().

    {
        $this->fill_on_load_code = true;
        $this->setContentStyles();

        $tpl = new ilTemplate("tpl.lm_content.html", true, true, "Modules/LearningModule/Presentation");

        // call ilLMContentRendererGUI

        $navigation_renderer = new ilLMNavigationRendererGUI(
            $this->service,
            $this,
            $this->lng,
            $this->user,
            $this->tpl,
            $this->requested_obj_id,
            $this->requested_back_pg,
            $this->requested_frame
        );


        if (!$skip_nav) {
            $tpl->setVariable("TOP_NAVIGATION", $navigation_renderer->renderTop());
            $tpl->setVariable("BOTTOM_NAVIGATION", $navigation_renderer->renderBottom());
        }
        $tpl->setVariable("PAGE_CONTENT", $this->getPageContent());
        $tpl->setVariable("RATING", $this->renderRating());


        return $tpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentFrameSet()

ilLMPresentationGUI::getCurrentFrameSet

(

)

get frames of current frame set

Definition at line 498 of file class.ilLMPresentationGUI.php.

    {
        return $this->frames;
    }

getCurrentPageId()

ilLMPresentationGUI::getCurrentPageId

(

)

Get the current page id.

Returns

bool|int current page id

Definition at line 1309 of file class.ilLMPresentationGUI.php.

References $current_page_id, $ilUser, $requested_obj_id, $user, ilLMObject\_isPagePublic(), ilPageObject\_lookupActive(), ilLMObject\_lookupType(), ANONYMOUS_USER_ID, and offlineMode().

Referenced by basicPageGuiInit(), downloadFile(), executeCommand(), getHeaderAction(), getSuccessorPage(), ilLMMenu(), ilLMNotes(), ilLMSubMenu(), ilMainMenu(), renderRating(), and showPrintView().

    {
        return $this->service->getNavigationStatus()->getCurrentPage();

        $ilUser = $this->user;

        if (!$this->offlineMode() && $this->current_page_id !== false) {
            return $this->current_page_id;
        }

        $this->chapter_has_no_active_page = false;
        $this->deactivated_page = false;
        
        // determine object id
        if (empty($this->requested_obj_id)) {
            $obj_id = $this->lm_tree->getRootId();
        } else {
            $obj_id = $this->requested_obj_id;
            $active = ilLMPage::_lookupActive(
                $obj_id,
                $this->lm->getType(),
                $this->lm_set->get("time_scheduled_page_activation")
            );

            if (!$active &&
                ilLMPageObject::_lookupType($obj_id) == "pg") {
                $this->deactivated_page = true;
            }
        }

        // obj_id not in tree -> it is a unassigned page -> return page id
        if (!$this->lm_tree->isInTree($obj_id)) {
            return $obj_id;
        }

        $curr_node = $this->lm_tree->getNodeData($obj_id);
        
        $active = ilLMPage::_lookupActive(
            $obj_id,
            $this->lm->getType(),
            $this->lm_set->get("time_scheduled_page_activation")
        );

        if ($curr_node["type"] == "pg" &&
            $active) {          // page in tree -> return page id
            $page_id = $curr_node["obj_id"];
        } else {                // no page -> search for next page and return its id
            $succ_node = true;
            $active = false;
            $page_id = $obj_id;
            while ($succ_node && !$active) {
                $succ_node = $this->lm_tree->fetchSuccessorNode($page_id, "pg");
                $page_id = $succ_node["obj_id"];
                $active = ilLMPage::_lookupActive(
                    $page_id,
                    $this->lm->getType(),
                    $this->lm_set->get("time_scheduled_page_activation")
                );
            }

            if ($succ_node["type"] != "pg") {
                $this->chapter_has_no_active_page = true;
                return 0;
            }

            // if public access get first public page in chapter
            if ($ilUser->getId() == ANONYMOUS_USER_ID &&
               $this->lm_gui->object->getPublicAccessMode() == 'selected') {
                $public = ilLMObject::_isPagePublic($page_id);

                while ($public === false && $page_id > 0) {
                    $succ_node = $this->lm_tree->fetchSuccessorNode($page_id, 'pg');
                    $page_id = $succ_node['obj_id'];
                    $public = ilLMObject::_isPagePublic($page_id);
                }
            }
            
            // check whether page found is within "clicked" chapter
            if ($this->lm_tree->isInTree($page_id)) {
                $path = $this->lm_tree->getPathId($page_id);
                if (!in_array($this->requested_obj_id, $path)) {
                    $this->chapter_has_no_active_page = true;
                }
            }
        }

        $this->current_page_id = $page_id;
        return $page_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExportFormat()

ilLMPresentationGUI::getExportFormat

(

)

get export format

Returns

string export format

Definition at line 471 of file class.ilLMPresentationGUI.php.

Referenced by renderTabs().

    {
        return $this->export_format;
    }

Here is the caller graph for this function:

getFocusLink()

ilLMPresentationGUI::getFocusLink	(		$a_ref_id,
			$a_obj_id,
			$a_return_ref_id
	)

Get focused link (used in learning objectives courses)

Parameters

int	$a_ref_id	reference id of learning module
int	$a_obj_id	chapter or page id
int	$a_return_ref_id	return ref id

Returns

string link

Definition at line 2899 of file class.ilLMPresentationGUI.php.

    {
        return "ilias.php?baseClass=ilLMPresentationGUI&ref_id=" . $a_ref_id . "&obj_id=" . $a_obj_id . "&focus_id=" .
            $a_obj_id . "&focus_return=" . $a_return_ref_id;
    }

getHeaderAction()

ilLMPresentationGUI::getHeaderAction

(

$a_redraw = false

)

Add header action.

Definition at line 1028 of file class.ilLMPresentationGUI.php.

References $access, $embed_mode, $ilSetting, $settings, $tpl, ANONYMOUS_USER_ID, getCurrentPageId(), ilUtil\getImagePath(), ilNotification\hasNotification(), ilNotification\hasOptOut(), offlineMode(), ilCommonActionDispatcherGUI\setSubObject(), ilNotification\TYPE_LM, ilNotification\TYPE_LM_PAGE, ilCommonActionDispatcherGUI\TYPE_REPOSITORY, and user().

Referenced by addHeaderAction(), getHTML(), and redrawHeaderAction().

    {
        if ($this->offline) {
            return;
        }
        $ilAccess = $this->access;
        $ilSetting = $this->settings;
        $tpl = $this->tpl;

        $lm_id = $this->lm->getId();
        $pg_id = $this->getCurrentPageId();

        $this->lng->loadLanguageModule("content");

        $dispatcher = new ilCommonActionDispatcherGUI(
            ilCommonActionDispatcherGUI::TYPE_REPOSITORY,
            $ilAccess,
            $this->lm->getType(),
            $this->lm->getRefId(),
            $this->lm->getId()
        );
        $dispatcher->setSubObject("pg", $this->getCurrentPageId());

        $this->ctrl->setParameter($this, "embed_mode", $this->embed_mode);
        $this->ctrl->setParameterByClass("ilnotegui", "embed_mode", $this->embed_mode);
        $this->ctrl->setParameterByClass("iltagginggui", "embed_mode", $this->embed_mode);
        ilObjectListGUI::prepareJSLinks(
            $this->ctrl->getLinkTarget($this, "redrawHeaderAction", "", true),
            $this->ctrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "ilnotegui"), "", "", true, false),
            $this->ctrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "iltagginggui"), "", "", true, false),
            $this->tpl
        );

        $lg = $dispatcher->initHeaderAction();
        if (!$ilSetting->get("disable_notes")) {
            $lg->enableNotes(true);
            if (!$this->embed_mode) {
                $lg->enableComments($this->lm->publicNotes(), false);
            }
        }
                
        if ($this->lm->hasRating() && !$this->offlineMode()) {
            $lg->enableRating(
                true,
                $this->lng->txt("lm_rating"),
                false,
                array("ilcommonactiondispatchergui", "ilratinggui")
            );
        }

        // notification
        if ($this->user->getId() != ANONYMOUS_USER_ID && !$this->embed_mode) {
            if (ilNotification::hasNotification(ilNotification::TYPE_LM, $this->user->getId(), $lm_id)) {
                $this->ctrl->setParameter($this, "ntf", 1);
                if (ilNotification::hasOptOut($lm_id)) {
                    $lg->addCustomCommand($this->ctrl->getLinkTarget($this), "cont_notification_deactivate_lm");
                }

                $lg->addHeaderIcon(
                    "not_icon",
                    ilUtil::getImagePath("notification_on.svg"),
                    $this->lng->txt("cont_notification_activated")
                );
            } else {
                $this->ctrl->setParameter($this, "ntf", 2);
                $lg->addCustomCommand($this->ctrl->getLinkTarget($this), "cont_notification_activate_lm");

                if (ilNotification::hasNotification(ilNotification::TYPE_LM_PAGE, $this->user->getId(), $pg_id)) {
                    $this->ctrl->setParameter($this, "ntf", 3);
                    $lg->addCustomCommand($this->ctrl->getLinkTarget($this), "cont_notification_deactivate_page");

                    $lg->addHeaderIcon(
                        "not_icon",
                        ilUtil::getImagePath("notification_on.svg"),
                        $this->lng->txt("cont_page_notification_activated")
                    );
                } else {
                    $this->ctrl->setParameter($this, "ntf", 4);
                    $lg->addCustomCommand($this->ctrl->getLinkTarget($this), "cont_notification_activate_page");

                    $lg->addHeaderIcon(
                        "not_icon",
                        ilUtil::getImagePath("notification_off.svg"),
                        $this->lng->txt("cont_notification_deactivated")
                    );
                }
            }
            $this->ctrl->setParameter($this, "ntf", "");
        }

        if (!$this->offline) {
            if ($ilAccess->checkAccess("write", "", $this->requested_ref_id)) {
                if ($this->getCurrentPageId() <= 0) {
                    $link = $this->ctrl->getLinkTargetByClass(["ilLMEditorGUI", "ilobjlearningmodulegui"], "chapters");
                } else {
                    $link = ILIAS_HTTP_PATH . "/ilias.php?baseClass=ilLMEditorGUI&ref_id=" . $this->requested_ref_id .
                        "&obj_id=" . $this->getCurrentPageId() . "&to_page=1";
                }
                $lg->addCustomCommand($link, "edit_page");
            }
        }


        if (!$a_redraw) {
            return $lg->getHeaderAction($this->tpl);
        } else {
            // we need to add onload code manually (rating, comments, etc.)
            return $lg->getHeaderAction() .
                $tpl->getOnLoadCodeForAsynch();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHTML()

ilLMPresentationGUI::getHTML

(

$pars

)

Get HTML (called by kios mode through ilCtrl)

Parameters

$pars

Returns

string|void

Exceptions

ilLMPresentationException

Definition at line 3125 of file class.ilLMPresentationGUI.php.

References $tpl, addResourceFiles(), getContent(), getHeaderAction(), ilLMNotes(), and renderRating().

    {
        $this->addResourceFiles();
        switch ($pars["cmd"]) {
            case "layout":
                $tpl = new ilTemplate("tpl.embedded_view.html", true, true, "Modules/LearningModule");
                $tpl->setVariable("HEAD_ACTION", $this->getHeaderAction());
                $tpl->setVariable("PAGE_RATING", $this->renderRating());
                $tpl->setVariable("PAGE", $this->getContent(true));
                $tpl->setVariable("COMMENTS", $this->ilLMNotes());
                return $tpl->get();
        }
        return "";
    }

Here is the call graph for this function:

getLayoutLinkTargets()

ilLMPresentationGUI::getLayoutLinkTargets

(

)

Definition at line 1400 of file class.ilLMPresentationGUI.php.

References $i, $res, $type, exit, xpath_eval(), and xpath_new_context().

    {
        if (!is_object($this->layout_doc)) {
            return array();
        }

        $xpc = xpath_new_context($this->layout_doc);

        $path = "/ilLayout/ilLinkTargets/LinkTarget";
        $res = xpath_eval($xpc, $path);
        $targets = array();
        for ($i = 0; $i < count($res->nodeset); $i++) {
            $type = $res->nodeset[$i]->get_attribute("Type");
            $frame = $res->nodeset[$i]->get_attribute("Frame");
            $onclick = $res->nodeset[$i]->get_attribute("OnClick");
            $targets[$type] = array("Type" => $type, "Frame" => $frame, "OnClick" => $onclick);
        }
        var_dump($targets);
        exit;
        return $targets;
    }

Here is the call graph for this function:

getLMPage()

ilLMPresentationGUI::getLMPage	(		$a_id,
			$a_type = ""
	)

Get lm page object.

Parameters

Definition at line 3026 of file class.ilLMPresentationGUI.php.

References $lang, $type, and ilPageObject\_exists().

Referenced by ilMedia().

    {
        $type = ($a_type == "mep")
            ? "mep"
            : "lm";

        $lang = $this->lang;
        if (!ilPageObject::_exists($type, $a_id, $lang)) {
            $lang = "-";
            if ($this->lang != "-" && ilPageObject::_exists($type, $a_id, $this->ot->getFallbackLanguage())) {
                $lang = $this->ot->getFallbackLanguage();
            }
        }

        switch ($type) {
            case "mep":
                return new ilMediaPoolPage($a_id, 0, $lang);
            default:
                return new ilLMPage($a_id, 0, $lang);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLMPageGUI()

ilLMPresentationGUI::getLMPageGUI

(

$a_id

)

Get lm page gui object.

Parameters

Definition at line 3008 of file class.ilLMPresentationGUI.php.

References ilPageObject\_exists().

Referenced by downloadFile(), executeCommand(), and showPrintView().

    {
        $concrete_lang = $this->service->getPresentationStatus()->getConcreteLang();
        if ($this->lang != "-" && ilPageObject::_exists("lm", $a_id, $this->lang)) {
            return new ilLMPageGUI($a_id, 0, false, $this->lang, $concrete_lang);
        }
        if ($this->lang != "-" && ilPageObject::_exists("lm", $a_id, $this->ot->getFallbackLanguage())) {
            return new ilLMPageGUI($a_id, 0, false, $this->ot->getFallbackLanguage(), $concrete_lang);
        }
        return new ilLMPageGUI($a_id, 0, false, "", $concrete_lang);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLMPresentationTitle()

ilLMPresentationGUI::getLMPresentationTitle

(

)

Get lm presentationtitle.

Parameters

Definition at line 934 of file class.ilLMPresentationGUI.php.

Referenced by ilLocator(), initScreenHead(), renderPageTitle(), setHeader(), showPrintView(), and showPrintViewSelection().

    {
        return $this->service->getPresentationStatus()->getLMPresentationTitle();
    }

Here is the caller graph for this function:

getOfflineDirectory()

ilLMPresentationGUI::getOfflineDirectory

(

)

get offline directory

Returns

directory where to store offline files

current used in code paragraph

Definition at line 2969 of file class.ilLMPresentationGUI.php.

References $offline_directory.

Referenced by basicPageGuiInit(), handleCodeParagraph(), and ilGlossary().

    {
        return $this->offline_directory;
    }

Here is the caller graph for this function:

getPageContent()

ilLMPresentationGUI::getPageContent ( )

protected

Get page content.

Definition at line 1513 of file class.ilLMPresentationGUI.php.

References help(), and user().

Referenced by getContent(), and page().

    {
        $content_renderer = new ilLMContentRendererGUI(
            $this->service,
            $this,
            $this->lng,
            $this->ctrl,
            $this->access,
            $this->user,
            $this->help,
            $this->requested_obj_id
        );

        return $content_renderer->render();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getService()

ilLMPresentationGUI::getService

(

)

Get service.

Returns

ilLMPresentationService

Definition at line 325 of file class.ilLMPresentationGUI.php.

References $service.

Referenced by renderTabs().

                                 : \ilLMPresentationService
    {
        return $this->service;
    }

Here is the caller graph for this function:

getSourcecodeDownloadLink()

ilLMPresentationGUI::getSourcecodeDownloadLink

(

)

Definition at line 2949 of file class.ilLMPresentationGUI.php.

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

    {
        if (!$this->offlineMode()) {
            //$this->ctrl->setParameter($this, session_name(), session_id());
            $target = $this->ctrl->getLinkTarget($this, "");
            $target = ilUtil::appendUrlParameterString($target, session_name() . "=" . session_id());
            return $this->ctrl->getLinkTarget($this, "");
        } else {
            return "";
        }
    }

Here is the call graph for this function:

getSuccessorPage()

ilLMPresentationGUI::getSuccessorPage

(

)

Get successor page.

Parameters

Definition at line 1750 of file class.ilLMPresentationGUI.php.

References $ilUser, $requested_obj_id, $user, ilLMObject\_isPagePublic(), ilPageObject\_lookupActivationData(), ilPageObject\_lookupActive(), ilLMObject\_lookupType(), ANONYMOUS_USER_ID, getCurrentPageId(), and ilUtil\now().

    {
        $ilUser = $this->user;

        $page_id = $this->getCurrentPageId();

        if (empty($page_id)) {
            return 0;
        }

        // determine successor page_id
        $found = false;

        // empty chapter
        if ($this->chapter_has_no_active_page &&
            ilLMObject::_lookupType($this->requested_obj_id) == "st") {
            $c_id = $this->requested_obj_id;
        } else {
            if ($this->deactivated_page) {
                $c_id = $this->requested_obj_id;
            } else {
                $c_id = $page_id;
            }
        }
        while (!$found) {
            $succ_node = $this->lm_tree->fetchSuccessorNode($c_id, "pg");
            $c_id = $succ_node["obj_id"];

            $active = ilLMPage::_lookupActive(
                $c_id,
                $this->lm->getType(),
                $this->lm_set->get("time_scheduled_page_activation")
            );

            if ($succ_node["obj_id"] > 0 &&
                $ilUser->getId() == ANONYMOUS_USER_ID &&
                ($this->lm->getPublicAccessMode() == "selected" &&
                    !ilLMObject::_isPagePublic($succ_node["obj_id"]))) {
                $found = false;
            } elseif ($succ_node["obj_id"] > 0 && !$active) {
                // look, whether activation data should be shown
                $act_data = ilLMPage::_lookupActivationData((int) $succ_node["obj_id"], $this->lm->getType());
                if ($act_data["show_activation_info"] &&
                    (ilUtil::now() < $act_data["activation_start"])) {
                    $found = true;
                } else {
                    $found = false;
                }
            } else {
                $found = true;
            }
        }

        if ($found) {
            return $succ_node["obj_id"];
        }
        return 0;
    }

Here is the call graph for this function:

getTracker()

ilLMPresentationGUI::getTracker ( )

protected

Get tracker.

Returns

ilLMTracker

Definition at line 345 of file class.ilLMPresentationGUI.php.

Referenced by filterNonAccessibleNode(), and showPrintView().

    {
        return $this->service->getTracker();
    }

Here is the caller graph for this function:

glossary()

ilLMPresentationGUI::glossary

(

)

Returns

string

Exceptions

ilException

Definition at line 820 of file class.ilLMPresentationGUI.php.

References ilAccordionGUI\addCss(), ilAccordionGUI\addJavaScript(), ilGlossary(), ilUIFramework\init(), iljQueryUtil\initjQuery(), iljQueryUtil\initjQueryUI(), offlineMode(), renderPageTitle(), setContentStyles(), and setSystemStyle().

    {
        $this->tpl = new ilGlobalTemplate("tpl.glossary_term_output.html", true, true, "Modules/LearningModule");
        //$GLOBALS["tpl"] = $this->tpl;
        $this->renderPageTitle();

        iljQueryUtil::initjQuery($this->tpl);
        iljQueryUtil::initjQueryUI($this->tpl);
        ilUIFramework::init($this->tpl);
        ilAccordionGUI::addJavaScript($this->tpl);
        ilAccordionGUI::addCss($this->tpl);

        // set style sheets
        $this->setContentStyles();
        $this->setSystemStyle();

        $this->ilGlossary();
        if (!$this->offlineMode()) {
            $this->tpl->printToStdout();
        } else {
            return $this->tpl->printToString();
        }

        return "";
    }

Here is the call graph for this function:

handleCodeParagraph()

ilLMPresentationGUI::handleCodeParagraph	(		$page_id,
			$paragraph_id,
			$title,
			$text
	)

store paragraph into file directory files/codefile_$pg_id_$paragraph_id/downloadtitle

Definition at line 2978 of file class.ilLMPresentationGUI.php.

References getOfflineDirectory(), and ilUtil\makeDirParents().

    {
        $directory = $this->getOfflineDirectory() . "/codefiles/" . $page_id . "/" . $paragraph_id;
        ilUtil::makeDirParents($directory);
        $file = $directory . "/" . $title;
        if (!($fp = @fopen($file, "w+"))) {
            die("<b>Error</b>: Could not open \"" . $file . "\" for writing" .
                " in <b>" . __FILE__ . "</b> on line <b>" . __LINE__ . "</b><br />");
        }
        chmod($file, 0770);
        fwrite($fp, $text);
        fclose($fp);
    }

Here is the call graph for this function:

ilGlossary()

ilLMPresentationGUI::ilGlossary

(

)

show glossary term

Definition at line 1641 of file class.ilLMPresentationGUI.php.

References $ctrl, getOfflineDirectory(), offlineMode(), and setContentStyles().

Referenced by glossary(), and layout().

    {
        $ilCtrl = $this->ctrl;

        $term_gui = new ilGlossaryTermGUI($this->requested_obj_id);

        // content style
        $this->setContentStyles();

        $term_gui->setPageLinker($this->linker);

        $term_gui->setOfflineDirectory($this->getOfflineDirectory());
        if (!$this->offlineMode()) {
            $ilCtrl->setParameter($this, "pg_type", "glo");
        }
        $term_gui->output($this->offlineMode(), $this->tpl);


        if (!$this->offlineMode()) {
            $ilCtrl->setParameter($this, "pg_type", "");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ilJavaScript()

ilLMPresentationGUI::ilJavaScript	(		$a_inline = "",
			$a_file = "",
			$a_location = ""
	)

Puts JS into template.

Definition at line 1735 of file class.ilLMPresentationGUI.php.

Referenced by layout().

    {
        if ($a_inline != "") {
            $js_tpl = new ilTemplate($a_inline, true, false, $a_location);
            $js = $js_tpl->get();
            $this->tpl->setVariable("INLINE_JS", $js);
        }
    }

Here is the caller graph for this function:

ilLMMenu()

ilLMPresentationGUI::ilLMMenu

(

)

output learning module menu

Definition at line 943 of file class.ilLMPresentationGUI.php.

References getCurrentPageId(), and renderTabs().

Referenced by layout().

    {
        $this->renderTabs("content", $this->getCurrentPageId());
        /*$this->tpl->setVariable("MENU", $this->lm_gui->setilLMMenu($this->offlineMode()
            ,$this->getExportFormat(), "content", false, true, $this->getCurrentPageId(),
            $this->lang, $this->export_all_languages));*/
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLMNotes()

ilLMPresentationGUI::ilLMNotes

(

)

output notes of page

Definition at line 1143 of file class.ilLMPresentationGUI.php.

References $access, $ilSetting, $settings, ilNoteGUI\enablePublicNotesDeletion(), getCurrentPageId(), and offlineMode().

Referenced by getHTML(), and layout().

                                : string
    {
        $ilAccess = $this->access;
        $ilSetting = $this->settings;

        // no notes in offline (export) mode
        if ($this->offlineMode()) {
            return "";
        }
        
        // now output comments
        
        if ($ilSetting->get("disable_comments")) {
            return "";
        }
        if (!$this->lm->publicNotes()) {
            return "";
        }

        $next_class = $this->ctrl->getNextClass($this);

        $pg_id = $this->getCurrentPageId();

        if ($pg_id == 0) {
            return "";
        }
        $notes_gui = new ilNoteGUI($this->lm->getId(), $this->getCurrentPageId(), "pg");
        
        if ($ilAccess->checkAccess("write", "", $this->requested_ref_id) &&
            $ilSetting->get("comments_del_tutor", 1)) {
            $notes_gui->enablePublicNotesDeletion(true);
        }
        
        $this->ctrl->setParameter($this, "frame", $this->requested_frame);
        $this->ctrl->setParameter($this, "obj_id", $this->requested_obj_id);
        
        $notes_gui->enablePrivateNotes();
        if ($this->lm->publicNotes()) {
            $notes_gui->enablePublicNotes();
        }

        $callback = array($this, "observeNoteAction");
        $notes_gui->addObserver($callback);

        if ($next_class == "ilnotegui") {
            $html = $this->ctrl->forwardCommand($notes_gui);
        } else {
            $html = $notes_gui->getNotesHTML();
        }
        return $html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLMSubMenu()

ilLMPresentationGUI::ilLMSubMenu

(

)

output learning module submenu

Definition at line 963 of file class.ilLMPresentationGUI.php.

References $rbacsystem, ilFrameTargetInfo\_getFrame(), getCurrentPageId(), and offlineMode().

Referenced by layout().

    {
        $rbacsystem = $this->rbacsystem;
        if ($this->abstract) {
            return;
        }

        $showViewInFrameset = true;
        
        if ($showViewInFrameset) {
            $buttonTarget = ilFrameTargetInfo::_getFrame("MainContent");
        } else {
            $buttonTarget = "_top";
        }


        $tpl_menu = new ilTemplate("tpl.lm_sub_menu.html", true, true, "Modules/LearningModule");

        $pg_id = $this->getCurrentPageId();
        if ($pg_id == 0) {
            return;
        }

        // edit learning module
        if (!$this->offlineMode()) {
            if ($rbacsystem->checkAccess("write", $this->requested_ref_id)) {
                $tpl_menu->setCurrentBlock("edit_page");
                $page_id = $this->getCurrentPageId();
                $tpl_menu->setVariable("EDIT_LINK", ILIAS_HTTP_PATH . "/ilias.php?baseClass=ilLMEditorGUI&ref_id=" . $this->requested_ref_id .
                    "&obj_id=" . $page_id . "&to_page=1");
                $tpl_menu->setVariable("EDIT_TXT", $this->lng->txt("edit_page"));
                $tpl_menu->setVariable("EDIT_TARGET", $buttonTarget);
                $tpl_menu->parseCurrentBlock();
            }

            $page_id = $this->getCurrentPageId();

            // permanent link
            $this->tpl->setPermanentLink("pg", "", $page_id . "_" . $this->lm->getRefId());
        }

        $this->tpl->setVariable("SUBMENU", $tpl_menu->get());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLocator()

ilLMPresentationGUI::ilLocator

(

$a_std_templ_loaded = false

)

locator

Definition at line 1199 of file class.ilLMPresentationGUI.php.

References $_GET, $ctrl, $DIC, $lang, $locator, $requested_frame, $requested_obj_id, $requested_ref_id, $tree, ilFrameTargetInfo\_getFrame(), ilStructureObject\_getPresentationTitle(), ilLMObjectFactory\getInstance(), getLMPresentationTitle(), offlineMode(), and ilUtil\shortenText().

Referenced by initScreenHead(), and layout().

    {
        global $DIC;
        $ltiview = $DIC["lti"];
        $ilLocator = $this->locator;
        $tree = $this->tree;
        $ilCtrl = $this->ctrl;

        if (empty($this->requested_obj_id)) {
            $a_id = $this->lm_tree->getRootId();
        } else {
            $a_id = $this->requested_obj_id;
        }


        if (!$this->lm->cleanFrames()) {
            $frame_param = $this->requested_frame;
            $frame_target = "";
        } elseif (!$this->offlineMode()) {
            $frame_param = "";
            $frame_target = ilFrameTargetInfo::_getFrame("MainContent");
        } else {
            $frame_param = "";
            $frame_target = "_top";
        }

        if (!$this->offlineMode()) {
            // LTI
            if ($ltiview->isActive()) {
                $ilLocator->addRepositoryItems();
            } else {
                $ilLocator->addRepositoryItems();
                //$ilLocator->addItem("...", "");

                /*
                $par_id = $tree->getParentId($this->requested_ref_id);
                $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $par_id);
                $ilLocator->addItem(
                    ilObject::_lookupTitle(ilObject::_lookupObjId($par_id)),
                    $ilCtrl->getLinkTargetByClass("ilrepositorygui", "frameset"),
                    ilFrameTargetInfo::_getFrame("MainContent"), $par_id);
                $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $this->requested_ref_id);*/
            }
        } else {
            $ilLocator->setOffline(true);
        }

        if ($this->lm_tree->isInTree($a_id)) {
            $path = $this->lm_tree->getPathFull($a_id);

            foreach ($path as $key => $row) {
                if ($row["type"] != "pg") {
                    if ($row["child"] != $this->lm_tree->getRootId()) {
                        $ilLocator->addItem(
                            ilUtil::shortenText(
                                ilStructureObject::_getPresentationTitle(
                                    $row["child"],
                                    ilLMOBject::CHAPTER_TITLE,
                                    $this->lm->isActiveNumbering(),
                                    $this->lm_set->get("time_scheduled_page_activation"),
                                    false,
                                    0,
                                    $this->lang
                                ),
                                50,
                                true
                            ),
                            $this->linker->getLink("layout", $row["child"], $frame_param, "StructureObject"),
                            $frame_target
                        );
                    } else {
                        $ilLocator->addItem(
                            ilUtil::shortenText($this->getLMPresentationTitle(), 50, true),
                            $this->linker->getLink("layout", "", $frame_param),
                            $frame_target,
                            $this->requested_ref_id
                        );
                    }
                }
            }
        } else {                // lonely page
            $ilLocator->addItem(
                $this->getLMPresentationTitle(),
                $this->linker->getLink("layout", "", $this->requested_frame)
            );

            $lm_obj = ilLMObjectFactory::getInstance($this->lm, $a_id);

            $ilLocator->addItem(
                $lm_obj->getTitle(),
                $this->linker->getLink("layout", $a_id, $frame_param),
                $frame_target
            );
        }

        if (DEBUG) {
            $debug = "DEBUG: <font color=\"red\">" . $this->type . "::" . $this->id . "::" . $_GET["cmd"] . "</font><br/>";
        }

        //$prop_name = $this->objDefinition->getPropertyName($_GET["cmd"],$this->type);


        $this->tpl->setLocator();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMainMenu()

ilLMPresentationGUI::ilMainMenu

(

)

output main menu

Definition at line 885 of file class.ilLMPresentationGUI.php.

References $DIC, getCurrentPageId(), and offlineMode().

    {
        // LTI
        global $DIC;
        $ltiview = $DIC["lti"];
        if ($ltiview->isActive()) {
            $ilMainMenu = new LTI\ilMainMenuGUI("_top", false, $this->tpl);
        } else {
            $ilMainMenu = new ilMainMenuGUI("_top", false, $this->tpl);
        }

        if ($this->offlineMode()) {
            $this->tpl->touchBlock("pg_intro");
            $this->tpl->touchBlock("pg_outro");
            return;
        }

        $page_id = $this->getCurrentPageId();
        if ($page_id > 0) {
            $ilMainMenu->setLoginTargetPar("pg_" . $page_id . "_" . $this->lm->getRefId());
        }

        //$this->tpl->touchBlock("mm_intro");
        //$this->tpl->touchBlock("mm_outro");
        $this->tpl->touchBlock("pg_intro");
        $this->tpl->touchBlock("pg_outro");
        $this->tpl->setBodyClass("std");
        $this->tpl->setVariable("MAINMENU", $ilMainMenu->getHTML());
        // LTI
        $this->tpl->setVariable("MAINMENU_SPACER", $ilMainMenu->getSpacerClass());
    }

Here is the call graph for this function:

ilMedia()

ilLMPresentationGUI::ilMedia

(

)

output media

Definition at line 1667 of file class.ilLMPresentationGUI.php.

References $_GET, $xml, ilMediaItem\_getMapAreasIntLinks(), ilUtil\getImagePath(), getLMPage(), ilUtil\getWebspaceDir(), IL_MODE_ALIAS, IL_MODE_OUTPUT, ilObjMediaObjectGUI\includePresentationJS(), ilObjMediaObject\isTypeAllowed(), offlineMode(), renderPageTitle(), setContentStyles(), xslt_create(), xslt_error(), and xslt_free().

Referenced by media().

    {
        $this->setContentStyles();

        $this->renderPageTitle();

        $this->tpl->setCurrentBlock("ilMedia");
        $med_links = ilMediaItem::_getMapAreasIntLinks($this->requested_mob_id);
        $link_xml = $this->linker->getLinkXML($med_links);

        $media_obj = new ilObjMediaObject($this->requested_mob_id);
        if (!empty($_GET["pg_id"])) {
            $pg_obj = $this->getLMPage($_GET["pg_id"], $_GET["pg_type"]);
            $pg_obj->buildDom();

            $xml = "<dummy>";
            // todo: we get always the first alias now (problem if mob is used multiple
            // times in page)
            $xml .= $pg_obj->getMediaAliasElement($this->requested_mob_id);
            $xml .= $media_obj->getXML(IL_MODE_OUTPUT);
            $xml .= $link_xml;
            $xml .= "</dummy>";
        } else {
            $xml = "<dummy>";
            // todo: we get always the first alias now (problem if mob is used multiple
            // times in page)
            $xml .= $media_obj->getXML(IL_MODE_ALIAS);
            $xml .= $media_obj->getXML(IL_MODE_OUTPUT);
            $xml .= $link_xml;
            $xml .= "</dummy>";
        }


        $xsl = file_get_contents("./Services/COPage/xsl/page.xsl");
        $args = array( '/_xml' => $xml, '/_xsl' => $xsl );
        $xh = xslt_create();

        if (!$this->offlineMode()) {
            $wb_path = ilUtil::getWebspaceDir("output") . "/";
        } else {
            $wb_path = "";
        }

        $mode = ($_GET["cmd"] == "fullscreen")
            ? "fullscreen"
            : "media";
        $enlarge_path = ilUtil::getImagePath("enlarge.svg", false, "output", $this->offlineMode());
        $fullscreen_link =
            $this->linker->getLink("fullscreen");
        $params = array('mode' => $mode, 'enlarge_path' => $enlarge_path,
            'link_params' => "ref_id=" . $this->lm->getRefId(),'fullscreen_link' => $fullscreen_link,
                        'enable_html_mob' => ilObjMediaObject::isTypeAllowed("html") ? "y" : "n",
            'ref_id' => $this->lm->getRefId(), 'pg_frame' => $pg_frame, 'webspace_path' => $wb_path);
        $output = xslt_process($xh, "arg:/_xml", "arg:/_xsl", null, $args, $params);

        echo xslt_error($xh);
        xslt_free($xh);

        // unmask user html
        $this->tpl->setVariable("MEDIA_CONTENT", $output);
        
        // add js
        ilObjMediaObjectGUI::includePresentationJS($this->tpl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ilTOC()

ilLMPresentationGUI::ilTOC

(

$a_get_explorer = false

)

table of contents

Definition at line 920 of file class.ilLMPresentationGUI.php.

Referenced by refreshToc().

    {
        $fac = new ilLMTOCExplorerGUIFactory();
        $exp = $fac->getExplorer($this->service, "ilTOC");
        $exp->handleCommand();
        return $exp;
    }

Here is the caller graph for this function:

infoScreen()

ilLMPresentationGUI::infoScreen

(

)

this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed

Definition at line 1910 of file class.ilLMPresentationGUI.php.

References outputInfoScreen().

    {
        $this->ctrl->setCmd("showSummary");
        $this->ctrl->setCmdClass("ilinfoscreengui");
        $this->outputInfoScreen();
    }

Here is the call graph for this function:

initByRequest()

ilLMPresentationGUI::initByRequest	(		$query_params,
		bool	$embed_mode = false
	)

Init services and this class by request params.

The request params are usually retrieved by HTTP request, but also adjusted during HTML exports, this is, why this method needs to be public.

Parameters

array

$query_params

request query params

Definition at line 280 of file class.ilLMPresentationGUI.php.

References $embed_mode, ilObjectTranslation\getInstance(), and user().

    {
        $this->service = new ilLMPresentationService(
            $this->user,
            $query_params,
            $this->offline,
            $this->export_all_languages,
            $this->export_format,
            null,
            $embed_mode
        );

        $request = $this->service->getRequest();

        $this->requested_obj_type = $request->getRequestedObjType();
        $this->requested_ref_id = $request->getRequestedRefId();
        $this->requested_transl = $request->getRequestedTranslation();      // handled by presentation status
        $this->requested_obj_id = $request->getRequestedObjId();            // handled by navigation status
        $this->requested_back_pg = $request->getRequestedBackPage();
        $this->requested_frame = $request->getRequestedFrame();
        $this->requested_search_string = $request->getRequestedSearchString();
        $this->requested_focus_return = $request->getRequestedFocusReturn();
        $this->requested_mob_id = $request->getRequestedMobId();

        $this->lm_set = $this->service->getSettings();
        $this->lm_gui = $this->service->getLearningModuleGUI();
        $this->lm = $this->service->getLearningModule();
        $this->tracker = $this->service->getTracker();
        $this->linker = $this->service->getLinker();
        $this->embed_mode = $embed_mode;
        if ($request->getRequestedEmbedMode()) {
            $this->embed_mode = true;
        }

        // language translation
        $this->lang = $this->service->getPresentationStatus()->getLang();
        $this->lm_tree = $this->service->getLMTree();
        $this->focus_id = $this->service->getPresentationStatus()->getFocusId();
        $this->ot = ilObjectTranslation::getInstance($this->lm->getId());
    }

Here is the call graph for this function:

initPrintViewSelectionForm()

ilLMPresentationGUI::initPrintViewSelectionForm

(

)

Init print view selection form.

Definition at line 2248 of file class.ilLMPresentationGUI.php.

References $ctrl, $lng, and ilRadioGroupInputGUI\setValue().

Referenced by showPrintViewSelection().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $this->form = new ilPropertyFormGUI();
        $this->form->setForceTopButtons(true);

        // selection type
        $radg = new ilRadioGroupInputGUI($lng->txt("cont_selection"), "sel_type");
        $radg->setValue("page");
        $op1 = new ilRadioOption($lng->txt("cont_current_page"), "page");
        $radg->addOption($op1);
        $op2 = new ilRadioOption($lng->txt("cont_current_chapter"), "chapter");
        $radg->addOption($op2);
        $op3 = new ilRadioOption($lng->txt("cont_selected_pg_chap"), "selection");
        $radg->addOption($op3);

        $nl = new ilNestedListInputGUI("", "obj_id");
        $this->nl = $nl;
        $op3->addSubItem($nl);


        $this->form->addItem($radg);

        $this->form->addCommandButton("showPrintView", $lng->txt("cont_show_print_view"));
        $this->form->setOpenTag(false);
        $this->form->setCloseTag(false);

        $this->form->setTitle(" ");
        $this->form->setFormAction($ilCtrl->getFormAction($this));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initScreenHead()

ilLMPresentationGUI::initScreenHead (   $a_active_tab = "info" )

protected

Definition at line 1925 of file class.ilLMPresentationGUI.php.

References $access, $ilUser, $locator, $user, ilUtil\getImagePath(), getLMPresentationTitle(), ilLocator(), renderPageTitle(), and renderTabs().

Referenced by executeCommand(), and outputInfoScreen().

    {
        $ilAccess = $this->access;
        $ilLocator = $this->locator;
        $ilUser = $this->user;
        
        $this->renderPageTitle();
        
        // set style sheets
        /*
        if (!$this->offlineMode())
        {
            $this->tpl->setStyleSheetLocation(ilUtil::getStyleSheetLocation());
        }
        else
        {
            $style_name = $ilUser->getPref("style").".css";;
            $this->tpl->setStyleSheetLocation("./".$style_name);
        }*/

        $this->tpl->loadStandardTemplate();
        $this->tpl->setTitle($this->getLMPresentationTitle());
        $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_lm.svg"));

        $this->renderTabs($a_active_tab, 0);
        /*$this->tpl->setVariable("TABS", $this->lm_gui->setilLMMenu($this->offlineMode()
            ,$this->getExportFormat(), $a_active_tab, true, false, 0,
            $this->lang, $this->export_all_languages));*/
        
        // Full locator, if read permission is given
        if ($ilAccess->checkAccess("read", "", $this->requested_ref_id)) {
            $this->ilLocator(true);
        } else {
            $ilLocator->addRepositoryItems();
            $this->tpl->setLocator();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

injectTemplate()

ilLMPresentationGUI::injectTemplate

(

$tpl

)

Inject template.

Parameters

Definition at line 336 of file class.ilLMPresentationGUI.php.

References $tpl.

    {
        $this->tpl = $tpl;
    }

layout()

ilLMPresentationGUI::layout	(		$a_xml = "main.xml",
			$doShow = true
	)

generates frame layout

Definition at line 520 of file class.ilLMPresentationGUI.php.

References $additional, $attributes, $DIC, $ilUser, $requested_obj_type, $result, $tpl, $user, addHeaderAction(), addResourceFiles(), attrib2arr(), determineLayout(), domxml_open_mem(), getContent(), ilUtil\getStyleSheetLocation(), ilGlossary(), ilJavaScript(), ilLMMenu(), ilLMNotes(), ilLMSubMenu(), ilLocator(), media(), offlineMode(), renderPageTitle(), setHeader(), ui(), xpath_eval(), and xpath_new_context().

Referenced by executeCommand(), and resume().

    {
        global $DIC;

        $tpl = $this->tpl;
        $ilUser = $this->user;
        $layout = $this->determineLayout();

        // xmldocfile is deprecated! Use domxml_open_file instead.
        // But since using relative pathes with domxml under windows don't work,
        // we need another solution:
        $xmlfile = file_get_contents("./Modules/LearningModule/layouts/lm/" . $layout . "/" . $a_xml);

        if (!$doc = domxml_open_mem($xmlfile)) {
            throw new ilLMPresentationException("ilLMPresentation: XML File invalid. Error reading " .
                $layout . "/" . $a_xml . ".");
        }
        $this->layout_doc = $doc;
        //echo ":".htmlentities($xmlfile).":$layout:$a_xml:";

        // get current frame node
        $xpc = xpath_new_context($doc);
        $path = (empty($this->requested_frame) || ($this->requested_frame == "_blank"))
            ? "/ilLayout/ilFrame[1]"
            : "//ilFrame[@name='" . $this->requested_frame . "']";
        $result = xpath_eval($xpc, $path);
        $found = $result->nodeset;
        if (count($found) != 1) {
            throw new ilLMPresentationException("ilLMPresentation: XML File invalid. Found " . count($found) . " nodes for " .
                " path " . $path . " in " . $layout . "/" . $a_xml . ". LM Layout is " . $this->lm->getLayout());
        }
        $node = $found[0];

        // ProcessFrameset
        // node is frameset, if it has cols or rows attribute
        $attributes = $this->attrib2arr($node->attributes());

        $this->frames = array();

        // ProcessContentTag
        if ((empty($attributes["template"]) || !empty($this->requested_obj_type))
                && ($this->requested_frame != "_blank" || $this->requested_obj_type != "MediaObject")) {
            // we got a variable content frame (can display different
            // object types (PageObject, MediaObject, GlossarItem)
            // and contains elements for them)

            // determine object type
            if (empty($this->requested_obj_type)) {
                $obj_type = "PageObject";
            } else {
                $obj_type = $this->requested_obj_type;
            }

            // get object specific node
            $childs = $node->child_nodes();
            $found = false;
            foreach ($childs as $child) {
                if ($child->node_name() == $obj_type) {
                    $found = true;
                    $attributes = $this->attrib2arr($child->attributes());
                    $node = $child;
                    //echo "<br>2node:".$node->node_name();
                    break;
                }
            }
            if (!$found) {
                throw new ilLMPresentationException("ilLMPresentation: No template specified for frame '" .
                        $this->requested_frame . "' and object type '" . $obj_type . "'.");
            }
        }

        // get template
        $in_module = ($attributes["template_location"] == "module")
                ? true
                : false;
        /*                      if ($in_module)
                    {
                        $this->tpl = new ilGlobalTemplate($attributes["template"], true, true, $in_module);
                        $this->tpl->setBodyClass("");
                    }
                    else
                    {
                        $this->tpl = $tpl;
                    }*/

        // set style sheets
        if (!$this->offlineMode()) {
            $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
        } else {
            $style_name = $ilUser->getPref("style") . ".css";
            $this->tpl->setVariable("LOCATION_STYLESHEET", "./style/" . $style_name);
        }
            

        // to make e.g. advanced seletions lists work:
        //                      $GLOBALS["tpl"] = $this->tpl;

        $childs = $node->child_nodes();
            
        foreach ($childs as $child) {
            $child_attr = $this->attrib2arr($child->attributes());

            switch ($child->node_name()) {
                    case "ilMainMenu":
                        // @todo 6.0
//                                              $this->ilMainMenu();
                        break;

                    case "ilTOC":
                        // @todo 6.0
//                                              $this->ilTOC($child_attr["target_frame"]);
                        break;

                    case "ilPage":
                        $this->renderPageTitle();
                        $this->setHeader();
                        $this->ilLMMenu();
                        $this->addHeaderAction();
                        $content = $this->getContent();
                        $content .= $this->ilLMNotes();
                        $additional = $this->ui->renderer() ->render($this->additional_content);
                        $this->tpl->setContent($content . $additional);
                        break;

                    case "ilGlossary":
                        $content = $this->ilGlossary($child);
                        break;

                    case "ilLMNavigation":
                        // @todo 6.0
//                                              $this->ilLMNavigation();
                        break;

                    case "ilMedia":
                        $this->media();
                        break;

                    case "ilLocator":
                        $this->ilLocator();
                        break;
                        
                    case "ilJavaScript":
                        $this->ilJavaScript(
                            $child_attr["inline"],
                            $child_attr["file"],
                            $child_attr["location"]
                        );
                        break;

                    case "ilLMMenu":
                        //$this->ilLMMenu();
                        break;

                    case "ilLMHead":
                        // @todo 6.0
//                                              $this->ilLMHead();
                        break;
                        
                    case "ilLMSubMenu":
                        $this->ilLMSubMenu();
                        break;
                        
                    case "ilLMNotes":
                        $this->ilLMNotes();
                        break;
                }
        }

        // TODO: Very dirty hack to force the import of JavaScripts in learning content in the FAQ frame (e.g. if jsMath is in the content)
        // Unfortunately there is no standardized way to do this somewhere else. Calling fillJavaScripts always in ilTemplate causes multiple additions of the the js files.
        // 19.7.2014: outcommented, since fillJavaScriptFiles is called in the next blocks, and the
        // following lines would add the js files two times
        //                      if (strcmp($this->requested_frame, "topright") == 0) $this->tpl->fillJavaScriptFiles();
        //                      if (strcmp($this->requested_frame, "right") == 0) $this->tpl->fillJavaScriptFiles();
        //                      if (strcmp($this->requested_frame, "botright") == 0) $this->tpl->fillJavaScriptFiles();

        $this->addResourceFiles();

        if ($doShow) {
            // (horrible) workaround for preventing template engine
            // from hiding paragraph text that is enclosed
            // in curly brackets (e.g. "{a}", see ilPageObjectGUI::showPage())

            // @todo 6.0
            /*$this->tpl->fillTabs();
            if ($this->fill_on_load_code)
            {
                $this->tpl->fillOnLoadCode();
            }
            $content =  $this->tpl->get();
            $content = str_replace("&#123;", "{", $content);
            $content = str_replace("&#125;", "}", $content);

            header('Content-type: text/html; charset=UTF-8');
            echo $content;*/
            $tpl->printToStdout();
        } else {
            /*$tpl->printToStdout();
            $this->tpl->fillLeftNav();
            $this->tpl->fillOnLoadCode();*/

            $content = $tpl->printToString();
        }

        return($content);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

media()

ilLMPresentationGUI::media

(

)

Returns

string

Exceptions

ilException

Definition at line 798 of file class.ilLMPresentationGUI.php.

References ilMedia(), offlineMode(), setContentStyles(), and setSystemStyle().

Referenced by fullscreen(), and layout().

    {
        $this->tpl = new ilGlobalTemplate("tpl.fullscreen.html", true, true, "Modules/LearningModule");
        //$GLOBALS["tpl"] = $this->tpl;

        // set style sheets
        $this->setContentStyles();
        $this->setSystemStyle();

        $this->ilMedia();
        if (!$this->offlineMode()) {
            $this->tpl->printToStdout();
        } else {
            return $this->tpl->printToString();
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

nop()

ilLMPresentationGUI::nop

(

)

this dummy function is needed for offline package creation

Definition at line 479 of file class.ilLMPresentationGUI.php.

    {
    }

observeNoteAction()

ilLMPresentationGUI::observeNoteAction	(		$a_lm_id,
			$a_page_id,
			$a_type,
			$a_action,
			$a_note_id
	)

Generate new ilNote and send Notifications to the users informing that there are new comments in the LM.

Parameters

$a_lm_id
$a_page_id
$a_type
$a_action
$a_note_id

Definition at line 3068 of file class.ilLMPresentationGUI.php.

References ilLearningModuleNotification\ACTION_COMMENT, and ilNotification\TYPE_LM_PAGE.

    {
        $note = new ilNote($a_note_id);
        $note = $note->getText();

        $notification = new ilLearningModuleNotification(
            ilLearningModuleNotification::ACTION_COMMENT,
            ilNotification::TYPE_LM_PAGE,
            $this->lm,
            $a_page_id,
            $note
        );

        $notification->send();
    }

offlineMode()

ilLMPresentationGUI::offlineMode

(

)

checks wether offline content generation is activated

Definition at line 460 of file class.ilLMPresentationGUI.php.

References $offline.

Referenced by addResourceFiles(), basicPageGuiInit(), filterNonAccessibleNode(), getCurrentPageId(), getHeaderAction(), getSourcecodeDownloadLink(), glossary(), ilGlossary(), ilLMNotes(), ilLMSubMenu(), ilLocator(), ilMainMenu(), ilMedia(), layout(), media(), outputInfoScreen(), page(), renderRating(), and renderTabs().

    {
        return $this->offline;
    }

Here is the caller graph for this function:

outputInfoScreen()

ilLMPresentationGUI::outputInfoScreen

(

$a_standard_locator = false

)

info screen

Definition at line 1966 of file class.ilLMPresentationGUI.php.

References $access, initScreenHead(), and offlineMode().

Referenced by executeCommand(), infoScreen(), and showInfoScreen().

    {
        $ilAccess = $this->access;

        $this->initScreenHead();
        
        $this->lng->loadLanguageModule("meta");

        $info = new ilInfoScreenGUI($this->lm_gui);
        $info->enablePrivateNotes();
        $info->enableLearningProgress();

        $info->enableNews();
        if ($ilAccess->checkAccess("write", "", $this->requested_ref_id)) {
            $news_set = new ilSetting("news");
            $enable_internal_rss = $news_set->get("enable_rss_for_internal");
            
            $info->enableNewsEditing();
            
            if ($enable_internal_rss) {
                $info->setBlockProperty("news", "settings", true);
            }
        }
        
        // add read / back button
        /*
        if ($ilAccess->checkAccess("read", "", $this->requested_ref_id))
        {
            if ($this->requested_obj_id > 0)
            {
                $this->ctrl->setParameter($this, "obj_id", $this->requested_obj_id);
                $info->addButton($this->lng->txt("back"),
                    $this->ctrl->getLinkTarget($this, "layout"));
            }
            else
            {
                $info->addButton($this->lng->txt("view"),
                    $this->ctrl->getLinkTarget($this, "layout"));
            }
        }*/
        
        // show standard meta data section
        $info->addMetaDataSections($this->lm->getId(), 0, $this->lm->getType());

        if ($this->offlineMode()) {
            $this->tpl->setContent($info->getHTML());
            return $this->tpl->get();
        } else {
            // forward the command
            $this->ctrl->forwardCommand($info);
            //$this->tpl->setContent("aa");
            $this->tpl->printToStdout();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

page()

ilLMPresentationGUI::page

(

)

Definition at line 846 of file class.ilLMPresentationGUI.php.

References $DIC, $GLOBALS, $ilUser, $tpl, $user, getPageContent(), ilUtil\getStyleSheetLocation(), offlineMode(), renderPageTitle(), and setContentStyles().

    {
        global $DIC;

        $ilUser = $this->user;

        //if ($this->requested_frame != "_blank")
        //{
        //      $this->layout();
        //}
        //else
        //{
        $this->tpl = new ilGlobalTemplate("tpl.page_fullscreen.html", true, true, "Modules/LearningModule");
        $GLOBALS["tpl"] = $this->tpl;
        $this->renderPageTitle();

        $this->setContentStyles();

        // set style sheets
        if (!$this->offlineMode()) {
            $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
        } else {
            $style_name = $ilUser->getPref("style") . ".css";
            ;
            $this->tpl->setVariable("LOCATION_STYLESHEET", "./style/" . $style_name);
        }

        $this->tpl->setVariable("PAGE_CONTENT", $this->getPageContent());
        if (!$this->offlineMode()) {
            $this->tpl->printToStdout();
        } else {
            return $this->tpl->get();
        }
        //}
    }

Here is the call graph for this function:

processNodes()

ilLMPresentationGUI::processNodes	(	&	$a_content,
		&	$a_node
	)

Definition at line 1810 of file class.ilLMPresentationGUI.php.

References $_GET, $attributes, $requested_obj_id, attrib2arr(), and buildTag().

    {
        $child_nodes = $a_node->child_nodes();
        foreach ($child_nodes as $child) {
            if ($child->node_name() == "ilFrame") {
                $attributes = $this->attrib2arr($child->attributes());
                // node is frameset, if it has cols or rows attribute
                if ((!empty($attributes["rows"])) || (!empty($attrubtes["cols"]))) {
                    // if framset has name, another http request is necessary
                    // (html framesets don't have names, so we need a wrapper frame)
                    if (!empty($attributes["name"])) {
                        unset($attributes["template"]);
                        unset($attributes["template_location"]);
                        $attributes["src"] =
                            $this->linker->getLink(
                                "layout",
                                $this->requested_obj_id,
                                $attributes["name"],
                                "",
                                "keep",
                                "",
                                $_GET["srcstring"]
                            );
                        $attributes["title"] = $this->lng->txt("cont_frame_" . $attributes["name"]);
                        $a_content .= $this->buildTag("", "frame", $attributes);
                        $this->frames[$attributes["name"]] = $attributes["name"];
                    //echo "<br>processNodes:add1 ".$attributes["name"];
                    } else {    // ok, no name means that we can easily output the frameset tag
                        $a_content .= $this->buildTag("start", "frameset", $attributes);
                        $this->processNodes($a_content, $child);
                        $a_content .= $this->buildTag("end", "frameset");
                    }
                } else {        // frame with
                    unset($attributes["template"]);
                    unset($attributes["template_location"]);
                    $attributes["src"] =
                        $this->linker->getLink(
                            "layout",
                            $this->requested_obj_id,
                            $attributes["name"],
                            "",
                            "keep",
                            "",
                            $_GET["srcstring"]
                        );
                    $attributes["title"] = $this->lng->txt("cont_frame_" . $attributes["name"]);
                    if ($attributes["name"] == "toc") {
                        $attributes["src"] .= "#" . $this->requested_obj_id;
                    } else {
                        // Handle Anchors
                        if ($_GET["anchor"] != "") {
                            $attributes["src"] .= "#" . rawurlencode($_GET["anchor"]);
                        }
                    }
                    $a_content .= $this->buildTag("", "frame", $attributes);
                    $this->frames[$attributes["name"]] = $attributes["name"];
                }
            }
        }
    }

Here is the call graph for this function:

redrawHeaderAction()

ilLMPresentationGUI::redrawHeaderAction

(

)

Redraw header action.

Definition at line 1011 of file class.ilLMPresentationGUI.php.

References exit, and getHeaderAction().

    {
        echo $this->getHeaderAction(true);
        exit;
    }

Here is the call graph for this function:

refreshToc()

ilLMPresentationGUI::refreshToc

(

)

Refresh toc (called if questions have been answered correctly)

Definition at line 3051 of file class.ilLMPresentationGUI.php.

References exit, and ilTOC().

    {
        $exp = $this->ilTOC(true);

        echo $exp->getHTML() .
            "<script>" . $exp->getOnLoadCode() . "</script>";
        exit;
    }

Here is the call graph for this function:

renderPageTitle()

ilLMPresentationGUI::renderPageTitle ( )

protected

Definition at line 2993 of file class.ilLMPresentationGUI.php.

References getLMPresentationTitle().

Referenced by glossary(), ilMedia(), initScreenHead(), layout(), page(), and showPrintView().

    {
        $this->tpl->setHeaderPageTitle($this->getLMPresentationTitle());
        // @todo 6.0
//              $this->tpl->fillWindowTitle();
//              $this->tpl->fillContentLanguage();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderRating()

ilLMPresentationGUI::renderRating ( )

protected

Render rating.

Returns

string

Definition at line 1534 of file class.ilLMPresentationGUI.php.

References getCurrentPageId(), and offlineMode().

Referenced by getContent(), and getHTML().

    {
        // rating
        $rating = "";
        if ($this->lm->hasRatingPages() && !$this->offlineMode()) {
            $rating_gui = new ilRatingGUI();
            $rating_gui->setObject($this->lm->getId(), "lm", $this->getCurrentPageId(), "lm");
            $rating_gui->setYourRatingText($this->lng->txt("lm_rate_page"));

            /*
                $this->tpl->setVariable("VAL_RATING", $rating->getHTML(false, true,
                    "il.ExcPeerReview.saveComments(".$a_set["peer_id"].", %rating%)"));
            */

            $this->ctrl->setParameter($this, "pgid", $this->getCurrentPageId());
            $this->tpl->addOnLoadCode("il.LearningModule.setRatingUrl('" .
                $this->ctrl->getLinkTarget($this, "updatePageRating", "", true, false) .
                "')");
            $this->ctrl->setParameter($this, "pgid", "");

            $rating = '<div id="ilrtrpg" style="text-align:right">' .
                $rating_gui->getHtml(true, true, "il.LearningModule.saveRating(%rating%);") .
                "</div>";
        }
        return $rating;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderTabs()

ilLMPresentationGUI::renderTabs (   $active_tab,   $current_page_id  )

protected

Render tabs.

Parameters

$active_tab
$current_page_id

Definition at line 3090 of file class.ilLMPresentationGUI.php.

References $additional_content, $current_page_id, getExportFormat(), getService(), offlineMode(), ilLMMenuRendererGUI\render(), and user().

Referenced by ilLMMenu(), and initScreenHead().

    {
        $menu_editor = new ilLMMenuEditor();
        $menu_editor->setObjId($this->lm->getId());

        $navigation_renderer = new ilLMMenuRendererGUI(
            $this->getService(),
            $this->tabs,
            $this->toolbar,
            $current_page_id,
            $active_tab,
            (string) $this->getExportFormat(),
            $this->export_all_languages,
            $this->lm,
            $this->offlineMode(),
            $menu_editor,
            $this->lang,
            $this->ctrl,
            $this->access,
            $this->user,
            $this->lng,
            $this->tpl,
            function ($additional_content) {
                $this->additional_content[] = $additional_content;
            }
        );
        $navigation_renderer->render();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resume()

ilLMPresentationGUI::resume

(

)

Definition at line 512 of file class.ilLMPresentationGUI.php.

References layout().

    {
        $this->layout();
    }

Here is the call graph for this function:

saveFrameUrl()

ilLMPresentationGUI::saveFrameUrl

(

)

Save frame url.

Parameters

Definition at line 778 of file class.ilLMPresentationGUI.php.

References $_GET, and $store.

    {
        $store = new ilSessionIStorage("lm");
        if ($_GET["url"] != "") {
            $store->set("cf_" . $this->lm->getId(), $_GET["url"]);
        } else {
            $store->set("cf_" . $this->lm->getId(), $_GET["url"]);
        }
    }

setContentStyles()

ilLMPresentationGUI::setContentStyles ( )

protected

Set content style.

Definition at line 1425 of file class.ilLMPresentationGUI.php.

References ilObjStyleSheet\getContentStylePath(), and ilObjStyleSheet\getSyntaxStylePath().

Referenced by getContent(), glossary(), ilGlossary(), ilMedia(), media(), page(), showMessageScreen(), and showPrintView().

    {
        // content style

        $this->tpl->addCss(ilObjStyleSheet::getContentStylePath($this->lm->getStyleSheetId()));
        $this->tpl->addCss(ilObjStyleSheet::getSyntaxStylePath());

        /*
        $this->tpl->setCurrentBlock("ContentStyle");
        if (!$this->offlineMode())
        {
            $this->tpl->setVariable("LOCATION_CONTENT_STYLESHEET",
                ilObjStyleSheet::getContentStylePath($this->lm->getStyleSheetId()));
        }
        else
        {
            $this->tpl->setVariable("LOCATION_CONTENT_STYLESHEET", "content_style/content.css");
        }
        $this->tpl->parseCurrentBlock();

        // syntax style
        $this->tpl->setCurrentBlock("SyntaxStyle");
        if (!$this->offlineMode())
        {
            $this->tpl->setVariable("LOCATION_SYNTAX_STYLESHEET",
                ilObjStyleSheet::getSyntaxStylePath());
        }
        else
        {
            $this->tpl->setVariable("LOCATION_SYNTAX_STYLESHEET",
                "syntaxhighlight.css");
        }
        $this->tpl->parseCurrentBlock();*/
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setHeader()

ilLMPresentationGUI::setHeader

(

)

output lm header

Definition at line 954 of file class.ilLMPresentationGUI.php.

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

Referenced by layout().

    {
        $this->tpl->setTitle($this->getLMPresentationTitle());
        $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_lm.svg"));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setSystemStyle()

ilLMPresentationGUI::setSystemStyle ( )

protected

Set system style.

Definition at line 1463 of file class.ilLMPresentationGUI.php.

References ilUtil\getStyleSheetLocation().

Referenced by glossary(), and media().

    {
        $this->tpl->addCss(ilUtil::getStyleSheetLocation());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showDownloadList()

ilLMPresentationGUI::showDownloadList

(

)

show download list

Definition at line 2819 of file class.ilLMPresentationGUI.php.

References $tpl, ilMDUtils\_parseCopyright(), exit, and ui().

    {
        if (!$this->lm->isActiveDownloads() || !$this->lm->isActiveLMMenu()) {
            return;
        }

        //$this->setContentStyles();
        //$this->renderPageTitle();

        //$this->tpl->loadStandardTemplate();

        //$this->renderTabs("download", 0);

        //$this->ilLocator(true);
        //$this->tpl->stopTitleFloating();
        $tpl = new ilTemplate("tpl.lm_download_list.html", true, true, "Modules/LearningModule");

        // set title header
        //$this->tpl->setTitle($this->getLMPresentationTitle());
        //$this->tpl->setTitleIcon(ilUtil::getImagePath("icon_lm.svg"));

        // output copyright information
        $md = new ilMD($this->lm->getId(), 0, $this->lm->getType());
        if (is_object($md_rights = $md->getRights())) {
            $copyright = $md_rights->getDescription();
            
            $copyright = ilMDUtils::_parseCopyright($copyright);

            if ($copyright != "") {
                $this->lng->loadLanguageModule("meta");
                $tpl->setCurrentBlock("copyright");
                $tpl->setVariable("TXT_COPYRIGHT", $this->lng->txt("meta_copyright"));
                $tpl->setVariable("LM_COPYRIGHT", $copyright);
                $tpl->parseCurrentBlock();
            }
        }

        $download_table = new ilLMDownloadTableGUI($this, "showDownloadList", $this->lm);
        $tpl->setVariable("DOWNLOAD_TABLE", $download_table->getHTML());
        //$this->tpl->printToStdout();

        $modal = $this->ui->factory()->modal()->roundtrip(
            $this->lng->txt("download"),
            $this->ui->factory()->legacy($tpl->get())
        );
        echo $this->ui->renderer()->render($modal);
        exit();
    }

Here is the call graph for this function:

showInfoScreen()

ilLMPresentationGUI::showInfoScreen

(

)

info screen call from inside learning module

Definition at line 1920 of file class.ilLMPresentationGUI.php.

References outputInfoScreen().

    {
        $this->outputInfoScreen(true);
    }

Here is the call graph for this function:

showMessageScreen()

ilLMPresentationGUI::showMessageScreen

(

$a_content

)

Show message screen.

Parameters

Definition at line 2911 of file class.ilLMPresentationGUI.php.

References $tpl, and setContentStyles().

Referenced by showNavRestrictionDueToQuestions(), showNoPageAccess(), and showNoPublicAccess().

    {
        // content style
        $this->setContentStyles();

        $tpl = new ilTemplate("tpl.page_message_screen.html", true, true, "Modules/LearningModule");
        $tpl->setVariable("TXT_PAGE_NO_PUBLIC_ACCESS", $a_content);

        $this->tpl->setVariable("PAGE_CONTENT", $tpl->get());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showNavRestrictionDueToQuestions()

ilLMPresentationGUI::showNavRestrictionDueToQuestions

(

)

Show message if navigation to page is not allowed due to unanswered questions.

Definition at line 2943 of file class.ilLMPresentationGUI.php.

References showMessageScreen().

    {
        $this->showMessageScreen($this->lng->txt("cont_no_page_access_unansw_q"));
    }

Here is the call graph for this function:

showNoPageAccess()

ilLMPresentationGUI::showNoPageAccess

(

)

Show info message, if page is not accessible in public area.

Definition at line 2934 of file class.ilLMPresentationGUI.php.

References showMessageScreen().

    {
        $this->showMessageScreen($this->lng->txt("msg_no_page_access"));
    }

Here is the call graph for this function:

showNoPublicAccess()

ilLMPresentationGUI::showNoPublicAccess

(

)

Show info message, if page is not accessible in public area.

Definition at line 2926 of file class.ilLMPresentationGUI.php.

References showMessageScreen().

    {
        $this->showMessageScreen($this->lng->txt("msg_page_no_public_access"));
    }

Here is the call graph for this function:

showPrintView()

ilLMPresentationGUI::showPrintView

(

)

show print view

Definition at line 2284 of file class.ilLMPresentationGUI.php.

References $_POST, $ctrl, $ilUser, $lang, $lng, $tpl, $user, ilObjContentObject\_checkPreconditionsOfPage(), ilLMObject\_exists(), ilStructureObject\_getPresentationTitle(), ilLMPageObject\_getPresentationTitle(), ilInternalLink\_getTargetsOfSource(), ilLMObject\_isPagePublic(), ilGlossaryTerm\_lookGlossaryTerm(), ilPageObject\_lookupActive(), ilLMObject\_lookupType(), ilMDUtils\_parseCopyright(), ANONYMOUS_USER_ID, getCurrentPageId(), ilGlossaryDefinition\getDefinitionList(), ilObjStyleSheet\getEffectiveContentStyleId(), ilMD\getGeneral(), ilUtil\getImagePath(), getLMPageGUI(), getLMPresentationTitle(), getTracker(), ilUtil\getWebspaceDir(), IL_INST_ID, ilLMObject\PAGE_TITLE, renderPageTitle(), ilUtil\sendFailure(), setContentStyles(), and ilUtil\sortArray().

    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $tabs = $this->tabs;

        if (!$this->lm->isActivePrintView() || !$this->lm->isActiveLMMenu()) {
            return;
        }

        $this->renderPageTitle();

        $tabs->setBackTarget(
            $lng->txt("back"),
            $ilCtrl->getLinkTarget($this, "layout")
        );
        
        $c_obj_id = $this->getCurrentPageId();
        // set values according to selection
        if ($_POST["sel_type"] == "page") {
            if (!is_array($_POST["obj_id"]) || !in_array($c_obj_id, $_POST["obj_id"])) {
                $_POST["obj_id"][] = $c_obj_id;
            }
        }
        if ($_POST["sel_type"] == "chapter" && $c_obj_id > 0) {
            $path = $this->lm_tree->getPathFull($c_obj_id);
            $chap_id = $path[1]["child"];
            if ($chap_id > 0) {
                $_POST["obj_id"][] = $chap_id;
            }
        }
        
        $this->setContentStyles();

        $tpl = new ilTemplate("tpl.lm_print_view.html", true, true, "Modules/LearningModule");

        // set title header
        $this->tpl->setTitle($this->getLMPresentationTitle());

        $nodes = $this->lm_tree->getSubtree($this->lm_tree->getNodeData($this->lm_tree->getRootId()));

        $act_level = 99999;
        $activated = false;

        $glossary_links = array();
        $output_header = false;
        $media_links = array();

        // get header and footer
        if ($this->lm->getFooterPage() > 0 && !$this->lm->getHideHeaderFooterPrint()) {
            if (ilLMObject::_exists($this->lm->getFooterPage())) {
                $page_object_gui = $this->getLMPageGUI($this->lm->getFooterPage());
                $page_object_gui->setStyleId(ilObjStyleSheet::getEffectiveContentStyleId(
                    $this->lm->getStyleSheetId(),
                    "lm"
                ));

    
                // determine target frames for internal links
                $page_object_gui->setLinkFrame($this->requested_frame);
                $page_object_gui->setOutputMode("print");
                $page_object_gui->setPresentationTitle("");
                $page_object_gui->setFileDownloadLink("#");
                $page_object_gui->setFullscreenLink("#");
                $page_object_gui->setSourceCodeDownloadScript("#");
                $footer_page_content = $page_object_gui->showPage();
            }
        }
        if ($this->lm->getHeaderPage() > 0 && !$this->lm->getHideHeaderFooterPrint()) {
            if (ilLMObject::_exists($this->lm->getHeaderPage())) {
                $page_object_gui = $this->getLMPageGUI($this->lm->getHeaderPage());
                $page_object_gui->setStyleId(ilObjStyleSheet::getEffectiveContentStyleId(
                    $this->lm->getStyleSheetId(),
                    "lm"
                ));

    
                // determine target frames for internal links
                $page_object_gui->setLinkFrame($this->requested_frame);
                $page_object_gui->setOutputMode("print");
                $page_object_gui->setPresentationTitle("");
                $page_object_gui->setFileDownloadLink("#");
                $page_object_gui->setFullscreenLink("#");
                $page_object_gui->setSourceCodeDownloadScript("#");
                $header_page_content = $page_object_gui->showPage();
            }
        }

        // add free selected pages
        if (is_array($_POST["obj_id"])) {
            foreach ($_POST["obj_id"] as $k) {
                if ($k > 0 && !$this->lm_tree->isInTree($k)) {
                    if (ilLMObject::_lookupType($k) == "pg") {
                        $nodes[] = array("obj_id" => $k, "type" => "pg", "free" => true);
                    }
                }
            }
        } else {
            ilUtil::sendFailure($lng->txt("cont_print_no_page_selected"), true);
            $ilCtrl->redirect($this, "showPrintViewSelection");
        }

        foreach ($nodes as $node_key => $node) {
            // check page activation
            $active = ilLMPage::_lookupActive(
                $node["obj_id"],
                $this->lm->getType(),
                $this->lm_set->get("time_scheduled_page_activation")
            );
            if ($node["type"] == "pg" && !$active) {
                continue;
            }
            
            // print all subchapters/subpages if higher chapter
            // has been selected
            if ($node["depth"] <= $act_level) {
                if (is_array($_POST["obj_id"]) && in_array($node["obj_id"], $_POST["obj_id"])) {
                    $act_level = $node["depth"];
                    $activated = true;
                } else {
                    $act_level = 99999;
                    $activated = false;
                }
            }
            if ($this->lm->getRestrictForwardNavigation()) {
                if ($this->getTracker()->hasPredIncorrectAnswers($node["obj_id"])) {
                    continue;
                }
            }
            if ($activated &&
                ilObjContentObject::_checkPreconditionsOfPage($this->lm->getRefId(), $this->lm->getId(), $node["obj_id"])) {
                // output learning module header
                if ($node["type"] == "du") {
                    $output_header = true;
                }
                
                // output chapter title
                if ($node["type"] == "st") {
                    if ($ilUser->getId() == ANONYMOUS_USER_ID &&
                       $this->lm_gui->object->getPublicAccessMode() == "selected") {
                        if (!ilLMObject::_isPagePublic($node["obj_id"])) {
                            continue;
                        }
                    }

                    $chap = new ilStructureObject($this->lm, $node["obj_id"]);
                    $tpl->setCurrentBlock("print_chapter");

                    $chapter_title = $chap->_getPresentationTitle(
                        $node["obj_id"],
                        $this->lm->isActiveNumbering(),
                        $this->lm_set->get("time_scheduled_page_activation"),
                        0,
                        $this->lang
                    );
                    $tpl->setVariable(
                        "CHAP_TITLE",
                        $chapter_title
                    );
                        
                    if ($this->lm->getPageHeader() == ilLMOBject::CHAPTER_TITLE) {
                        if ($nodes[$node_key + 1]["type"] == "pg") {
                            $tpl->setVariable(
                                "CHAP_HEADER",
                                $header_page_content
                            );
                            $did_chap_page_header = true;
                        }
                    }

                    $tpl->parseCurrentBlock();
                    $tpl->setCurrentBlock("print_block");
                    $tpl->parseCurrentBlock();
                }

                // output page
                if ($node["type"] == "pg") {
                    if ($ilUser->getId() == ANONYMOUS_USER_ID &&
                       $this->lm_gui->object->getPublicAccessMode() == "selected") {
                        if (!ilLMObject::_isPagePublic($node["obj_id"])) {
                            continue;
                        }
                    }

                    $tpl->setCurrentBlock("print_item");
                    
                    // get page
                    $page_id = $node["obj_id"];
                    $page_object_gui = $this->getLMPageGUI($page_id);
                    $page_object = $page_object_gui->getPageObject();
                    $page_object_gui->setStyleId(ilObjStyleSheet::getEffectiveContentStyleId(
                        $this->lm->getStyleSheetId(),
                        "lm"
                    ));


                    // get lm page
                    $lm_pg_obj = new ilLMPageObject($this->lm, $page_id);
                    $lm_pg_obj->setLMId($this->lm->getId());

                    // determine target frames for internal links
                    $page_object_gui->setLinkFrame($this->requested_frame);
                    $page_object_gui->setOutputMode("print");
                    $page_object_gui->setPresentationTitle("");
                    
                    if ($this->lm->getPageHeader() == ilLMObject::PAGE_TITLE || $node["free"] === true) {
                        $page_title = ilLMPageObject::_getPresentationTitle(
                            $lm_pg_obj->getId(),
                            $this->lm->getPageHeader(),
                            $this->lm->isActiveNumbering(),
                            $this->lm_set->get("time_scheduled_page_activation"),
                            false,
                            0,
                            $this->lang
                        );

                        // prevent page title after chapter title
                        // that have the same content
                        if ($this->lm->isActiveNumbering()) {
                            $chapter_title = trim(substr(
                                $chapter_title,
                                strpos($chapter_title, " ")
                            ));
                        }

                        if ($page_title != $chapter_title) {
                            $page_object_gui->setPresentationTitle($page_title);
                        }
                    }

                    // handle header / footer
                    $hcont = $header_page_content;
                    $fcont = $footer_page_content;

                    if ($this->lm->getPageHeader() == ilLMOBject::CHAPTER_TITLE) {
                        if ($did_chap_page_header) {
                            $hcont = "";
                        }
                        if ($nodes[$node_key + 1]["type"] == "pg" &&
                            !($nodes[$node_key + 1]["depth"] <= $act_level
                             && !in_array($nodes[$node_key + 1]["obj_id"], $_POST["obj_id"]))) {
                            $fcont = "";
                        }
                    }
                    
                    $page_object_gui->setFileDownloadLink("#");
                    $page_object_gui->setFullscreenLink("#");
                    $page_object_gui->setSourceCodeDownloadScript("#");
                    $page_content = $page_object_gui->showPage();
                    if ($this->lm->getPageHeader() != ilLMObject::PAGE_TITLE) {
                        $tpl->setVariable(
                            "CONTENT",
                            $hcont . $page_content . $fcont
                        );
                    } else {
                        $tpl->setVariable(
                            "CONTENT",
                            $hcont . $page_content . $fcont . "<br />"
                        );
                    }
                    $chapter_title = "";
                    $tpl->parseCurrentBlock();
                    $tpl->setCurrentBlock("print_block");
                    $tpl->parseCurrentBlock();

                    // get internal links
                    $int_links = ilInternalLink::_getTargetsOfSource($this->lm->getType() . ":pg", $node["obj_id"]);

                    $got_mobs = false;

                    foreach ($int_links as $key => $link) {
                        if ($link["type"] == "git" &&
                            ($link["inst"] == IL_INST_ID || $link["inst"] == 0)) {
                            $glossary_links[$key] = $link;
                        }
                        if ($link["type"] == "mob" &&
                            ($link["inst"] == IL_INST_ID || $link["inst"] == 0)) {
                            $got_mobs = true;
                            $mob_links[$key] = $link;
                        }
                    }

                    // this is not cool because of performance reasons
                    // unfortunately the int link table does not
                    // store the target frame (we want to append all linked
                    // images but not inline images (i.e. mobs with no target
                    // frame))
                    if ($got_mobs) {
                        $page_object->buildDom();
                        $links = $page_object->getInternalLinks();
                        foreach ($links as $link) {
                            if ($link["Type"] == "MediaObject"
                                && $link["TargetFrame"] != ""
                                && $link["TargetFrame"] != "None") {
                                $media_links[] = $link;
                            }
                        }
                    }
                }
            }
        }

        $annex_cnt = 0;
        $annexes = array();

        // glossary
        if (count($glossary_links) > 0 && !$this->lm->isActivePreventGlossaryAppendix()) {
            // sort terms
            $terms = array();
            
            foreach ($glossary_links as $key => $link) {
                $term = ilGlossaryTerm::_lookGlossaryTerm($link["id"]);
                $terms[$term . ":" . $key] = array("key" => $key, "link" => $link, "term" => $term);
            }
            $terms = ilUtil::sortArray($terms, "term", "asc");
            //ksort($terms);

            foreach ($terms as $t) {
                $link = $t["link"];
                $key = $t["key"];
                $defs = ilGlossaryDefinition::getDefinitionList($link["id"]);
                $def_cnt = 1;

                // output all definitions of term
                foreach ($defs as $def) {
                    // definition + number, if more than 1 definition
                    if (count($defs) > 1) {
                        $tpl->setCurrentBlock("def_title");
                        $tpl->setVariable(
                            "TXT_DEFINITION",
                            $this->lng->txt("cont_definition") . " " . ($def_cnt++)
                        );
                        $tpl->parseCurrentBlock();
                    }
                    $page_gui = new ilGlossaryDefPageGUI($def["id"]);
                    $page_gui->setTemplateOutput(false);
                    $page_gui->setOutputMode("print");

                    $tpl->setCurrentBlock("definition");
                    $page_gui->setFileDownloadLink("#");
                    $page_gui->setFullscreenLink("#");
                    $page_gui->setSourceCodeDownloadScript("#");
                    $output = $page_gui->showPage();
                    $tpl->setVariable("VAL_DEFINITION", $output);
                    $tpl->parseCurrentBlock();
                }

                // output term
                $tpl->setCurrentBlock("term");
                $tpl->setVariable(
                    "VAL_TERM",
                    $term = ilGlossaryTerm::_lookGlossaryTerm($link["id"])
                );
                $tpl->parseCurrentBlock();
            }

            // output glossary header
            $annex_cnt++;
            $tpl->setCurrentBlock("glossary");
            $annex_title = $this->lng->txt("cont_annex") . " " .
                chr(64 + $annex_cnt) . ": " . $this->lng->txt("glo");
            $tpl->setVariable("TXT_GLOSSARY", $annex_title);
            $tpl->parseCurrentBlock();

            $annexes[] = $annex_title;
        }

        // referenced images
        if (count($media_links) > 0) {
            foreach ($media_links as $media) {
                if (substr($media["Target"], 0, 4) == "il__") {
                    $arr = explode("_", $media["Target"]);
                    $id = $arr[count($arr) - 1];
                    
                    $med_obj = new ilObjMediaObject($id);
                    $med_item = $med_obj->getMediaItem("Standard");
                    if (is_object($med_item)) {
                        if (is_int(strpos($med_item->getFormat(), "image"))) {
                            $tpl->setCurrentBlock("ref_image");
                            
                            // image source
                            if ($med_item->getLocationType() == "LocalFile") {
                                $tpl->setVariable(
                                    "IMG_SOURCE",
                                    ilUtil::getWebspaceDir("output") . "/mobs/mm_" . $id .
                                    "/" . $med_item->getLocation()
                                );
                            } else {
                                $tpl->setVariable(
                                    "IMG_SOURCE",
                                    $med_item->getLocation()
                                );
                            }
                            
                            if ($med_item->getCaption() != "") {
                                $tpl->setVariable("IMG_TITLE", $med_item->getCaption());
                            } else {
                                $tpl->setVariable("IMG_TITLE", $med_obj->getTitle());
                            }
                            $tpl->parseCurrentBlock();
                        }
                    }
                }
            }
            
            // output glossary header
            $annex_cnt++;
            $tpl->setCurrentBlock("ref_images");
            $annex_title = $this->lng->txt("cont_annex") . " " .
                chr(64 + $annex_cnt) . ": " . $this->lng->txt("cont_ref_images");
            $tpl->setVariable("TXT_REF_IMAGES", $annex_title);
            $tpl->parseCurrentBlock();

            $annexes[] = $annex_title;
        }

        // output learning module title and toc
        if ($output_header) {
            $tpl->setCurrentBlock("print_header");
            $tpl->setVariable("LM_TITLE", $this->getLMPresentationTitle());
            if ($this->lm->getDescription() != "none") {
                $md = new ilMD($this->lm->getId(), 0, $this->lm->getType());
                $md_gen = $md->getGeneral();
                foreach ($md_gen->getDescriptionIds() as $id) {
                    $md_des = $md_gen->getDescription($id);
                    $description = $md_des->getDescription();
                }

                $tpl->setVariable(
                    "LM_DESCRIPTION",
                    $description
                );
            }
            $tpl->parseCurrentBlock();

            // output toc
            $nodes2 = $nodes;
            foreach ($nodes2 as $node2) {
                if ($node2["type"] == "st"
                    && ilObjContentObject::_checkPreconditionsOfPage($this->lm->getRefId(), $this->lm->getId(), $node2["obj_id"])) {
                    for ($j = 1; $j < $node2["depth"]; $j++) {
                        $tpl->setCurrentBlock("indent");
                        $tpl->setVariable("IMG_BLANK", ilUtil::getImagePath("browser/blank.png"));
                        $tpl->parseCurrentBlock();
                    }
                    $tpl->setCurrentBlock("toc_entry");
                    $tpl->setVariable(
                        "TXT_TOC_TITLE",
                        ilStructureObject::_getPresentationTitle(
                            $node2["obj_id"],
                            ilLMOBject::CHAPTER_TITLE,
                            $this->lm->isActiveNumbering(),
                            $this->lm_set->get("time_scheduled_page_activation"),
                            false,
                            0,
                            $this->lang
                        )
                    );
                    $tpl->parseCurrentBlock();
                }
            }

            // annexes
            foreach ($annexes as $annex) {
                $tpl->setCurrentBlock("indent");
                $tpl->setVariable("IMG_BLANK", ilUtil::getImagePath("browser/blank.png"));
                $tpl->parseCurrentBlock();
                $tpl->setCurrentBlock("toc_entry");
                $tpl->setVariable("TXT_TOC_TITLE", $annex);
                $tpl->parseCurrentBlock();
            }

            $tpl->setCurrentBlock("toc");
            $tpl->setVariable("TXT_TOC", $this->lng->txt("cont_toc"));
            $tpl->parseCurrentBlock();

            $tpl->setCurrentBlock("print_start_block");
            $tpl->parseCurrentBlock();
        }
        
        // output author information
        $md = new ilMD($this->lm->getId(), 0, $this->lm->getType());
        if (is_object($lifecycle = $md->getLifecycle())) {
            $sep = $author = "";
            foreach (($ids = $lifecycle->getContributeIds()) as $con_id) {
                $md_con = $lifecycle->getContribute($con_id);
                if ($md_con->getRole() == "Author") {
                    foreach ($ent_ids = $md_con->getEntityIds() as $ent_id) {
                        $md_ent = $md_con->getEntity($ent_id);
                        $author = $author . $sep . $md_ent->getEntity();
                        $sep = ", ";
                    }
                }
            }
            if ($author != "") {
                $this->lng->loadLanguageModule("meta");
                $tpl->setCurrentBlock("author");
                $tpl->setVariable("TXT_AUTHOR", $this->lng->txt("meta_author"));
                $tpl->setVariable("LM_AUTHOR", $author);
                $tpl->parseCurrentBlock();
            }
        }

        
        // output copyright information
        if (is_object($md_rights = $md->getRights())) {
            $copyright = $md_rights->getDescription();
            $copyright = ilMDUtils::_parseCopyright($copyright);

            if ($copyright != "") {
                $this->lng->loadLanguageModule("meta");
                $tpl->setCurrentBlock("copyright");
                $tpl->setVariable("TXT_COPYRIGHT", $this->lng->txt("meta_copyright"));
                $tpl->setVariable("LM_COPYRIGHT", $copyright);
                $tpl->parseCurrentBlock();
            }
        }

        $this->tpl->setContent($tpl->get());
        $this->tpl->printToStdout();
    }

Here is the call graph for this function:

showPrintViewSelection()

ilLMPresentationGUI::showPrintViewSelection

(

)

show selection screen for print view

Definition at line 2024 of file class.ilLMPresentationGUI.php.

References $_POST, Vendor\Package\$f, $ilUser, $lang, $lng, $requested_obj_id, $tpl, $user, ilObjContentObject\_checkPreconditionsOfPage(), ilStructureObject\_getPresentationTitle(), ilLMPageObject\_getPresentationTitle(), ilLMObject\_isPagePublic(), ilPageObject\_lookupActive(), ANONYMOUS_USER_ID, exit, filterNonAccessibleNode(), ilUtil\getImagePath(), getLMPresentationTitle(), initPrintViewSelectionForm(), and ui().

    {
        $ilUser = $this->user;
        $lng = $this->lng;
        
        if (!$this->lm->isActivePrintView() || !$this->lm->isActiveLMMenu()) {
            return;
        }



//        $this->setContentStyles();
//        $this->renderPageTitle();

//        $this->tpl->loadStandardTemplate();

//        $this->renderTabs("print", 0);
        /*$this->tpl->setVariable("TABS", $this->lm_gui->setilLMMenu($this->offlineMode()
            ,$this->getExportFormat(), "print", true,false, 0,
            $this->lang, $this->export_all_languages));*/


        $tpl = new ilTemplate("tpl.lm_print_selection.html", true, true, "Modules/LearningModule");

//        $this->ilLocator(true);
        /*        $this->tpl->addBlockFile(
                    "ADM_CONTENT",
                    "adm_content",
                    "tpl.lm_print_selection.html",
                    "Modules/LearningModule"
                );*/

        // set title header
//        $this->tpl->setTitle($this->getLMPresentationTitle());
//        $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_lm.svg"));

        /*$this->tpl->setVariable("TXT_BACK", $this->lng->txt("back"));
        $this->ctrl->setParameterByClass("illmpresentationgui", "obj_id", $this->requested_obj_id);
        $this->tpl->setVariable("LINK_BACK",
            $this->ctrl->getLinkTargetByClass("illmpresentationgui", ""));*/

        $this->ctrl->setParameterByClass("illmpresentationgui", "obj_id", $this->requested_obj_id);
        $tpl->setVariable("FORMACTION", $this->ctrl->getFormaction($this));

        $nodes = $this->lm_tree->getSubtree($this->lm_tree->getNodeData($this->lm_tree->getRootId()));
        $nodes = $this->filterNonAccessibleNode($nodes);

        if (!is_array($_POST["item"])) {
            if ($this->requested_obj_id != "") {
                $_POST["item"][$this->requested_obj_id] = "y";
            } else {
                $_POST["item"][1] = "y";
            }
        }

        $this->initPrintViewSelectionForm();

        foreach ($nodes as $node) {

            // check page activation
            $active = ilLMPage::_lookupActive(
                $node["obj_id"],
                $this->lm->getType(),
                $this->lm_set->get("time_scheduled_page_activation")
            );

            if ($node["type"] == "pg" &&
                !$active) {
                continue;
            }

            $text = $img_scr = $img_alt = "";
            $disabled = false;
            $checked = false;

            switch ($node["type"]) {
                // page
                case "pg":
                    $text =
                        ilLMPageObject::_getPresentationTitle(
                            $node["obj_id"],
                            $this->lm->getPageHeader(),
                            $this->lm->isActiveNumbering(),
                            $this->lm_set->get("time_scheduled_page_activation"),
                            false,
                            0,
                            $this->lang
                        );
                    
                    if ($ilUser->getId() == ANONYMOUS_USER_ID &&
                       $this->lm_gui->object->getPublicAccessMode() == "selected") {
                        if (!ilLMObject::_isPagePublic($node["obj_id"])) {
                            $disabled = true;
                            $text .= " (" . $this->lng->txt("cont_no_access") . ")";
                        }
                    }
                    $img_src = ilUtil::getImagePath("icon_pg.svg");
                    $img_alt = $lng->txt("icon") . " " . $lng->txt("pg");
                    break;

                // learning module
                case "du":
                    $text = $this->getLMPresentationTitle();
                    $img_src = ilUtil::getImagePath("icon_lm.svg");
                    $img_alt = $lng->txt("icon") . " " . $lng->txt("obj_lm");
                    break;

                // chapter
                case "st":
                    $text =
                        ilStructureObject::_getPresentationTitle(
                            $node["obj_id"],
                            ilLMOBject::CHAPTER_TITLE,
                            $this->lm->isActiveNumbering(),
                            $this->lm_set->get("time_scheduled_page_activation"),
                            false,
                            0,
                            $this->lang
                        );
                    if ($ilUser->getId() == ANONYMOUS_USER_ID &&
                       $this->lm_gui->object->getPublicAccessMode() == "selected") {
                        if (!ilLMObject::_isPagePublic($node["obj_id"])) {
                            $disabled = true;
                            $text .= " (" . $this->lng->txt("cont_no_access") . ")";
                        }
                    }
                    $img_src = ilUtil::getImagePath("icon_st.svg");
                    $img_alt = $lng->txt("icon") . " " . $lng->txt("st");
                    break;
            }

            if (!ilObjContentObject::_checkPreconditionsOfPage($this->lm->getRefId(), $this->lm->getId(), $node["obj_id"])) {
                $text .= " (" . $this->lng->txt("cont_no_access") . ")";
            }

            $this->nl->addListNode(
                $node["obj_id"],
                $text,
                $node["parent"],
                $checked,
                $disabled,
                $img_src,
                $img_alt
            );
        }

        
        // check for free page
        if ($this->requested_obj_id > 0 && !$this->lm_tree->isInTree($this->requested_obj_id)) {
            $text =
                ilLMPageObject::_getPresentationTitle(
                    $this->requested_obj_id,
                    $this->lm->getPageHeader(),
                    $this->lm->isActiveNumbering(),
                    $this->lm_set->get("time_scheduled_page_activation"),
                    false,
                    0,
                    $this->lang
                );
            
            if ($ilUser->getId() == ANONYMOUS_USER_ID &&
               $this->lm_gui->object->getPublicAccessMode() == "selected") {
                if (!ilLMObject::_isPagePublic($this->requested_obj_id)) {
                    $disabled = true;
                    $text .= " (" . $this->lng->txt("cont_no_access") . ")";
                }
            }
            $img_src = ilUtil::getImagePath("icon_pg.svg");
            $id = $this->requested_obj_id;

            $checked = true;

            $this->nl->addListNode(
                $id,
                $text,
                0,
                $checked,
                $disabled,
                $img_src,
                $img_alt
            );
        }

        $f = $this->form->getHTML();

        // submit toolbar
//        $tb = new ilToolbarGUI();
//        $tb->addFormButton($lng->txt("cont_show_print_view"), "showPrintView");
//        $tpl->setVariable("TOOLBAR", $tb->getHTML());

        $tpl->setVariable("ITEM_SELECTION", $f);
//        $this->tpl->printToStdout();

        $modal = $this->ui->factory()->modal()->roundtrip(
            $this->lng->txt("cont_print_view"),
            $this->ui->factory()->legacy($tpl->get())
        );
        echo $this->ui->renderer()->render($modal);
        exit();
    }

Here is the call graph for this function:

updatePageRating()

ilLMPresentationGUI::updatePageRating

(

)

Definition at line 1563 of file class.ilLMPresentationGUI.php.

References $_GET, $_POST, $ilUser, $user, exit, ilRating\resetRatingForUserAndObject(), and ilRating\writeRatingForUserAndObject().

    {
        $ilUser = $this->user;
        
        $pg_id = $_GET["pgid"];
        if (!$this->ctrl->isAsynch() || !$pg_id) {
            exit();
        }
                
        $rating = (int) $_POST["rating"];
        if ($rating) {
            ilRating::writeRatingForUserAndObject(
                $this->lm->getId(),
                "lm",
                $pg_id,
                "lm",
                $ilUser->getId(),
                $_POST["rating"]
            );
        } else {
            ilRating::resetRatingForUserAndObject(
                $this->lm->getId(),
                "lm",
                $pg_id,
                "lm",
                $ilUser->getId()
            );
        }
        
        $rating = new ilRatingGUI();
        $rating->setObject($this->lm->getId(), "lm", $pg_id, "lm", $ilUser->getId());
        $rating->setYourRatingText($this->lng->txt("lm_rate_page"));
        
        echo $rating->getHtml(true, true, "il.LearningModule.saveRating(%rating%);");
        
        echo $this->tpl->getOnLoadCodeForAsynch();
        exit();
    }

Here is the call graph for this function:

Field Documentation

$access

ilLMPresentationGUI::$access

protected

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

Referenced by executeCommand(), getHeaderAction(), ilLMNotes(), initScreenHead(), and outputInfoScreen().

$additional_content

ilLMPresentationGUI::$additional_content = []

protected

Definition at line 183 of file class.ilLMPresentationGUI.php.

Referenced by renderTabs().

$chapter_has_no_active_page

ilLMPresentationGUI::$chapter_has_no_active_page = false

Definition at line 113 of file class.ilLMPresentationGUI.php.

$ctrl

ilLMPresentationGUI::$ctrl

protected

Definition at line 36 of file class.ilLMPresentationGUI.php.

Referenced by executeCommand(), ilGlossary(), ilLocator(), initPrintViewSelectionForm(), and showPrintView().

$current_page_id

ilLMPresentationGUI::$current_page_id = 0

protected

Definition at line 98 of file class.ilLMPresentationGUI.php.

Referenced by getCurrentPageId(), and renderTabs().

$deactivated_page

ilLMPresentationGUI::$deactivated_page = false

Definition at line 118 of file class.ilLMPresentationGUI.php.

$embed_mode

ilLMPresentationGUI::$embed_mode = false

protected

Definition at line 93 of file class.ilLMPresentationGUI.php.

Referenced by getHeaderAction(), and initByRequest().

$error

ilLMPresentationGUI::$error

protected

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

Referenced by executeCommand().

$export_all_languages

ilLMPresentationGUI::$export_all_languages = false

protected

Definition at line 108 of file class.ilLMPresentationGUI.php.

$focus_id

ilLMPresentationGUI::$focus_id = 0

protected

Definition at line 103 of file class.ilLMPresentationGUI.php.

$help

ilLMPresentationGUI::$help

protected

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

$layout_doc

ilLMPresentationGUI::$layout_doc

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

$linker

ilLMPresentationGUI::$linker

protected

Definition at line 163 of file class.ilLMPresentationGUI.php.

$lm

ilLMPresentationGUI::$lm

protected

Definition at line 81 of file class.ilLMPresentationGUI.php.

$lng

ilLMPresentationGUI::$lng

Definition at line 88 of file class.ilLMPresentationGUI.php.

Referenced by executeCommand(), initPrintViewSelectionForm(), showPrintView(), and showPrintViewSelection().

$locator

ilLMPresentationGUI::$locator

protected

Definition at line 66 of file class.ilLMPresentationGUI.php.

Referenced by ilLocator(), and initScreenHead().

$main_menu

ilLMPresentationGUI::$main_menu

protected

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

$nav_history

ilLMPresentationGUI::$nav_history

protected

Definition at line 46 of file class.ilLMPresentationGUI.php.

Referenced by executeCommand().

$offline

ilLMPresentationGUI::$offline

Definition at line 90 of file class.ilLMPresentationGUI.php.

Referenced by offlineMode().

$offline_directory

ilLMPresentationGUI::$offline_directory

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

Referenced by getOfflineDirectory().

$ot

ilLMPresentationGUI::$ot

protected

Definition at line 188 of file class.ilLMPresentationGUI.php.

$rbacsystem

ilLMPresentationGUI::$rbacsystem

protected

Definition at line 31 of file class.ilLMPresentationGUI.php.

Referenced by ilLMSubMenu().

$requested_back_pg

ilLMPresentationGUI::$requested_back_pg

protected

Definition at line 123 of file class.ilLMPresentationGUI.php.

$requested_focus_return

ilLMPresentationGUI::$requested_focus_return

protected

Definition at line 133 of file class.ilLMPresentationGUI.php.

$requested_frame

ilLMPresentationGUI::$requested_frame

protected

Definition at line 158 of file class.ilLMPresentationGUI.php.

Referenced by ilLocator().

$requested_obj_id

ilLMPresentationGUI::$requested_obj_id

protected

Definition at line 143 of file class.ilLMPresentationGUI.php.

Referenced by executeCommand(), getCurrentPageId(), getSuccessorPage(), ilLocator(), processNodes(), and showPrintViewSelection().

$requested_obj_type

ilLMPresentationGUI::$requested_obj_type

protected

Definition at line 148 of file class.ilLMPresentationGUI.php.

Referenced by layout().

$requested_ref_id

ilLMPresentationGUI::$requested_ref_id

protected

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

Referenced by ilLocator().

$requested_search_string

ilLMPresentationGUI::$requested_search_string

protected

Definition at line 128 of file class.ilLMPresentationGUI.php.

$requested_transl

ilLMPresentationGUI::$requested_transl

protected

Definition at line 153 of file class.ilLMPresentationGUI.php.

$service

ilLMPresentationGUI::$service

protected

Definition at line 168 of file class.ilLMPresentationGUI.php.

Referenced by getService().

$settings

ilLMPresentationGUI::$settings

protected

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

Referenced by getHeaderAction(), and ilLMNotes().

$toolbar

ilLMPresentationGUI::$toolbar

protected

Definition at line 178 of file class.ilLMPresentationGUI.php.

$tpl

ilLMPresentationGUI::$tpl

Definition at line 86 of file class.ilLMPresentationGUI.php.

Referenced by getContent(), getHeaderAction(), getHTML(), injectTemplate(), layout(), page(), showDownloadList(), showMessageScreen(), showPrintView(), and showPrintViewSelection().

$tree

ilLMPresentationGUI::$tree

protected

Definition at line 71 of file class.ilLMPresentationGUI.php.

Referenced by ilLocator().

$ui

ilLMPresentationGUI::$ui

protected

Definition at line 173 of file class.ilLMPresentationGUI.php.

$user

ilLMPresentationGUI::$user

protected

Definition at line 26 of file class.ilLMPresentationGUI.php.

Referenced by executeCommand(), getCurrentPageId(), getSuccessorPage(), initScreenHead(), layout(), page(), showPrintView(), showPrintViewSelection(), and updatePageRating().

---

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

• Modules/LearningModule/Presentation/classes/class.ilLMPresentationGUI.php