[Summary view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

   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       * We are limited by both PHP's max int value and DB (cross-db) max int allowed. Use the smallest one.
  41       */
  42      const MAX_TIME = PHP_INT_MAX < 9999999999 ? PHP_MAX_INT : 9999999999;
  43  
  44      /**
  45       * The analysable unique identifier in the site.
  46       *
  47       * @return int.
  48       */
  49      public function get_id();
  50  
  51      /**
  52       * The analysable human readable name
  53       *
  54       * @return string
  55       */
  56      public function get_name();
  57  
  58      /**
  59       * The analysable context.
  60       *
  61       * @return \context
  62       */
  63      public function get_context();
  64  
  65      /**
  66       * The start of the analysable if there is one.
  67       *
  68       * @return int|false
  69       */
  70      public function get_start();
  71  
  72      /**
  73       * The end of the analysable if there is one.
  74       *
  75       * @return int|false
  76       */
  77      public function get_end();
  78  }