analytics/classes/analysable.php

   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 namespace core_analytics;
  18
  19 /**
  20  * Any element analysers can analyse.
  21  *
  22  * @package   core_analytics
  23  * @copyright 2016 David Monllao {@link http://www.davidmonllao.com}
  24  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25  */
  26 interface analysable {
  27
  28     /**
  29      * Max timestamp.
  30      */
  31     const MAX_TIME = SQL_INT_MAX;
  32
  33     /**
  34      * The analysable unique identifier in the site.
  35      *
  36      * @return int.
  37      */
  38     public function get_id();
  39
  40     /**
  41      * The analysable human readable name
  42      *
  43      * @return string
  44      */
  45     public function get_name();
  46
  47     /**
  48      * The analysable context.
  49      *
  50      * @return \context
  51      */
  52     public function get_context();
  53
  54     /**
  55      * The start of the analysable if there is one.
  56      *
  57      * @return int|false
  58      */
  59     public function get_start();
  60
  61     /**
  62      * The end of the analysable if there is one.
  63      *
  64      * @return int|false
  65      */
  66     public function get_end();
  67 }