ilLMNavigationStatus Class Reference

Checks current navigation request status. More...

Collaboration diagram for ilLMNavigationStatus:

Public Member Functions
	__construct (ilObjUser $user, int $request_obj_id, ilLMTree $lm_tree, ilObjLearningModule $lm, ilSetting $lm_set, $requested_back_page, string $cmd, int $focus_id)
	Constructor. More...
	isChapterWithoutActivePage ()
	Has current chapter no avtive page? More...
	isDeactivatedPage ()
	Has current chapter no avtive page? More...
	getCurrentPage ()
	Has current chapter no avtive page? More...
	getBackPageId ()
	Get back link page id. More...
	getSuccessorPageId ()
	getPredecessorPageId ()
	Get predecessor page id. More...

Protected Member Functions
	determineStatus ()
	Determine status. More...

Protected Attributes
	$current_page_id = null
	$chapter_has_no_active_page = false
	$deactivated_page = false
	$lm
	$lm_tree
	$user
	$lm_set
	$requested_back_page
	$cmd
	$focus_id
	$requested_obj_id

Detailed Description

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

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

Definition at line 13 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,
			$requested_back_page,
		string	$cmd,
		int	$focus_id
	)

Constructor.

Parameters

ilObjUser	$user
	$request_obj_id
ilLMTree	$lm_tree
ilObjLearningModule	$lm
ilSetting	$lm_set
string	$cmd
int	$focus_id

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

References $cmd, $focus_id, $lm, $lm_set, $lm_tree, $requested_back_page, $user, determineStatus(), and user().

      {
        $this->user = $user;
        $this->requested_obj_id = (int) $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();
    }

Here is the call graph for this function:

Member Function Documentation

determineStatus()

ilLMNavigationStatus::determineStatus ( )

protected

Determine status.

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

References $requested_obj_id, $user, ilObjContentObjectAccess\_getLastAccessedPage(), ilLMObject\_isPagePublic(), ilPageObject\_lookupActive(), ilLMObject\_lookupContObjID(), ilLMObject\_lookupType(), and ANONYMOUS_USER_ID.

Referenced by __construct().

    {
        $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 && ((int) $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 null;
        }

        $curr_node = $this->lm_tree->getNodeData($obj_id);

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

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

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

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

                while ($public === false && $page_id > 0) {
                    $succ_node = $this->lm_tree->fetchSuccessorNode($page_id, 'pg');
                    $page_id = $succ_node['obj_id'];
                    $public = ilLMObject::_isPagePublic($page_id);
                }
            }

            // check whether page found is within "clicked" chapter
            if ($this->lm_tree->isInTree($page_id)) {
                $path = $this->lm_tree->getPathId($page_id);
                if (!in_array($requested_obj_id, $path)) {
                    $this->chapter_has_no_active_page = true;
                }
            }
        }

        $this->current_page_id = $page_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBackPageId()

ilLMNavigationStatus::getBackPageId

(

)

Get back link page id.

Returns

int

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

References $current_page_id, and $requested_back_page.

                                    : int
    {
        $page_id = $this->current_page_id;

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

        $back_pg = $this->requested_back_page;

        // process navigation for free page
        if (!$this->lm_tree->isInTree($page_id)) {
            return $back_pg;
        }
        return $back_pg;
    }

getCurrentPage()

ilLMNavigationStatus::getCurrentPage

(

)

Has current chapter no avtive page?

Returns

int

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

References $current_page_id.

    {
        return $this->current_page_id;
    }

getPredecessorPageId()

ilLMNavigationStatus::getPredecessorPageId

(

)

Get predecessor page id.

Returns

int

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

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

                                           : int
    {
        $page_id = $this->current_page_id;
        $user_id = $this->user->getId();

        // 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 = $this->lm_tree->fetchPredecessorNode($c_id, "pg");
            $c_id = $pre_node["obj_id"];
            $active = ilLMPage::_lookupActive(
                $c_id,
                $this->lm->getType(),
                $this->lm_set->get("time_scheduled_page_activation")
            );
            if ($pre_node["obj_id"] > 0 &&
                $user_id == ANONYMOUS_USER_ID &&
                ($this->lm->getPublicAccessMode() == "selected" &&
                    !ilLMObject::_isPagePublic($pre_node["obj_id"]))) {
                $found = false;
            } else {
                if ($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;
    }

Here is the call graph for this function:

getSuccessorPageId()

ilLMNavigationStatus::getSuccessorPageId

(

)

Returns

int

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

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

                                         : int
    {
        $page_id = $this->current_page_id;
        $user_id = $this->user->getId();

        // 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 &&
                $user_id == ANONYMOUS_USER_ID &&
                ($this->lm->getPublicAccessMode() == "selected" &&
                    !ilLMObject::_isPagePublic($succ_node["obj_id"]))) {
                $found = false;
            } else {
                if ($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;
    }

Here is the call graph for this function:

isChapterWithoutActivePage()

ilLMNavigationStatus::isChapterWithoutActivePage

(

)

Has current chapter no avtive page?

Returns

bool

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

References $chapter_has_no_active_page.

    {
        return $this->chapter_has_no_active_page;
    }

isDeactivatedPage()

ilLMNavigationStatus::isDeactivatedPage

(

)

Has current chapter no avtive page?

Returns

bool

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

References $deactivated_page.

    {
        return $this->deactivated_page;
    }

Field Documentation

$chapter_has_no_active_page

ilLMNavigationStatus::$chapter_has_no_active_page = false

protected

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

Referenced by isChapterWithoutActivePage().

$cmd

ilLMNavigationStatus::$cmd

protected

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

Referenced by __construct().

$current_page_id

ilLMNavigationStatus::$current_page_id = null

protected

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

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

$deactivated_page

ilLMNavigationStatus::$deactivated_page = false

protected

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

Referenced by isDeactivatedPage().

$focus_id

ilLMNavigationStatus::$focus_id

protected

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

Referenced by __construct().

$lm

ilLMNavigationStatus::$lm

protected

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

Referenced by __construct().

$lm_set

ilLMNavigationStatus::$lm_set

protected

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

Referenced by __construct().

$lm_tree

ilLMNavigationStatus::$lm_tree

protected

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

Referenced by __construct().

$requested_back_page

ilLMNavigationStatus::$requested_back_page

protected

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

Referenced by __construct(), and getBackPageId().

$requested_obj_id

ilLMNavigationStatus::$requested_obj_id

protected

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

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

$user

ilLMNavigationStatus::$user

protected

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

Referenced by __construct(), and determineStatus().

---

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

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