[Summary view]

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 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 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\tour as toursource;
  30  
  31  /**
  32   * Tour 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 tour implements \renderable {
  38  
  39      /**
  40       * @var The tour instance.
  41       */
  42      protected $tour;
  43  
  44      /**
  45       * The tour output.
  46       *
  47       * @param   toursource      $tour       The tour being output.
  48       */
  49      public function __construct (toursource $tour) {
  50          $this->tour = $tour;
  51      }
  52  
  53      /**
  54       * Prepare the data for export.
  55       *
  56       * @param   \renderer_base      $output     The output renderable.
  57       * @return  object
  58       */
  59      public function export_for_template(\renderer_base $output) {
  60          $result = (object) [
  61              'name'  => $this->tour->get_tour_key(),
  62              'steps' => [],
  63              'endtourlabel' => $this->tour->get_endtourlabel(),
  64              'displaystepnumbers' => $this->tour->get_display_step_numbers(),
  65          ];
  66  
  67          foreach ($this->tour->get_steps() as $step) {
  68              $result->steps[] = (new step($step))->export_for_template($output);
  69          }
  70  
  71          return $result;
  72      }
  73  }