ILIAS
Release_4_0_x_branch Revision 61816
|
Class ilChangeEvent tracks change events on repository objects. More...
Public Member Functions | |
_recordWriteEvent ($obj_id, $usr_id, $action, $parent_obj_id=null) | |
Records a write event. | |
_recordReadEvent ($obj_id, $usr_id, $isCatchupWriteEvents=true) | |
Records a read event and catches up with write events. | |
_catchupWriteEvents ($obj_id, $usr_id, $timestamp=null) | |
Catches up with all write events which occured before the specified timestamp. |
Static Public Member Functions | |
static | _lookupUncaughtWriteEvents ($obj_id, $usr_id) |
Catches up with all write events which occured before the specified timestamp. | |
static | _lookupChangeState ($obj_id, $usr_id) |
Returns the change state of the object for the specified user. | |
static | _lookupInsideChangeState ($parent_obj_id, $usr_id) |
Returns the changed state of objects which are children of the specified parent object. | |
static | _lookupReadEvents ($obj_id, $usr_id=null) |
Reads all read events which occured on the object which happened after the last time the user caught up with them. | |
static | lookupUsersInProgress ($a_obj_id) |
Lookup users in progress. | |
static | _activate () |
Activates change event tracking. | |
static | _deactivate () |
Deactivates change event tracking. | |
static | _isActive () |
Returns true, if change event tracking is active. | |
static | _delete ($a_obj_id) |
Delete object entries. |
Class ilChangeEvent tracks change events on repository objects.
The following events are considered to be a 'write event':
The following events are considered to be a 'read event':
*reading the content of a container using WebDAV is not counted, because WebDAV clients can't see all objects in a container.
A user can catch up with write events, by calling __catchupWriteEvents(...).
A user can query, if an object has changed, since the last time he has caught up with write events, by calling _lookupUncaughtWriteEvents(...).
Definition at line 55 of file class.ilChangeEvent.php.
|
static |
Activates change event tracking.
Definition at line 551 of file class.ilChangeEvent.php.
References $ilDB, $query, $res, and _isActive().
Referenced by ilTrackingTest\testChangeEvent(), and ilObjUserTracking\updateSettings().
ilChangeEvent::_catchupWriteEvents | ( | $obj_id, | |
$usr_id, | |||
$timestamp = null |
|||
) |
Catches up with all write events which occured before the specified timestamp.
$obj_id | int The object. |
$usr_id | int The user. |
$timestamp | SQL timestamp. |
Definition at line 181 of file class.ilChangeEvent.php.
References $ilDB, $query, $res, $timestamp, and $usr_id.
Referenced by _recordReadEvent(), ilContainerGUI\pasteObject(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilDAVServer\PUT(), ilRepUtil\restoreObjects(), ilObjFolderGUI\updateObject(), ilObjFileGUI\updateObject(), ilObjGroupGUI\updateObject(), ilObjCategoryGUI\updateObject(), and ilObjCourseGUI\updateObject().
|
static |
Deactivates change event tracking.
Definition at line 608 of file class.ilChangeEvent.php.
Referenced by ilTrackingTest\testChangeEvent(), and ilObjUserTracking\updateSettings().
|
static |
Delete object entries.
Definition at line 631 of file class.ilChangeEvent.php.
Referenced by ilObject\delete().
|
static |
Returns true, if change event tracking is active.
Definition at line 619 of file class.ilChangeEvent.php.
Referenced by ilObjUserTracking\__readSettings(), _activate(), ilInfoScreenGUI\addObjectSections(), ilDAVServer\COPY(), ilDAVServer\DELETE(), ilDAVServer\GET(), ilObjectListGUI\getProperties(), ilDAVServer\MKCOL(), ilDAVServer\MOVE(), ilContainerGUI\pasteObject(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilDAVServer\PROPFIND(), ilDAVServer\PUT(), ilRepUtil\removeObjectsFromSystem(), ilRepUtil\restoreObjects(), ilObjFolderGUI\saveObject(), ilObjGroupGUI\saveObject(), ilObjFileGUI\saveObject(), ilObjCategoryGUI\saveObject(), ilObjCourseGUI\saveObject(), ilObjFileGUI\sendFileObject(), ilContainerContentGUI\setOutput(), ilObjFolderGUI\updateObject(), ilObjFileGUI\updateObject(), ilObjGroupGUI\updateObject(), ilObjCategoryGUI\updateObject(), ilObjCourseGUI\updateObject(), ilObjUserTracking\updateSettings(), ilCourseContentGUI\view(), and ilObjectGUI\viewObject().
|
static |
Returns the change state of the object for the specified user.
which happened after the last time the user caught up with them.
$obj_id | int The object |
$usr_id | int The user who is interested into these events. |
Definition at line 328 of file class.ilChangeEvent.php.
References $ilDB, $q, $query, $res, $row, $usr_id, and DB_FETCHMODE_ASSOC.
Referenced by ilObjectListGUI\getProperties(), and ilTrackingTest\testChangeEvent().
|
static |
Returns the changed state of objects which are children of the specified parent object.
Note this gives a different result than calling _lookupChangeState of each child object. This is because, this function treats a catch on the write events on the parent as a catch up for all child objects. This difference was made, because it greatly improves performance of this function.
$parent_obj_id | int The object id of the parent object. |
$usr_id | int The user who is interested into these events. |
Definition at line 393 of file class.ilChangeEvent.php.
References $ilDB, $q, $query, $res, $row, $usr_id, and DB_FETCHMODE_ASSOC.
Referenced by ilObjectListGUI\getProperties(), and ilTrackingTest\testChangeEvent().
|
static |
Reads all read events which occured on the object which happened after the last time the user caught up with them.
NOTE: THIS FUNCTION NEEDS TO BE REWRITTEN. READ EVENTS ARE OF INTEREST AT REF_ID's OF OBJECTS.
$obj_id | int The object |
$usr_id | int The user who is interested into these events. / public static function _lookupUncaughtReadEvents($obj_id, $usr_id) { global $ilDB; |
$q = "SELECT ts ". "FROM catch_read_events ". "WHERE obj_id=".$ilDB->quote($obj_id)." ". "AND usr_id=".$ilDB->quote($usr_id); $r = $ilDB->query($q); $catchup = null; while ($row = $r->fetchRow(DB_FETCHMODE_ASSOC)) { $catchup = $row['ts']; }
$q = "SELECT * ". "FROM read_event ". "WHERE obj_id=".$ilDB->quote($obj_id)." ". ($catchup == null ? "" : "AND last_access > ".$ilDB->quote($catchup))." ". ($catchup == null ? "" : "AND last_access > ".$ilDB->quote($catchup))." ". "ORDER BY last_access DESC"; $r = $ilDB->query($q); $events = array(); while ($row = $r->fetchRow(DB_FETCHMODE_ASSOC)) { $events[] = $row; } return $events; } Reads all read events which occured on the object.
$obj_id | int The object |
$usr_id | int Optional, the user who performed these events. |
Definition at line 486 of file class.ilChangeEvent.php.
References $ilDB, $query, $res, $row, and $usr_id.
Referenced by ilLPStatusVisits\_getCompleted(), ilLPStatusTypicalLearningTime\_getCompleted(), ilLPStatusTypicalLearningTime\_getInProgress(), ilLPStatusVisits\_getInProgress(), ilLearningProgress\_getProgress(), ilLearningProgress\_lookupProgressByObjId(), and ilInfoScreenGUI\addObjectSections().
|
static |
Catches up with all write events which occured before the specified timestamp.
THIS FUNCTION IS CURRENTLY NOT IN USE. BEFORE IT CAN BE USED, THE TABLE catch_read_events MUST BE CREATED.
$obj_id | int The object. |
$usr_id | int The user. |
$timestamp | SQL timestamp. / function _catchupReadEvents($obj_id, $usr_id, $timestamp = null) { global $ilDB; |
$q = "INSERT INTO catch_read_events ". "(obj_id, usr_id, action, ts) ". "VALUES (". $ilDB->quote($obj_id).",". $ilDB->quote($usr_id).",". $ilDB->quote('read').","; if ($timestamp == null) { $q .= "NOW()". ") ON DUPLICATE KEY UPDATE ts=NOW()"; } else { $q .= $ilDB->quote($timestamp). ") ON DUPLICATE KEY UPDATE ts=".$ilDB->quote($timestamp); }
$r = $ilDB->query($q); } Reads all write events which occured on the object which happened after the last time the user caught up with them.
$obj_id | int The object |
$usr_id | int The user who is interested into these events. |
Definition at line 275 of file class.ilChangeEvent.php.
References $ilDB, $q, $query, $res, $row, $usr_id, and DB_FETCHMODE_ASSOC.
Referenced by ilTrackingTest\testChangeEvent().
ilChangeEvent::_recordReadEvent | ( | $obj_id, | |
$usr_id, | |||
$isCatchupWriteEvents = true |
|||
) |
Records a read event and catches up with write events.
$obj_id | int The object which was read. |
$usr_id | int The user who performed a read action. |
$catchupWriteEvents | boolean If true, this function catches up with write events. |
Definition at line 123 of file class.ilChangeEvent.php.
References $ilDB, $query, $res, $row, $usr_id, _catchupWriteEvents(), and ilObjUserTracking\_getValidTimeSpan().
Referenced by ilLicense\_noteAccess(), ilLearningProgress\_tracProgress(), ilLearningProgress\_updateProgress(), ilDAVServer\COPY(), ilDAVServer\GET(), ilContainerGUI\pasteObject(), ilDAVServer\PROPFIND(), ilObjFileGUI\sendFileObject(), ilContainerContentGUI\setOutput(), ilCourseContentGUI\view(), and ilObjectGUI\viewObject().
ilChangeEvent::_recordWriteEvent | ( | $obj_id, | |
$usr_id, | |||
$action, | |||
$parent_obj_id = null |
|||
) |
Records a write event.
The parent object should be specified for the 'delete', 'undelete' and 'add' and 'remove' events.
$obj_id | int The object which was written to. |
$usr_id | int The user who performed a write action. |
$action | string The name of the write action. 'create', 'update', 'delete', 'add', 'remove', 'undelete'. |
$parent_obj_id | int The object id of the parent object. If this is null, then the event is recorded for all parents of the object. If this is not null, then the event is only recorded for the specified parent. |
Definition at line 72 of file class.ilChangeEvent.php.
References $ilDB, $query, and $usr_id.
Referenced by ilDAVServer\COPY(), ilDAVServer\DELETE(), ilDAVServer\MKCOL(), ilDAVServer\MOVE(), ilContainerGUI\pasteObject(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilDAVServer\PUT(), ilRepUtil\removeObjectsFromSystem(), ilRepUtil\restoreObjects(), ilObjFolderGUI\saveObject(), ilObjGroupGUI\saveObject(), ilObjFileGUI\saveObject(), ilObjCategoryGUI\saveObject(), ilObjCourseGUI\saveObject(), ilObjFolderGUI\updateObject(), ilObjFileGUI\updateObject(), ilObjGroupGUI\updateObject(), ilObjCategoryGUI\updateObject(), and ilObjCourseGUI\updateObject().
|
static |
Lookup users in progress.
Definition at line 531 of file class.ilChangeEvent.php.
References $ilDB, $query, $res, and $row.
Referenced by ilLPStatusManualByTutor\__getCourseInProgress(), ilLPStatusManual\__getCourseInProgress(), ilLPStatusManualByTutor\__getGroupInProgress(), ilLPStatusManual\__getGroupInProgress(), ilLPStatusManual\__getLMInProgress(), and ilLPStatusObjectives\_getInProgress().