Last visited history for repository items. More...

Collaboration diagram for ilNavigationHistory:

Public Member Functions
	__construct ()

	addItem (int $a_ref_id, string $a_link, string $a_type, string $a_title="", ?int $a_sub_obj_id=null, string $a_goto_link="")
	Add an item to the stack. More...

	getItems ()
	Get navigation item stack. More...

	deleteDBEntries ()

	deleteSessionEntries ()

Protected Attributes
ILIAS Repository LastVisited NavigationSessionRepository	$repo

ilObjUser	$user

ilDBInterface	$db

ilTree	$tree

ilObjectDefinition	$obj_definition

ilComponentRepository	$component_repository

Private Attributes
array	$items

Detailed Description

Last visited history for repository items.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilNavigationHistory::__construct ( )

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

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

     {
         global $DIC;
 
         $this->user = $DIC->user();
         $this->db = $DIC->database();
         $this->tree = $DIC->repositoryTree();
         $this->obj_definition = $DIC["objDefinition"];
         $this->items = array();
 
         $this->repo = new \ILIAS\Repository\LastVisited\NavigationSessionRepository();
         $this->items = $this->repo->getHistory();
         $this->component_repository = $DIC["component.repository"];
     }

Here is the call graph for this function:

Member Function Documentation

◆ addItem()

ilNavigationHistory::addItem	(	int	$a_ref_id,
		string	$a_link,
		string	$a_type,
		string	$a_title = `""`,
		?int	$a_sub_obj_id = `null`,
		string	$a_goto_link = `""`
	)

Add an item to the stack.

If ref_id is already used, the item is moved to the top.

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

References $db, $id, $ilDB, ILIAS\LTI\ToolProvider\$key, $user, ilObject\_exists(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), and getItems().

Referenced by ilObjIndividualAssessmentGUI\addToNavigationHistory(), ilHTLMPresentationGUI\executeCommand(), ilObjForumGUI\getSafePostCommands(), and ilObjForumGUI\viewThreadObject().

      : void {
         $ilUser = $this->user;
         $ilDB = $this->db;
 
         // never store?
         if ((int) ($ilUser->prefs["store_last_visited"] ?? 0) == 2) {
             return;
         }
 
         $a_sub_obj_id = (string) $a_sub_obj_id;
 
         if ($a_title === "" && $a_ref_id > 0) {
             $obj_id = ilObject::_lookupObjId($a_ref_id);
             if (ilObject::_exists($obj_id)) {
                 $a_title = ilObject::_lookupTitle($obj_id);
             }
         }
 
         $id = $a_ref_id . ":" . $a_sub_obj_id;
 
         $new_items[$id] = array("id" => $id,"ref_id" => $a_ref_id, "link" => $a_link, "title" => $a_title,
             "type" => $a_type, "sub_obj_id" => $a_sub_obj_id, "goto_link" => $a_goto_link);
 
         $cnt = 1;
         foreach ($this->items as $key => $item) {
             if ($item["id"] != $id && $cnt <= 10) {
                 $new_items[$item["id"]] = $item;
                 $cnt++;
             }
         }
 
         // put items in session
         $this->items = $new_items;
 
         $this->repo->setHistory($this->items);
 
         // only store in session?
         if ((int) ($ilUser->prefs["store_last_visited"] ?? 0) == 1) {
             return;
         }
 
 
         // update entries in db
         $ilDB->update(
             "usr_data",
             array(
                     "last_visited" => array("clob", serialize($this->getItems()))),
             array(
                 "usr_id" => array("integer", $ilUser->getId()))
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteDBEntries()

ilNavigationHistory::deleteDBEntries ( )

Definition at line 190 of file class.ilNavigationHistory.php.

References $db, $ilDB, and $user.

                                      : void
     {
         $ilUser = $this->user;
         $ilDB = $this->db;
 
         // update entries in db
         $ilDB->update(
             "usr_data",
             array(
                     "last_visited" => array("clob", serialize(array()))),
             array(
                 "usr_id" => array("integer", $ilUser->getId()))
         );
     }

◆ deleteSessionEntries()

ilNavigationHistory::deleteSessionEntries ( )

Definition at line 205 of file class.ilNavigationHistory.php.

                                           : void
     {
         $this->repo->setHistory([]);
     }

◆ getItems()

ilNavigationHistory::getItems ( )

Get navigation item stack.

Definition at line 117 of file class.ilNavigationHistory.php.

References $component_repository, $db, $ilDB, $items, $obj_definition, $tree, $user, ilObject\_lookupObjId(), ilObject\_lookupTitle(), ANONYMOUS_USER_ID, ilComponentRepository\getPluginById(), ilComponentRepository\hasPluginId(), and ilTree\isInTree().

Referenced by addItem().

                               : array
     {
         $tree = $this->tree;
         $ilDB = $this->db;
         $ilUser = $this->user;
         $objDefinition = $this->obj_definition;
         $component_repository = $this->component_repository;
 
         $items = array();
 
         foreach ($this->items as $it) {
             if (
                 $tree->isInTree($it["ref_id"]) &&
                 (
                     !$objDefinition->isPluginTypeName($it["type"]) ||
                     (
                         $component_repository->hasPluginId($it["type"]) &&
                         $component_repository->getPluginById($it["type"])->isActive()
                     )
                 )
             ) {
                 $items[$it["ref_id"] . ":" . $it["sub_obj_id"]] = $it;
             }
         }
         // less than 10? -> get items from db
         if (count($items) < 10 && $ilUser->getId() !== ANONYMOUS_USER_ID) {
             $set = $ilDB->query(
                 "SELECT last_visited FROM usr_data " .
                 " WHERE usr_id = " . $ilDB->quote($ilUser->getId(), "integer")
             );
             $rec = $ilDB->fetchAssoc($set);
             $db_entries = unserialize((string) $rec["last_visited"], ["allowed_classes" => false]);
             $cnt = count($items);
             if (is_array($db_entries)) {
                 foreach ($db_entries as $rec) {
                     if (
                         $cnt <= 10 &&
                         !isset($items[$rec["ref_id"] . ":" . $rec["sub_obj_id"]]) &&
                         $tree->isInTree((int) $rec["ref_id"]) &&
                         (
                             !$objDefinition->isPluginTypeName($rec["type"]) ||
                             (
                                 $component_repository->hasPluginId($rec["type"]) &&
                                 $component_repository->getPluginById($rec["type"])->isActive()
                             )
                         )
                     ) {
                         $link = ($rec["goto_link"] != "")
                                 ? $rec["goto_link"]
                                 : ilLink::_getLink((int) $rec["ref_id"]);
                         if ($rec["sub_obj_id"] != "") {
                             $title = $rec["title"];
                         } elseif ($rec["type"] === "sess") {
                             try {
                                 $sess = new ilObjSession((int) $rec["ref_id"]);
                                 $title = $sess->getPresentationTitle();
                             } catch (ilObjectTypeMismatchException) {
                                 $title = ilObject::_lookupTitle(ilObject::_lookupObjId((int) $rec["ref_id"]));
                             }
                         } else {
                             $title = ilObject::_lookupTitle(ilObject::_lookupObjId((int) $rec["ref_id"]));
                         }
                         $items[$rec["ref_id"] . ":" . $rec["sub_obj_id"]] = array("id" => $rec["ref_id"] . ":" . $rec["sub_obj_id"],
                                 "ref_id" => $rec["ref_id"], "link" => $link, "title" => $title,
                                 "type" => $rec["type"], "sub_obj_id" => $rec["sub_obj_id"], "goto_link" => $rec["goto_link"]);
                         $cnt++;
                     }
                 }
             }
         }
         return $items;
     }