ilLMContentRendererGUI Class Reference

Collaboration diagram for ilLMContentRendererGUI:

Public Member Functions
	__construct (ilLMPresentationService $service, ilLMPresentationGUI $parent_gui, ilLanguage $lng, ilCtrl $ctrl, ilAccessHandler $access, ilObjUser $user, ilHelpGUI $help, $requested_obj_id)
	Constructor. More...
	render ($a_head_foot_page_id=0)
	Render lm content. More...
	getLMPageGUI ($a_id)
	Get lm page gui object. More...
	renderPreconditionsOfPage ()
	show preconditions of the page More...
	getSuccessorPage ()
	Get successor page. More...

Data Fields
const	STATUS_ACCESS = 0
const	STATUS_NO_ACCESS = 1
const	STATUS_NO_PUBLIC_ACCESS = 2
const	STATUS_FAILED_PRECONDITIONS = 3
const	STATUS_CORRECT_ANSWER_MISSING = 4
const	STATUS_NO_PAGE_IN_CHAPTER = 5
const	STATUS_DEACTIVATED_PAGE = 6
const	STATUS_NO_PAGE_FOUND = 7

Protected Member Functions
	initHelp ()
	Init help. More...
	determineStatus ()
	Determine Status (should be factored out later to something like LMPageAccessStatus) More...
	initSearchHighlighting ()
	Init search highlighting. More...
	renderFocusMessage ()
	Render focus message. More...
	renderNoPageAccess ()
	Show info message, if page is not accessible in public area. More...
	renderMessageScreen ($a_content)
	Show message screen. More...
	renderNoPublicAccess ()
	Show info message, if page is not accessible in public area. More...
	renderNavRestrictionDueToQuestions ()
	Show message if navigation to page is not allowed due to unanswered questions. More...
	renderNoPageInChapterMessage ()
	Render no page in chapter message. More...
	renderNoPageFoundMessage ()
	Render no page found message. More...
	renderDeactivatedPageMessage ()
	Render deactivated page message. More...

Protected Attributes
	$access
	$user
	$help
	$current_page
	$lm
	$lng
	$offline
	$tracker
	$ctrl
	$lm_tree
	$parent_gui
	$lm_set
	$lang
	$linker
	$ot
	$concrete_lang

Detailed Description

Author

killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 11 of file class.ilLMContentRendererGUI.php.

Constructor & Destructor Documentation

__construct()

ilLMContentRendererGUI::__construct	(	ilLMPresentationService	$service,
		ilLMPresentationGUI	$parent_gui,
		ilLanguage	$lng,
		ilCtrl	$ctrl,
		ilAccessHandler	$access,
		ilObjUser	$user,
		ilHelpGUI	$help,
			$requested_obj_id
	)

Constructor.

Definition at line 102 of file class.ilLMContentRendererGUI.php.

References $access, $ctrl, $DIC, $help, $lng, $parent_gui, $user, ilObjectTranslation\getInstance(), ilLMPresentationService\getLearningModule(), ilLMPresentationService\getLinker(), ilLMPresentationService\getLMTree(), ilLMPresentationService\getNavigationStatus(), ilLMPresentationService\getPresentationStatus(), ilLMPresentationService\getSettings(), ilLMPresentationService\getTracker(), help(), and user().

      {
        global $DIC;

        $this->access = $access;
        $this->user = $user;
        $this->help = $help;
        $this->ctrl = $ctrl;
        $this->lm_tree = $service->getLMTree();
        $this->lang = $service->getPresentationStatus()->getLang();
        $this->current_page = $service->getNavigationStatus()->getCurrentPage();
        $this->lm = $service->getLearningModule();
        $this->lm_set = $service->getSettings();
        $this->lng = $lng;
        $this->offline = $service->getPresentationStatus()->offline;
        $this->tracker = $service->getTracker();
        $this->linker = $service->getLinker();
        $this->parent_gui = $parent_gui;
        $this->chapter_has_no_active_page = $service->getNavigationStatus()->isChapterWithoutActivePage();
        $this->deactivated_page = $service->getNavigationStatus()->isDeactivatedPage();
        $this->focus_id = $service->getPresentationStatus()->getFocusId();
        $this->concrete_lang = $service->getPresentationStatus()->getConcreteLang();

        $this->search_string = $service->getPresentationStatus()->getSearchString();
        $this->requested_obj_id = $requested_obj_id;
        $this->requested_focus_return = $service->getPresentationStatus()->getFocusReturn();

        $this->ot = ilObjectTranslation::getInstance($this->lm->getId());
    }

Here is the call graph for this function:

Member Function Documentation

determineStatus()

ilLMContentRendererGUI::determineStatus ( )

protected

Determine Status (should be factored out later to something like LMPageAccessStatus)

Parameters

Definition at line 157 of file class.ilLMContentRendererGUI.php.

References $current_page, $user, ilObjContentObject\_checkPreconditionsOfPage(), ilLMObject\_isPagePublic(), ilLMObject\_lookupType(), ANONYMOUS_USER_ID, and ilPageObject\lookupParentId().

Referenced by render().

    {
        $user = $this->user;

        $status = self::STATUS_ACCESS;

        // check page id
        $requested_page_lm = ilLMPage::lookupParentId($this->current_page, "lm");
        if ($requested_page_lm != $this->lm->getId()) {
            $status = self::STATUS_NO_ACCESS;
        }


        // check if page is (not) visible in public area
        if ($user->getId() == ANONYMOUS_USER_ID &&
            $this->lm->getPublicAccessMode() == 'selected') {
            if (!ilLMObject::_isPagePublic($this->current_page)) {
                $status = self::STATUS_NO_PUBLIC_ACCESS;
            }
        }

        // preconditions
        if (!ilObjContentObject::_checkPreconditionsOfPage($this->lm->getRefId(), $this->lm->getId(), $this->current_page)) {
            $status = self::STATUS_FAILED_PRECONDITIONS;
        }

        // if navigation is restricted based on correct answered questions
        // check if we have preceeding pages including unsanswered/incorrect answered questions
        if (!$this->offline) {
            if ($this->lm->getRestrictForwardNavigation()) {
                if ($this->tracker->hasPredIncorrectAnswers($this->current_page)) {
                    $status = self::STATUS_CORRECT_ANSWER_MISSING;
                }
            }
        }

        // no active page found in chapter
        if ($this->chapter_has_no_active_page &&
            ilLMObject::_lookupType($this->requested_obj_id) == "st") {
            $status = self::STATUS_NO_PAGE_IN_CHAPTER;
        }

        if ($this->deactivated_page) {
            $status = self::STATUS_DEACTIVATED_PAGE;
        }

        if ($this->current_page == 0) {
            $status = self::STATUS_NO_PAGE_FOUND;
        }


        return $status;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLMPageGUI()

ilLMContentRendererGUI::getLMPageGUI

(

$a_id

)

Get lm page gui object.

Parameters

Definition at line 370 of file class.ilLMContentRendererGUI.php.

References $concrete_lang, ilPageObject\_exists(), and ilPageObjectGUI\OFFLINE.

Referenced by render().

    {
        if ($this->lang != "-" && ilPageObject::_exists("lm", $a_id, $this->lang)) {
            $page_gui = new ilLMPageGUI($a_id, 0, false, $this->lang, $this->concrete_lang);
        } else {
            if ($this->lang != "-" && ilPageObject::_exists("lm", $a_id, $this->ot->getFallbackLanguage())) {
                $page_gui = new ilLMPageGUI($a_id, 0, false, $this->ot->getFallbackLanguage(), $this->concrete_lang);
            } else {
                $page_gui = new ilLMPageGUI($a_id, 0, false, "", $this->concrete_lang);
            }
        }
        if ($this->offline) {
            $page_gui->setOutputMode(ilPageObjectGUI::OFFLINE);
        }
        return $page_gui;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSuccessorPage()

ilLMContentRendererGUI::getSuccessorPage

(

)

Get successor page.

Parameters

Definition at line 637 of file class.ilLMContentRendererGUI.php.

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

Referenced by renderFocusMessage().

    {
        $ilUser = $this->user;

        $page_id = $this->current_page;

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

        // determine successor page_id
        $found = false;

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

initHelp()

ilLMContentRendererGUI::initHelp ( )

protected

Init help.

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

References $help.

Referenced by render().

    {
        $ilHelp = $this->help;
        $ilHelp->setScreenIdComponent("lm");
        $ilHelp->setScreenId("content");
        $ilHelp->setSubScreenId("content");
    }

Here is the caller graph for this function:

initSearchHighlighting()

ilLMContentRendererGUI::initSearchHighlighting ( )

protected

Init search highlighting.

Definition at line 214 of file class.ilLMContentRendererGUI.php.

References $user, ilUserSearchCache\_getInstance(), ilTextHighlighterGUI\highlight(), and ilUserSearchCache\LAST_QUERY.

Referenced by render().

    {
        $user = $this->user;

        if ($this->search_string != "" && !$this->offline) {
            $cache = ilUserSearchCache::_getInstance($user->getId());
            $cache->switchSearchType(ilUserSearchCache::LAST_QUERY);
            $search_string = $cache->getQuery();

            // advanced search?
            if (is_array($search_string)) {
                $search_string = $search_string["lom_content"];
            }

            $p = new ilQueryParser($search_string);
            $p->parse();

            $words = $p->getQuotedWords();
            if (is_array($words)) {
                foreach ($words as $w) {
                    ilTextHighlighterGUI::highlight("ilLMPageContent", $w);
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

render()

ilLMContentRendererGUI::render

(

$a_head_foot_page_id = 0

)

Render lm content.

Parameters

int

$a_head_foot_page_id

Returns

string

Definition at line 247 of file class.ilLMContentRendererGUI.php.

References $_GET, $current_page, $ilUser, $lang, $ret, $user, ilLMObject\_exists(), ilLMPageObject\_getPresentationTitle(), ilCourseLMHistory\_updateLastAccess(), determineStatus(), getLMPageGUI(), initHelp(), initSearchHighlighting(), renderDeactivatedPageMessage(), renderFocusMessage(), renderNavRestrictionDueToQuestions(), renderNoPageAccess(), renderNoPageFoundMessage(), renderNoPageInChapterMessage(), renderNoPublicAccess(), and renderPreconditionsOfPage().

    {
        $ilUser = $this->user;

        $this->initHelp();

        switch ($this->determineStatus()) {
            case self::STATUS_NO_ACCESS:
                return $this->renderNoPageAccess();

            case self::STATUS_NO_PUBLIC_ACCESS:
                return $this->renderNoPublicAccess();

            case self::STATUS_FAILED_PRECONDITIONS:
                return $this->renderPreconditionsOfPage();

            case self::STATUS_CORRECT_ANSWER_MISSING:
                return $this->renderNavRestrictionDueToQuestions();

            case self::STATUS_NO_PAGE_IN_CHAPTER:
                return $this->renderNoPageInChapterMessage();

            case self::STATUS_DEACTIVATED_PAGE:
                return $this->renderDeactivatedPageMessage();

            case self::STATUS_NO_PAGE_FOUND:
                return $this->renderNoPageFoundMessage();

        }

        // page id is e.g. > 0 when footer or header page is processed
        if ($a_head_foot_page_id == 0) {
            $page_id = $this->current_page;
            $this->initSearchHighlighting();
        } else {
            $page_id = $a_head_foot_page_id;
        }

        // check if page is out of focus
        $focus_mess = $this->renderFocusMessage();
        $page_object_gui = $this->getLMPageGUI($page_id);

        // @todo 6.0 (factor this out (maybe to ilLMPageGUI)
        $this->parent_gui->basicPageGuiInit($page_object_gui);

        $page_object = $page_object_gui->getPageObject();
        $page_object->buildDom();
        $page_object->registerOfflineHandler($this);

        $page_object_gui->setTemplateOutput(false);

        // Update course items
        ilCourseLMHistory::_updateLastAccess($ilUser->getId(), $this->lm->getRefId(), $page_id);

        // read link targets
        $page_object_gui->setPageLinker($this->linker);

        // get lm page object
        $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($_GET["frame"]);

        // page title and tracking (not for header or footer page)
        if ($page_id == 0 || ($page_id != $this->lm->getHeaderPage() &&
                $page_id != $this->lm->getFooterPage())) {
            $page_object_gui->setPresentationTitle(
                ilLMPageObject::_getPresentationTitle(
                    $lm_pg_obj->getId(),
                    $this->lm->getPageHeader(),
                    $this->lm->isActiveNumbering(),
                    $this->lm_set->get("time_scheduled_page_activation"),
                    false,
                    0,
                    $this->lang
                )
            );

            // track access
            if ($page_id != 0 && !$this->offline) {
                $this->tracker->trackAccess($page_id, $ilUser->getId());
            }
        } else {
            $page_object_gui->setEnabledPageFocus(false);
            $page_object_gui->getPageConfig()->setEnableSelfAssessment(false);
        }

        // ADDED FOR CITATION
        $page_object_gui->setLinkParams("ref_id=" . $this->lm->getRefId());
        $page_object_gui->setTemplateTargetVar("PAGE_CONTENT");
        // @todo 6.0
        //              $page_object_gui->setSourcecodeDownloadScript($this->getSourcecodeDownloadLink());

        $ret = $page_object_gui->presentation($page_object_gui->getOutputMode());

        // process header
        if ($this->lm->getHeaderPage() > 0 &&
            $page_id != $this->lm->getHeaderPage() &&
            ($page_id == 0 || $page_id != $this->lm->getFooterPage())) {
            if (ilLMObject::_exists($this->lm->getHeaderPage())) {
                $head = $this->render($this->lm->getHeaderPage());
            }
        }

        // process footer
        if ($this->lm->getFooterPage() > 0 &&
            $page_id != $this->lm->getFooterPage() &&
            ($page_id == 0 || $page_id != $this->lm->getHeaderPage())) {
            if (ilLMObject::_exists($this->lm->getFooterPage())) {
                $foot = $this->render($this->lm->getFooterPage());
            }
        }

        return $head . $focus_mess . $ret . $foot;
    }

Here is the call graph for this function:

renderDeactivatedPageMessage()

ilLMContentRendererGUI::renderDeactivatedPageMessage ( )

protected

Render deactivated page message.

Returns

string

Definition at line 543 of file class.ilLMContentRendererGUI.php.

References ilPageObject\_lookupActivationData(), ilLMObject\_lookupTitle(), ilDatePresentation\formatDate(), IL_CAL_DATETIME, and ilUtil\now().

Referenced by render().

    {
        $mtpl = new ilTemplate(
            "tpl.no_content_message.html",
            true,
            true,
            "Modules/LearningModule"
        );
        $m = $this->lng->txt("cont_page_currently_deactivated");
        $act_data = ilLMPage::_lookupActivationData($this->requested_obj_id, $this->lm->getType());
        if ($act_data["show_activation_info"] &&
            (ilUtil::now() < $act_data["activation_start"])) {
            $m .= "<p>" . sprintf(
                $this->lng->txt("cont_page_activation_on"),
                ilDatePresentation::formatDate(
                    new ilDateTime($act_data["activation_start"], IL_CAL_DATETIME)
                )
            ) .
                "</p>";
        }
        $mtpl->setVariable("MESSAGE", $m);
        $mtpl->setVariable(
            "ITEM_TITLE",
            ilLMObject::_lookupTitle($this->requested_obj_id)
        );
        return $mtpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderFocusMessage()

ilLMContentRendererGUI::renderFocusMessage ( )

protected

Render focus message.

Parameters

Definition at line 395 of file class.ilLMContentRendererGUI.php.

References ilLink\_getLink(), ilObject\_lookupType(), and getSuccessorPage().

Referenced by render().

    {
        $focus_mess = "";
        if ($this->focus_id > 0) {
            $path = $this->lm_tree->getPathId($this->current_page);

            // out of focus
            if (!in_array($this->focus_id, $path)) {
                $mtpl = new ilTemplate(
                    "tpl.out_of_focus_message.html",
                    true,
                    true,
                    "Modules/LearningModule"
                );
                $mtpl->setVariable("MESSAGE", $this->lng->txt("cont_out_of_focus_message"));
                $mtpl->setVariable("TXT_SHOW_CONTENT", $this->lng->txt("cont_show_content_after_focus"));

                if ($this->requested_focus_return == 0 || ilObject::_lookupType((int) $this->requested_focus_return, true) != "crs") {
                    $mtpl->setVariable("TXT_BACK_BEGINNING", $this->lng->txt("cont_to_focus_beginning"));
                    $this->ctrl->setParameter($this->parent_gui, "obj_id", $this->focus_id);
                    $mtpl->setVariable("LINK_BACK_TO_BEGINNING", $this->ctrl->getLinkTarget($this->parent_gui, "layout"));
                    $this->ctrl->setParameter($this->parent_gui, "obj_id", $this->requested_obj_id);
                } else {
                    $mtpl->setVariable("TXT_BACK_BEGINNING", $this->lng->txt("cont_to_focus_return_crs"));
                    $mtpl->setVariable("LINK_BACK_TO_BEGINNING", ilLink::_getLink($this->requested_focus_return));
                }

                $this->ctrl->setParameter($this->parent_gui, "focus_id", "");
                $mtpl->setVariable("LINK_SHOW_CONTENT", $this->ctrl->getLinkTarget($this->parent_gui, "layout"));
                $this->ctrl->setParameter($this->parent_gui, "focus_id", $this->requested_obj_id);

                $focus_mess = $mtpl->get();
            } else {
                $sp = $this->getSuccessorPage();
                $path2 = array();
                if ($sp > 0) {
                    $path2 = $this->lm_tree->getPathId($this->getSuccessorPage());
                }
                if ($sp == 0 || !in_array($this->focus_id, $path2)) {
                    $mtpl = new ilTemplate(
                        "tpl.out_of_focus_message.html",
                        true,
                        true,
                        "Modules/LearningModule"
                    );
                    $mtpl->setVariable("MESSAGE", $this->lng->txt("cont_out_of_focus_message_last_page"));
                    $mtpl->setVariable("TXT_SHOW_CONTENT", $this->lng->txt("cont_show_content_after_focus"));

                    if ($this->requested_focus_return == 0 || ilObject::_lookupType($this->requested_focus_return, true) != "crs") {
                        $mtpl->setVariable("TXT_BACK_BEGINNING", $this->lng->txt("cont_to_focus_beginning"));
                        $this->ctrl->setParameter($this->parent_gui, "obj_id", $this->focus_id);
                        $mtpl->setVariable("LINK_BACK_TO_BEGINNING", $this->ctrl->getLinkTarget($this->parent_gui, "layout"));
                        $this->ctrl->setParameter($this->parent_gui, "obj_id", $this->requested_obj_id);
                    } else {
                        $mtpl->setVariable("TXT_BACK_BEGINNING", $this->lng->txt("cont_to_focus_return_crs"));
                        $mtpl->setVariable("LINK_BACK_TO_BEGINNING", ilLink::_getLink($this->requested_focus_return));
                    }

                    $this->ctrl->setParameter($this->parent_gui, "focus_id", "");
                    $mtpl->setVariable("LINK_SHOW_CONTENT", $this->ctrl->getLinkTarget($this->parent_gui, "layout"));
                    $this->ctrl->setParameter($this->parent_gui, "focus_id", $this->requested_obj_id);

                    $focus_mess = $mtpl->get();
                }
            }
        }
        return $focus_mess;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderMessageScreen()

ilLMContentRendererGUI::renderMessageScreen (   $a_content )

protected

Show message screen.

Parameters

string

content

Returns

string

Definition at line 480 of file class.ilLMContentRendererGUI.php.

References $tpl.

Referenced by renderNavRestrictionDueToQuestions(), renderNoPageAccess(), renderNoPageFoundMessage(), and renderNoPublicAccess().

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

        return $tpl->get();
    }

Here is the caller graph for this function:

renderNavRestrictionDueToQuestions()

ilLMContentRendererGUI::renderNavRestrictionDueToQuestions ( )

protected

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

Returns

string

Definition at line 503 of file class.ilLMContentRendererGUI.php.

References renderMessageScreen().

Referenced by render().

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

Here is the call graph for this function:

Here is the caller graph for this function:

renderNoPageAccess()

ilLMContentRendererGUI::renderNoPageAccess ( )

protected

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

Returns

string

Definition at line 469 of file class.ilLMContentRendererGUI.php.

References renderMessageScreen().

Referenced by render().

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

Here is the call graph for this function:

Here is the caller graph for this function:

renderNoPageFoundMessage()

ilLMContentRendererGUI::renderNoPageFoundMessage ( )

protected

Render no page found message.

Returns

string

Definition at line 532 of file class.ilLMContentRendererGUI.php.

References renderMessageScreen().

Referenced by render().

    {
        return $this->renderMessageScreen($this->lng->txt("cont_no_page"));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderNoPageInChapterMessage()

ilLMContentRendererGUI::renderNoPageInChapterMessage ( )

protected

Render no page in chapter message.

Returns

string

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

References ilLMObject\_lookupTitle().

Referenced by render().

    {
        $mtpl = new ilTemplate(
            "tpl.no_content_message.html",
            true,
            true,
            "Modules/LearningModule"
        );
        $mtpl->setVariable("MESSAGE", $this->lng->txt("cont_no_page_in_chapter"));
        $mtpl->setVariable(
            "ITEM_TITLE",
            ilLMObject::_lookupTitle($this->requested_obj_id)
        );
        return $mtpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderNoPublicAccess()

ilLMContentRendererGUI::renderNoPublicAccess ( )

protected

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

Returns

string

Definition at line 493 of file class.ilLMContentRendererGUI.php.

References renderMessageScreen().

Referenced by render().

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

Here is the call graph for this function:

Here is the caller graph for this function:

renderPreconditionsOfPage()

ilLMContentRendererGUI::renderPreconditionsOfPage

(

)

show preconditions of the page

Definition at line 575 of file class.ilLMContentRendererGUI.php.

References $_GET, $current_page, $i, ilLink\_getLink(), ilObjContentObject\_getMissingPreconditionsOfPage(), ilObjContentObject\_getMissingPreconditionsTopChapter(), ilLMObject\_lookupTitle(), and ilObject\_lookupTitle().

Referenced by render().

    {
        $conds = ilObjContentObject::_getMissingPreconditionsOfPage($this->lm->getRefId(), $this->lm->getId(), $this->current_page);
        $topchap = ilObjContentObject::_getMissingPreconditionsTopChapter($this->lm->getRefId(), $this->lm->getId(), $this->current_page);

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

        // list all missing preconditions
        foreach ($conds as $cond) {
            $obj_link = ilLink::_getLink($cond["trigger_ref_id"]);
            $ptpl->setCurrentBlock("condition");
            $ptpl->setVariable("VAL_ITEM", ilObject::_lookupTitle($cond["trigger_obj_id"]));
            $ptpl->setVariable("LINK_ITEM", $obj_link);
            if ($cond["operator"] == "passed") {
                $cond_str = $this->lng->txt("passed");
            } else {
                $cond_str = $this->lng->txt("condition_" . $cond["operator"]);
            }
            $ptpl->setVariable("VAL_CONDITION", $cond_str . " " . $cond["value"]);
            $ptpl->parseCurrentBlock();
        }

        $ptpl->setVariable(
            "TXT_MISSING_PRECONDITIONS",
            sprintf(
                $this->lng->txt("cont_missing_preconditions"),
                ilLMObject::_lookupTitle($topchap)
            )
        );
        $ptpl->setVariable("TXT_ITEM", $this->lng->txt("object"));
        $ptpl->setVariable("TXT_CONDITION", $this->lng->txt("condition"));

        // output skip chapter link
        $parent = $this->lm_tree->getParentId($topchap);
        $childs = $this->lm_tree->getChildsByType($parent, "st");
        $j = -2;
        $i = 1;
        foreach ($childs as $child) {
            if ($child["child"] == $topchap) {
                $j = $i;
            }
            if ($i++ == ($j + 1)) {
                $succ_node = $this->lm_tree->fetchSuccessorNode($child["child"], "pg");
            }
        }
        if ($succ_node != "") {
            $link = "<br /><a href=\"" .
                $this->linker->getLink("layout", $succ_node["obj_id"], $_GET["frame"]) .
                "\">" . $this->lng->txt("cont_skip_chapter") . "</a>";
            $ptpl->setVariable("LINK_SKIP_CHAPTER", $link);
        }

        return $ptpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilLMContentRendererGUI::$access

protected

Definition at line 25 of file class.ilLMContentRendererGUI.php.

Referenced by __construct().

$concrete_lang

ilLMContentRendererGUI::$concrete_lang

protected

Definition at line 97 of file class.ilLMContentRendererGUI.php.

Referenced by getLMPageGUI().

$ctrl

ilLMContentRendererGUI::$ctrl

protected

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

Referenced by __construct().

$current_page

ilLMContentRendererGUI::$current_page

protected

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

Referenced by determineStatus(), getSuccessorPage(), render(), and renderPreconditionsOfPage().

$help

ilLMContentRendererGUI::$help

protected

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

Referenced by __construct(), and initHelp().

$lang

ilLMContentRendererGUI::$lang

protected

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

Referenced by render().

$linker

ilLMContentRendererGUI::$linker

protected

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

$lm

ilLMContentRendererGUI::$lm

protected

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

$lm_set

ilLMContentRendererGUI::$lm_set

protected

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

$lm_tree

ilLMContentRendererGUI::$lm_tree

protected

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

$lng

ilLMContentRendererGUI::$lng

protected

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

Referenced by __construct().

$offline

ilLMContentRendererGUI::$offline

protected

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

$ot

ilLMContentRendererGUI::$ot

protected

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

$parent_gui

ilLMContentRendererGUI::$parent_gui

protected

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

Referenced by __construct().

$tracker

ilLMContentRendererGUI::$tracker

protected

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

$user

ilLMContentRendererGUI::$user

protected

Definition at line 30 of file class.ilLMContentRendererGUI.php.

Referenced by __construct(), determineStatus(), getSuccessorPage(), initSearchHighlighting(), and render().

STATUS_ACCESS

const ilLMContentRendererGUI::STATUS_ACCESS = 0

Definition at line 13 of file class.ilLMContentRendererGUI.php.

STATUS_CORRECT_ANSWER_MISSING

const ilLMContentRendererGUI::STATUS_CORRECT_ANSWER_MISSING = 4

Definition at line 17 of file class.ilLMContentRendererGUI.php.

STATUS_DEACTIVATED_PAGE

const ilLMContentRendererGUI::STATUS_DEACTIVATED_PAGE = 6

Definition at line 19 of file class.ilLMContentRendererGUI.php.

STATUS_FAILED_PRECONDITIONS

const ilLMContentRendererGUI::STATUS_FAILED_PRECONDITIONS = 3

Definition at line 16 of file class.ilLMContentRendererGUI.php.

STATUS_NO_ACCESS

const ilLMContentRendererGUI::STATUS_NO_ACCESS = 1

Definition at line 14 of file class.ilLMContentRendererGUI.php.

STATUS_NO_PAGE_FOUND

const ilLMContentRendererGUI::STATUS_NO_PAGE_FOUND = 7

Definition at line 20 of file class.ilLMContentRendererGUI.php.

STATUS_NO_PAGE_IN_CHAPTER

const ilLMContentRendererGUI::STATUS_NO_PAGE_IN_CHAPTER = 5

Definition at line 18 of file class.ilLMContentRendererGUI.php.

STATUS_NO_PUBLIC_ACCESS

const ilLMContentRendererGUI::STATUS_NO_PUBLIC_ACCESS = 2

Definition at line 15 of file class.ilLMContentRendererGUI.php.

---

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

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