[Summary view]

Differences Between: [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403]

   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   * Tour Step Renderable.
  19   *
  20   * @package    tool_usertours
  21   * @copyright  2016 Andrew Nicols <andrew@nicols.co.uk>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace tool_usertours\output;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use tool_usertours\step as stepsource;
  30  
  31  /**
  32   * Tour Step Renderable.
  33   *
  34   * @copyright  2016 Andrew Nicols <andrew@nicols.co.uk>
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class step implements \renderable {
  38  
  39      /**
  40       * @var The step instance.
  41       */
  42      protected $step;
  43  
  44      /**
  45       * The step output.
  46       *
  47       * @param   stepsource      $step       The step being output.
  48       */
  49      public function __construct(stepsource $step) {
  50          $this->step = $step;
  51      }
  52  
  53      /**
  54       * Export the step configuration.
  55       *
  56       * @param   renderer_base   $output     The renderer.
  57       * @return  object
  58       */
  59      public function export_for_template(\renderer_base $output) {
  60          global $PAGE;
  61          $step = $this->step;
  62  
  63          $result = (object) [
  64              'stepid'    => $step->get_id(),
  65              'title'     => external_format_text(
  66                      stepsource::get_string_from_input($step->get_title()),
  67                      FORMAT_HTML,
  68                      $PAGE->context->id,
  69                      'tool_usertours'
  70                  )[0],
  71              'content'   => external_format_text(
  72                      stepsource::get_string_from_input($step->get_content()),
  73                      FORMAT_HTML,
  74                      $PAGE->context->id,
  75                      'tool_usertours'
  76                  )[0],
  77              'element'   => $step->get_target()->convert_to_css(),
  78          ];
  79  
  80          $result->content = str_replace("\n", "<br>\n", $result->content);
  81  
  82          foreach ($step->get_config_keys() as $key) {
  83              $result->$key = $step->get_config($key);
  84          }
  85  
  86          return $result;
  87      }
  88  }