324241b9da1f11823fd073052f1ee48249cc1870
[moodle.git] / admin / tool / behat / renderer.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/>.
17 /**
18  * Behat tool renderer
19  *
20  * @package    tool_behat
21  * @copyright  2012 David MonllaĆ³
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 global $CFG;
28 require_once($CFG->libdir . '/behat/classes/behat_selectors.php');
30 /**
31  * Renderer for behat tool web features
32  *
33  * @package    tool_behat
34  * @copyright  2012 David MonllaĆ³
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class tool_behat_renderer extends plugin_renderer_base {
39     /**
40      * Renders the list of available steps according to the submitted filters.
41      *
42      * @param mixed $stepsdefinitions Available steps array.
43      * @param moodleform $form
44      * @return string HTML code
45      */
46     public function render_stepsdefinitions($stepsdefinitions, $form) {
48         $title = get_string('pluginname', 'tool_behat');
50         // Header.
51         $html = $this->output->header();
52         $html .= $this->output->heading($title);
54         // Info.
55         $installurl = behat_command::DOCS_URL . '#Installation';
56         $installlink = html_writer::tag('a', $installurl, array('href' => $installurl, 'target' => '_blank'));
57         $writetestsurl = behat_command::DOCS_URL . '#Writting_features';
58         $writetestslink = html_writer::tag('a', $writetestsurl, array('href' => $writetestsurl, 'target' => '_blank'));
59         $writestepsurl = behat_command::DOCS_URL . '#Adding_steps_definitions';
60         $writestepslink = html_writer::tag('a', $writestepsurl, array('href' => $writestepsurl, 'target' => '_blank'));
61         $infos = array(
62             get_string('installinfo', 'tool_behat', $installlink),
63             get_string('newtestsinfo', 'tool_behat', $writetestslink),
64             get_string('newstepsinfo', 'tool_behat', $writestepslink)
65         );
67         // List of steps.
68         $html .= $this->output->box_start();
69         $html .= html_writer::tag('h1', get_string('infoheading', 'tool_behat'));
70         $html .= html_writer::tag('div', get_string('aim', 'tool_behat'));
71         $html .= html_writer::empty_tag('div');
72         $html .= html_writer::empty_tag('ul');
73         $html .= html_writer::empty_tag('li');
74         $html .= implode(html_writer::end_tag('li') . html_writer::empty_tag('li'), $infos);
75         $html .= html_writer::end_tag('li');
76         $html .= html_writer::end_tag('ul');
77         $html .= html_writer::end_tag('div');
78         $html .= $this->output->box_end();
80         // Form.
81         ob_start();
82         $form->display();
83         $html .= ob_get_contents();
84         ob_end_clean();
86         if (empty($stepsdefinitions)) {
87             $stepsdefinitions = get_string('nostepsdefinitions', 'tool_behat');
88         } else {
90             $stepsdefinitions = implode('', $stepsdefinitions);
92             // Replace text selector type arguments with a user-friendly select.
93             $stepsdefinitions = preg_replace_callback('/(TEXT_SELECTOR\d?_STRING)/',
94                 function ($matches) {
95                     return html_writer::select(behat_selectors::get_allowed_text_selectors(), uniqid());
96                 },
97                 $stepsdefinitions
98             );
100             // Replace selector type arguments with a user-friendly select.
101             $stepsdefinitions = preg_replace_callback('/(SELECTOR\d?_STRING)/',
102                 function ($matches) {
103                     return html_writer::select(behat_selectors::get_allowed_selectors(), uniqid());
104                 },
105                 $stepsdefinitions
106             );
108             // Replace simple OR options.
109             $regex = '#\(\?P<[^>]+>([^\)|]+\|[^\)]+)\)#';
110             $stepsdefinitions = preg_replace_callback($regex,
111                 function($matches){
112                     return html_writer::select(explode('|', $matches[1]), uniqid());
113                 },
114                 $stepsdefinitions
115             );
117         }
119         // Steps definitions.
120         $html .= html_writer::tag('div', $stepsdefinitions, array('class' => 'steps-definitions'));
122         $html .= $this->output->footer();
124         return $html;
125     }