105 lines
3.1 KiB
PHP
105 lines
3.1 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* 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; under version 2
|
||
|
|
* of the License (non-upgradable).
|
||
|
|
*
|
||
|
|
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||
|
|
*
|
||
|
|
* Copyright (c) 2017 (original work) Open Assessment Technologies SA;
|
||
|
|
*
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace oat\taoEventLog\model\userLastActivityLog;
|
||
|
|
|
||
|
|
use oat\oatbox\user\User;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Interface UserLastActivityLog
|
||
|
|
*
|
||
|
|
* Service to log the user activity.
|
||
|
|
* May be used to analize current load, get approximate amount of active users.
|
||
|
|
*
|
||
|
|
* @package oat\taoEventLog\model\userLastActivityLog
|
||
|
|
* @author Aleh Hutnikau, <hutnikau@1pt.com>
|
||
|
|
*/
|
||
|
|
interface UserLastActivityLog
|
||
|
|
{
|
||
|
|
const USER_ID = 'user_id';
|
||
|
|
const USER_ROLES = 'user_role';
|
||
|
|
const ACTION = 'action';
|
||
|
|
const EVENT_TIME = 'event_time';
|
||
|
|
const DETAILS = 'details';
|
||
|
|
|
||
|
|
const SERVICE_ID = 'taoEventLog/UserLastActivityLog';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Log user activity.
|
||
|
|
*
|
||
|
|
* @param User $user
|
||
|
|
* @param string $action - activity name
|
||
|
|
* @param array $details - additional details
|
||
|
|
* @return boolean
|
||
|
|
*/
|
||
|
|
public function log(User $user, $action, array $details = []);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Find user activities.
|
||
|
|
*
|
||
|
|
* Result example:
|
||
|
|
* ```
|
||
|
|
* [
|
||
|
|
* [...],
|
||
|
|
* [
|
||
|
|
* 'user_id' => 'http://sample/first.rdf#i1490617729993174',
|
||
|
|
* 'user_role' => 'http://www.tao.lu/Ontologies/TAO.rdf#BackOfficeRole,http://www.tao.lu/Ontologies/TAOLTI.rdf#LtiDeliveryProviderManagerRole',
|
||
|
|
* 'event_time' => '1490617792.5479'
|
||
|
|
* ],
|
||
|
|
* [...],
|
||
|
|
* ]
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* Filters parameter example:
|
||
|
|
* ```
|
||
|
|
* [
|
||
|
|
* ['user_id', 'in', ['http://sample/first.rdf#i1490617729993174', 'http://sample/first.rdf#i1490617729993174'],
|
||
|
|
* ['event_time', 'between', '1490703795.3624', '1490704796.2467'],
|
||
|
|
* ]
|
||
|
|
* ```
|
||
|
|
* Available operations: `<`, `>`, `<>`, `<=`, `>=`, `=`, `between`, `like`
|
||
|
|
*
|
||
|
|
* Options parameter example:
|
||
|
|
* ```
|
||
|
|
* [
|
||
|
|
* 'limit' => 100,
|
||
|
|
* 'offset' => 200,
|
||
|
|
* 'group' => 'user_id,
|
||
|
|
* ]
|
||
|
|
* ```
|
||
|
|
* Available options: 'limit', 'offset', 'group'.
|
||
|
|
*
|
||
|
|
* @param array $filters filters by user id, url, role etc.
|
||
|
|
* @param array $options
|
||
|
|
* @return \Iterator
|
||
|
|
*/
|
||
|
|
public function find(array $filters = [], array $options = []);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Count number of records by given search criteria
|
||
|
|
* For usage details see self::find method.
|
||
|
|
*
|
||
|
|
* @param array $filters @see self::find() description.
|
||
|
|
* @param array $options
|
||
|
|
* @return integer
|
||
|
|
*/
|
||
|
|
public function count(array $filters = [], array $options = []);
|
||
|
|
}
|