This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilLMNavigationRendererGUI:

Public Member Functions
	__construct (ilLMPresentationService $service, ilLMPresentationGUI $parent_gui, ilLanguage $lng, ilObjUser $user, ilGlobalTemplateInterface $main_tpl, int $requested_obj_id, string $requested_back_pg, string $requested_frame, ilToolbarGUI $toolbar, \ILIAS\DI\UIServices $ui)

	renderTop ()

	renderBottom ()

Protected Member Functions
	render (bool $top=true)

	addDropdown ()

Protected Attributes
ilToolbarGUI	$toolbar

ILIAS DI UIServices	$ui

string	$requested_frame

int	$requested_back_pg

int	$requested_obj_id

ilLMPresentationLinker	$linker

bool	$deactivated_page

bool	$chapter_has_no_active_page

ilObjUser	$user

int	$current_page

ilObjLearningModule	$lm

ilLanguage	$lng

bool	$offline

ilLMTracker	$tracker

ilLMTree	$lm_tree

ilLMPresentationGUI	$parent_gui

ilSetting	$lm_set

ilGlobalTemplateInterface	$main_tpl

string	$lang

ilLMNavigationStatus	$navigation_status

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 22 of file class.ilLMNavigationRendererGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilLMNavigationRendererGUI::__construct	(	ilLMPresentationService	$service,
		ilLMPresentationGUI	$parent_gui,
		ilLanguage	$lng,
		ilObjUser	$user,
		ilGlobalTemplateInterface	$main_tpl,
		int	$requested_obj_id,
		string	$requested_back_pg,
		string	$requested_frame,
		ilToolbarGUI	$toolbar,
		\ILIAS\DI\UIServices	$ui
	)

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

References $lng, $main_tpl, $parent_gui, $requested_frame, $requested_obj_id, $toolbar, $ui, $user, ilLMPresentationService\getLearningModule(), ilLMPresentationService\getLinker(), ilLMPresentationService\getLMTree(), ilLMPresentationService\getNavigationStatus(), ilLMPresentationService\getPresentationStatus(), ilLMPresentationService\getSettings(), ilLMPresentationService\getTracker(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

       {
         $this->user = $user;
         $this->toolbar = $toolbar;
         $this->ui = $ui;
         $this->lm_tree = $service->getLMTree();
         $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->parent_gui = $parent_gui;
         $this->chapter_has_no_active_page = $service->getNavigationStatus()->isChapterWithoutActivePage();
         $this->deactivated_page = $service->getNavigationStatus()->isDeactivatedPage();
         $this->linker = $service->getLinker();
         $this->navigation_status = $service->getNavigationStatus();
         $this->requested_obj_id = $requested_obj_id;
         $back_pg = explode(":", $requested_back_pg);
         $this->requested_back_pg = (int) $back_pg[0];
         $this->requested_frame = $requested_frame;
         $this->main_tpl = $main_tpl;
         $this->lang = $service->getPresentationStatus()->getLang();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addDropdown()

ilLMNavigationRendererGUI::addDropdown ( )

protected

Definition at line 267 of file class.ilLMNavigationRendererGUI.php.

References $lang, ilObjContentObject\_checkPreconditionsOfPage(), ilStructureObject\_getPresentationTitle(), ilLMPageObject\_getPresentationTitle(), ilPageObject\_lookupActive(), ilLMObject\CHAPTER_TITLE, ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), and ILIAS\Repository\ui().

Referenced by render().

     {
         $nodes = $this->lm_tree->getSubTree($this->lm_tree->getNodeData($this->lm_tree->getRootId()));
         //$nodes = $this->filterNonAccessibleNode($nodes);
 
         foreach ($nodes as $node) {
             $disabled = false;
 
             // 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 = "";
             $checked = false;
 
             switch ($node["type"]) {
                 // page
                 case "pg":
                     if ($this->lm->getTOCMode() !== "pages") {
                         continue 2;
                     }
                     $text =
                         ilLMPageObject::_getPresentationTitle(
                             $node["obj_id"],
                             $this->lm->getPageHeader(),
                             $this->lm->isActiveNumbering(),
                             (bool) $this->lm_set->get("time_scheduled_page_activation"),
                             false,
                             $this->lm->getId(),
                             $this->lang,
                             true
                         );
 
                     break;
 
                     // learning module
                 case "du":
                     $text = "";
                     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,
                             $this->lm->getId(),
                             $this->lang,
                             true
                         );
                     break;
             }
 
             if (!ilObjContentObject::_checkPreconditionsOfPage(
                 $this->lm->getRefId(),
                 $this->lm->getId(),
                 $node["obj_id"]
             )) {
                 $disabled = true;
                 $text .= " (" . $this->lng->txt("cont_no_access") . ")";
             }
 
             $href = $this->linker->getLink("layout", $node["obj_id"]);
 
             if ($text !== "") {
                 if ($this->lm->getTOCMode() === "pages" && $this->current_page == $node["obj_id"]) {
                     $text = "» " . $text;
                 }
                 if ($this->lm->getTOCMode() !== "pages") {
                     if ($this->lm_tree->getParentId($this->current_page) == $node["obj_id"]) {
                         $text = "» " . $text;
                     }
                 }
                 $text = str_pad("", ($node["depth"] - 1) * 12, "&nbsp;") . $text;
                 $actions[] = $this->ui->factory()->button()->shy(
                     $text,
                     $href
                 );
             }
         }
 
         if ($this->lm->getTOCMode() === "pages") {
             $title = ilLMPageObject::_getPresentationTitle(
                 $this->current_page,
                 $this->lm->getPageHeader(),
                 $this->lm->isActiveNumbering(),
                 (bool) $this->lm_set->get("time_scheduled_page_activation"),
                 false,
                 $this->lm->getId(),
                 $this->lang,
                 true
             );
         } else {
             $st_id = $this->lm_tree->getParentId($this->current_page);
             if ($st_id > 0) {
                 $title = ilStructureObject::_getPresentationTitle(
                     $st_id,
                     ilLMObject::CHAPTER_TITLE,
                     $this->lm->isActiveNumbering(),
                     (bool) $this->lm_set->get("time_scheduled_page_activation"),
                     false,
                     $this->lm->getId(),
                     $this->lang,
                     true
                 );
             }
         }
 
         $title = "<span style='vertical-align: bottom; max-width:60px; display: inline-block; overflow: hidden; white-space: nowrap; text-overflow: ellipsis;'>" . $title . "</span>";
 
 
         $this->toolbar->addStickyItem(
             $this->ui->factory()->dropdown()->standard($actions)->withLabel($title)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

ilLMNavigationRendererGUI::render ( bool $top = true )

protected

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

References Vendor\Package\$b, $current_page, $lang, ilLMPageObject\_getPresentationTitle(), addDropdown(), ilUtil\getImagePath(), ILIAS\Repository\lng(), ilStr\shortenTextExtended(), ILIAS\Repository\toolbar(), and ILIAS\Repository\ui().

Referenced by renderBottom(), and renderTop().

                                                : string
     {
         $page_id = $this->current_page;
 
         $tpl = new ilTemplate("tpl.lm_navigation.html", true, true, "components/ILIAS/LearningModule/Presentation");
 
         if (empty($page_id)) {
             return "";
         }
 
         // process navigation for free page
         $back_pg = $this->navigation_status->getBackPageId();
         if ($back_pg > 0) {
             $back_href =
                 $this->linker->getLink(
                     "layout",
                     $back_pg,
                     "",
                     "",
                     "reduce"
                 );
             $back_img =
                 ilUtil::getImagePath("nav/nav_arr2_L.png", false, "output", $this->offline);
             $tpl->setCurrentBlock("ilLMNavigation_Prev");
             $tpl->setVariable("IMG_PREV", $back_img);
             $tpl->setVariable("HREF_PREV", $back_href);
             $tpl->setVariable("TXT_PREV", $this->lng->txt("back"));
             $tpl->setVariable("ALT_PREV", $this->lng->txt("back"));
             $tpl->setVariable("SPACER_PREV", $this->offline
                 ? "images/media/spacer.png"
                 : ilUtil::getImagePath("media/spacer.png"));
             $tpl->parseCurrentBlock();
             if ($top) {
                 $b = $this->ui->factory()->button()->standard(
                     "<span class=\"glyphicon glyphicon-chevron-left \" aria-hidden=\"true\"></span>",
                     $back_href
                 );
                 $this->toolbar->addStickyItem($b);
             }
         } else {
             $pre_id = $this->navigation_status->getPredecessorPageId();
             if ($pre_id > 0) {
                 // get presentation title
                 $prev_title = ilLMPageObject::_getPresentationTitle(
                     $pre_id,
                     $this->lm->getPageHeader(),
                     $this->lm->isActiveNumbering(),
                     (bool) $this->lm_set->get("time_scheduled_page_activation"),
                     false,
                     0,
                     $this->lang,
                     true
                 );
                 $prev_title = ilStr::shortenTextExtended($prev_title, 50, true);
                 $prev_img =
                     ilUtil::getImagePath("nav/nav_arr_L.png", false, "output", $this->offline);
 
                 if (!$this->lm->cleanFrames()) {
                     $prev_href =
                         $this->linker->getLink(
                             "layout",
                             $pre_id,
                             $this->requested_frame
                         );
                     $prev_target = "";
                 } else {
                     if (!$this->offline) {
                         $prev_href =
                             $this->linker->getLink("layout", $pre_id);
                     } else {
                         $prev_href =
                             $this->linker->getLink("layout", $pre_id);
                     }
                 }
 
                 $tpl->setCurrentBlock("ilLMNavigation_Prev");
                 $tpl->setVariable("IMG_PREV", $prev_img);
                 $tpl->setVariable("HREF_PREV", $prev_href);
                 $tpl->setVariable("TXT_PREV", $prev_title);
                 $tpl->setVariable("ALT_PREV", $this->lng->txt("previous"));
                 $tpl->setVariable("SPACER_PREV", $this->offline
                     ? "images/media/spacer.png"
                     : ilUtil::getImagePath("media/spacer.png"));
 
                 if ($top) {
                     $b = $this->ui->factory()->button()->standard(
                         "<span class=\"glyphicon glyphicon-chevron-left \" aria-hidden=\"true\"></span>",
                         $prev_href
                     );
                     $this->toolbar->addStickyItem($b);
                 }
             } else {
                 if ($top) {
                     $b = $this->ui->factory()->button()->standard(
                         "<span class=\"glyphicon glyphicon-chevron-left \" aria-hidden=\"true\"></span>",
                         "#"
                     )->withUnavailableAction();
                     $this->toolbar->addStickyItem($b);
                 }
             }
 
             $this->addDropdown();
 
             $succ_id = $this->navigation_status->getSuccessorPageId();
             if ($succ_id > 0) {
                 // get presentation title
                 $succ_title = ilLMPageObject::_getPresentationTitle(
                     $succ_id,
                     $this->lm->getPageHeader(),
                     $this->lm->isActiveNumbering(),
                     (bool) $this->lm_set->get("time_scheduled_page_activation"),
                     false,
                     0,
                     $this->lang,
                     true
                 );
                 $succ_title = ilStr::shortenTextExtended($succ_title, 50, true);
                 $succ_img =
                     ilUtil::getImagePath("nav/nav_arr_R.png", false, "output", $this->offline);
                 if (!$this->lm->cleanFrames()) {
                     $succ_href =
                         $this->linker->getLink(
                             "layout",
                             $succ_id,
                             $this->requested_frame
                         );
                     $succ_target = "";
                 } else {
                     if (!$this->offline) {
                         $succ_href =
                             $this->linker->getLink("layout", $succ_id);
                     } else {
                         $succ_href =
                             $this->linker->getLink("layout", $succ_id);
                     }
                 }
 
                 $tpl->setCurrentBlock("ilLMNavigation_Next");
                 $tpl->setVariable("IMG_SUCC", $succ_img);
                 $tpl->setVariable("HREF_SUCC", $succ_href);
                 $tpl->setVariable("TXT_SUCC", $succ_title);
                 $tpl->setVariable("ALT_SUCC", $this->lng->txt("next"));
                 $tpl->setVariable("SPACER_SUCC", $this->offline
                     ? "images/media/spacer.png"
                     : ilUtil::getImagePath("media/spacer.png"));
                 $tpl->parseCurrentBlock();
 
                 // check if successor page is not restricted
                 if (!$this->offline) {
                     if ($this->lm->getRestrictForwardNavigation()) {
                         if ($this->tracker->hasPredIncorrectAnswers($succ_id)) {
                             $this->main_tpl->addOnLoadCode("il.LearningModule.hideNextNavigation();");
                         }
                     }
                 }
                 if ($top) {
                     $b = $this->ui->factory()->button()->standard(
                         "<span class=\"glyphicon glyphicon-chevron-right \" aria-hidden=\"true\"></span>",
                         $succ_href
                     );
                     $this->toolbar->addStickyItem($b);
                 }
             } else {
                 if ($top) {
                     $b = $this->ui->factory()->button()->standard(
                         "<span class=\"glyphicon glyphicon-chevron-right \" aria-hidden=\"true\"></span>",
                         "#"
                     )->withUnavailableAction();
                     $this->toolbar->addStickyItem($b);
                 }
             }
         }
         $tpl->setVariable("CLASS", ($top) ? "tnav_Top" : "bnav_Bottom");
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderBottom()

ilLMNavigationRendererGUI::renderBottom ( )

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

References render().

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

Here is the call graph for this function:

◆ renderTop()

ilLMNavigationRendererGUI::renderTop ( )

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

References render().

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

Here is the call graph for this function:

Field Documentation

◆ $chapter_has_no_active_page

bool ilLMNavigationRendererGUI::$chapter_has_no_active_page

protected

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

◆ $current_page

int ilLMNavigationRendererGUI::$current_page

protected

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

Referenced by render().

◆ $deactivated_page

bool ilLMNavigationRendererGUI::$deactivated_page

protected

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

◆ $lang

string ilLMNavigationRendererGUI::$lang

protected

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

Referenced by addDropdown(), and render().

◆ $linker

ilLMPresentationLinker ilLMNavigationRendererGUI::$linker

protected

Definition at line 29 of file class.ilLMNavigationRendererGUI.php.

◆ $lm

ilObjLearningModule ilLMNavigationRendererGUI::$lm

protected

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

◆ $lm_set

ilSetting ilLMNavigationRendererGUI::$lm_set

protected

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

◆ $lm_tree

ilLMTree ilLMNavigationRendererGUI::$lm_tree

protected

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

◆ $lng

ilLanguage ilLMNavigationRendererGUI::$lng

protected

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

Referenced by __construct().

◆ $main_tpl

ilGlobalTemplateInterface ilLMNavigationRendererGUI::$main_tpl

protected

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

Referenced by __construct().

◆ $navigation_status

ilLMNavigationStatus ilLMNavigationRendererGUI::$navigation_status

protected

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

◆ $offline

bool ilLMNavigationRendererGUI::$offline

protected

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

◆ $parent_gui

ilLMPresentationGUI ilLMNavigationRendererGUI::$parent_gui

protected

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

Referenced by __construct().

◆ $requested_back_pg

int ilLMNavigationRendererGUI::$requested_back_pg

protected

Definition at line 27 of file class.ilLMNavigationRendererGUI.php.

◆ $requested_frame

string ilLMNavigationRendererGUI::$requested_frame

protected

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

Referenced by __construct().

◆ $requested_obj_id

int ilLMNavigationRendererGUI::$requested_obj_id

protected

Definition at line 28 of file class.ilLMNavigationRendererGUI.php.

Referenced by __construct().

◆ $toolbar

ilToolbarGUI ilLMNavigationRendererGUI::$toolbar

protected

Definition at line 24 of file class.ilLMNavigationRendererGUI.php.

Referenced by __construct().

◆ $tracker

ilLMTracker ilLMNavigationRendererGUI::$tracker

protected

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

◆ $ui

ILIAS DI UIServices ilLMNavigationRendererGUI::$ui

protected

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

Referenced by __construct().

◆ $user

ilObjUser ilLMNavigationRendererGUI::$user

protected

Definition at line 32 of file class.ilLMNavigationRendererGUI.php.

Referenced by __construct().

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

components/ILIAS/LearningModule/Presentation/class.ilLMNavigationRendererGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addDropdown()

◆ render()

◆ renderBottom()

◆ renderTop()

Field Documentation

◆ $chapter_has_no_active_page

◆ $current_page

◆ $deactivated_page

◆ $lang

◆ $linker

◆ $lm

◆ $lm_set

◆ $lm_tree

◆ $lng

◆ $main_tpl

◆ $navigation_status

◆ $offline

◆ $parent_gui

◆ $requested_back_pg

◆ $requested_frame

◆ $requested_obj_id

◆ $toolbar

◆ $tracker

◆ $ui

◆ $user