class.ilLearningProgress.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/
 
class ilLearningProgress
{
    // Static
    public static function _tracProgress(
        int $a_user_id,
        int $a_obj_id,
        int $a_ref_id,
        string $a_obj_type = ''
    ): bool {
        ilChangeEvent::_recordReadEvent(
            $a_obj_type,
            $a_ref_id,
            $a_obj_id,
            $a_user_id
        );
 
        ilLPStatus::setInProgressIfNotAttempted($a_obj_id, $a_user_id);
 
        return true;
    }
 
    public static function _getProgress(int $a_user_id, int $a_obj_id): array
    {
        $events = ilChangeEvent::_lookupReadEvents($a_obj_id, $a_user_id);
 
        $progress = [];
        foreach ($events as $row) {
            $tmp_date = new ilDateTime($row['last_access'], IL_CAL_UNIX);
            $row['last_access'] = $tmp_date->get(IL_CAL_UNIX);
 
            $tmp_date = new ilDateTime($row['first_access'], IL_CAL_DATETIME);
            $row['first_access'] = $tmp_date->get(IL_CAL_UNIX);
 
            if ($progress) {
                $progress['spent_seconds'] += (int) $row['spent_seconds'];
                $progress['access_time'] = max(
                    $progress['access_time'],
                    (int) $row['last_access']
                );
                $progress['access_time_min'] = min(
                    $progress['access_time_min'],
                    (int) $row['first_access']
                );
            } else {
                $progress['obj_id'] = (int) $row['obj_id'];
                $progress['user_id'] = (int) $row['usr_id'];
                $progress['spent_seconds'] = (int) $row['spent_seconds'];
                $progress['access_time'] = (int) $row['last_access'];
                $progress['access_time_min'] = (int) $row['first_access'];
                $progress['visits'] = (int) $row['read_count'];
            }
        }
        return $progress;
    }
 
    public static function _lookupProgressByObjId(int $a_obj_id): array
    {
        $progress = [];
        foreach (ilChangeEvent::_lookupReadEvents($a_obj_id) as $row) {
            if (isset($progress[$row['usr_id']])) {
                $progress[$row['usr_id']]['spent_seconds'] += (int) $row['spent_seconds'];
                $progress[$row['usr_id']]['read_count'] += (int) $row['read_count'];
                $progress[$row['usr_id']]['ts'] = max(
                    (int) $row['last_access'],
                    (int) $progress[$row['usr_id']]['ts']
                );
            } else {
                $progress[$row['usr_id']]['spent_seconds'] = (int) $row['spent_seconds'];
                $progress[$row['usr_id']]['read_count'] = (int) $row['read_count'];
                $progress[$row['usr_id']]['ts'] = (int) $row['last_access'];
            }
            $progress[$row['usr_id']]['usr_id'] = (int) $row['usr_id'];
            $progress[$row['usr_id']]['obj_id'] = (int) $row['obj_id'];
        }
        return $progress;
    }
}