backup/util/loggers/core_backup_html_logger.class.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  * Logger that stores HTML log data in memory, ready for later display.
  19  *
  20  * @package core_backup
  21  * @copyright 2013 The Open University
  22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24 class core_backup_html_logger extends base_logger {
  25     /**
  26      * @var string HTML output
  27      */
  28     protected $html = '';
  29
  30     protected function action($message, $level, $options = null) {
  31         $prefix = $this->get_prefix($level, $options);
  32         $depth = isset($options['depth']) ? $options['depth'] : 0;
  33         $this->html .= $prefix . str_repeat('&nbsp;&nbsp;', $depth) .
  34                 s($message) . '<br/>' . PHP_EOL;
  35         return true;
  36     }
  37
  38     /**
  39      * Gets the full HTML content of the log.
  40      *
  41      * @return string HTML content of log
  42      */
  43     public function get_html() {
  44         return $this->html;
  45     }
  46 }