class WebDriverActions (View source)

WebDriver action builder. It implements the builder pattern.

Properties

protected $driver
protected $keyboard
protected $mouse
protected $action

Methods

__construct(WebDriverHasInputDevices $driver)

No description

perform()

A convenience method for performing the actions without calling build().

click(WebDriverElement|null $element = null)

Mouse click.

clickAndHold(WebDriverElement|null $element = null)

Mouse click and hold.

contextClick(WebDriverElement|null $element = null)

Context-click (right click).

doubleClick(WebDriverElement|null $element = null)

Double click.

dragAndDrop(WebDriverElement $source, WebDriverElement $target)

Drag and drop from $source to $target.

dragAndDropBy(WebDriverElement $source, int $x_offset, int $y_offset)

Drag $source and drop by offset ($x_offset, $y_offset).

moveByOffset(int $x_offset, int $y_offset)

Mouse move by offset.

moveToElement(WebDriverElement $element, int $x_offset = null, int $y_offset = null)

Move to the middle of the given WebDriverElement.

release(WebDriverElement|null $element = null)

Release the mouse button.

keyDown(WebDriverElement|null $element = null, string $key = null)

Press a key on keyboard.

keyUp(WebDriverElement|null $element = null, string $key = null)

Release a key on keyboard.

sendKeys(WebDriverElement|null $element = null, string $keys = null)

Send keys by keyboard.

Details

__construct(WebDriverHasInputDevices $driver)

No description

Parameters

WebDriverHasInputDevices $driver

perform()

A convenience method for performing the actions without calling build().

WebDriverActions click(WebDriverElement|null $element = null)

Mouse click.

If $element is provided, move to the middle of the element first.

Parameters

WebDriverElement|null $element

Return Value

WebDriverActions

WebDriverActions clickAndHold(WebDriverElement|null $element = null)

Mouse click and hold.

If $element is provided, move to the middle of the element first.

Parameters

WebDriverElement|null $element

Return Value

WebDriverActions

WebDriverActions contextClick(WebDriverElement|null $element = null)

Context-click (right click).

If $element is provided, move to the middle of the element first.

Parameters

WebDriverElement|null $element

Return Value

WebDriverActions

WebDriverActions doubleClick(WebDriverElement|null $element = null)

Double click.

If $element is provided, move to the middle of the element first.

Parameters

WebDriverElement|null $element

Return Value

WebDriverActions

WebDriverActions dragAndDrop(WebDriverElement $source, WebDriverElement $target)

Drag and drop from $source to $target.

Parameters

WebDriverElement $source
WebDriverElement $target

Return Value

WebDriverActions

WebDriverActions dragAndDropBy(WebDriverElement $source, int $x_offset, int $y_offset)

Drag $source and drop by offset ($x_offset, $y_offset).

Parameters

WebDriverElement $source
int $x_offset
int $y_offset

Return Value

WebDriverActions

WebDriverActions moveByOffset(int $x_offset, int $y_offset)

Mouse move by offset.

Parameters

int $x_offset
int $y_offset

Return Value

WebDriverActions

WebDriverActions moveToElement(WebDriverElement $element, int $x_offset = null, int $y_offset = null)

Move to the middle of the given WebDriverElement.

Extra shift, calculated from the top-left corner of the element, can be set by passing $x_offset and $y_offset parameters.

Parameters

WebDriverElement $element
int $x_offset
int $y_offset

Return Value

WebDriverActions

WebDriverActions release(WebDriverElement|null $element = null)

Release the mouse button.

If $element is provided, move to the middle of the element first.

Parameters

WebDriverElement|null $element

Return Value

WebDriverActions

WebDriverActions keyDown(WebDriverElement|null $element = null, string $key = null)

Press a key on keyboard.

If $element is provided, focus on that element first.

Parameters

WebDriverElement|null $element
string $key

Return Value

WebDriverActions

See also

WebDriverKeys for special keys like CONTROL, ALT, etc.

WebDriverActions keyUp(WebDriverElement|null $element = null, string $key = null)

Release a key on keyboard.

If $element is provided, focus on that element first.

Parameters

WebDriverElement|null $element
string $key

Return Value

WebDriverActions

See also

WebDriverKeys for special keys like CONTROL, ALT, etc.

WebDriverActions sendKeys(WebDriverElement|null $element = null, string $keys = null)

Send keys by keyboard.

If $element is provided, focus on that element first (using single mouse click).

Parameters

WebDriverElement|null $element
string $keys

Return Value

WebDriverActions

See also

WebDriverKeys for special keys like CONTROL, ALT, etc.