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

Collaboration diagram for ilHistory:

Static Public Member Functions
static	_createEntry (int $a_obj_id, string $a_action, array $a_info_params=[], string $a_obj_type="", string $a_user_comment="", bool $a_update_last=false)
	Creates a new history entry for an object. More...

static	_getEntriesForObject (int $a_obj_id, string $a_obj_type="")
	get all history entries for an object More...

static	_compareHistArray (array $a, array $b)

static	_removeEntriesForObject (int $a_obj_id)
	remove all history entries for an object More...

static	_copyEntriesForObject (int $a_src_id, int $a_dst_id)
	copy all history entries for an object More...

static	_getEntryByHistoryID (int $a_hist_entry_id)
	returns a single history entry More...

static	_removeEntryByHistoryID (int $a_hist_entry_id)
	Removes a single entry from the history. More...

static	_changeUserId (int $a_hist_entry_id, int $new_user_id)
	Changes the user id of the specified history entry. More...

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 This class methods for maintain history enties for objects

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

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

Member Function Documentation

◆ _changeUserId()

static ilHistory::_changeUserId	(	int	$a_hist_entry_id,
		int	$new_user_id
	)

static

Changes the user id of the specified history entry.

Definition at line 250 of file class.ilHistory.php.

References $DIC, and $ilDB.

                                                                                 : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $ilDB->update(
             "history",
             array("usr_id" => array("integer", $new_user_id)),
             array("id" => array("integer", $a_hist_entry_id))
         );
     }

◆ _compareHistArray()

static ilHistory::_compareHistArray	(	array	$a,
		array	$b
	)

static

Definition at line 167 of file class.ilHistory.php.

Referenced by HistCompareTest\testCompare(), HistCompareTest\testCompare2(), and HistCompareTest\testCompare3().

                                                                 : int
     {
         if ($a["date"] == $b["date"]) {
             return 0;
         }
         return ($a["date"] < $b["date"]) ? -1 : 1;
     }

Here is the caller graph for this function:

◆ _copyEntriesForObject()

static ilHistory::_copyEntriesForObject	(	int	$a_src_id,
		int	$a_dst_id
	)

static

copy all history entries for an object

Definition at line 192 of file class.ilHistory.php.

References $DIC, $id, $ilDB, and ilUtil\now().

                                                                               : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $q = "SELECT * FROM history WHERE obj_id = " .
             $ilDB->quote($a_src_id, "integer");
         $r = $ilDB->query($q);
 
         while ($row = $ilDB->fetchObject($r)) {
             $id = $ilDB->nextId("history");
             $ilDB->insert("history", array(
                 "id" => array("integer", $id),
                 "obj_id" => array("integer", $a_dst_id),
                 "obj_type" => array("text", $row->obj_type),
                 "action" => array("text", $row->action),
                 "hdate" => array("timestamp", ilUtil::now()),
                 "usr_id" => array("integer", $row->usr_id),
                 "info_params" => array("text", $row->info_params),
                 "user_comment" => array("clob", $row->user_comment)
                 ));
         }
     }

Here is the call graph for this function:

◆ _createEntry()

static ilHistory::_createEntry	(	int	$a_obj_id,
		string	$a_action,
		array	$a_info_params = `[]`,
		string	$a_obj_type = `""`,
		string	$a_user_comment = `""`,
		bool	$a_update_last = `false`
	)

static

Creates a new history entry for an object.

The information text parameters have to be separated by comma. The information text has to be stored in a langage variable "hist_<object_type>_<action>". This text can contain placeholders %1, %2, ... for each parameter. The placehoders are replaced by the parameters in ilHistoryTableGUI.

Please note that the object type must be specified, if the object is not derived from ilObject.

Parameters

int	$a_obj_id	object id
string	$a_action
array	$a_info_params	information parameters
string	$a_obj_type	object type (must only be set, if object is not in object_data table)
string	$a_user_comment
bool	$a_update_last

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

References $DIC, $id, $ilDB, $ilUser, ILIAS\LTI\ToolProvider\$key, $param, ilObject\_lookupType(), and ilUtil\now().

Referenced by ilPageEditorGUI\addChangeComment(), ilObjContentObjectGUI\confirmedDelete(), ilLMObject\create(), ilWebLinkDatabaseRepository\createItem(), ilWebLinkDatabaseRepository\createList(), ilWebLinkDatabaseRepository\deleteItemByLinkID(), ilWebLinkDatabaseRepository\deleteList(), ilObjContentObject\executeDragDrop(), ilLMPageObjectGUI\updateHistory(), ilWebLinkDatabaseRepository\updateItem(), and ilWebLinkDatabaseRepository\updateList().

      : void {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
 
         if ($a_obj_type == "") {
             $a_obj_type = ilObject::_lookupType($a_obj_id);
         }
 
         if (is_array($a_info_params)) {
             foreach ($a_info_params as $key => $param) {
                 $a_info_params[$key] = str_replace(",", "&#044;", $param);
             }
             $a_info_params = implode(",", $a_info_params);
         }
 
         // get last entry of object
         $last_entry_sql = "SELECT * FROM history WHERE " .
             " obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
             " obj_type = " . $ilDB->quote($a_obj_type, "text") . " ORDER BY hdate DESC";
         $last_entry_set = $ilDB->query($last_entry_sql);
         $last_entry = $ilDB->fetchAssoc($last_entry_set);
 
         // note: insert is forced if last entry already has a comment and a
         // new comment is given too OR
         // if entry should not be updated OR
         // if current action or user id are not equal with last entry
         if (($a_user_comment != "" && $last_entry["user_comment"] != "")
             || !$a_update_last || $a_action != $last_entry["action"]
             || $ilUser->getId() != $last_entry["usr_id"]) {
             $id = $ilDB->nextId("history");
             $ilDB->insert("history", array(
                 "id" => array("integer", $id),
                 "obj_id" => array("integer", $a_obj_id),
                 "obj_type" => array("text", $a_obj_type),
                 "action" => array("text", $a_action),
                 "hdate" => array("timestamp", ilUtil::now()),
                 "usr_id" => array("integer", $ilUser->getId()),
                 "info_params" => array("text", $a_info_params),
                 "user_comment" => array("clob", $a_user_comment)
                 ));
         } else {
             $fields = array(
                 "hdate" => array("timestamp", ilUtil::now())
                 );
             if ($a_user_comment != "") {
                 $fields["user_comment"] = array("clob", $a_user_comment);
             }
 
             $ilDB->update("history", $fields, array(
                 "id" => array("integer", $last_entry["id"])
                 ));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getEntriesForObject()

static ilHistory::_getEntriesForObject	(	int	$a_obj_id,
		string	$a_obj_type = `""`
	)

static

get all history entries for an object

Parameters

int	$a_obj_id
string	$a_obj_type

Returns: array array of history entries (arrays with keys "date", "user_id", "obj_id", "action", "info_params")

Definition at line 111 of file class.ilHistory.php.

References $DIC, $ilDB, $query, and ilObject\_lookupType().

Referenced by ilECSFileSettings\buildJson(), ilHistoryTableGUI\getDataFromDb(), and ilFileObjectToStorageDirectory\getHistoryData().

      : array {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         if ($a_obj_type == "") {
             $a_obj_type = ilObject::_lookupType($a_obj_id);
         }
         $query = "SELECT * FROM history WHERE obj_id = " .
             $ilDB->quote($a_obj_id, "integer") . " AND " .
             "obj_type = " . $ilDB->quote($a_obj_type, "text") .
             " ORDER BY hdate DESC";
 
         $hist_set = $ilDB->query($query);
         $hist_items = array();
         while ($hist_rec = $ilDB->fetchAssoc($hist_set)) {
             $hist_items[] = array("date" => $hist_rec["hdate"],
                 "user_id" => $hist_rec["usr_id"],
                 "obj_id" => $hist_rec["obj_id"],
                 "obj_type" => $hist_rec["obj_type"],
                 "action" => $hist_rec["action"],
                 "info_params" => $hist_rec["info_params"],
                 "user_comment" => $hist_rec["user_comment"],
                 "hist_entry_id" => $hist_rec["id"]);
         }
 
         if ($a_obj_type == "lm") {
             $query = "SELECT h.*, l.title as title FROM history h, lm_data l WHERE " .
                 " l.lm_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
                 " l.obj_id = h.obj_id AND " .
                 " (h.obj_type=" . $ilDB->quote($a_obj_type . ":pg", "text") . " OR h.obj_type=" . $ilDB->quote($a_obj_type . ":st", "text") . ") " .
                 " ORDER BY h.hdate DESC";
 
             $hist_set = $ilDB->query($query);
             while ($hist_rec = $ilDB->fetchAssoc($hist_set)) {
                 $hist_items[] = array("date" => $hist_rec["hdate"],
                     "user_id" => $hist_rec["usr_id"],
                     "obj_id" => $hist_rec["obj_id"],
                     "obj_type" => $hist_rec["obj_type"],
                     "action" => $hist_rec["action"],
                     "info_params" => $hist_rec["info_params"],
                     "user_comment" => $hist_rec["user_comment"],
                     "hist_entry_id" => $hist_rec["id"],
                     "title" => $hist_rec["title"]);
             }
             usort($hist_items, array("ilHistory", "_compareHistArray"));
             $hist_items2 = array_reverse($hist_items);
             return $hist_items2;
         }
 
         return $hist_items;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getEntryByHistoryID()

static ilHistory::_getEntryByHistoryID ( int $a_hist_entry_id )

static

returns a single history entry

Definition at line 220 of file class.ilHistory.php.

References $DIC, and $ilDB.

                                                                      : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $q = "SELECT * FROM history WHERE id = " .
             $ilDB->quote($a_hist_entry_id, "integer");
         $r = $ilDB->query($q);
 
         return $ilDB->fetchAssoc($r);
     }

◆ _removeEntriesForObject()

static ilHistory::_removeEntriesForObject ( int $a_obj_id )

static

remove all history entries for an object

Definition at line 178 of file class.ilHistory.php.

References $DIC, and $ilDB.

Referenced by ilObjBibliographic\doDelete(), ilObjFile\doDelete(), ilObjCmiXapi\doDelete(), and ilFileXMLParser\setFileContents().

                                                                  : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $q = "DELETE FROM history WHERE obj_id = " .
             $ilDB->quote($a_obj_id, "integer");
         $ilDB->manipulate($q);
     }

Here is the caller graph for this function:

◆ _removeEntryByHistoryID()

static ilHistory::_removeEntryByHistoryID ( int $a_hist_entry_id )

static

Removes a single entry from the history.

Definition at line 236 of file class.ilHistory.php.

References $DIC, and $ilDB.

                                                                         : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $q = "DELETE FROM history WHERE id = " .
             $ilDB->quote($a_hist_entry_id, "integer");
         $ilDB->manipulate($q);
     }

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

Services/History/classes/class.ilHistory.php

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ _changeUserId()

◆ _compareHistArray()

◆ _copyEntriesForObject()

◆ _createEntry()

◆ _getEntriesForObject()

◆ _getEntryByHistoryID()

◆ _removeEntriesForObject()

◆ _removeEntryByHistoryID()