ddd1a885432ad354b5ea1668a8b8c641e78ea63b
[moodle.git] / lib / tests / behat / behat_deprecated.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  * Steps definitions that will be deprecated in the next releases.
19  *
20  * @package    core
21  * @category   test
22  * @copyright  2013 David MonllaĆ³
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
28 require_once(__DIR__ . '/../../../lib/behat/behat_base.php');
30 use Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException,
31     Behat\Gherkin\Node\TableNode as TableNode,
32     Behat\Gherkin\Node\PyStringNode as PyStringNode;
34 /**
35  * Deprecated behat step definitions.
36  *
37  * @package    core
38  * @category   test
39  * @copyright  2013 David MonllaĆ³
40  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
42 class behat_deprecated extends behat_base {
44     /**
45      * Sets the specified value to the field.
46      *
47      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" to multiline$/
48      * @throws ElementNotFoundException Thrown by behat_base::find
49      * @param string $field
50      * @param PyStringNode $value
51      * @deprecated since Moodle 3.2 MDL-55406 - please do not use this step any more.
52      */
53     public function i_set_the_field_to_multiline($field, PyStringNode $value) {
55         $alternative = 'I set the field "' . $this->escape($field) . '"  to multiline:';
56         $this->deprecated_message($alternative);
58         $this->execute('behat_forms::i_set_the_field_to_multiline', array($field, $value));
59     }
61     /**
62      * Click on a given link in the moodle-actionmenu that is currently open.
63      * @Given /^I follow "(?P<link_string>(?:[^"]|\\")*)" in the open menu$/
64      * @param string $linkstring the text (or id, etc.) of the link to click.
65      * @deprecated since Moodle 3.2 MDL-55839 - please do not use this step any more.
66      */
67     public function i_follow_in_the_open_menu($linkstring) {
68         $alternative = 'I choose "' . $this->escape($linkstring) . '" from the open action menu';
69         $this->deprecated_message($alternative, true);
70     }
72     /**
73      * Navigates to the course gradebook and selects a specified item from the grade navigation tabs.
74      * @Given /^I go to "(?P<gradepath_string>(?:[^"]|\\")*)" in the course gradebook$/
75      * @param string $gradepath
76      * @deprecated since Moodle 3.3 MDL-57282 - please do not use this step any more.
77      */
78     public function i_go_to_in_the_course_gradebook($gradepath) {
79         $alternative = 'I navigate to "' . $this->escape($gradepath) . '"  in the course gradebook';
80         $this->deprecated_message($alternative);
82         $this->execute('behat_grade::i_navigate_to_in_the_course_gradebook', $gradepath);
83     }
85     /**
86      * Throws an exception if $CFG->behat_usedeprecated is not allowed.
87      *
88      * @throws Exception
89      * @param string|array $alternatives Alternative/s to the requested step
90      * @param bool $throwexception If set to true we always throw exception, irrespective of behat_usedeprecated setting.
91      * @return void
92      */
93     protected function deprecated_message($alternatives, $throwexception = false) {
94         global $CFG;
96         // We do nothing if it is enabled.
97         if (!empty($CFG->behat_usedeprecated) && !$throwexception) {
98             return;
99         }
101         if (is_scalar($alternatives)) {
102             $alternatives = array($alternatives);
103         }
105         // Show an appropriate message based on the throwexception flag.
106         if ($throwexception) {
107             $message = 'This step has been removed. Rather than using this step you can:';
108         } else {
109             $message = 'Deprecated step, rather than using this step you can:';
110         }
112         // Add all alternatives to the message.
113         foreach ($alternatives as $alternative) {
114             $message .= PHP_EOL . '- ' . $alternative;
115         }
117         if (!$throwexception) {
118             $message .= PHP_EOL . '- Set $CFG->behat_usedeprecated in config.php to allow the use of deprecated steps
119                     if you don\'t have any other option';
120         }
122         throw new Exception($message);
123     }