MDL-37657 behat: Adding definitions related with forms
[moodle.git] / lib / behat / form_field / behat_form_field.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Generic moodleforms field.
20  *
21  * @package    core_form
22  * @category   test
23  * @copyright  2012 David MonllaĆ³
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
29 use Behat\Mink\Session as Session,
30     Behat\Mink\Element\NodeElement as NodeElement;
32 /**
33  * Representation of a moodle field.
34  *
35  * Basically an interface with Mink session.
36  *
37  * @package    core_form
38  * @category   test
39  * @copyright  2012 David MonllaĆ³
40  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
42 class behat_form_field {
44     protected $session;
45     protected $fieldnode;
47     /**
48      * General constructor with the node and the session to interact with.
49      *
50      * @param Session $session Reference to Mink session to traverse/modify the page DOM.
51      * @param NodeElement $fieldnode The field DOM node
52      * @return void
53      */
54     public function __construct(Session $session, NodeElement $fieldnode) {
55         $this->session = $session;
56         $this->field = $fieldnode;
57     }
59     /**
60      * Sets the value to a field.
61      *
62      * @param string $value
63      * @return void
64      */
65     public function set_value($value) {
66         $this->field->setValue($value);
67     }
69     /**
70      * Returns the current value of the select element.
71      *
72      * @return string
73      */
74     public function get_value() {
75         return $this->field->getValue();
76     }
78 }