ilLMPresentationGUI Class Reference

Class ilLMPresentationGUI GUI class for learning module presentation. More...

Inheritance diagram for ilLMPresentationGUI:

Collaboration diagram for ilLMPresentationGUI:

Public Member Functions
	__construct (string $a_export_format="", bool $a_all_languages=false, string $a_export_dir="", bool $claim_repo_context=true, ?array $query_params=null, bool $embed_mode=false)
	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...
	getSafePostCommands ()
	This method must return a list of safe POST commands. More...
	initByRequest (?array $query_params=null, bool $embed_mode=false)
	Init services and this class by request params. More...
	getService ()
	injectTemplate (ilGlobalTemplateInterface $tpl)
	executeCommand ()
	offlineMode ()
	checks whether offline content generation is activated More...
	getExportFormat ()
	nop ()
	this dummy function is needed for offline package creation More...
	attrib2arr (?DOMNamedNodeMap $a_attributes)
	getCurrentFrameSet ()
	get frames of current frame set More...
	determineLayout ()
	Determine layout. More...
	resume ()
	layout (string $a_xml="main.xml", bool $doShow=true)
	saveFrameUrl ()
	fullscreen ()
	media ()
	glossary ()
	page ()
	ilTOC ()
	table of contents More...
	getLMPresentationTitle ()
	ilLMMenu ()
	setHeader ()
	ilLMSubMenu ()
	output learning module submenu More...
	redrawHeaderAction ()
	addHeaderAction ()
	getHeaderAction (bool $a_redraw=false)
	ilLMNotes ()
	output notes of page More...
	ilLocator ()
	getCurrentPageId ()
	Get the current page id. More...
	getContent (bool $skip_nav=false)
	updatePageRating ()
	basicPageGuiInit (\ilPageObjectGUI $a_page_gui)
	ilGlossary ()
	ilMedia ()
	ilJavaScript (string $a_inline="", string $a_file="", string $a_location="")
	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 ()
	info screen More...
	showPrintViewSelection ()
	show selection screen for print view More...
	initPrintViewSelectionForm ()
	showPrintView ()
	downloadFile ()
	download file of file lists More...
	getFocusLink (int $a_ref_id, int $a_obj_id, int $a_return_ref_id)
	Get focused link (used in learning objectives courses) More...
	showMessageScreen (string $a_content)
	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 ()
	handleCodeParagraph (int $page_id, int $paragraph_id, string $title, string $text)
	store paragraph into file directory files/codefile_$pg_id_$paragraph_id/downloadtitle More...
	getLMPageGUI (int $a_id)
	getLMPage (int $a_id, string $a_type="")
	refreshToc ()
	Refresh toc (called if questions have been answered correctly) More...
	observeNoteAction (int $a_lm_id, int $a_page_id, string $a_type, string $a_action, int $a_note_id)
	Generate new ilNote and send Notifications to the users informing that there are new comments in the LM. More...
	getHTML (array $pars)
	Get HTML (called by kiosk mode through ilCtrl) More...

Data Fields
string	$lang
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
DOMDocument	$layout_doc
bool	$offline
string	$offline_directory
bool	$chapter_has_no_active_page = false
bool	$deactivated_page = false

Protected Member Functions
	getTracker ()
	addResourceFiles ()
	setContentStyles ()
	Set content style. More...
	setSystemStyle ()
	Set system style. More...
	getPageContent ()
	renderRating ()
	initScreenHead (string $a_active_tab="info")
	filterNonAccessibleNode (array $nodes)
	renderPageTitle ()
	renderTabs (string $active_tab, int $current_page_id)

Protected Attributes
ILIAS COPage Dom DomUtil	$dom_util
ILIAS COPage Xsl XslManager	$xsl
ILIAS Notes GUIService	$notes_gui
ILIAS GlobalScreen Services	$global_screen
ILIAS Notes DomainService	$notes
ILIAS LearningModule ReadingTime ReadingTimeManager	$reading_time_manager
string	$requested_url
string	$requested_type
ilLMTracker	$tracker
ilTabsGUI	$tabs
ilNestedListInputGUI	$nl
ilSetting	$lm_set
ilObjLearningModuleGUI	$lm_gui
bool	$fill_on_load_code
ilLMTree	$lm_tree
array	$frames
string	$export_format
ilPropertyFormGUI	$form
ilObjUser	$user
ilRbacSystem	$rbacsystem
ilCtrl	$ctrl
ilNavigationHistory	$nav_history
ilAccessHandler	$access
ilSetting	$settings
ilLocatorGUI	$locator
ilTree	$tree
ilHelpGUI	$help
LOMServices	$lom_services
ilObjLearningModule	$lm
bool	$embed_mode = false
int	$current_page_id = 0
int	$focus_id = 0
bool	$export_all_languages = false
string	$requested_back_pg
string	$requested_search_string
string	$requested_focus_return
int	$requested_ref_id
int	$requested_obj_id
string	$requested_obj_type
string	$requested_transl
string	$requested_frame
ilLMPresentationLinker	$linker
ilLMPresentationService	$service
ILIAS DI UIServices	$ui
ilToolbarGUI	$toolbar
array	$additional_content = []
string	$requested_cmd = ""
int	$requested_pg_id = 0
string	$requested_pg_type = ""
int	$requested_mob_id = 0
int	$requested_notification_switch = 0
bool	$abstract = false
Translations	$ot
ILIAS Style Content Object ObjectFacade	$content_style_domain
ILIAS Style Content GUIService	$content_style_gui
ILIAS Style Content Service	$cs = null

Detailed Description

Class ilLMPresentationGUI GUI class for learning module presentation.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilLMPresentationGUI: ilCommentGUI, ilInfoScreenGUI ilLMPresentationGUI: ilLMPageGUI, ilGlossaryDefPageGUI, ilCommonActionDispatcherGUI ilLMPresentationGUI: ilLearningProgressGUI, ilAssGenFeedbackPageGUI ilLMPresentationGUI: ilRatingGUI

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

Constructor & Destructor Documentation

__construct()

ilLMPresentationGUI::__construct	(	string	$a_export_format = "",
		bool	$a_all_languages = false,
		string	$a_export_dir = "",
		bool	$claim_repo_context = true,
		?array	$query_params = null,
		bool	$embed_mode = false
	)

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

References $DIC, $ilErr, $lng, $params, $requested_obj_id, ILIAS\Repository\access(), ilRbacSystem\checkAccess(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), initByRequest(), ilLMGSToolProvider\LM_QUERY_PARAMS, ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ILIAS\Repository\locator(), ILIAS\Repository\settings(), ilLMGSToolProvider\SHOW_LINK_SLATES, ilLMGSToolProvider\SHOW_TOC_TOOL, ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), ilLanguage\txt(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

      {
        global $DIC;

        $this->offline = ($a_export_format != "");
        $this->export_all_languages = $a_all_languages;
        $this->export_format = $a_export_format;        // html/scorm
        $this->offline_directory = $a_export_dir;

        $this->tabs = $DIC->tabs();
        $this->toolbar = $DIC->toolbar();
        $this->user = $DIC->user();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->nav_history = $DIC["ilNavigationHistory"];
        $this->access = $DIC->access();
        $this->settings = $DIC->settings();
        $this->locator = $DIC["ilLocator"];
        $this->tree = $DIC->repositoryTree();
        $this->help = $DIC["ilHelp"];
        $this->global_screen = $DIC->globalScreen();
        $this->lom_services = $DIC->learningObjectMetadata();

        $lng = $DIC->language();
        $rbacsystem = $DIC->rbac()->system();
        $ilCtrl = $DIC->ctrl();
        $ilErr = $DIC["ilErr"];

        // load language vars
        $lng->loadLanguageModule("content");

        $this->lng = $lng;
        $this->ui = $DIC->ui();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->frames = array();
        $this->ctrl = $ilCtrl;
        $this->ctrl->saveParameter($this, array("ref_id", "transl", "focus_id", "focus_return"));

        $this->cs = $DIC->contentStyle();

        $this->initByRequest($query_params, $embed_mode);

        // check, if learning module is online
        if (!$rbacsystem->checkAccess("write", $this->requested_ref_id)) {
            if ($this->lm->getOfflineStatus()) {
                $ilErr->raiseError($lng->txt("permission_denied"), $ilErr->WARNING);
            }
        }

        if ($claim_repo_context) {
            $DIC->globalScreen()->tool()->context()->claim()->repository();
        }

        if (!$ilCtrl->isAsynch()) {
            // moved this into the if due to #0027200
            if (!$embed_mode) {
                if ($this->service->getPresentationStatus()->isTocNecessary()) {
                    $DIC->globalScreen()->tool()->context()->current()->addAdditionalData(
                        ilLMGSToolProvider::SHOW_TOC_TOOL,
                        true
                    );
                }
            }
            $DIC->globalScreen()->tool()->context()->current()->addAdditionalData(
                ilLMGSToolProvider::SHOW_LINK_SLATES,
                true
            );
        }

        if ($embed_mode) {
            $ilCtrl->setParameter($this, "embed_mode", 1);
            $params = [
                "obj_id" => $this->requested_obj_id,
                "ref_id" => $this->lm->getRefId(),
                "frame" => ""
            ];
            $DIC->globalScreen()->tool()->context()->current()->addAdditionalData(
                \ilLMGSToolProvider::LM_QUERY_PARAMS,
                $params
            );
        }
        $this->reading_time_manager = new \ILIAS\LearningModule\ReadingTime\ReadingTimeManager();
        $this->notes = $DIC->notes()->domain();
        $this->xsl = $DIC->copage()->internal()->domain()->xsl();
        $this->dom_util = $DIC->copage()->internal()->domain()->domUtil();
        $this->notes_gui = $DIC->notes()->gui();
    }

Here is the call graph for this function:

Member Function Documentation

addHeaderAction()

ilLMPresentationGUI::addHeaderAction

(

)

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

References getHeaderAction().

Referenced by layout().

                                     : void
    {
        //$this->tpl->setVariable("HEAD_ACTION", $this->getHeaderAction());
        $this->tpl->setHeaderActionMenu($this->getHeaderAction());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addResourceFiles()

ilLMPresentationGUI::addResourceFiles ( )

protected

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

References ilAccordionGUI\addCss(), ilAccordionGUI\addJavaScript(), ILIAS\Repository\ctrl(), ilYuiUtil\initConnection(), iljQueryUtil\initjQuery(), and offlineMode().

Referenced by getHTML(), and layout().

                                         : void
    {
        iljQueryUtil::initjQuery($this->tpl);
        //iljQueryUtil::initjQueryUI($this->tpl);

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

            $this->tpl->addJavaScript("assets/js/LearningModule.js");

            // 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');");
                }

                $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("assets/js/Basic.js");
            ilYuiUtil::initConnection($this->tpl);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

attrib2arr()

ilLMPresentationGUI::attrib2arr

(

?DOMNamedNodeMap

$a_attributes

)

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

Referenced by layout().

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

Here is the caller graph for this function:

basicPageGuiInit()

ilLMPresentationGUI::basicPageGuiInit

(

\ilPageObjectGUI

$a_page_gui

)

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

References ILIAS\Repository\ctrl(), getCurrentPageId(), getOfflineDirectory(), offlineMode(), ilPageObjectGUI\setFileDownloadLink(), ilPageObjectGUI\setFullscreenLink(), ilPageObjectGUI\setOfflineDirectory(), ilPageObjectGUI\setOutputMode(), ilPageObjectGUI\setSourcecodeDownloadScript(), and ilPageObjectGUI\setStyleId().

Referenced by executeCommand().

                                                                  : void
    {
        $a_page_gui->setStyleId(
            $this->content_style_domain->getEffectiveStyleId()
        );
        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:

determineLayout()

ilLMPresentationGUI::determineLayout

(

)

Determine layout.

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

Referenced by layout().

                                     : string
    {
        return "standard";
    }

Here is the caller graph for this function:

downloadFile()

ilLMPresentationGUI::downloadFile

(

)

download file of file lists

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

References getCurrentPageId(), and getLMPageGUI().

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

Here is the call graph for this function:

executeCommand()

ilLMPresentationGUI::executeCommand

(

)

Exceptions

ilCtrlException
ilLMPresentationException
ilPermissionException

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

References $access, $ctrl, $lng, $nav_history, $requested_obj_id, $user, basicPageGuiInit(), ILIAS\Repository\ctrl(), getCurrentPageId(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getLMPageGUI(), initScreenHead(), layout(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, outputInfoScreen(), ilNotification\setNotification(), ilLanguage\txt(), ilNotification\TYPE_LM, ilNotification\TYPE_LM_PAGE, and ILIAS\Repository\user().

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

        // 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)))) {
            throw new ilPermissionException($lng->txt("permission_denied"));
        }

        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd("layout");

        $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 "ilcommentgui":
                $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($this->requested_pg_id);
                //$this->basicPageGuiInit($page_gui);
                $ret = $ilCtrl->forwardCommand($page_gui);
                break;

            case "ilglossarydefpagegui":
                // see #32198
                //$page_gui = new ilGlossaryDefPageGUI($this->requested_obj_id);
                $page_gui = new ilGlossaryDefPageGUI($this->requested_pg_id);
                $this->basicPageGuiInit($page_gui);
                $ret = $ilCtrl->forwardCommand($page_gui);
                break;

            case "illearningprogressgui":
                $this->initScreenHead("learning_progress");
                $new_gui = new ilLearningProgressGUI(
                    ilLearningProgressBaseGUI::LP_CONTEXT_REPOSITORY,
                    $this->requested_ref_id,
                    $ilUser->getId()
                );
                $this->ctrl->forwardCommand($new_gui);
                // this is nasty, but the LP classes do "sometimes" a printToStdout
                // sometimes not, (here editManual does, other commands not)
                if ($this->ctrl->getCmd() !== "editManual") {
                    $this->tpl->printToStdout();
                }
                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 ($this->requested_notification_switch > 0) {
                    switch ($this->requested_notification_switch) {
                        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 ( array  $nodes )

protected

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

References getTracker(), ilLMTracker\hasPredIncorrectAnswers(), and offlineMode().

Referenced by showPrintViewSelection().

     : array {
        $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 663 of file class.ilLMPresentationGUI.php.

References media().

                                : string
    {
        return $this->media();
    }

Here is the call graph for this function:

getContent()

ilLMPresentationGUI::getContent

(

bool

$skip_nav = false

)

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

References ILIAS\UICore\GlobalTemplate\get(), getPageContent(), ILIAS\Repository\lng(), renderRating(), setContentStyles(), ILIAS\UICore\GlobalTemplate\setVariable(), ILIAS\Repository\toolbar(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Referenced by getHTML(), and layout().

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

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

        if (!$skip_nav) {
            $navigation_renderer = new ilLMNavigationRendererGUI(
                $this->service,
                $this,
                $this->lng,
                $this->user,
                $this->tpl,
                $this->requested_obj_id,
                $this->requested_back_pg,
                $this->requested_frame,
                $this->toolbar,
                $this->ui
            );

            $navigation_renderer->renderTop();
            //$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 454 of file class.ilLMPresentationGUI.php.

References $frames.

                                        : array
    {
        return $this->frames;
    }

getCurrentPageId()

ilLMPresentationGUI::getCurrentPageId

(

)

Get the current page id.

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

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

                                      : ?int
    {
        return $this->service->getNavigationStatus()->getCurrentPage();
    }

Here is the caller graph for this function:

getExportFormat()

ilLMPresentationGUI::getExportFormat

(

)

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

References $export_format.

Referenced by renderTabs().

                                     : string
    {
        return $this->export_format;
    }

Here is the caller graph for this function:

getFocusLink()

ilLMPresentationGUI::getFocusLink	(	int	$a_ref_id,
		int	$a_obj_id,
		int	$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

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

     : string {
        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

(

bool

$a_redraw = false

)

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

References $access, $embed_mode, $ilSetting, $settings, $tpl, ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), getCurrentPageId(), ilUtil\getImagePath(), ILIAS\UICore\GlobalTemplate\getOnLoadCodeForAsynch(), ilNotification\hasNotification(), ilNotification\hasOptOut(), ILIAS\Repository\lng(), offlineMode(), ilObjectListGUI\prepareJsLinks(), ilCommonActionDispatcherGUI\setSubObject(), ilNotification\TYPE_LM, ilNotification\TYPE_LM_PAGE, ilCommonActionDispatcherGUI\TYPE_REPOSITORY, and ILIAS\Repository\user().

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

     : string {
        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", (int) $this->embed_mode);
        $this->ctrl->setParameterByClass("ilcommentgui", "embed_mode", (int) $this->embed_mode);
        $this->ctrl->setParameterByClass("iltagginggui", "embed_mode", (int) $this->embed_mode);
        ilObjectListGUI::prepareJsLinks(
            $this->ctrl->getLinkTarget($this, "redrawHeaderAction", "", true),
            "",
            $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"),
                true
            );
        }

        // 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("object/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("object/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("object/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

(

array

$pars

)

Get HTML (called by kiosk mode through ilCtrl)

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

References addResourceFiles(), ILIAS\UICore\GlobalTemplate\get(), getContent(), getHeaderAction(), ilLMNotes(), renderRating(), and ILIAS\UICore\GlobalTemplate\setVariable().

                                        : string
    {
        $this->addResourceFiles();
        switch ($pars["cmd"]) {
            case "layout":
                $tpl = new ilTemplate("tpl.embedded_view.html", true, true, "components/ILIAS/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:

getLMPage()

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

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

References $lang, and ilPageObject\_exists().

Referenced by ilMedia().

     : ilPageObject {
        $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->getDefaultLanguage())) {
                $lang = $this->ot->getDefaultLanguage();
            }
        }

        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

(

int

$a_id

)

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

References ilPageObject\_exists().

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

                                           : ilLMPageGUI
    {
        $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->getDefaultLanguage())) {
            return new ilLMPageGUI($a_id, 0, false, $this->ot->getDefaultLanguage(), $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

(

)

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

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

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

Here is the caller graph for this function:

getOfflineDirectory()

ilLMPresentationGUI::getOfflineDirectory

(

)

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

References $offline_directory.

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

                                         : string
    {
        return $this->offline_directory;
    }

Here is the caller graph for this function:

getPageContent()

ilLMPresentationGUI::getPageContent ( )

protected

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

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by getContent(), and page().

                                       : string
    {
        $content_renderer = new ilLMContentRendererGUI(
            $this->service,
            $this,
            $this->lng,
            $this->ot,
            $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:

getSafePostCommands()

ilLMPresentationGUI::getSafePostCommands

(

)

This method must return a list of safe POST commands.

Safe post commands returned by this method will no longer be CSRF protected and will NOT be appended by an ilCtrlToken.

Returns

string[]

Implements ilCtrlSecurityInterface.

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

                                         : array
    {
        return [
            "showPrintView",
        ];
    }

getService()

ilLMPresentationGUI::getService

(

)

Definition at line 274 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 2204 of file class.ilLMPresentationGUI.php.

References ILIAS\Repository\ctrl(), and offlineMode().

                                               : string
    {
        if (!$this->offlineMode()) {
            return $this->ctrl->getLinkTarget($this, "");
        } else {
            return "";
        }
    }

Here is the call graph for this function:

getTracker()

ilLMPresentationGUI::getTracker ( )

protected

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

Referenced by filterNonAccessibleNode(), and showPrintView().

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

Here is the caller graph for this function:

getUnsafeGetCommands()

ilLMPresentationGUI::getUnsafeGetCommands

(

)

This method must return a list of unsafe GET commands.

Unsafe get commands returned by this method will now be CSRF protected, which means an ilCtrlToken is appended each time a link-target is generated to the class implementing this interface with a command from that list.

Tokens will be validated in

See also

ilCtrlInterface::getCmd(), whereas the fallback command will be used if the CSRF validation fails.

Returns

string[]

Implements ilCtrlSecurityInterface.

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

                                          : array
    {
        return [];
    }

glossary()

ilLMPresentationGUI::glossary

(

)

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

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

                              : string
    {
        $this->tpl = new ilGlobalTemplate("tpl.glossary_term_output.html", true, true, "components/ILIAS/LearningModule");
        $this->renderPageTitle();

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

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

        $this->ilGlossary();

        $js = $this->global_screen->layout()->meta()->getJs();
        foreach ($js->getItemsInOrderOfDelivery() as $item) {
            $this->tpl->addJavaScript($item->getContent());
        }

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

        return "";
    }

Here is the call graph for this function:

handleCodeParagraph()

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

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

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

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

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

Here is the call graph for this function:

ilGlossary()

ilLMPresentationGUI::ilGlossary

(

)

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

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

Referenced by glossary(), and layout().

                                : void
    {
        $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	(	string	$a_inline = "",
		string	$a_file = "",
		string	$a_location = ""
	)

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

Referenced by layout().

     : void {
        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

(

)

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

References getCurrentPageId(), and renderTabs().

Referenced by layout().

                              : void
    {
        $this->renderTabs("content", $this->getCurrentPageId());
    }

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 943 of file class.ilLMPresentationGUI.php.

References $access, $ilSetting, $settings, ILIAS\Repository\ctrl(), 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 = $this->notes_gui->getCommentsGUI($this->lm->getId(), $this->getCurrentPageId(), "pg");
        $notes_gui->setUseObjectTitleHeader(false);

        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 == "ilcommentgui") {
            $html = $this->ctrl->forwardCommand($notes_gui);
        } else {
            $html = $notes_gui->getListHTML();
        }
        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 771 of file class.ilLMPresentationGUI.php.

References $rbacsystem, ilRbacSystem\checkAccess(), getCurrentPageId(), ILIAS\Repository\lng(), null, and offlineMode().

Referenced by layout().

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


        $tpl_menu = new ilTemplate("tpl.lm_sub_menu.html", true, true, "components/ILIAS/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->parseCurrentBlock();
            }

            $page_id = $this->getCurrentPageId();

            // permanent link
            $this->tpl->setPermanentLink("pg", null, $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

(

)

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

References $DIC, $lang, $locator, $path, $requested_frame, $requested_obj_id, $requested_ref_id, ilFrameTargetInfo\_getFrame(), ilStructureObject\_getPresentationTitle(), ilLMObject\CHAPTER_TITLE, ilLMObjectFactory\getInstance(), getLMPresentationTitle(), offlineMode(), and ilStr\shortenTextExtended().

Referenced by initScreenHead(), and layout().

                               : void
    {
        global $DIC;
        $ltiview = $DIC["lti"];
        $ilLocator = $this->locator;

        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()) {
                // Do nothing, its complicated...
            } else {
                $ilLocator->addRepositoryItems();
            }
        } 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(
                            ilStr::shortenTextExtended(
                                ilStructureObject::_getPresentationTitle(
                                    $row["child"],
                                    ilLMObject::CHAPTER_TITLE,
                                    $this->lm->isActiveNumbering(),
                                    (bool) $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(
                            ilStr::shortenTextExtended($this->getLMPresentationTitle(), 50, true),
                            $this->linker->getLink("layout", 0, $frame_param),
                            $frame_target,
                            $this->requested_ref_id
                        );
                    }
                }
            }
        } else {        // lonely page
            $ilLocator->addItem(
                $this->getLMPresentationTitle(),
                $this->linker->getLink("layout", 0, $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
            );
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilMedia()

ilLMPresentationGUI::ilMedia

(

)

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

References $params, ilMediaItem\_getMapAreasIntLinks(), ilUtil\getImagePath(), getLMPage(), ilFileUtils\getWebspaceDir(), IL_MODE_ALIAS, IL_MODE_OUTPUT, ilObjMediaObjectGUI\includePresentationJS(), ilObjMediaObject\isTypeAllowed(), offlineMode(), renderPageTitle(), and setContentStyles().

Referenced by media().

                             : void
    {
        $pg_frame = "";
        $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($this->requested_pg_id)) {
            $pg_obj = $this->getLMPage($this->requested_pg_id, $this->requested_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);
        } 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>";

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

        $mode = ($this->requested_cmd == "fullscreen")
            ? "fullscreen"
            : "media";
        $enlarge_path = ilUtil::getImagePath("media/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 = $this->xsl->process($xml, $params);

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

(

)

table of contents

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

Referenced by refreshToc().

                           : ilLMTOCExplorerGUI
    {
        $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 1346 of file class.ilLMPresentationGUI.php.

References ILIAS\Repository\ctrl().

                                : void
    {
        $this->ctrl->redirectByClass(ilInfoScreenGUI::class, "showSummary");
    }

Here is the call graph for this function:

initByRequest()

ilLMPresentationGUI::initByRequest	(	?array	$query_params = null,
		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 209 of file class.ilLMPresentationGUI.php.

References $DIC, $embed_mode, $post, null, and ILIAS\Repository\user().

Referenced by __construct().

     : void {
        global $DIC;

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

        $post = is_null($query_params)
            ? null
            : [];

        $request = $DIC->learningModule()
                       ->internal()
                       ->gui()
                       ->presentation()
                       ->request(
                           $query_params,
                           $post
                       );

        $this->requested_obj_type = $request->getObjType();
        $this->requested_ref_id = $request->getRefId();
        $this->requested_transl = $request->getTranslation();      // handled by presentation status
        $this->requested_obj_id = $request->getObjId();            // handled by navigation status
        $this->requested_back_pg = $request->getBackPage();
        $this->requested_frame = $request->getFrame();
        $this->requested_search_string = $request->getSearchString();
        $this->requested_focus_return = $request->getFocusReturn();
        $this->requested_mob_id = $request->getMobId();
        $this->requested_cmd = $request->getCmd();
        $this->requested_pg_id = $request->getPgId();
        $this->requested_pg_type = $request->getPgType();
        $this->requested_notification_switch = $request->getNotificationSwitch();
        $this->requested_type = $request->getType();
        $this->requested_url = $request->getUrl();

        $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->getEmbedMode()) {
            $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 = $this->lm->getObjectProperties()->getPropertyTranslations();
        $this->content_style_gui = $this->cs->gui();
        $this->content_style_domain = $this->cs->domain()->styleForRefId($this->lm->getRefId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initPrintViewSelectionForm()

ilLMPresentationGUI::initPrintViewSelectionForm

(

)

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

References $ctrl, $lng, $nl, ILIAS\Repository\form(), ilRadioGroupInputGUI\setValue(), and ilLanguage\txt().

Referenced by showPrintViewSelection().

                                                : void
    {
        $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 ( string  $a_active_tab = "info" )

protected

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

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

Referenced by executeCommand(), and outputInfoScreen().

     : void {
        $ilAccess = $this->access;
        $ilLocator = $this->locator;

        $this->renderPageTitle();

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

        $this->renderTabs($a_active_tab, 0);

        // Full locator, if read permission is given
        if ($ilAccess->checkAccess("read", "", $this->requested_ref_id)) {
            $this->ilLocator();
        } 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

(

ilGlobalTemplateInterface

$tpl

)

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

References $tpl.

                                                                  : void
    {
        $this->tpl = $tpl;
    }

layout()

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

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

References $path, $requested_obj_type, $tpl, $user, addHeaderAction(), addResourceFiles(), attrib2arr(), determineLayout(), getContent(), ilUtil\getStyleSheetLocation(), ilGlossary(), ilJavaScript(), ilLMMenu(), ilLMNotes(), ilLMSubMenu(), ilLocator(), media(), null, offlineMode(), ILIAS\UICore\GlobalTemplate\printToStdout(), ILIAS\UICore\GlobalTemplate\printToString(), renderPageTitle(), setHeader(), and ILIAS\Repository\ui().

Referenced by executeCommand(), and resume().

     : string {
        $content = "";
        $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(ILIAS_ABSOLUTE_PATH . "/components/ILIAS/LearningModule/layouts/lm/" . $layout . "/" . $a_xml);

        $error = null;
        $doc = $this->dom_util->docFromString($xmlfile, $error);
        $this->layout_doc = $doc;

        // get current frame node
        $path = (empty($this->requested_frame) || ($this->requested_frame == "_blank"))
            ? "/ilLayout/ilFrame[1]"
            : "//ilFrame[@name='" . $this->requested_frame . "']";
        $nodes = $this->dom_util->path($doc, $path);
        if (count($nodes) != 1) {
            throw new ilLMPresentationException("ilLMPresentation: XML File invalid. Found " . count($nodes) . " nodes for " .
                " path " . $path . " in " . $layout . "/" . $a_xml . ". LM Layout is " . $this->lm->getLayout());
        }
        $node = $nodes->item(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
            $found = false;
            foreach ($node->childNodes as $child) {
                if ($child->nodeName == $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 . "'.");
            }
        }

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

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

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

                case "ilGlossary":
                    $this->ilGlossary();
                    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;
            }
        }

        $this->addResourceFiles();

        if ($doShow) {
            $tpl->printToStdout();
        } else {
            $content = $tpl->printToString();
        }

        return ($content);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

media()

ilLMPresentationGUI::media

(

)

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

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

Referenced by fullscreen(), and layout().

                           : string
    {
        $this->tpl = new ilGlobalTemplate("tpl.fullscreen.html", true, true, "components/ILIAS/LearningModule");

        // 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 436 of file class.ilLMPresentationGUI.php.

                         : void
    {
    }

observeNoteAction()

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

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

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

References ilLearningModuleNotification\ACTION_COMMENT, and ilNotification\TYPE_LM_PAGE.

     : void {
        $note = $this->notes->getById($a_note_id);
        $text = $note->getText();

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

        $notification->send();
    }

offlineMode()

ilLMPresentationGUI::offlineMode

(

)

checks whether offline content generation is activated

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

References $offline.

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

                                 : bool
    {
        return $this->offline;
    }

Here is the caller graph for this function:

outputInfoScreen()

ilLMPresentationGUI::outputInfoScreen

(

)

info screen

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

References $access, $info, ILIAS\Repository\ctrl(), initScreenHead(), ILIAS\Repository\lng(), and offlineMode().

Referenced by executeCommand(), and showInfoScreen().

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

        if (!$this->lm->isInfoEnabled()) {
            return "";
        }

        $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);
            }
        }

        // show standard meta data section
        $info->addMetaDataSections($this->lm->getId(), 0, $this->lm->getType());

        $this->lng->loadLanguageModule("copg");
        $est_reading_time = $this->reading_time_manager->getReadingTime($this->lm->getId());
        if (!is_null($est_reading_time)) {
            $info->addProperty(
                $this->lng->txt("copg_est_reading_time"),
                sprintf($this->lng->txt("copg_x_minutes"), $est_reading_time)
            );
        }

        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();
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

page()

ilLMPresentationGUI::page

(

)

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

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

                          : string
    {
        $ilUser = $this->user;
        $this->tpl = new ilGlobalTemplate("tpl.page_fullscreen.html", true, true, "components/ILIAS/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();
        }
        return "";
    }

Here is the call graph for this function:

redrawHeaderAction()

ilLMPresentationGUI::redrawHeaderAction

(

)

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

References exit, and getHeaderAction().

                                        : void
    {
        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 2285 of file class.ilLMPresentationGUI.php.

References exit, and ilTOC().

                                : void
    {
        $exp = $this->ilTOC();

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

Here is the call graph for this function:

renderPageTitle()

ilLMPresentationGUI::renderPageTitle ( )

protected

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

References getLMPresentationTitle().

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

                                        : void
    {
        $this->tpl->setHeaderPageTitle($this->getLMPresentationTitle());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderRating()

ilLMPresentationGUI::renderRating ( )

protected

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

References ILIAS\Repository\ctrl(), getCurrentPageId(), ILIAS\Repository\lng(), and offlineMode().

Referenced by getContent(), and getHTML().

                                     : string
    {
        // 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->ctrl->setParameter($this, "pg_id", $this->getCurrentPageId());
            $this->tpl->addOnLoadCode("il.LearningModule.setRatingUrl('" .
                $this->ctrl->getLinkTarget($this, "updatePageRating", "", true, false) .
                "')");
            $this->ctrl->setParameter($this, "pg_id", "");

            $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 ( string  $active_tab, int  $current_page_id  )

protected

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

References $additional_content, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), getExportFormat(), getService(), ILIAS\Repository\lng(), offlineMode(), ilLMMenuRendererGUI\render(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Referenced by ilLMMenu(), and initScreenHead().

     : void {
        $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,
            $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

(

)

Exceptions

ilLMPresentationException

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

References layout().

                            : void
    {
        $this->layout();
    }

Here is the call graph for this function:

saveFrameUrl()

ilLMPresentationGUI::saveFrameUrl

(

)

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

References $requested_url.

                                  : void
    {
        $store = new ilSessionIStorage("lm");
        $store->set("cf_" . $this->lm->getId(), $this->requested_url);
    }

setContentStyles()

ilLMPresentationGUI::setContentStyles ( )

protected

Set content style.

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

References ilObjStyleSheet\getSyntaxStylePath().

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

                                         : void
    {
        // content style
        $this->content_style_gui->addCss(
            $this->tpl,
            $this->lm->getRefId()
        );
        $this->tpl->addCss(ilObjStyleSheet::getSyntaxStylePath());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setHeader()

ilLMPresentationGUI::setHeader

(

)

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

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

Referenced by layout().

                               : void
    {
        $this->tpl->setTitle($this->getLMPresentationTitle());
        $this->tpl->setTitleIcon(ilUtil::getImagePath("standard/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 1105 of file class.ilLMPresentationGUI.php.

References ilUtil\getStyleSheetLocation().

Referenced by glossary(), and media().

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

Here is the call graph for this function:

Here is the caller graph for this function:

showInfoScreen()

ilLMPresentationGUI::showInfoScreen

(

)

info screen call from inside learning module

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

References outputInfoScreen().

                                    : void
    {
        $this->outputInfoScreen();
    }

Here is the call graph for this function:

showMessageScreen()

ilLMPresentationGUI::showMessageScreen

(

string

$a_content

)

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

References ILIAS\UICore\GlobalTemplate\get(), setContentStyles(), and ILIAS\UICore\GlobalTemplate\setVariable().

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

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

        $tpl = new ilTemplate("tpl.page_message_screen.html", true, true, "components/ILIAS/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 2199 of file class.ilLMPresentationGUI.php.

References ILIAS\Repository\lng(), and showMessageScreen().

                                                      : void
    {
        $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 2190 of file class.ilLMPresentationGUI.php.

References ILIAS\Repository\lng(), and showMessageScreen().

                                      : void
    {
        $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 2182 of file class.ilLMPresentationGUI.php.

References ILIAS\Repository\lng(), and showMessageScreen().

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

Here is the call graph for this function:

showPrintView()

ilLMPresentationGUI::showPrintView

(

)

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

References $ctrl, Vendor\Package\$e, $id, $lang, $lng, $path, $tabs, $user, ilObjContentObject\_checkPreconditionsOfPage(), ilLMObject\_exists(), ilStructureObject\_getPresentationTitle(), ilLMPageObject\_getPresentationTitle(), ilInternalLink\_getTargetsOfSource(), ilGlossaryTerm\_lookGlossaryTerm(), ilPageObject\_lookupActive(), ilLMObject\_lookupType(), ilLMObject\CHAPTER_TITLE, ILIAS\UICore\GlobalTemplate\get(), ilObjStyleSheet\getContentPrintStyle(), getCurrentPageId(), ilUtil\getImagePath(), getLMPageGUI(), getLMPresentationTitle(), getTracker(), ilFileUtils\getWebspaceDir(), IL_INST_ID, ILIAS\Repository\lng(), ilLMObject\PAGE_TITLE, ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), renderPageTitle(), ilTabsGUI\setBackTarget(), setContentStyles(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), ILIAS\UICore\GlobalTemplate\setVariable(), ilArrayUtil\sortArray(), ilLanguage\txt(), and ILIAS\Repository\ui().

                                   : void
    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $tabs = $this->tabs;
        $header_page_content = "";
        $footer_page_content = "";
        $chapter_title = "";
        $did_chap_page_header = false;

        $lom_paths = $this->lom_services->paths();
        $lom_data_helper = $this->lom_services->dataHelper();
        $lom_cp_helper = $this->lom_services->copyrightHelper();
        $lom_reader = $this->lom_services->read($this->lm->getId(), 0, $this->lm->getType());

        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
        $sel_type = $this->service->getRequest()->getSelectedType();
        $sel_obj_ids = $this->service->getRequest()->getSelectedObjIds();
        if ($sel_type == "page") {
            if (!in_array($c_obj_id, $sel_obj_ids)) {
                $sel_obj_ids[] = $c_obj_id;
            }
        }
        if ($sel_type == "chapter" && $c_obj_id > 0) {
            $path = $this->lm_tree->getPathFull($c_obj_id);
            $chap_id = $path[1]["child"];
            if ($chap_id > 0) {
                $sel_obj_ids[] = $chap_id;
            }
        }

        $this->setContentStyles();
        $this->tpl->addCss(ilObjStyleSheet::getContentPrintStyle());

        $tpl = new ilTemplate("tpl.lm_print_view.html", true, true, "components/ILIAS/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();
        $last_page_title = "";

        // 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(
                    $this->content_style_domain->getEffectiveStyleId()
                );

                // 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(
                    $this->content_style_domain->getEffectiveStyleId()
                );

                // 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 (count($sel_obj_ids) > 0) {
            foreach ($sel_obj_ids 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 {
            $this->tpl->setOnScreenMessage('failure', $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(),
                (bool) $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 (in_array($node["obj_id"], $sel_obj_ids)) {
                    $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") {

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

                    $chapter_title = $chap->_getPresentationTitle(
                        $node["obj_id"],
                        ilLMObject::CHAPTER_TITLE,
                        $this->lm->isActiveNumbering(),
                        (bool) $this->lm_set->get("time_scheduled_page_activation"),
                        false,
                        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") {

                    $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(
                        $this->content_style_domain->getEffectiveStyleId()
                    );

                    // 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"] ?? false) === true) {
                    if (true) {
                        $page_title = ilLMPageObject::_getPresentationTitle(
                            $lm_pg_obj->getId(),
                            $this->lm->getPageHeader(),
                            $this->lm->isActiveNumbering(),
                            (bool) $this->lm_set->get("time_scheduled_page_activation"),
                            false,
                            0,
                            $this->lang
                        );

                        if ($this->lm->getPageHeader() === ilLMObject::CHAPTER_TITLE) {
                            // remove the suffic (x/n)
                            $page_title = trim(substr($page_title, 0, strrpos($page_title, " ")));
                        }

                        // 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_title !== $last_page_title) {
                            $page_object_gui->setPresentationTitle($page_title);
                        }
                        $last_page_title = $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"], $sel_obj_ids))) {
                            $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();
                        $tf = $link["TargetFrame"] ?? "";
                        foreach ($links as $link) {
                            if ($link["Type"] === "MediaObject"
                                && $tf !== ""
                                && $tf !== "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 = ilArrayUtil::sortArray($terms, "term", "asc");
            //ksort($terms);

            foreach ($terms as $t) {
                $link = $t["link"];
                $key = $t["key"];

                try {
                    // output definition of term
                    $page_gui = new ilGlossaryDefPageGUI($link["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();
                } catch (Exception $e) {

                }
            }

            // 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",
                                    ilFileUtils::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") {
                $tpl->setVariable(
                    "LM_DESCRIPTION",
                    $lom_reader->firstData($lom_paths->firstDescription())->value()
                );
            }
            $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(),
                            (bool) $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
        $authors = $lom_data_helper->makePresentableAsList(
            ", ",
            ...$lom_reader->allData($lom_paths->authors())
        );
        if ($authors != "") {
            $this->lng->loadLanguageModule("meta");
            $tpl->setCurrentBlock("author");
            $tpl->setVariable("TXT_AUTHOR", $this->lng->txt("meta_author"));
            $tpl->setVariable("LM_AUTHOR", $authors);
            $tpl->parseCurrentBlock();
        }

        // output copyright information
        if ($lom_cp_helper->hasPresetCopyright($lom_reader)) {
            $copyright = $this->ui->renderer()->render(
                $lom_cp_helper->readPresetCopyright($lom_reader)->presentAsUIComponents()
            );
        } else {
            $copyright = $lom_cp_helper->readCustomCopyright($lom_reader);
        }
        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->addOnLoadCode("il.Util.print();");
        $this->tpl->printToStdout();
    }

Here is the call graph for this function:

showPrintViewSelection()

ilLMPresentationGUI::showPrintViewSelection

(

)

show selection screen for print view

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

References Vendor\Package\$f, $id, $lang, $lng, $requested_obj_id, $user, ilObjContentObject\_checkPreconditionsOfPage(), ilStructureObject\_getPresentationTitle(), ilLMPageObject\_getPresentationTitle(), ilPageObject\_lookupActive(), ilLMObject\CHAPTER_TITLE, ILIAS\Repository\ctrl(), exit, filterNonAccessibleNode(), ILIAS\Repository\form(), ILIAS\UICore\GlobalTemplate\get(), ilUtil\getImagePath(), getLMPresentationTitle(), initPrintViewSelectionForm(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\setVariable(), ilLanguage\txt(), and ILIAS\Repository\ui().

                                            : void
    {
        $ilUser = $this->user;
        $lng = $this->lng;

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

        $disabled = false;
        $img_alt = "";

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

        $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);

        $this->initPrintViewSelectionForm();

        foreach ($nodes as $node) {
            $img_src = "";
            $disabled = false;
            $img_alt = "";

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

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

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

            switch ($node["type"]) {
                // page
                case "pg":
                    $text =
                        ilLMPageObject::_getPresentationTitle(
                            $node["obj_id"],
                            $this->lm->getPageHeader(),
                            $this->lm->isActiveNumbering(),
                            (bool) $this->lm_set->get("time_scheduled_page_activation"),
                            false,
                            0,
                            $this->lang
                        );

                    $img_src = ilUtil::getImagePath("standard/icon_pg.svg");
                    $img_alt = $lng->txt("icon") . " " . $lng->txt("pg");
                    break;

                    // learning module
                case "du":
                    $text = $this->getLMPresentationTitle();
                    $img_src = ilUtil::getImagePath("standard/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(),
                            (bool) $this->lm_set->get("time_scheduled_page_activation"),
                            false,
                            0,
                            $this->lang
                        );
                    $img_src = ilUtil::getImagePath("standard/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(),
                    (bool) $this->lm_set->get("time_scheduled_page_activation"),
                    false,
                    0,
                    $this->lang
                );

            $img_src = ilUtil::getImagePath("standard/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->getHTMLAsync();

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

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

Here is the call graph for this function:

updatePageRating()

ilLMPresentationGUI::updatePageRating

(

)

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

References $user, ILIAS\Repository\ctrl(), exit, ILIAS\Repository\lng(), ilRating\resetRatingForUserAndObject(), and ilRating\writeRatingForUserAndObject().

                                      : void
    {
        $ilUser = $this->user;
        $pg_id = $this->service->getRequest()->getPgId();
        if (!$this->ctrl->isAsynch() || !$pg_id) {
            exit();
        }

        $rating = $this->service->getRequest()->getRating();
        if ($rating) {
            ilRating::writeRatingForUserAndObject(
                $this->lm->getId(),
                "lm",
                $pg_id,
                "lm",
                $ilUser->getId(),
                $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");
        $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

$abstract

bool ilLMPresentationGUI::$abstract = false

protected

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

$access

ilAccessHandler ilLMPresentationGUI::$access

protected

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

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

$additional_content

array ilLMPresentationGUI::$additional_content = []

protected

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

Referenced by renderTabs().

$chapter_has_no_active_page

bool ilLMPresentationGUI::$chapter_has_no_active_page = false

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

$content_style_domain

ILIAS Style Content Object ObjectFacade ilLMPresentationGUI::$content_style_domain

protected

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

$content_style_gui

ILIAS Style Content GUIService ilLMPresentationGUI::$content_style_gui

protected

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

$cs

ILIAS Style Content Service ilLMPresentationGUI::$cs = null

protected

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

$ctrl

ilCtrl ilLMPresentationGUI::$ctrl

protected

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

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

$current_page_id

int ilLMPresentationGUI::$current_page_id = 0

protected

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

$deactivated_page

bool ilLMPresentationGUI::$deactivated_page = false

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

$dom_util

ILIAS COPage Dom DomUtil ilLMPresentationGUI::$dom_util

protected

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

$embed_mode

bool ilLMPresentationGUI::$embed_mode = false

protected

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

Referenced by getHeaderAction(), and initByRequest().

$export_all_languages

bool ilLMPresentationGUI::$export_all_languages = false

protected

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

$export_format

string ilLMPresentationGUI::$export_format

protected

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

Referenced by getExportFormat().

$fill_on_load_code

bool ilLMPresentationGUI::$fill_on_load_code

protected

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

$focus_id

int ilLMPresentationGUI::$focus_id = 0

protected

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

$form

ilPropertyFormGUI ilLMPresentationGUI::$form

protected

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

$frames

array ilLMPresentationGUI::$frames

protected

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

Referenced by getCurrentFrameSet().

$global_screen

ILIAS GlobalScreen Services ilLMPresentationGUI::$global_screen

protected

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

$help

ilHelpGUI ilLMPresentationGUI::$help

protected

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

$lang

string ilLMPresentationGUI::$lang

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

Referenced by getLMPage(), ilLocator(), showPrintView(), and showPrintViewSelection().

$layout_doc

DOMDocument ilLMPresentationGUI::$layout_doc

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

$linker

ilLMPresentationLinker ilLMPresentationGUI::$linker

protected

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

$lm

ilObjLearningModule ilLMPresentationGUI::$lm

protected

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

$lm_gui

ilObjLearningModuleGUI ilLMPresentationGUI::$lm_gui

protected

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

$lm_set

ilSetting ilLMPresentationGUI::$lm_set

protected

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

$lm_tree

ilLMTree ilLMPresentationGUI::$lm_tree

protected

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

$lng

ilLanguage ilLMPresentationGUI::$lng

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

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

$locator

ilLocatorGUI ilLMPresentationGUI::$locator

protected

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

Referenced by ilLocator(), and initScreenHead().

$lom_services

LOMServices ilLMPresentationGUI::$lom_services

protected

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

$nav_history

ilNavigationHistory ilLMPresentationGUI::$nav_history

protected

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

Referenced by executeCommand().

$nl

ilNestedListInputGUI ilLMPresentationGUI::$nl

protected

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

Referenced by initPrintViewSelectionForm().

$notes

ILIAS Notes DomainService ilLMPresentationGUI::$notes

protected

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

$notes_gui

ILIAS Notes GUIService ilLMPresentationGUI::$notes_gui

protected

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

$offline

bool ilLMPresentationGUI::$offline

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

Referenced by offlineMode().

$offline_directory

string ilLMPresentationGUI::$offline_directory

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

Referenced by getOfflineDirectory().

$ot

Translations ilLMPresentationGUI::$ot

protected

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

$rbacsystem

ilRbacSystem ilLMPresentationGUI::$rbacsystem

protected

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

Referenced by ilLMSubMenu().

$reading_time_manager

ILIAS LearningModule ReadingTime ReadingTimeManager ilLMPresentationGUI::$reading_time_manager

protected

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

$requested_back_pg

string ilLMPresentationGUI::$requested_back_pg

protected

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

$requested_cmd

string ilLMPresentationGUI::$requested_cmd = ""

protected

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

$requested_focus_return

string ilLMPresentationGUI::$requested_focus_return

protected

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

$requested_frame

string ilLMPresentationGUI::$requested_frame

protected

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

Referenced by ilLocator().

$requested_mob_id

int ilLMPresentationGUI::$requested_mob_id = 0

protected

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

$requested_notification_switch

int ilLMPresentationGUI::$requested_notification_switch = 0

protected

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

$requested_obj_id

int ilLMPresentationGUI::$requested_obj_id

protected

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

Referenced by __construct(), executeCommand(), ilLocator(), and showPrintViewSelection().

$requested_obj_type

string ilLMPresentationGUI::$requested_obj_type

protected

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

Referenced by layout().

$requested_pg_id

int ilLMPresentationGUI::$requested_pg_id = 0

protected

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

$requested_pg_type

string ilLMPresentationGUI::$requested_pg_type = ""

protected

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

$requested_ref_id

int ilLMPresentationGUI::$requested_ref_id

protected

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

Referenced by ilLocator().

$requested_search_string

string ilLMPresentationGUI::$requested_search_string

protected

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

$requested_transl

string ilLMPresentationGUI::$requested_transl

protected

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

$requested_type

string ilLMPresentationGUI::$requested_type

protected

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

$requested_url

string ilLMPresentationGUI::$requested_url

protected

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

Referenced by saveFrameUrl().

$service

ilLMPresentationService ilLMPresentationGUI::$service

protected

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

Referenced by getService().

$settings

ilSetting ilLMPresentationGUI::$settings

protected

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

Referenced by getHeaderAction(), and ilLMNotes().

$tabs

ilTabsGUI ilLMPresentationGUI::$tabs

protected

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

Referenced by showPrintView().

$toolbar

ilToolbarGUI ilLMPresentationGUI::$toolbar

protected

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

$tpl

ilGlobalTemplateInterface ilLMPresentationGUI::$tpl

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

Referenced by getHeaderAction(), injectTemplate(), layout(), and page().

$tracker

ilLMTracker ilLMPresentationGUI::$tracker

protected

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

$tree

ilTree ilLMPresentationGUI::$tree

protected

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

$ui

ILIAS DI UIServices ilLMPresentationGUI::$ui

protected

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

$user

ilObjUser ilLMPresentationGUI::$user

protected

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

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

$xsl

ILIAS COPage Xsl XslManager ilLMPresentationGUI::$xsl

protected

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

---

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

• components/ILIAS/LearningModule/Presentation/class.ilLMPresentationGUI.php