-
-
Notifications
You must be signed in to change notification settings - Fork 212
/
ChoiceFormField.php
212 lines (178 loc) · 5.7 KB
/
ChoiceFormField.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
<?php
/*
* This file is part of the Panther project.
*
* (c) Kévin Dunglas <dunglas@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace Symfony\Component\Panther\DomCrawler\Field;
use Facebook\WebDriver\WebDriverSelect;
use Facebook\WebDriver\WebDriverSelectInterface;
use Symfony\Component\DomCrawler\Field\ChoiceFormField as BaseChoiceFormField;
use Symfony\Component\Panther\WebDriver\WebDriverCheckbox;
/**
* @author Kévin Dunglas <dunglas@gmail.com>
*/
final class ChoiceFormField extends BaseChoiceFormField
{
use FormFieldTrait;
/**
* @var string
*/
private $type;
/**
* @var WebDriverSelectInterface
*/
private $selector;
public function hasValue()
{
if (\count($this->selector->getAllSelectedOptions())) {
return true;
}
return $this->element->isSelected();
}
public function select($value)
{
foreach ((array) $value as $v) {
$this->selector->selectByValue($v);
}
}
/**
* Ticks a checkbox.
*
* @throws \LogicException When the type provided is not correct
*/
public function tick()
{
if ('checkbox' !== $type = $this->element->getAttribute('type')) {
throw new \LogicException(\sprintf('You cannot tick "%s" as it is not a checkbox (%s).', $this->element->getAttribute('name'), $type));
}
$this->setValue(true);
}
/**
* Ticks a checkbox.
*
* @throws \LogicException When the type provided is not correct
*/
public function untick()
{
if ('checkbox' !== $type = $this->element->getAttribute('type')) {
throw new \LogicException(\sprintf('You cannot tick "%s" as it is not a checkbox (%s).', $this->element->getAttribute('name'), $type));
}
$this->setValue(false);
}
public function getValue()
{
$type = $this->element->getAttribute('type');
if (!$this->hasValue()) {
return $this->isMultiple() && 'checkbox' !== $type ? [] : null;
}
if ($this->isMultiple()) {
$value = [];
foreach ($this->selector->getAllSelectedOptions() as $selectedOption) {
if ($selectedOption->isSelected()) {
$value[] = $selectedOption->getAttribute('value');
}
}
$count = \count($value);
if (1 === $count && 'checkbox' === $type) {
return \current($value);
}
return $value;
} elseif (\count($this->selector->getAllSelectedOptions())) {
return $this->selector->getFirstSelectedOption()->getAttribute('value');
}
return $this->element->getAttribute('value');
}
/**
* Sets the value of the field.
*
* @param string|array|bool $value The value of the field
*
* @throws \InvalidArgumentException When value type provided is not correct
*/
public function setValue($value)
{
if (\is_bool($value)) {
if ('checkbox' !== $this->type) {
throw new \InvalidArgumentException(\sprintf('Invalid argument of type "%s"', \gettype($value)));
}
if ($value) {
if (!$this->element->isSelected()) {
$this->element->click();
}
} elseif ($this->element->isSelected()) {
$this->element->click();
}
return;
}
foreach ((array) $value as $v) {
$this->selector->selectByValue($v);
}
}
public function addChoice(\DOMElement $node)
{
throw $this->createNotSupportedException(__METHOD__);
}
/**
* Returns the type of the choice field (radio, select, or checkbox).
*
* @return string The type
*/
public function getType()
{
return $this->type;
}
/**
* Returns true if the field accepts multiple values.
*
* @return bool true if the field accepts multiple values, false otherwise
*/
public function isMultiple()
{
return $this->selector->isMultiple();
}
/**
* Returns list of available field options.
*
* @return array
*/
public function availableOptionValues()
{
$options = [];
foreach ($this->selector->getOptions() as $option) {
$options[] = $option->getAttribute('value');
}
return $options;
}
/**
* Disables the internal validation of the field.
*
* @return self
*/
public function disableValidation()
{
throw $this->createNotSupportedException(__METHOD__);
}
/**
* Initializes the form field.
*
* @throws \LogicException When node type is incorrect
*/
protected function initialize()
{
$tagName = $this->element->getTagName();
if ('input' !== $tagName && 'select' !== $tagName) {
throw new \LogicException(\sprintf('A ChoiceFormField can only be created from an input or select tag (%s given).', $tagName));
}
$type = \strtolower((string) $this->element->getAttribute('type'));
if ('input' === $tagName && 'checkbox' !== $type && 'radio' !== $type) {
throw new \LogicException(\sprintf('A ChoiceFormField can only be created from an input tag with a type of checkbox or radio (given type is %s).', $type));
}
$this->type = 'select' === $tagName ? 'select' : $type;
$this->selector = 'select' === $this->type ? new WebDriverSelect($this->element) : new WebDriverCheckbox($this->element);
}
}