ce732d17b01d627b2521da4624fb77de45a22273
[moodle.git] / lib / tests / behat / behat_filters.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 related to filters.
19  *
20  * @package    core
21  * @category   test
22  * @copyright  2018 the Open University
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__ . '/../../behat/behat_base.php');
29 require_once(__DIR__ . '/../../filterlib.php');
32 /**
33  * Steps definitions related to filters.
34  *
35  * @package    core
36  * @category   test
37  * @copyright  2018 the Open University
38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 class behat_filters extends behat_base {
42     /**
43      * Set the global filter configuration.
44      *
45      * @Given /^the "(?P<filter_name>(?:[^"]|\\")*)" filter is "(on|off|disabled)"$/
46      *
47      * @param string $filtername the name of a filter, e.g. 'glossary'.
48      * @param string $statename 'on', 'off' or 'disabled'.
49      */
50     public function the_filter_is($filtername, $statename) {
51         switch ($statename) {
52             case 'on':
53                 $state = TEXTFILTER_ON;
54                 break;
55             case 'off':
56                 $state = TEXTFILTER_OFF;
57                 break;
58             case 'disabled':
59                 $state = TEXTFILTER_DISABLED;
60                 break;
61             default:
62                 throw new coding_exception('Unknown filter state: ' . $statename);
63         }
64         filter_set_global_state($filtername, $state);
65     }
66 }