[Summary view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Any access before the official start of the course.
  19   *
  20   * @package   core
  21   * @copyright 2016 David Monllao {@link http://www.davidmonllao.com}
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\analytics\indicator;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Any access before the official start of the course.
  31   *
  32   * @package   core
  33   * @copyright 2016 David Monllao {@link http://www.davidmonllao.com}
  34   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class any_access_before_start extends \core_analytics\local\indicator\binary {
  37  
  38      /**
  39       * Returns the name.
  40       *
  41       * If there is a corresponding '_help' string this will be shown as well.
  42       *
  43       * @return \lang_string
  44       */
  45      public static function get_name() : \lang_string {
  46          return new \lang_string('indicator:accessesbeforestart');
  47      }
  48  
  49      /**
  50       * required_sample_data
  51       *
  52       * @return string[]
  53       */
  54      public static function required_sample_data() {
  55          return array('user', 'course', 'context');
  56      }
  57  
  58      /**
  59       * calculate_sample
  60       *
  61       * @param int $sampleid
  62       * @param string $samplesorigin
  63       * @param int $starttime
  64       * @param int $endtime
  65       * @return float
  66       */
  67      protected function calculate_sample($sampleid, $samplesorigin, $starttime = false, $endtime = false) {
  68          global $DB;
  69  
  70          $user = $this->retrieve('user', $sampleid);
  71          $course = \core_analytics\course::instance($this->retrieve('course', $sampleid));
  72  
  73          if (!$logstore = \core_analytics\manager::get_analytics_logstore()) {
  74              throw new \coding_exception('No available log stores');
  75          }
  76  
  77          // Filter by context to use the logstore_standard_log db table index.
  78          $context = $this->retrieve('context', $sampleid);
  79          $select = "userid = :userid AND contextlevel = :contextlevel AND contextinstanceid = :contextinstanceid AND " .
  80              "timecreated < :start";
  81          $params = array('userid' => $user->id, 'contextlevel' => $context->contextlevel,
  82              'contextinstanceid' => $context->instanceid, 'start' => $course->get_start());
  83  
  84          $nlogs = $logstore->get_events_select_count($select, $params);
  85          if ($nlogs) {
  86              return self::get_max_value();
  87          } else {
  88              return self::get_min_value();
  89          }
  90      }
  91  }