[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   * Test indicator. Always null.
  19   *
  20   * @package   core_analytics
  21   * @copyright 2017 David Monllaó {@link http://www.davidmonllao.com}
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  /**
  28   * Test indicator. Always null.
  29   *
  30   * @package   core_analytics
  31   * @copyright 2017 David Monllaó {@link http://www.davidmonllao.com}
  32   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33   */
  34  class test_indicator_null extends \core_analytics\local\indicator\binary {
  35  
  36      /**
  37       * Returns a lang_string object representing the name for the indicator.
  38       *
  39       * Used as column identificator.
  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          // Using a string that exists and contains a corresponding '_help' string.
  47          return new \lang_string('allowstealthmodules');
  48      }
  49  
  50      /**
  51       * calculate_sample
  52       *
  53       * @param int $sampleid
  54       * @param string $samplesorigin
  55       * @param int $starttime
  56       * @param int $endtime
  57       * @return float
  58       */
  59      protected function calculate_sample($sampleid, $samplesorigin, $starttime, $endtime) {
  60          return null;
  61      }
  62  }