ilChangeEvent Class Reference

Class ilChangeEvent tracks change events on repository objects. More...

Collaboration diagram for ilChangeEvent:

Static Public Member Functions
static	_recordWriteEvent (int $obj_id, int $usr_id, string $action, ?int $parent_obj_id=null)
	Records a write event. More...
static	_recordReadEvent (string $a_type, int $a_ref_id, int $obj_id, int $usr_id, bool $isCatchupWriteEvents=true, $a_ext_rc=null, $a_ext_time=null)
static	_recordObjStats (int $a_obj_id, ?int $a_spent_seconds, ?int $a_read_count, ?int $a_childs_spent_seconds=null, ?int $a_child_read_count=null)
static	_syncObjectStats (?int $a_now=null, int $a_minimum=20000)
static	_catchupWriteEvents (int $obj_id, int $usr_id, ?string $timestamp=null)
	Catches up with all write events which occured before the specified timestamp. More...
static	_lookupUncaughtWriteEvents (int $obj_id, int $usr_id)
	Reads all write events which occured on the object which happened after the last time the user caught up with them. More...
static	_lookupChangeState (int $obj_id, int $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. More...
static	lookupUsersInProgress (int $a_obj_id)
static	hasAccessed (int $a_obj_id, int $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 (int $a_obj_id)
	Delete object entries. More...
static	_deleteReadEvents (int $a_obj_id)
static	_deleteReadEventsForUsers (int $a_obj_id, array $a_user_ids)
static	_getAllUserIds (int $a_obj_id)

Static Private Attributes
static array	$has_accessed = []

Detailed Description

Class ilChangeEvent tracks change events on repository objects.

The following events are considered to be a 'write event':

• The creation of a new repository object
• A change of the data or meta-data of an object
• A move, link, copy, deletion or undeletion of the object UI objects, which cause a 'write event', must call _recordWriteEvent(...) In most cases, UI objects let the user catch up with write events on the object, when doing this call. The following events are considered to be a 'read event':
• Opening a container object in the browser*
• Opening / downloading / reading an object UI objects, which cause a 'read event', must call _recordReadEvent(...). In most cases, UI objects let the user catch up with write events on the object, when doing this call. *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(...).

  Author

  Werner Randelshofer werne.nosp@m.r.ra.nosp@m.ndels.nosp@m.hofe.nosp@m.r@hsl.nosp@m.u.ch

  Version

  Id

  class.ilChangeEvent.php,v 1.02 2007/05/07 19:25:34 wrandels Exp

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

Member Function Documentation

_activate()

static ilChangeEvent::_activate ( )

static

Activates change event tracking.

Definition at line 765 of file class.ilChangeEvent.php.

                                      : bool
    {
        if (ilChangeEvent::_isActive()) {
            return false;
        } else {
            global $DIC;
 
            $ilDB = $DIC['ilDB'];
 
            // Insert initial data into table write_event
            // We need to do this here, because we need
            // to catch up write events that occured while the change event tracking was
            // deactivated.
 
            // IGNORE isn't supported in oracle
            $set = $ilDB->query(
                sprintf(
                    'SELECT r1.obj_id,r2.obj_id p,d.owner,%s,d.create_date ' .
                    'FROM object_data d ' .
                    'LEFT JOIN write_event w ON d.obj_id = w.obj_id ' .
                    'JOIN object_reference r1 ON d.obj_id=r1.obj_id ' .
                    'JOIN tree t ON t.child=r1.ref_id ' .
                    'JOIN object_reference r2 on r2.ref_id=t.parent ' .
                    'WHERE w.obj_id IS NULL',
                    $ilDB->quote('create', 'text')
                )
            );
            $res = null;
            while ($rec = $ilDB->fetchAssoc($set)) {
                $nid = $ilDB->nextId("write_event");
                $query = 'INSERT INTO write_event ' .
                    '(write_id, obj_id,parent_obj_id,usr_id,action,ts) VALUES (' .
                    $ilDB->quote($nid, "integer") . "," .
                    $ilDB->quote($rec["obj_id"], "integer") . "," .
                    $ilDB->quote($rec["p"], "integer") . "," .
                    $ilDB->quote($rec["owner"], "integer") . "," .
                    $ilDB->quote("create", "text") . "," .
                    $ilDB->quote($rec["create_date"], "timestamp") .
                    ')';
                $res = $ilDB->query($query);
            }
 
            global $DIC;
 
            $ilSetting = $DIC['ilSetting'];
            $ilSetting->set('enable_change_event_tracking', '1');
 
            return $res !== null;
        }
    }

References $DIC, $ilDB, $ilSetting, $query, $res, and _isActive().

Referenced by ilObjRepositorySettingsGUI\saveSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

_catchupWriteEvents()

static ilChangeEvent::_catchupWriteEvents ( int  $obj_id, int  $usr_id, ?string  $timestamp = null  )

static

Catches up with all write events which occured before the specified timestamp.

Parameters

$obj_id	int The object.
$usr_id	int The user.
$timestamp	string|null timestamp.

Returns

void

Definition at line 525 of file class.ilChangeEvent.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT obj_id FROM catch_write_events " .
            "WHERE obj_id = " . $ilDB->quote($obj_id, 'integer') . " " .
            "AND usr_id  = " . $ilDB->quote($usr_id, 'integer');
        $res = $ilDB->query($query);
        if ($res->numRows()) {
            $ts = ($timestamp == null)
                ? ilUtil::now()
                : $timestamp;
        } else {
            $ts = ilUtil::now();
        }
 
        // alex, use replace due to bug #10406
        $ilDB->replace(
            "catch_write_events",
            array(
                "obj_id" => array("integer", $obj_id),
                "usr_id" => array("integer", $usr_id)
            ),
            array(
                "ts" => array("timestamp", $ts)
            )
        );
    }

References $timestamp, and ilUtil\now().

Referenced by ilContainerGUI\pasteObject(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilObjFileGUI\update(), ilObjCategoryGUI\updateObject(), ilObjCourseGUI\updateObject(), and ilObjGroupGUI\updateObject().

Here is the call graph for this function:

Here is the caller graph for this function:

_deactivate()

static ilChangeEvent::_deactivate ( )

static

Deactivates change event tracking.

Definition at line 819 of file class.ilChangeEvent.php.

                                        : bool
    {
        global $DIC;
 
        $ilSetting = $DIC['ilSetting'];
        $ilSetting->set('enable_change_event_tracking', '0');
        return true;
    }

References $DIC, and $ilSetting.

Referenced by ilObjRepositorySettingsGUI\saveSettings().

Here is the caller graph for this function:

_delete()

static ilChangeEvent::_delete ( int  $a_obj_id )

static

Delete object entries.

Definition at line 842 of file class.ilChangeEvent.php.

                                                 : bool
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $query = sprintf(
            'DELETE FROM write_event WHERE obj_id = %s ',
            $ilDB->quote($a_obj_id, 'integer')
        );
        $aff = $ilDB->manipulate($query);
 
        $query = sprintf(
            'DELETE FROM read_event WHERE obj_id = %s ',
            $ilDB->quote($a_obj_id, 'integer')
        );
        $aff = $ilDB->manipulate($query);
        return true;
    }

References $DIC, $ilDB, and $query.

Referenced by ilObjectLP\handleDelete().

Here is the caller graph for this function:

_deleteReadEvents()

static ilChangeEvent::_deleteReadEvents ( int  $a_obj_id )

static

Definition at line 861 of file class.ilChangeEvent.php.

                                                           : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $ilDB->manipulate(
            "DELETE FROM read_event" .
            " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer")
        );
    }

References $DIC, and $ilDB.

_deleteReadEventsForUsers()

static ilChangeEvent::_deleteReadEventsForUsers ( int  $a_obj_id, array  $a_user_ids  )

static

Definition at line 873 of file class.ilChangeEvent.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $ilDB->manipulate(
            "DELETE FROM read_event" .
            " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer") .
            " AND " . $ilDB->in("usr_id", $a_user_ids, "", "integer")
        );
    }

Referenced by ilObjSCORM2004LearningModule\deleteTrackingDataOfUsers(), ilObjSCORMLearningModule\deleteTrackingDataOfUsers(), and ilObjectLP\resetLPDataForUserIds().

Here is the caller graph for this function:

_getAllUserIds()

static ilChangeEvent::_getAllUserIds ( int  $a_obj_id )

static

Definition at line 888 of file class.ilChangeEvent.php.

                                                        : array
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $res = array();
        $set = $ilDB->query(
            "SELECT usr_id FROM read_event" .
            " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer")
        );
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = (int) $row["usr_id"];
        }
        return $res;
    }

References $DIC, $ilDB, $res, and ILIAS\Repository\int().

Referenced by ilObjectLP\gatherLPUsers().

Here is the call graph for this function:

Here is the caller graph for this function:

_isActive()

static ilChangeEvent::_isActive ( )

static

Returns true, if change event tracking is active.

Definition at line 831 of file class.ilChangeEvent.php.

                                      : bool
    {
        global $DIC;
 
        $ilSetting = $DIC['ilSetting'];
        return $ilSetting->get('enable_change_event_tracking', '0') == '1';
    }

References $DIC, and $ilSetting.

Referenced by ilObjUserTracking\__readSettings(), _activate(), ilObjRepositorySettingsGUI\addToExternalSettingsForm(), and ilObjRepositorySettingsGUI\initSettingsForm().

Here is the caller graph for this function:

_lookupChangeState()

static ilChangeEvent::_lookupChangeState ( int  $obj_id, int  $usr_id  )

static

Returns the change state of the object for the specified user.

which happened after the last time the user caught up with them.

Parameters

$obj_id	int The object
$usr_id	int The user who is interested into these events.

Returns

int 0 = object is unchanged, 1 = object is new, 2 = object has changed

Definition at line 622 of file class.ilChangeEvent.php.

                                                                       : int
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $q = "SELECT ts " .
            "FROM catch_write_events " .
            "WHERE obj_id=" . $ilDB->quote($obj_id, 'integer') . " " .
            "AND usr_id=" . $ilDB->quote($usr_id, 'integer');
        $r = $ilDB->query($q);
        $catchup = null;
        while ($row = $r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $catchup = $row['ts'];
        }
 
        if ($catchup == null) {
            $ilDB->setLimit(1);
            $query = sprintf(
                'SELECT * FROM write_event ' .
                'WHERE obj_id = %s ' .
                'AND usr_id <> %s ',
                $ilDB->quote($obj_id, 'integer'),
                $ilDB->quote($usr_id, 'integer')
            );
            $res = $ilDB->query($query);
        } else {
            $ilDB->setLimit(1);
            $query = sprintf(
                'SELECT * FROM write_event ' .
                'WHERE obj_id = %s ' .
                'AND usr_id <> %s ' .
                'AND ts > %s ',
                $ilDB->quote($obj_id, 'integer'),
                $ilDB->quote($usr_id, 'integer'),
                $ilDB->quote($catchup, 'timestamp')
            );
            $res = $ilDB->query($query);
        }
 
        $numRows = $res->numRows();
        if ($numRows > 0) {
            $row = $ilDB->fetchAssoc($res);
            // if we have write events, and user never catched one, report as new (1)
            // if we have write events, and user catched an old write event, report as changed (2)
            return ($catchup == null) ? 1 : 2;
        } else {
            return 0; // user catched all write events, report as unchanged (0)
        }
    }

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_ASSOC.

_lookupReadEvents()

static ilChangeEvent::_lookupReadEvents (   $obj_id,   $usr_id = null  )

static

Reads all read events which occured on the object.

Parameters

$obj_id	int The object
$usr_id	int Optional, the user who performed these events.

Definition at line 678 of file class.ilChangeEvent.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        if ($usr_id == null) {
            $query = sprintf(
                'SELECT * FROM read_event ' .
                'WHERE obj_id = %s ' .
                'ORDER BY last_access DESC',
                $ilDB->quote($obj_id, 'integer')
            );
            $res = $ilDB->query($query);
        } else {
            $query = sprintf(
                'SELECT * FROM read_event ' .
                'WHERE obj_id = %s ' .
                'AND usr_id = %s ' .
                'ORDER BY last_access DESC',
                $ilDB->quote($obj_id, 'integer'),
                $ilDB->quote($usr_id, 'integer')
            );
            $res = $ilDB->query($query);
        }
 
        $counter = 0;
        $events = [];
        while ($row = $ilDB->fetchAssoc($res)) {
            $events[$counter]['obj_id'] = $row['obj_id'];
            $events[$counter]['usr_id'] = $row['usr_id'];
            $events[$counter]['last_access'] = $row['last_access'];
            $events[$counter]['read_count'] = $row['read_count'];
            $events[$counter]['spent_seconds'] = $row['spent_seconds'];
            $events[$counter]['first_access'] = $row['first_access'];
 
            $counter++;
        }
        return $events;
    }

References $DIC, $ilDB, $query, and $res.

Referenced by ilLPStatusContentVisited\_getCompleted(), ilLPStatusTypicalLearningTime\_getCompleted(), ilLPStatusVisits\_getCompleted(), ilLPStatusTypicalLearningTime\_getInProgress(), ilLPStatusVisits\_getInProgress(), ilLearningProgress\_getProgress(), ilLearningProgress\_lookupProgressByObjId(), ilLPStatusTypicalLearningTime\determineStatus(), ilLPStatusVisits\determineStatus(), and ILIAS\MediaCast\Presentation\VideoViewGUI\renderSideColumn().

Here is the caller graph for this function:

_lookupUncaughtWriteEvents()

static ilChangeEvent::_lookupUncaughtWriteEvents ( int  $obj_id, int  $usr_id  )

static

Reads all write events which occured on the object which happened after the last time the user caught up with them.

Parameters

$obj_id	int The object
$usr_id	int The user who is interested into these events.

Returns

array with rows from table write_event

Definition at line 566 of file class.ilChangeEvent.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $q = "SELECT ts " .
            "FROM catch_write_events " .
            "WHERE obj_id=" . $ilDB->quote($obj_id, 'integer') . " " .
            "AND usr_id=" . $ilDB->quote($usr_id, 'integer');
        $r = $ilDB->query($q);
        $catchup = null;
        while ($row = $r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $catchup = $row['ts'];
        }
 
        if ($catchup == null) {
            $query = sprintf(
                'SELECT * FROM write_event ' .
                'WHERE obj_id = %s ' .
                'AND usr_id <> %s ' .
                'ORDER BY ts DESC',
                $ilDB->quote($obj_id, 'integer'),
                $ilDB->quote($usr_id, 'integer')
            );
            $res = $ilDB->query($query);
        } else {
            $query = sprintf(
                'SELECT * FROM write_event ' .
                'WHERE obj_id = %s ' .
                'AND usr_id <> %s ' .
                'AND ts >= %s ' .
                'ORDER BY ts DESC',
                $ilDB->quote($obj_id, 'integer'),
                $ilDB->quote($usr_id, 'integer'),
                $ilDB->quote($catchup, 'timestamp')
            );
            $res = $ilDB->query($query);
        }
        $events = array();
        while ($row = $ilDB->fetchAssoc($res)) {
            $events[] = $row;
        }
        return $events;
    }

_recordObjStats()

static ilChangeEvent::_recordObjStats ( int  $a_obj_id, ?int  $a_spent_seconds, ?int  $a_read_count, ?int  $a_childs_spent_seconds = null, ?int  $a_child_read_count = null  )

static

Definition at line 309 of file class.ilChangeEvent.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        if (!ilObjUserTracking::_enabledObjectStatistics() ||
            $a_obj_id <= 0) { // #12706
            return;
        }
 
        $now = time();
 
        $fields = array();
        $fields['log_id'] = array("integer", $ilDB->nextId('obj_stat_log'));
        $fields["obj_id"] = array("integer", $a_obj_id);
        $fields["obj_type"] = array("text", ilObject::_lookupType($a_obj_id));
        $fields["tstamp"] = array("timestamp", $now);
        $fields["yyyy"] = array("integer", date("Y"));
        $fields["mm"] = array("integer", date("m"));
        $fields["dd"] = array("integer", date("d"));
        $fields["hh"] = array("integer", date("H"));
        if ($a_spent_seconds > 0) {
            $fields["spent_seconds"] = array("integer", $a_spent_seconds);
        }
        if ($a_read_count > 0) {
            $fields["read_count"] = array("integer", $a_read_count);
        }
        if ($a_childs_spent_seconds > 0) {
            $fields["childs_spent_seconds"] = array("integer",
                                                    $a_childs_spent_seconds
            );
        }
        if ($a_child_read_count > 0) {
            $fields["childs_read_count"] = array("integer",
                                                 $a_child_read_count
            );
        }
        $ilDB->insert("obj_stat_log", $fields);
 
        // 0.01% probability
        if (mt_rand(1, 100) == 1) {
            self::_syncObjectStats($now);
        }
    }

_recordReadEvent()

static ilChangeEvent::_recordReadEvent ( string  $a_type, int  $a_ref_id, int  $obj_id, int  $usr_id, bool  $isCatchupWriteEvents = true,   $a_ext_rc = null,   $a_ext_time = null  )

static

Definition at line 103 of file class.ilChangeEvent.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $tree = $DIC['tree'];
 
        $validTimeSpan = ilObjUserTracking::_getValidTimeSpan();
 
        $query = sprintf(
            'SELECT * FROM read_event ' .
            'WHERE obj_id = %s ' .
            'AND usr_id = %s ',
            $ilDB->quote($obj_id, 'integer'),
            $ilDB->quote($usr_id, 'integer')
        );
        $res = $ilDB->query($query);
        $row = $ilDB->fetchObject($res);
 
        // read counter
        if ($a_ext_rc !== null) {
            $read_count = 'read_count = ' . $ilDB->quote(
                $a_ext_rc,
                "integer"
            ) . ", ";
            $read_count_init = max(1, (int) $a_ext_rc);
            $read_count_diff = max(1, (int) $a_ext_rc) - $row->read_count;
        } else {
            $read_count = 'read_count = read_count + 1, ';
            $read_count_init = 1;
            $read_count_diff = 1;
        }
 
        if ($row) {
            if ($a_ext_time !== null) {
                $time = (int) $a_ext_time;
            } else {
                $time = $ilDB->quote(
                    (time() - $row->last_access) <= $validTimeSpan
                        ? $row->spent_seconds + time() - $row->last_access
                        : $row->spent_seconds,
                    'integer'
                );
 
                // if we are in the valid interval, we do not
                // add anything to the read_count, since this is the
                // same access for us
                if ((time() - $row->last_access) <= $validTimeSpan) {
                    $read_count = '';
                    $read_count_init = 1;
                    $read_count_diff = 0;
                }
            }
            $time_diff = $time - (int) ($row->spent_seconds ?? 0);
 
            // Update
            $query = sprintf(
                'UPDATE read_event SET ' .
                $read_count .
                'spent_seconds = %s, ' .
                'last_access = %s ' .
                'WHERE obj_id = %s ' .
                'AND usr_id = %s ',
                $time,
                $ilDB->quote(time(), 'integer'),
                $ilDB->quote($obj_id, 'integer'),
                $ilDB->quote($usr_id, 'integer')
            );
            $aff = $ilDB->manipulate($query);
 
            self::_recordObjStats($obj_id, $time_diff, $read_count_diff);
        } else {
            if ($a_ext_time !== false) {
                $time = (int) $a_ext_time;
            } else {
                $time = 0;
            }
 
            $time_diff = $time - (int) ($row->spent_seconds ?? 0);
 
            // #10407
            $ilDB->replace(
                'read_event',
                array(
                    'obj_id' => array('integer', $obj_id),
                    'usr_id' => array('integer', $usr_id)
                ),
                array(
                    'read_count' => array('integer', $read_count_init),
                    'spent_seconds' => array('integer', $time),
                    'first_access' => array('timestamp', date("Y-m-d H:i:s")),
                    // was $ilDB->now()
                    'last_access' => array('integer', time())
                )
            );
 
            self::$has_accessed[$obj_id][$usr_id] = true;
 
            self::_recordObjStats($obj_id, $time_diff, $read_count_diff);
        }
 
        if ($isCatchupWriteEvents) {
            ilChangeEvent::_catchupWriteEvents($obj_id, $usr_id);
        }
 
        // update parents (no categories or root)
        if (!in_array($a_type, array("cat", "root", "crs"))) {
            if ($tree->isInTree($a_ref_id)) {
                $path = $tree->getPathId($a_ref_id);
 
                foreach ($path as $p) {
                    $obj2_id = ilObject::_lookupObjId($p);
                    $obj2_type = ilObject::_lookupType($obj2_id);
                    //echo "<br>1-$obj2_type-$p-$obj2_id-";
                    if (($p != $a_ref_id) && (in_array(
                        $obj2_type,
                        array("crs",
                                              "fold",
                                              "grp",
                                              "lso"
                        )
                    ))) {
                        $query = sprintf(
                            'SELECT * FROM read_event ' .
                            'WHERE obj_id = %s ' .
                            'AND usr_id = %s ',
                            $ilDB->quote($obj2_id, 'integer'),
                            $ilDB->quote($usr_id, 'integer')
                        );
                        $res2 = $ilDB->query($query);
                        if ($row2 = $ilDB->fetchAssoc($res2)) {
                            //echo "<br>2";
                            // update read count and spent seconds
                            $query = sprintf(
                                'UPDATE read_event SET ' .
                                'childs_read_count = childs_read_count + %s ,' .
                                'childs_spent_seconds = childs_spent_seconds + %s ' .
                                'WHERE obj_id = %s ' .
                                'AND usr_id = %s ',
                                $ilDB->quote((int) $read_count_diff, 'integer'),
                                $ilDB->quote((int) $time_diff, 'integer'),
                                $ilDB->quote($obj2_id, 'integer'),
                                $ilDB->quote($usr_id, 'integer')
                            );
                            $aff = $ilDB->manipulate($query);
 
                            self::_recordObjStats(
                                $obj2_id,
                                null,
                                null,
                                (int) $time_diff,
                                (int) $read_count_diff
                            );
                        } else {
 
                            // #10407
                            $ilDB->replace(
                                'read_event',
                                array(
                                    'obj_id' => array('integer', $obj2_id),
                                    'usr_id' => array('integer', $usr_id)
                                ),
                                array(
                                    'read_count' => array('integer', 1),
                                    'spent_seconds' => array('integer', $time),
                                    'first_access' => array('timestamp',
                                                            date("Y-m-d H:i:s")
                                    ), // was $ilDB->now()
                                    'last_access' => array('integer', time()),
                                    'childs_read_count' => array('integer',
                                                                 (int) $read_count_diff
                                    ),
                                    'childs_spent_seconds' => array('integer',
                                                                    (int) $time_diff
                                    )
                                )
                            );
 
                            self::$has_accessed[$obj2_id][$usr_id] = true;
 
                            self::_recordObjStats(
                                $obj2_id,
                                $time,
                                1,
                                (int) $time_diff,
                                (int) $read_count_diff
                            );
                        }
                    }
                }
            }
        }
 
        // @todo:
        // - calculate diff of spent_seconds and read_count
        // - use ref id to get parents of types grp, crs, fold
        // - add diffs to childs_spent_seconds and childs_read_count
    }

Referenced by ilObjSCORMTracking\_syncReadEvent(), ilSCORM2004Tracking\_syncReadEvent(), ilRemoteObjectBaseGUI\callObject(), ilSurveyExecutionGUI\executeCommand(), ilObjForumGUI\getContent(), ilWikiPageGUI\increaseViewCount(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilObjIndividualAssessmentGUI\recordIndividualAssessmentRead(), ilObjLearningSequenceGUI\recordLearningSequenceRead(), ilObjLinkResourceGUI\redirectToLink(), ilObjBlogGUI\renderFullscreenHeader(), ilObjPortfolioBaseGUI\renderFullscreenHeader(), ilObjCategoryGUI\renderObject(), ilObjFileGUI\sendFile(), ilContainerContentGUI\setOutput(), ilObjMediaCastGUI\showContentObject(), ilObjSCORMTracking\syncGlobalStatus(), ilLMTracker\trackAccess(), ilObjCmiXapiGUI\trackObjectReadEvent(), ilObjLTIConsumerGUI\trackObjectReadEvent(), ilObjTestGUI\trackTestObjectReadEvent(), ilObjectGUI\viewObject(), and ilObjForumGUI\viewThreadObject().

Here is the caller graph for this function:

_recordWriteEvent()

static ilChangeEvent::_recordWriteEvent ( int  $obj_id, int  $usr_id, string  $action, ?int  $parent_obj_id = null  )

static

Records a write event.

The parent object should be specified for the 'delete', 'undelete' and 'add' and 'remove' events.

Parameters

int	$obj_id	The object which was written to.
int	$usr_id	The user who performed a write action.
string	$action	The name of the write action. 'create', 'update', 'delete', 'add', 'remove', 'undelete'.
int | null	$parent_obj_id	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.

Returns

void

Definition at line 47 of file class.ilChangeEvent.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        /* see _recordReadEvent
        if (!ilChangeEvent::_isActive())
        {
            return;
        }
        */
 
        if ($parent_obj_id == null) {
            $pset = $ilDB->query(
                'SELECT r2.obj_id par_obj_id FROM object_reference r1 ' .
                'JOIN tree t ON t.child = r1.ref_id ' .
                'JOIN object_reference r2 ON r2.ref_id = t.parent ' .
                'WHERE r1.obj_id = ' . $ilDB->quote($obj_id, 'integer')
            );
 
            while ($prec = $ilDB->fetchAssoc($pset)) {
                $nid = $ilDB->nextId("write_event");
                $query = sprintf(
                    'INSERT INTO write_event ' .
                    '(write_id, obj_id, parent_obj_id, usr_id, action, ts) VALUES ' .
                    '(%s, %s, %s, %s, %s, ' . $ilDB->now() . ')',
                    $ilDB->quote($nid, 'integer'),
                    $ilDB->quote($obj_id, 'integer'),
                    $ilDB->quote($prec["par_obj_id"], 'integer'),
                    $ilDB->quote($usr_id, 'integer'),
                    $ilDB->quote($action, 'text')
                );
 
                $aff = $ilDB->manipulate($query);
            }
        } else {
            $nid = $ilDB->nextId("write_event");
            $query = sprintf(
                'INSERT INTO write_event ' .
                '(write_id, obj_id, parent_obj_id, usr_id, action, ts) ' .
                'VALUES (%s,%s,%s,%s,%s,' . $ilDB->now() . ')',
                $ilDB->quote($nid, 'integer'),
                $ilDB->quote($obj_id, 'integer'),
                $ilDB->quote($parent_obj_id, 'integer'),
                $ilDB->quote($usr_id, 'integer'),
                $ilDB->quote($action, 'text')
            );
            $aff = $ilDB->manipulate($query);
        }
    }

References $ilDB, and $query.

Referenced by ilObjCourseGUI\afterSave(), ilContainerGUI\pasteObject(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilObject2GUI\putObjectInTree(), ilObjectGUI\putObjectInTree(), ilObjFileGUI\update(), ilObjCategoryGUI\updateObject(), ilObjCourseGUI\updateObject(), and ilObjGroupGUI\updateObject().

Here is the caller graph for this function:

_syncObjectStats()

static ilChangeEvent::_syncObjectStats ( ?int  $a_now = null, int  $a_minimum = 20000  )

static

Definition at line 360 of file class.ilChangeEvent.php.

      {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        if (!$a_now) {
            $a_now = time();
        }
 
        set_time_limit(0);
 
        // has source table enough entries?
        $set = $ilDB->query("SELECT COUNT(*) AS counter FROM obj_stat_log");
        $row = $ilDB->fetchAssoc($set);
        if ($row["counter"] >= $a_minimum) {
            $ilAtomQuery = $ilDB->buildAtomQuery();
            $ilAtomQuery->addTableLock('obj_stat_log');
            $ilAtomQuery->addTableLock('obj_stat_tmp');
 
            $ilAtomQuery->addQueryCallable(
                function (ilDBInterface $ilDB) use ($a_now, $a_minimum, &$ret) {
 
                    // if other process was transferring, we had to wait for the lock and
                    // the source table should now have less than minimum/needed entries
                    $set = $ilDB->query(
                        "SELECT COUNT(*) AS counter FROM obj_stat_log"
                    );
                    $row = $ilDB->fetchAssoc($set);
                    if ($row["counter"] >= $a_minimum) {
                        // use only "full" seconds to have a clear cut
                        $ilDB->query(
                            "INSERT INTO obj_stat_tmp" .
                            " SELECT * FROM obj_stat_log" .
                            " WHERE tstamp < " . $ilDB->quote(
                                $a_now,
                                "timestamp"
                            )
                        );
 
                        // remove transferred entries from source table
                        $ilDB->query(
                            "DELETE FROM obj_stat_log" .
                            " WHERE tstamp < " . $ilDB->quote(
                                $a_now,
                                "timestamp"
                            )
                        );
 
                        $ret = true;
                    } else {
                        $ret = false;
                    }
                }
            );
 
            $ilAtomQuery->run();
 
            //continue only if obj_stat_log counter >= $a_minimum
            if ($ret) {
                $ilAtomQuery = $ilDB->buildAtomQuery();
                $ilAtomQuery->addTableLock('obj_stat_tmp');
                $ilAtomQuery->addTableLock('obj_stat');
 
                $ilAtomQuery->addQueryCallable(
                    function (ilDBInterface $ilDB) use ($a_now, $a_minimum) {
 
                        // process log data (timestamp is not needed anymore)
                        $sql = "SELECT obj_id, obj_type, yyyy, mm, dd, hh, SUM(read_count) AS read_count," .
                            " SUM(childs_read_count) AS childs_read_count, SUM(spent_seconds) AS spent_seconds," .
                            " SUM(childs_spent_seconds) AS childs_spent_seconds" .
                            " FROM obj_stat_tmp" .
                            " GROUP BY obj_id, obj_type, yyyy, mm, dd, hh";
                        $set = $ilDB->query($sql);
                        while ($row = $ilDB->fetchAssoc($set)) {
                            // "primary key"
                            $where = array("obj_id" => array("integer",
                                                             $row["obj_id"]
                            ),
                                           "obj_type" => array("text",
                                                               $row["obj_type"]
                                           ),
                                           "yyyy" => array("integer",
                                                           $row["yyyy"]
                                           ),
                                           "mm" => array("integer", $row["mm"]),
                                           "dd" => array("integer", $row["dd"]),
                                           "hh" => array("integer", $row["hh"])
                            );
 
                            $where_sql = array();
                            foreach ($where as $field => $def) {
                                $where_sql[] = $field . " = " . $ilDB->quote(
                                    $def[1],
                                    $def[0]
                                );
                            }
                            $where_sql = implode(" AND ", $where_sql);
 
                            // existing entry?
                            $check = $ilDB->query(
                                "SELECT read_count, childs_read_count, spent_seconds," .
                                "childs_spent_seconds" .
                                " FROM obj_stat" .
                                " WHERE " . $where_sql
                            );
                            if ($ilDB->numRows($check)) {
                                $old = $ilDB->fetchAssoc($check);
 
                                // add existing values
                                $fields = array("read_count" => array("integer",
                                                                      $old["read_count"] + $row["read_count"]
                                ),
                                                "childs_read_count" => array("integer",
                                                                             $old["childs_read_count"] + $row["childs_read_count"]
                                                ),
                                                "spent_seconds" => array("integer",
                                                                         $old["spent_seconds"] + $row["spent_seconds"]
                                                ),
                                                "childs_spent_seconds" => array("integer",
                                                                                $old["childs_spent_seconds"] + $row["childs_spent_seconds"]
                                                )
                                );
 
                                $ilDB->update("obj_stat", $fields, $where);
                            } else {
                                // new entry
                                $fields = $where;
                                $fields["read_count"] = array("integer",
                                                              $row["read_count"]
                                );
                                $fields["childs_read_count"] = array("integer",
                                                                     $row["childs_read_count"]
                                );
                                $fields["spent_seconds"] = array("integer",
                                                                 $row["spent_seconds"]
                                );
                                $fields["childs_spent_seconds"] = array("integer",
                                                                        $row["childs_spent_seconds"]
                                );
 
                                $ilDB->insert("obj_stat", $fields);
                            }
                        }
 
                        // clean up transfer table
                        $ilDB->query("DELETE FROM obj_stat_tmp");
                    }
                );
 
                $ilAtomQuery->run();
            }
        }
    }

References $check, $DIC, and $ilDB.

Referenced by ilLPObjectStatisticsGUI\adminSync().

Here is the caller graph for this function:

hasAccessed()

static ilChangeEvent::hasAccessed ( int  $a_obj_id, int  $a_usr_id  )

static

Has accessed.

Definition at line 741 of file class.ilChangeEvent.php.

                                                                    : bool
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        if (isset(self::$has_accessed[$a_obj_id][$a_usr_id])) {
            return self::$has_accessed[$a_obj_id][$a_usr_id];
        }
 
        $set = $ilDB->query(
            "SELECT usr_id FROM read_event WHERE " .
            "obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
            "usr_id = " . $ilDB->quote($a_usr_id, "integer")
        );
        if ($rec = $ilDB->fetchAssoc($set)) {
            return self::$has_accessed[$a_obj_id][$a_usr_id] = true;
        }
        return self::$has_accessed[$a_obj_id][$a_usr_id] = false;
    }

References $DIC, and $ilDB.

Referenced by ilLPStatusCollection\determineStatus(), ilLPStatusExerciseReturned\determineStatus(), ilLPStatusManual\determineStatus(), ilLPStatusManualByTutor\determineStatus(), ilLPStatusObjectives\determineStatus(), ilLPStatusTypicalLearningTime\determineStatus(), ilLPStatusVisitedPages\determineStatus(), and ilLPStatusVisits\determineStatus().

Here is the caller graph for this function:

lookupUsersInProgress()

static ilChangeEvent::lookupUsersInProgress ( int  $a_obj_id )

static

Definition at line 719 of file class.ilChangeEvent.php.

                                                               : array
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = sprintf(
            'SELECT DISTINCT(usr_id) usr FROM read_event ' .
            'WHERE obj_id = %s ',
            $ilDB->quote($a_obj_id, 'integer')
        );
        $res = $ilDB->query($query);
        $users = [];
        while ($row = $ilDB->fetchObject($res)) {
            $users[] = (int) $row->usr;
        }
        return $users;
    }

References $DIC, $ilDB, $query, $res, and ILIAS\Repository\int().

Referenced by ilLPStatusQuestions\_getCompleted(), ilLPStatusCollection\_getInProgress(), ilLPStatusExerciseReturned\_getInProgress(), ilLPStatusManual\_getInProgress(), ilLPStatusManualByTutor\_getInProgress(), ilLPStatusQuestions\_getInProgress(), ilLPStatusVisitedPages\_getInProgress(), ilLPStatusCollectionMobs\_getStatusInfo(), and ilLPStatusObjectives\_getStatusInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$has_accessed

array ilChangeEvent::$has_accessed = []

staticprivate

Definition at line 31 of file class.ilChangeEvent.php.

---

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

• Services/Tracking/classes/class.ilChangeEvent.php