[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   * Log storage reader interface.
  19   *
  20   * @package    core
  21   * @copyright  2013 Petr Skoda {@link http://skodak.org}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\log;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  interface reader {
  30      /**
  31       * Localised name of the reader.
  32       *
  33       * To be used in selection for in reports.
  34       *
  35       * @return string
  36       */
  37      public function get_name();
  38  
  39      /**
  40       * Longer description of the log data source.
  41       * @return string
  42       */
  43      public function get_description();
  44  
  45      /**
  46       * Are the new events appearing in the reader?
  47       *
  48       * @return bool true means new log events are being added, false means no new data will be added
  49       */
  50      public function is_logging();
  51  }