ILIAS
release_5-2 Revision v5.2.25-18-g3f80b828510
|
Class ilChangeEvent tracks change events on repository objects. More...
Static Public Member Functions | |
static | _recordWriteEvent ($obj_id, $usr_id, $action, $parent_obj_id=null) |
Records a write event. More... | |
static | _recordReadEvent ($a_type, $a_ref_id, $obj_id, $usr_id, $isCatchupWriteEvents=true, $a_ext_rc=false, $a_ext_time=false) |
Records a read event and catches up with write events. More... | |
static | _recordObjStats ($a_obj_id, $a_spent_seconds, $a_read_count, $a_childs_spent_seconds=null, $a_child_read_count=null) |
static | _syncObjectStats ($a_now=null, $a_minimum=20000) |
Process object statistics log data. More... | |
static | _catchupWriteEvents ($obj_id, $usr_id, $timestamp=null) |
Catches up with all write events which occured before the specified timestamp. More... | |
static | _lookupUncaughtWriteEvents ($obj_id, $usr_id) |
Catches up with all write events which occured before the specified timestamp. More... | |
static | _lookupChangeState ($obj_id, $usr_id) |
Returns the change state of the object for the specified user. More... | |
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. More... | |
static | lookupUsersInProgress ($a_obj_id) |
Lookup users in progress. More... | |
static | hasAccessed ($a_obj_id, $a_usr_id) |
Has accessed. More... | |
static | _activate () |
Activates change event tracking. More... | |
static | _deactivate () |
Deactivates change event tracking. More... | |
static | _isActive () |
Returns true, if change event tracking is active. More... | |
static | _delete ($a_obj_id) |
Delete object entries. More... | |
static | _deleteReadEvents ($a_obj_id) |
static | _deleteReadEventsForUsers ($a_obj_id, array $a_user_ids) |
static | _getAllUserIds ($a_obj_id) |
static | _updateAccessForScormOfflinePlayer ($obj_id, $usr_id, $i_last_access, $t_first_access) |
_updateAccessForScormOfflinePlayer needed to synchronize last_access and first_access when learning modul is used offline called in . More... | |
Static Private Attributes | |
static | $has_accessed = array() |
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 36 of file class.ilChangeEvent.php.
|
static |
Activates change event tracking.
Definition at line 829 of file class.ilChangeEvent.php.
References $ilDB, $ilSetting, $query, $res, and _isActive().
Referenced by ilObjRepositorySettingsGUI\saveSettings(), and ilTrackingTest\testChangeEvent().
|
static |
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 504 of file class.ilChangeEvent.php.
References $ilDB, $query, $res, $timestamp, array, and ilUtil\now().
Referenced by _recordReadEvent(), ilContainerGUI\pasteObject(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilDAVServer\PUT(), ilRepUtil\restoreObjects(), ilObjFileGUI\update(), ilObjRootFolderGUI\updateObject(), ilObjGroupGUI\updateObject(), ilObjCategoryGUI\updateObject(), and ilObjCourseGUI\updateObject().
|
static |
Deactivates change event tracking.
Definition at line 879 of file class.ilChangeEvent.php.
References $ilSetting.
Referenced by ilObjRepositorySettingsGUI\saveSettings(), and ilTrackingTest\testChangeEvent().
|
static |
Delete object entries.
Definition at line 900 of file class.ilChangeEvent.php.
Referenced by ilObjectLP\handleDelete().
|
static |
|
static |
Definition at line 922 of file class.ilChangeEvent.php.
References $ilDB.
Referenced by ilObjSCORM2004LearningModule\deleteTrackingDataOfUsers(), ilObjSCORMLearningModule\deleteTrackingDataOfUsers(), and ilObjectLP\resetLPDataForUserIds().
|
static |
Definition at line 931 of file class.ilChangeEvent.php.
References $ilDB, $res, $row, and array.
Referenced by ilObjectLP\gatherLPUsers().
|
static |
Returns true, if change event tracking is active.
Definition at line 889 of file class.ilChangeEvent.php.
References $ilSetting.
Referenced by ilObjUserTracking\__readSettings(), _activate(), ilInfoScreenGUI\addObjectSections(), ilObjRepositorySettingsGUI\addToExternalSettingsForm(), and ilObjRepositorySettingsGUI\initSettingsForm().
|
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 646 of file class.ilChangeEvent.php.
References $ilDB, $query, $r, $res, $row, and ilDBConstants\FETCHMODE_ASSOC.
Referenced by 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(ilDBConstants::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(ilDBConstants::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 741 of file class.ilChangeEvent.php.
References $counter, $ilDB, $query, $res, $row, and array.
Referenced by ilLPStatusDownloaded\_getCompleted(), ilLPStatusVisits\_getCompleted(), ilLPStatusTypicalLearningTime\_getCompleted(), ilLPStatusVisits\_getInProgress(), ilLPStatusTypicalLearningTime\_getInProgress(), ilLearningProgress\_getProgress(), ilLearningProgress\_lookupProgressByObjId(), ilInfoScreenGUI\addObjectSections(), ilLPStatusVisits\determinePercentage(), ilLPStatusTypicalLearningTime\determinePercentage(), ilLPStatusVisits\determineStatus(), ilLPStatusTypicalLearningTime\determineStatus(), and ilSCORMOfflineMode\il2sopSahsUser().
|
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 593 of file class.ilChangeEvent.php.
References $ilDB, $query, $r, $res, $row, array, and ilDBConstants\FETCHMODE_ASSOC.
Referenced by ilTrackingTest\testChangeEvent().
|
static |
Definition at line 324 of file class.ilChangeEvent.php.
References $ilDB, ilObjUserTracking\_enabledObjectStatistics(), ilObject\_lookupType(), array, date, and time.
|
static |
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 112 of file class.ilChangeEvent.php.
References $a_type, $ilDB, $path, $query, $res, $row, $time_diff, _catchupWriteEvents(), ilObjUserTracking\_getValidTimeSpan(), ilObject\_lookupObjId(), ilObject\_lookupType(), array, date, and time.
Referenced by ilLicense\_noteAccess(), ilObjSCORMTracking\_syncReadEvent(), ilSCORM2004Tracking\_syncReadEvent(), ilLearningProgress\_tracProgress(), ilRemoteObjectBaseGUI\callObject(), ilDAVServer\COPY(), ilDAVServer\GET(), ilObjMediaCast\handleLPUpdate(), ilObjSCORMLearningModule\importSuccessForSahsUser(), ilWikiPageGUI\increaseViewCount(), ilObjSessionGUI\infoScreen(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilDAVServer\PROPFIND(), ilObjLinkResourceGUI\redirectToLink(), ilObjPortfolioBaseGUI\renderFullscreenHeader(), ilObjBlogGUI\renderFullscreenHeader(), ilObjFileGUI\sendFile(), ilContainerContentGUI\setOutput(), ilObjMediaCastGUI\showContentObject(), ilObjSCORMTracking\syncGlobalStatus(), ilObjTestGUI\trackTestObjectReadEvent(), ilCourseContentGUI\view(), and ilObjectGUI\viewObject().
|
static |
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 55 of file class.ilChangeEvent.php.
Referenced by ilObjCourseGUI\afterSave(), ilDAVServer\COPY(), ilDAVServer\DELETE(), ilObjFileGUI\handleFileUpload(), ilDAVServer\MKCOL(), ilDAVServer\MOVE(), ilContainerGUI\pasteObject(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilDAVServer\PUT(), ilObject2GUI\putObjectInTree(), ilObjectGUI\putObjectInTree(), ilRepUtil\removeObjectsFromSystem(), ilRepUtil\restoreObjects(), ilObjFileGUI\save(), ilObjFileGUI\update(), ilObjRootFolderGUI\updateObject(), ilObjGroupGUI\updateObject(), ilObjCategoryGUI\updateObject(), and ilObjCourseGUI\updateObject().
|
static |
Process object statistics log data.
integer | $a_now | |
integer | $a_minimum |
Definition at line 376 of file class.ilChangeEvent.php.
References $ilDB, $old, $ret, $row, array, ilDBInterface\buildAtomQuery(), ilDBInterface\fetchAssoc(), ilDBInterface\insert(), ilDBInterface\numRows(), ilDBInterface\query(), ilDBInterface\quote(), time, and ilDBInterface\update().
Referenced by ilLPObjectStatisticsGUI\adminSync().
|
static |
_updateAccessForScormOfflinePlayer needed to synchronize last_access and first_access when learning modul is used offline called in .
/Modules/ScormAicc/classes/class.ilSCORMOfflineMode.php
Definition at line 953 of file class.ilChangeEvent.php.
References $ilDB, $res, and array.
Referenced by ilSCORMOfflineMode\scormPlayerUnloadForSop2il().
|
static |
Has accessed.
Definition at line 804 of file class.ilChangeEvent.php.
References $ilDB.
Referenced by ilLPStatusDownloaded\_getCompleted(), ilLPStatusVisitedPages\determineStatus(), ilLPStatusQuestions\determineStatus(), ilLPStatusManual\determineStatus(), ilLPStatusVisits\determineStatus(), ilLPStatusTypicalLearningTime\determineStatus(), ilLPStatusExerciseReturned\determineStatus(), ilLPStatusManualByTutor\determineStatus(), ilLPStatusObjectives\determineStatus(), ilLPStatusSCORM\determineStatus(), and ilLPStatusCollection\determineStatus().
|
static |
Lookup users in progress.
Definition at line 786 of file class.ilChangeEvent.php.
References $ilDB, $query, $res, $row, and array.
Referenced by ilLPStatusQuestions\_getCompleted(), ilLPStatusQuestions\_getInProgress(), ilLPStatusVisitedPages\_getInProgress(), ilLPStatusManual\_getInProgress(), ilLPStatusExerciseReturned\_getInProgress(), ilLPStatusCollection\_getInProgress(), ilLPStatusManualByTutor\_getInProgress(), and ilLPStatusObjectives\_getStatusInfo().
|
staticprivate |
Definition at line 38 of file class.ilChangeEvent.php.