[Summary view]

Differences Between: [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]

   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 element analysers can analyse.
  19   *
  20   * @package   core_analytics
  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;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Any element analysers can analyse.
  31   *
  32   * @package   core_analytics
  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  interface analysable {
  37  
  38      /**
  39       * Max timestamp.
  40       */
  41      const MAX_TIME = 9999999999;
  42  
  43      /**
  44       * The analysable unique identifier in the site.
  45       *
  46       * @return int.
  47       */
  48      public function get_id();
  49  
  50      /**
  51       * The analysable human readable name
  52       *
  53       * @return string
  54       */
  55      public function get_name();
  56  
  57      /**
  58       * The analysable context.
  59       *
  60       * @return \context
  61       */
  62      public function get_context();
  63  
  64      /**
  65       * The start of the analysable if there is one.
  66       *
  67       * @return int|false
  68       */
  69      public function get_start();
  70  
  71      /**
  72       * The end of the analysable if there is one.
  73       *
  74       * @return int|false
  75       */
  76      public function get_end();
  77  }