WebDriverSelect
in package
implements
WebDriverSelectInterface
Models a default HTML `<select>` tag, providing helper methods to select and deselect options.
Table of Contents
Interfaces
- WebDriverSelectInterface
- Models an element of select type, providing helper methods to select and deselect options.
Properties
- $element : WebDriverElement
- $isMulti : bool
Methods
- __construct() : mixed
- deselectAll() : mixed
- Deselect all options in multiple select tag.
- deselectByIndex() : mixed
- Deselect the option at the given index.
- deselectByValue() : mixed
- Deselect all options that have value attribute matching the argument. That is, when given "foo" this would deselect an option like:
- deselectByVisiblePartialText() : mixed
- Deselect all options that display text matching the argument. That is, when given "Bar" this would deselect an option like:
- deselectByVisibleText() : mixed
- Deselect all options that display text matching the argument. That is, when given "Bar" this would deselect an option like:
- getAllSelectedOptions() : array<string|int, WebDriverElement>
- getFirstSelectedOption() : WebDriverElement
- getOptions() : array<string|int, WebDriverElement>
- isMultiple() : bool
- selectByIndex() : mixed
- Select the option at the given index.
- selectByValue() : mixed
- Select all options that have value attribute matching the argument. That is, when given "foo" this would select an option like:
- selectByVisiblePartialText() : mixed
- Select all options that display text partially matching the argument. That is, when given "Bar" this would select an option like:
- selectByVisibleText() : mixed
- Select all options that display text matching the argument. That is, when given "Bar" this would select an option like:
- deselectOption() : mixed
- Mark option not selected
- selectOption() : mixed
- Mark option selected
Properties
$element
private
WebDriverElement
$element
$isMulti
private
bool
$isMulti
Methods
__construct()
public
__construct(WebDriverElement $element) : mixed
Parameters
- $element : WebDriverElement
deselectAll()
Deselect all options in multiple select tag.
public
deselectAll() : mixed
deselectByIndex()
Deselect the option at the given index.
public
deselectByIndex(mixed $index) : mixed
Parameters
- $index : mixed
-
The index of the option. (0-based)
deselectByValue()
Deselect all options that have value attribute matching the argument. That is, when given "foo" this would deselect an option like:
public
deselectByValue(mixed $value) : mixed
<option value="foo">Bar</option>
Parameters
- $value : mixed
-
The value to match against.
deselectByVisiblePartialText()
Deselect all options that display text matching the argument. That is, when given "Bar" this would deselect an option like:
public
deselectByVisiblePartialText(mixed $text) : mixed
<option value="foo">Foo Bar Baz</option>
Parameters
- $text : mixed
-
The visible text to match against.
deselectByVisibleText()
Deselect all options that display text matching the argument. That is, when given "Bar" this would deselect an option like:
public
deselectByVisibleText(mixed $text) : mixed
<option value="foo">Bar</option>
Parameters
- $text : mixed
-
The visible text to match against.
getAllSelectedOptions()
public
getAllSelectedOptions() : array<string|int, WebDriverElement>
Return values
array<string|int, WebDriverElement> —All selected options belonging to this select tag.
getFirstSelectedOption()
public
getFirstSelectedOption() : WebDriverElement
Return values
WebDriverElement —The first selected option in this select tag (or the currently selected option in a normal select)
getOptions()
public
getOptions() : array<string|int, WebDriverElement>
Return values
array<string|int, WebDriverElement> —All options belonging to this select tag.
isMultiple()
public
isMultiple() : bool
Return values
bool —Whether this select element support selecting multiple options.
selectByIndex()
Select the option at the given index.
public
selectByIndex(mixed $index) : mixed
Parameters
- $index : mixed
-
The index of the option. (0-based)
selectByValue()
Select all options that have value attribute matching the argument. That is, when given "foo" this would select an option like:
public
selectByValue(mixed $value) : mixed
<option value="foo">Bar</option>
Parameters
- $value : mixed
-
The value to match against.
selectByVisiblePartialText()
Select all options that display text partially matching the argument. That is, when given "Bar" this would select an option like:
public
selectByVisiblePartialText(mixed $text) : mixed
<option value="bar">Foo Bar Baz</option>
Parameters
- $text : mixed
-
The visible text to match against.
selectByVisibleText()
Select all options that display text matching the argument. That is, when given "Bar" this would select an option like:
public
selectByVisibleText(mixed $text) : mixed
<option value="foo">Bar</option>
Parameters
- $text : mixed
-
The visible text to match against.
deselectOption()
Mark option not selected
protected
deselectOption(WebDriverElement $option) : mixed
Parameters
- $option : WebDriverElement
selectOption()
Mark option selected
protected
selectOption(WebDriverElement $option) : mixed
Parameters
- $option : WebDriverElement