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 /**
  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  * Analysers get_analysers method return all analysable elements in the site;
  33  * it is important that analysable elements implement lazy loading to avoid
  34  * big memory footprints. See \core_analytics\course example.
  35  *
  36  * @package   core_analytics
  37  * @copyright 2016 David Monllao {@link http://www.davidmonllao.com}
  38  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39  */
  40 interface analysable {
  41
  42     /**
  43      * Max timestamp.
  44      */
  45     const MAX_TIME = 9999999999;
  46
  47     /**
  48      * The analysable unique identifier in the site.
  49      *
  50      * @return int.
  51      */
  52     public function get_id();
  53
  54     /**
  55      * The analysable human readable name
  56      *
  57      * @return string
  58      */
  59     public function get_name();
  60
  61     /**
  62      * The analysable context.
  63      *
  64      * @return \context
  65      */
  66     public function get_context();
  67
  68     /**
  69      * The start of the analysable if there is one.
  70      *
  71      * @return int|false
  72      */
  73     public function get_start();
  74
  75     /**
  76      * The end of the analysable if there is one.
  77      *
  78      * @return int|false
  79      */
  80     public function get_end();
  81 }