backup/util/interfaces/loggable.class.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * @package    moodlecore
  20  * @subpackage backup-interfaces
  21  * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 /**
  26  * Interface to apply to all the classes we want to be able to write to logs
  27  *
  28  * Any class being part of one backup/restore and needing to senf informatio
  29  * to logs must implement this interface (and have access to the @logger
  30  * instantiated object)
  31  *
  32  * TODO: Finish phpdocs
  33  */
  34 interface loggable {
  35
  36     /**
  37      * This function will be responsible for handling the params, and to call
  38      * to the corresponding logger->process() once all modifications in params
  39      * have been performed
  40      */
  41     public function log($message, $level, $a = null, $depth = null, $display = false);
  42 }