9516095fbdb080934b3e9c3ffa93c6e210a0ca8d
[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      * Navigates to the course gradebook and selects a specified item from the grade navigation tabs.
46      * @Given /^I go to "(?P<gradepath_string>(?:[^"]|\\")*)" in the course gradebook$/
47      * @param string $gradepath
48      * @deprecated since Moodle 3.3 MDL-57282 - please do not use this step any more.
49      */
50     public function i_go_to_in_the_course_gradebook($gradepath) {
51         $alternative = 'I navigate to "' . $this->escape($gradepath) . '"  in the course gradebook';
52         $this->deprecated_message($alternative);
54         $this->execute('behat_grade::i_navigate_to_in_the_course_gradebook', $gradepath);
55     }
57     /**
58      * Throws an exception if $CFG->behat_usedeprecated is not allowed.
59      *
60      * @throws Exception
61      * @param string|array $alternatives Alternative/s to the requested step
62      * @param bool $throwexception If set to true we always throw exception, irrespective of behat_usedeprecated setting.
63      * @return void
64      */
65     protected function deprecated_message($alternatives, $throwexception = false) {
66         global $CFG;
68         // We do nothing if it is enabled.
69         if (!empty($CFG->behat_usedeprecated) && !$throwexception) {
70             return;
71         }
73         if (is_scalar($alternatives)) {
74             $alternatives = array($alternatives);
75         }
77         // Show an appropriate message based on the throwexception flag.
78         if ($throwexception) {
79             $message = 'This step has been removed. Rather than using this step you can:';
80         } else {
81             $message = 'Deprecated step, rather than using this step you can:';
82         }
84         // Add all alternatives to the message.
85         foreach ($alternatives as $alternative) {
86             $message .= PHP_EOL . '- ' . $alternative;
87         }
89         if (!$throwexception) {
90             $message .= PHP_EOL . '- Set $CFG->behat_usedeprecated in config.php to allow the use of deprecated steps
91                     if you don\'t have any other option';
92         }
94         throw new Exception($message);
95     }
97 }