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

Collaboration diagram for ilLMNavigationStatus:

Public Member Functions
	__construct (ilObjUser $user, int $request_obj_id, ilLMTree $lm_tree, ilObjLearningModule $lm, ilSetting $lm_set, string $requested_back_page, string $cmd, int $focus_id)

	isChapterWithoutActivePage ()
	Has current chapter no active page? More...

	isDeactivatedPage ()

	getCurrentPage ()

	getBackPageId ()

	getSuccessorPageId ()

	getPredecessorPageId ()

Protected Member Functions
	determineStatus ()

Protected Attributes
int	$current_page_id = null

bool	$chapter_has_no_active_page = false

bool	$deactivated_page = false

ilObjLearningModule	$lm

ilLMTree	$lm_tree

ilObjUser	$user

ilSetting	$lm_set

int	$requested_back_page

string	$cmd

int	$focus_id

int	$requested_obj_id

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 Checks current navigation request status

determines the current page (request may e.g. pass a chapter id, in this case the next page is searched)
determines if all pages of a chapter are deactivated
determines if the current page is deactivated

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

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

Constructor & Destructor Documentation

◆ __construct()

ilLMNavigationStatus::__construct	(	ilObjUser	$user,
		int	$request_obj_id,
		ilLMTree	$lm_tree,
		ilObjLearningModule	$lm,
		ilSetting	$lm_set,
		string	$requested_back_page,
		string	$cmd,
		int	$focus_id
	)

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

      {
        $this->user = $user;
        $this->requested_obj_id = $request_obj_id;
        $this->lm_tree = $lm_tree;
        $this->lm = $lm;
        $this->lm_set = $lm_set;
        $this->requested_back_page = (int) $requested_back_page;
        $this->cmd = $cmd;
        $this->focus_id = $focus_id;
 
        $this->determineStatus();
    }

References $cmd, $focus_id, $lm, $lm_set, $lm_tree, $requested_back_page, $user, determineStatus(), ILIAS\Repository\int(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ determineStatus()

ilLMNavigationStatus::determineStatus ( )

protected

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

                                        : void
    {
        $user = $this->user;
 
        $this->chapter_has_no_active_page = false;
        $this->deactivated_page = false;
 
        $requested_obj_id = $this->requested_obj_id;
        if ($requested_obj_id > 0 && ilLMObject::_lookupContObjID($requested_obj_id) !== $this->lm->getId()) {
            $requested_obj_id = 0;
        }
 
        // determine object id
        if ($requested_obj_id == 0) {
            $obj_id = $this->lm_tree->getRootId();
            if ($this->cmd == "resume") {
                if ($user->getId() != ANONYMOUS_USER_ID && ($this->focus_id == 0)) {
                    $last_accessed_page = ilObjLearningModuleAccess::_getLastAccessedPage($this->lm->getRefId(), $user->getId());
                    // if last accessed page was final page do nothing, start over
                    if ($last_accessed_page &&
                        $last_accessed_page != $this->lm_tree->getLastActivePage()) {
                        $obj_id = $last_accessed_page;
                    }
                }
            }
        } else {
            $obj_id = $requested_obj_id;
            $active = ilLMPage::_lookupActive(
                $obj_id,
                $this->lm->getType(),
                $this->lm_set->get("time_scheduled_page_activation")
            );
 
            if (!$active &&
                ilLMPageObject::_lookupType($obj_id) == "pg") {
                $this->deactivated_page = true;
            }
        }
        // obj_id not in tree -> it is a unassigned page -> return page id
        if (!$this->lm_tree->isInTree($obj_id)) {
            $this->current_page_id = $obj_id;
            return;
        }
        $curr_node = $this->lm_tree->getNodeData($obj_id);
        $active = ilLMPage::_lookupActive(
            $obj_id,
            $this->lm->getType(),
            (bool) $this->lm_set->get("time_scheduled_page_activation")
        );
        $show = $active;
 
        // look, whether activation data should be shown
        $act_data = ilLMPage::_lookupActivationData((int) $curr_node["obj_id"], $this->lm->getType());
        if ($act_data["show_activation_info"] ?? false) {
            $show = true;
        }
 
        if ($curr_node["type"] == "pg" &&
            $show) {            // page in tree -> return page id
            $page_id = $curr_node["obj_id"];
        } else {                // no page -> search for next page and return its id
            $succ_node = true;
            $active = false;
            $page_id = $obj_id;
            while ($succ_node && !$active) {
                $succ_node = $this->lm_tree->fetchSuccessorNode($page_id, "pg");
                if (!is_null($succ_node)) {
                    $page_id = $succ_node["obj_id"];
                    $active = ilLMPage::_lookupActive(
                        $page_id,
                        $this->lm->getType(),
                        $this->lm_set->get("time_scheduled_page_activation")
                    );
                    if (!$active) {
                        // look, whether activation data should be shown
                        $act_data = ilLMPage::_lookupActivationData((int) $page_id, $this->lm->getType());
                        if ($act_data["show_activation_info"] ?? false) {
                            $active = true;
                            if (ilLMPageObject::_lookupType($page_id) == "pg") {
                                $this->deactivated_page = true;
                            }
                        }
                    }
                }
            }
 
            if (is_null($succ_node) || $succ_node["type"] != "pg") {
                $this->chapter_has_no_active_page = true;
                $this->current_page_id = 0;
                return;
            }
 
            // check whether page found is within "clicked" chapter
            if ($this->lm_tree->isInTree($page_id)) {
                $path = $this->lm_tree->getPathId($page_id);
                if (!in_array($requested_obj_id, $path)) {
                    $this->chapter_has_no_active_page = true;
                }
            }
        }
 
        $this->current_page_id = $page_id;
    }

References $path, $requested_obj_id, $user, ilObjContentObjectAccess\_getLastAccessedPage(), ilPageObject\_lookupActivationData(), ilPageObject\_lookupActive(), ilLMObject\_lookupContObjID(), ilLMObject\_lookupType(), ANONYMOUS_USER_ID, and ilObject\getId().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBackPageId()

ilLMNavigationStatus::getBackPageId ( )

Definition at line 185 of file class.ilLMNavigationStatus.php.

                                   : int
    {
        $page_id = $this->current_page_id;
 
        if (empty($page_id)) {
            return 0;
        }
 
        $back_pg = $this->requested_back_page;
 
        // process navigation for free page
        return $back_pg;
    }

References $current_page_id, and $requested_back_page.

◆ getCurrentPage()

ilLMNavigationStatus::getCurrentPage ( )

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

                                    : int
    {
        return $this->current_page_id;
    }

References $current_page_id.

◆ getPredecessorPageId()

ilLMNavigationStatus::getPredecessorPageId ( )

Definition at line 253 of file class.ilLMNavigationStatus.php.

                                          : int
    {
        $page_id = $this->current_page_id;
        $user_id = $this->user->getId();
        $pre_node = null;
 
        // determine predecessor page id
        $found = false;
        if ($this->deactivated_page) {
            $c_id = $this->requested_obj_id;
        } else {
            $c_id = $page_id;
        }
        while (!$found) {
            $pre_node = null;
            if ($this->lm_tree->isInTree($c_id)) {
                $pre_node = $this->lm_tree->fetchPredecessorNode($c_id, "pg");
            }
            if (is_array($pre_node)) {
                $c_id = $pre_node["obj_id"];
                $active = ilLMPage::_lookupActive(
                    $c_id,
                    $this->lm->getType(),
                    (bool) $this->lm_set->get("time_scheduled_page_activation")
                );
            }
            if (is_array($pre_node) && $pre_node["obj_id"] > 0 && !$active) {
                // look, whether activation data should be shown
                $act_data = ilLMPage::_lookupActivationData((int) $pre_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 (is_array($pre_node)) {
            return (int) $pre_node["obj_id"];
        }
 
        return 0;
    }

References $current_page_id, $requested_obj_id, $user_id, ilPageObject\_lookupActivationData(), ilPageObject\_lookupActive(), ilUtil\now(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ getSuccessorPageId()

ilLMNavigationStatus::getSuccessorPageId ( )

Definition at line 199 of file class.ilLMNavigationStatus.php.

                                        : int
    {
        $page_id = $this->current_page_id;
        $user_id = $this->user->getId();
        $succ_node = null;
 
        // 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 = null;
            if ($this->lm_tree->isInTree($c_id)) {
                $succ_node = $this->lm_tree->fetchSuccessorNode($c_id, "pg");
            }
            if (is_array($succ_node)) {
                $c_id = $succ_node["obj_id"];
 
                $active = ilLMPage::_lookupActive(
                    $c_id,
                    $this->lm->getType(),
                    $this->lm_set->get("time_scheduled_page_activation")
                );
            }
            if (is_array($succ_node) && $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 (is_array($succ_node)) {
            return (int) $succ_node["obj_id"];
        }
 
        return 0;
    }

References $current_page_id, $requested_obj_id, $user_id, ilPageObject\_lookupActivationData(), ilPageObject\_lookupActive(), ilLMObject\_lookupType(), ilUtil\now(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ isChapterWithoutActivePage()

ilLMNavigationStatus::isChapterWithoutActivePage ( )

Has current chapter no active page?

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

                                                : bool
    {
        return $this->chapter_has_no_active_page;
    }

References $chapter_has_no_active_page.

◆ isDeactivatedPage()

ilLMNavigationStatus::isDeactivatedPage ( )

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

                                       : bool
    {
        return $this->deactivated_page;
    }

References $deactivated_page.

Field Documentation

◆ $chapter_has_no_active_page

bool ilLMNavigationStatus::$chapter_has_no_active_page = false

protected

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

Referenced by isChapterWithoutActivePage().

◆ $cmd

string ilLMNavigationStatus::$cmd

protected

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

Referenced by __construct().

◆ $current_page_id

int ilLMNavigationStatus::$current_page_id = null

protected

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

Referenced by getBackPageId(), getCurrentPage(), getPredecessorPageId(), and getSuccessorPageId().

◆ $deactivated_page

bool ilLMNavigationStatus::$deactivated_page = false

protected

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

Referenced by isDeactivatedPage().

◆ $focus_id

int ilLMNavigationStatus::$focus_id

protected

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

Referenced by __construct().

◆ $lm

ilObjLearningModule ilLMNavigationStatus::$lm

protected

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

Referenced by __construct().

◆ $lm_set

ilSetting ilLMNavigationStatus::$lm_set

protected

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

Referenced by __construct().

◆ $lm_tree

ilLMTree ilLMNavigationStatus::$lm_tree

protected

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

Referenced by __construct().

◆ $requested_back_page

int ilLMNavigationStatus::$requested_back_page

protected

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

Referenced by __construct(), and getBackPageId().

◆ $requested_obj_id

int ilLMNavigationStatus::$requested_obj_id

protected

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

Referenced by determineStatus(), getPredecessorPageId(), and getSuccessorPageId().

◆ $user

ilObjUser ilLMNavigationStatus::$user

protected

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

Referenced by __construct(), and determineStatus().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ determineStatus()

◆ getBackPageId()

◆ getCurrentPage()

◆ getPredecessorPageId()

◆ getSuccessorPageId()

◆ isChapterWithoutActivePage()

◆ isDeactivatedPage()

Field Documentation

◆ $chapter_has_no_active_page

◆ $cmd

◆ $current_page_id

◆ $deactivated_page

◆ $focus_id

◆ $lm

◆ $lm_set

◆ $lm_tree

◆ $requested_back_page

◆ $requested_obj_id

◆ $user