You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

114 lines
3.9 KiB

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle 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 3 of the License, or
// (at your option) any later version.
//
// Moodle 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 Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Read actions indicator.
*
* @package core
* @copyright 2016 David Monllao {@link http://www.davidmonllao.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core\analytics\indicator;
defined('MOODLE_INTERNAL') || die();
/**
* Read actions indicator.
*
* @package core
* @copyright 2016 David Monllao {@link http://www.davidmonllao.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class read_actions extends \core_analytics\local\indicator\linear {
/**
* Returns the name.
*
* If there is a corresponding '_help' string this will be shown as well.
*
* @return \lang_string
*/
public static function get_name() : \lang_string {
return new \lang_string('indicator:readactions');
}
/**
* required_sample_data
*
* @return string[]
*/
public static function required_sample_data() {
// User is not required, calculate_sample can handle its absence.
return array('context');
}
/**
* calculate_sample
*
* @param int $sampleid
* @param string $sampleorigin
* @param int $starttime
* @param int $endtime
* @return float
*/
protected function calculate_sample($sampleid, $sampleorigin, $starttime = false, $endtime = false) {
if (!$starttime || !$endtime) {
return null;
}
$select = '';
$params = array();
if ($user = $this->retrieve('user', $sampleid)) {
$select .= "userid = :userid AND ";
$params = $params + array('userid' => $user->id);
}
if (!$logstore = \core_analytics\manager::get_analytics_logstore()) {
throw new \coding_exception('No available log stores');
}
// Filter by context to use the logstore_standard_log db table index.
$context = $this->retrieve('context', $sampleid);
$select .= "contextlevel = :contextlevel AND contextinstanceid = :contextinstanceid AND " .
"crud = 'r' AND timecreated > :starttime AND timecreated <= :endtime";
$params = $params + array('contextlevel' => $context->contextlevel,
'contextinstanceid' => $context->instanceid, 'starttime' => $starttime, 'endtime' => $endtime);
$nrecords = $logstore->get_events_select_count($select, $params);
// We define a list of ranges to fit $nrecords into it
// # Done absolutely nothing
// # Not much really, just accessing the course once a week
// # More than just accessing the course, some interaction
// # Significant contribution, will depend on the course anyway.
// We need to adapt the limits to the time range duration.
$nweeks = $this->get_time_range_weeks_number($starttime, $endtime);
// Careful with this, depends on the course.
$limit = $nweeks * 3 * 10;
$ranges = array(
array('eq', 0),
// 1 course access per week (3 records are easily generated).
array('le', $nweeks * 3),
// 3 course accesses per week doing some stuff.
array('le', $limit),
array('gt', $limit)
);
return $this->classify_value($nrecords, $ranges);
}
}