238bbeecc35e6f4973d0f3cafe70fb0279b88166
[moodle.git] / lib / behat / form_field / behat_form_autocomplete.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  * Auto complete form field class.
19  *
20  * @package    core_form
21  * @category   test
22  * @copyright  2015 Damyon Wiese
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_form_text.php');
30 /**
31  * Auto complete form field.
32  *
33  * @package    core_form
34  * @category   test
35  * @copyright  2015 Damyon Wiese
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class behat_form_autocomplete extends behat_form_text {
40     /**
41      * Sets the value to a field.
42      *
43      * @param string $value
44      * @return void
45      */
46     public function set_value($value) {
47         if (!$this->running_javascript()) {
48             throw new coding_exception('Setting the value of an autocomplete field requires javascript.');
49         }
51         // Set the value of the autocomplete's input.
52         // If this autocomplete offers suggestions then these should be fetched by setting the value and waiting for the
53         // JS to finish fetching those suggestions.
55         $istagelement = $this->field->hasAttribute('data-tags') && $this->field->getAttribute('data-tags');
57         if ($istagelement && false !== strpos($value, ',')) {
58             // Commas have a special meaning as a value separator in 'tag' autocomplete elements.
59             // To handle this we break the value up by comma, and enter it in chunks.
60             $values = explode(',', $value);
62             while ($value = array_shift($values)) {
63                 $this->set_value($value);
64             }
65         } else {
66             $this->field->setValue($value);
67             $this->wait_for_pending_js();
69             // If the autocomplete found suggestions, then it will have:
70             // 1) marked itself as expanded; and
71             // 2) have an aria-selected suggestion in the list.
72             $expanded = $this->field->getAttribute('aria-expanded');
73             $suggestion = $this->field->getParent()->find('css', '.form-autocomplete-suggestions > [aria-selected="true"]');
75             if ($expanded && null !== $suggestion) {
76                 // A suggestion was found.
77                 // Click on the first item in the list.
78                 $suggestion->click();
79             } else {
80                 // Press the return key to create a new tag.
81                 behat_base::type_keys($this->session, [behat_keys::ENTER]);
82             }
83             $this->wait_for_pending_js();
85             // Press the escape to close the autocomplete suggestions list.
86             behat_base::type_keys($this->session, [behat_keys::ESCAPE]);
87             $this->wait_for_pending_js();
88         }
89     }
90 }