[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   * Write actions in a course indicator.
  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   * Write actions in a course indicator.
  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_write_action_in_course 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:anywriteincourse');
  47      }
  48  
  49      /**
  50       * required_sample_data
  51       *
  52       * @return string[]
  53       */
  54      public static function required_sample_data() {
  55          // User is not required, calculate_sample can handle its absence.
  56          return array('course');
  57      }
  58  
  59      /**
  60       * calculate_sample
  61       *
  62       * @param int $sampleid
  63       * @param string $sampleorigin
  64       * @param int $starttime
  65       * @param int $endtime
  66       * @return float
  67       */
  68      protected function calculate_sample($sampleid, $sampleorigin, $starttime = false, $endtime = false) {
  69          global $DB;
  70  
  71          if (!$logstore = \core_analytics\manager::get_analytics_logstore()) {
  72              throw new \coding_exception('No available log stores');
  73          }
  74  
  75          // Filter by context to use the logstore_standard_log db table index.
  76          $course = $this->retrieve('course', $sampleid);
  77          $select = "courseid = :courseid AND anonymous = :anonymous AND (crud = 'c' OR crud = 'u')";
  78          $params = array('courseid' => $course->id, 'anonymous' => '0');
  79  
  80          if ($user = $this->retrieve('user', $sampleid)) {
  81              $select .= " AND userid = :userid";
  82              $params['userid'] = $user->id;
  83          }
  84  
  85          if ($starttime) {
  86              $select .= " AND timecreated > :starttime";
  87              $params['starttime'] = $starttime;
  88          }
  89          if ($endtime) {
  90              $select .= " AND timecreated <= :endtime";
  91              $params['endtime'] = $endtime;
  92          }
  93  
  94          $nlogs = $logstore->get_events_select_count($select, $params);
  95          if ($nlogs) {
  96              return self::get_max_value();
  97          } else {
  98              return self::get_min_value();
  99          }
 100      }
 101  }