1. class
  2. QATools
  3. QATools
  4. PageObject
  5. Element
  6. AbstractElementContainer

AbstractElementContainer

class AbstractElementContainer extends WebElement implements IElementContainer (View source)

The base class to be used for making blocks of elements.

To make a class that will represent a block of elements (e.g. web form) create a descendant of this class.

Properties

private NodeElement $_wrappedElement Wrapped element. from WebElement
private IPageFactory $_pageFactory Stores instance of used page factory. from WebElement
private Escaper $_xpathEscaper The XPath escaper. from WebElement

Methods

__construct(NodeElement $wrapped_element, IPageFactory $page_factory)

Initializes html element.

static INodeElementAware
fromNodeElement(NodeElement $node_element, IPageFactory $page_factory)

Creates Element instance based on existing NodeElement instance.

NodeElement|null
find(string $selector, string|array $locator)

Finds first element with specified selector.

from WebElement
NodeElement[]
findAll(string $selector, string|array $locator)

Finds all elements with specified selector.

from WebElement
mixed
waitFor(integer $timeout, callable $callback)

Waits for an element(-s) to appear and returns it.

from WebElement
mixed
__call(string $method, array $arguments)

Proxies all methods to sub-object.

from WebElement
Escaper
getXpathEscaper()

Returns the XPath escaper.

from WebElement
Session
getSession() deprecated

Returns element session.

from WebElement
IPageFactory
getPageFactory()

Returns page factory, used during object creation.

from WebElement
string
__toString()

Returns string representation of element.

from WebElement
Expectation
shouldReceive(string $name)

No description

from WebElement
string
getXpath()

Returns XPath for handled element.

from WebElement
NodeElement
getParent()

Returns parent element to the current one.

from WebElement
string
getTagName()

Returns current node tag name.

from WebElement
string|boolean|array
getValue()

Returns the value of the form field or option element.

from WebElement
void
setValue($value)

Sets the value of the form field.

from WebElement
boolean
hasAttribute($name)

Checks whether element has attribute with specified name.

from WebElement
string|null
getAttribute($name)

Returns specified attribute value.

from WebElement
boolean
hasClass($className)

Checks whether an element has a named CSS class.

from WebElement
void
click()

Clicks current node.

from WebElement
void
press()

Presses current button.

from WebElement
void
doubleClick()

Double-clicks current node.

from WebElement
void
rightClick()

Right-clicks current node.

from WebElement
void
check()

Checks current node if it's a checkbox field.

from WebElement
void
uncheck()

Unchecks current node if it's a checkbox field.

from WebElement
boolean
isChecked()

Checks whether current node is checked if it's a checkbox or radio field.

from WebElement
void
selectOption($option, $multiple = false)

Selects specified option for select field or specified radio button in the group.

from WebElement
boolean
isSelected()

Checks whether current node is selected if it's a option field.

from WebElement
void
attachFile($path)

Attach file to current node if it's a file input.

from WebElement
boolean
isVisible()

Checks whether current node is visible on page.

from WebElement
void
mouseOver()

Simulates a mouse over on the element.

from WebElement
void
dragTo(ElementInterface $destination)

Drags current node onto other node.

from WebElement
void
focus()

Brings focus to element.

from WebElement
void
blur()

Removes focus from element.

from WebElement
void
keyPress($char, $modifier = null)

Presses specific keyboard key.

from WebElement
void
keyDown($char, $modifier = null)

Pressed down specific keyboard key.

from WebElement
void
keyUp($char, $modifier = null)

Pressed up specific keyboard key.

from WebElement
void
submit()

Submits the form.

from WebElement
NodeElement|null
findById($id)

Finds element by its id.

from WebElement
boolean
hasLink($locator)

Checks whether element has a link with specified locator.

from WebElement
NodeElement|null
findLink($locator)

Finds link with specified locator.

from WebElement
void
clickLink($locator)

Clicks link with specified locator.

from WebElement
boolean
hasButton($locator)

Checks whether element has a button (input[type=submit|image|button|reset], button) with specified locator.

from WebElement
NodeElement|null
findButton($locator)

Finds button (input[type=submit|image|button|reset], button) with specified locator.

from WebElement
void
pressButton($locator)

Presses button (input[type=submit|image|button|reset], button) with specified locator.

from WebElement
boolean
hasField($locator)

Checks whether element has a field (input, textarea, select) with specified locator.

from WebElement
NodeElement|null
findField($locator)

Finds field (input, textarea, select) with specified locator.

from WebElement
void
fillField($locator, $value)

Fills in field (input, textarea, select) with specified locator.

from WebElement
boolean
hasCheckedField($locator)

Checks whether element has a checkbox with specified locator, which is checked.

from WebElement
boolean
hasUncheckedField($locator)

Checks whether element has a checkbox with specified locator, which is unchecked.

from WebElement
void
checkField($locator)

Checks checkbox with specified locator.

from WebElement
void
uncheckField($locator)

Unchecks checkbox with specified locator.

from WebElement
boolean
hasSelect($locator)

Checks whether element has a select field with specified locator.

from WebElement
void
selectFieldOption($locator, $value, $multiple = false)

Selects option from select field with specified locator.

from WebElement
boolean
hasTable($locator)

Checks whether element has a table with specified locator.

from WebElement
void
attachFileToField($locator, $path)

Attach file to file field with specified locator.

from WebElement
boolean
has($selector, $locator)

Checks whether element with specified selector exists inside the current element.

from WebElement
boolean
isValid()

Checks if an element still exists in the DOM.

from WebElement
string
getText()

Returns element text (inside tag).

from WebElement
string
getHtml()

Returns element inner html.

from WebElement
string
getOuterHtml()

Returns element outer html.

from WebElement

Details

at line 33
__construct(NodeElement $wrapped_element, IPageFactory $page_factory)

Initializes html element.

Parameters

NodeElement $wrapped_element Wrapped element.
IPageFactory $page_factory Page factory.

at line 49
static INodeElementAware fromNodeElement(NodeElement $node_element, IPageFactory $page_factory)

Creates Element instance based on existing NodeElement instance.

Parameters

NodeElement $node_element Node element.
IPageFactory $page_factory Page factory.

Return Value

INodeElementAware

in WebElement at line 137
NodeElement|null find(string $selector, string|array $locator)

Finds first element with specified selector.

Parameters

string $selector Selector engine name.
string|array $locator Selector locator.

Return Value

NodeElement|null

in WebElement at line 150
NodeElement[] findAll(string $selector, string|array $locator)

Finds all elements with specified selector.

Parameters

string $selector Selector engine name.
string|array $locator Selector locator.

Return Value

NodeElement[]

in WebElement at line 164
mixed waitFor(integer $timeout, callable $callback)

Waits for an element(-s) to appear and returns it.

Parameters

integer $timeout Maximal allowed waiting time in seconds.
callable $callback Callback, which result is both used as waiting condition and returned. Will receive reference to this element as first argument.

Return Value

mixed

in WebElement at line 178
mixed __call(string $method, array $arguments)

Proxies all methods to sub-object.

Parameters

string $method Method to proxy.
array $arguments Method arguments.

Return Value

mixed

Exceptions

ElementException When sub-object doesn't have a specified method.

in WebElement at line 194
Escaper getXpathEscaper()

Returns the XPath escaper.

Return Value

Escaper

in WebElement at line 205
Session getSession() deprecated

deprecated Accessing the session from the element is deprecated as of 1.2 and will be impossible in 2.0.

Returns element session.

Return Value

Session

in WebElement at line 220
protected IPageFactory getPageFactory()

Returns page factory, used during object creation.

Return Value

IPageFactory

in WebElement at line 230
string __toString()

Returns string representation of element.

Return Value

string

in WebElement at line 79
Expectation shouldReceive(string $name)

Parameters

string $name

Return Value

Expectation

in WebElement at line 79
string getXpath()

Returns XPath for handled element.

Return Value

string

in WebElement at line 79
NodeElement getParent()

Returns parent element to the current one.

Return Value

NodeElement

in WebElement at line 79
string getTagName()

Returns current node tag name.

Return Value

string

in WebElement at line 79
string|boolean|array getValue()

Returns the value of the form field or option element.

Return Value

string|boolean|array

in WebElement at line 79
void setValue($value)

Sets the value of the form field.

Parameters

$value

Return Value

void

in WebElement at line 79
boolean hasAttribute($name)

Checks whether element has attribute with specified name.

Parameters

$name

Return Value

boolean

in WebElement at line 79
string|null getAttribute($name)

Returns specified attribute value.

Parameters

$name

Return Value

string|null

in WebElement at line 79
boolean hasClass($className)

Checks whether an element has a named CSS class.

Parameters

$className

Return Value

boolean

in WebElement at line 79
void click()

Clicks current node.

Return Value

void

in WebElement at line 79
void press()

Presses current button.

Return Value

void

in WebElement at line 79
void doubleClick()

Double-clicks current node.

Return Value

void

in WebElement at line 79
void rightClick()

Right-clicks current node.

Return Value

void

in WebElement at line 79
void check()

Checks current node if it's a checkbox field.

Return Value

void

in WebElement at line 79
void uncheck()

Unchecks current node if it's a checkbox field.

Return Value

void

in WebElement at line 79
boolean isChecked()

Checks whether current node is checked if it's a checkbox or radio field.

Return Value

boolean

in WebElement at line 79
void selectOption($option, $multiple = false)

Selects specified option for select field or specified radio button in the group.

Parameters

$option
$multiple

Return Value

void

in WebElement at line 79
boolean isSelected()

Checks whether current node is selected if it's a option field.

Return Value

boolean

in WebElement at line 79
void attachFile($path)

Attach file to current node if it's a file input.

Parameters

$path

Return Value

void

in WebElement at line 79
boolean isVisible()

Checks whether current node is visible on page.

Return Value

boolean

in WebElement at line 79
void mouseOver()

Simulates a mouse over on the element.

Return Value

void

in WebElement at line 79
void dragTo(ElementInterface $destination)

Drags current node onto other node.

Parameters

ElementInterface $destination

Return Value

void

in WebElement at line 79
void focus()

Brings focus to element.

Return Value

void

in WebElement at line 79
void blur()

Removes focus from element.

Return Value

void

in WebElement at line 79
void keyPress($char, $modifier = null)

Presses specific keyboard key.

Parameters

$char
$modifier

Return Value

void

in WebElement at line 79
void keyDown($char, $modifier = null)

Pressed down specific keyboard key.

Parameters

$char
$modifier

Return Value

void

in WebElement at line 79
void keyUp($char, $modifier = null)

Pressed up specific keyboard key.

Parameters

$char
$modifier

Return Value

void

in WebElement at line 79
void submit()

Submits the form.

Return Value

void

in WebElement at line 79
NodeElement|null findById($id)

Finds element by its id.

Parameters

$id

Return Value

NodeElement|null

Checks whether element has a link with specified locator.

Parameters

$locator

Return Value

boolean

Finds link with specified locator.

Parameters

$locator

Return Value

NodeElement|null

Clicks link with specified locator.

Parameters

$locator

Return Value

void

in WebElement at line 79
boolean hasButton($locator)

Checks whether element has a button (input[type=submit|image|button|reset], button) with specified locator.

Parameters

$locator

Return Value

boolean

in WebElement at line 79
NodeElement|null findButton($locator)

Finds button (input[type=submit|image|button|reset], button) with specified locator.

Parameters

$locator

Return Value

NodeElement|null

in WebElement at line 79
void pressButton($locator)

Presses button (input[type=submit|image|button|reset], button) with specified locator.

Parameters

$locator

Return Value

void

in WebElement at line 79
boolean hasField($locator)

Checks whether element has a field (input, textarea, select) with specified locator.

Parameters

$locator

Return Value

boolean

in WebElement at line 79
NodeElement|null findField($locator)

Finds field (input, textarea, select) with specified locator.

Parameters

$locator

Return Value

NodeElement|null

in WebElement at line 79
void fillField($locator, $value)

Fills in field (input, textarea, select) with specified locator.

Parameters

$locator
$value

Return Value

void

in WebElement at line 79
boolean hasCheckedField($locator)

Checks whether element has a checkbox with specified locator, which is checked.

Parameters

$locator

Return Value

boolean

in WebElement at line 79
boolean hasUncheckedField($locator)

Checks whether element has a checkbox with specified locator, which is unchecked.

Parameters

$locator

Return Value

boolean

in WebElement at line 79
void checkField($locator)

Checks checkbox with specified locator.

Parameters

$locator

Return Value

void

in WebElement at line 79
void uncheckField($locator)

Unchecks checkbox with specified locator.

Parameters

$locator

Return Value

void

in WebElement at line 79
boolean hasSelect($locator)

Checks whether element has a select field with specified locator.

Parameters

$locator

Return Value

boolean

in WebElement at line 79
void selectFieldOption($locator, $value, $multiple = false)

Selects option from select field with specified locator.

Parameters

$locator
$value
$multiple

Return Value

void

in WebElement at line 79
boolean hasTable($locator)

Checks whether element has a table with specified locator.

Parameters

$locator

Return Value

boolean

in WebElement at line 79
void attachFileToField($locator, $path)

Attach file to file field with specified locator.

Parameters

$locator
$path

Return Value

void

in WebElement at line 79
boolean has($selector, $locator)

Checks whether element with specified selector exists inside the current element.

Parameters

$selector
$locator

Return Value

boolean

in WebElement at line 79
boolean isValid()

Checks if an element still exists in the DOM.

Return Value

boolean

in WebElement at line 79
string getText()

Returns element text (inside tag).

Return Value

string

in WebElement at line 79
string getHtml()

Returns element inner html.

Return Value

string

in WebElement at line 79
string getOuterHtml()

Returns element outer html.

Return Value

string