| 1 |
efrain |
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 |
namespace tool_usertours\output;
|
|
|
18 |
|
|
|
19 |
use tool_usertours\tour as toursource;
|
|
|
20 |
|
|
|
21 |
/**
|
|
|
22 |
* Tour renderable.
|
|
|
23 |
*
|
|
|
24 |
* @package tool_usertours
|
|
|
25 |
* @copyright 2016 Andrew Nicols <andrew@nicols.co.uk>
|
|
|
26 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
27 |
*/
|
|
|
28 |
class tour implements \renderable {
|
|
|
29 |
/**
|
|
|
30 |
* @var The tour instance.
|
|
|
31 |
*/
|
|
|
32 |
protected $tour;
|
|
|
33 |
|
|
|
34 |
/**
|
|
|
35 |
* The tour output.
|
|
|
36 |
*
|
|
|
37 |
* @param toursource $tour The tour being output.
|
|
|
38 |
*/
|
|
|
39 |
public function __construct(toursource $tour) {
|
|
|
40 |
$this->tour = $tour;
|
|
|
41 |
}
|
|
|
42 |
|
|
|
43 |
/**
|
|
|
44 |
* Prepare the data for export.
|
|
|
45 |
*
|
|
|
46 |
* @param \renderer_base $output The output renderable.
|
|
|
47 |
* @return object
|
|
|
48 |
*/
|
|
|
49 |
public function export_for_template(\renderer_base $output) {
|
|
|
50 |
$result = (object) [
|
|
|
51 |
'name' => $this->tour->get_tour_key(),
|
|
|
52 |
'steps' => [],
|
|
|
53 |
'endtourlabel' => $this->tour->get_endtourlabel(),
|
|
|
54 |
'displaystepnumbers' => $this->tour->get_display_step_numbers(),
|
|
|
55 |
];
|
|
|
56 |
|
|
|
57 |
foreach ($this->tour->get_steps() as $step) {
|
|
|
58 |
$result->steps[] = (new step($step))->export_for_template($output);
|
|
|
59 |
}
|
|
|
60 |
|
|
|
61 |
return $result;
|
|
|
62 |
}
|
|
|
63 |
}
|