Locator.md

layout	title
doc	Locator - Codeception - Documentation

Codeception\Util\Locator

Set of useful functions for using CSS and XPath locators. Please check them before writing complex functional or acceptance tests.

combine()

public static combine($selector1, $selector2)

Applies OR operator to any number of CSS or XPath selectors. You can mix up CSS and XPath selectors here.

{% highlight php %}

see('Title', Locator::combine('h1','h2','h3')); ?>

{% endhighlight %}

This will search for Title text in either h1, h2, or h3 tag. You can also combine CSS selector with XPath locator:

{% highlight php %}

fillField(Locator::combine('form input[type=text]','//form/textarea[2]'), 'qwerty'); ?>

{% endhighlight %}

As a result the Locator will produce a mixed XPath value that will be used in fillField action.

• static
• param $selector1
• param $selector2
• throws \Exception
• return string

See source

contains()

public static contains($element, $text)

Locates an element containing a text inside. Either CSS or XPath locator can be passed, however they will be converted to XPath.

{% highlight php %}

tr', -2); // previous than last row {% endhighlight %} * `param string` $element CSS or XPath locator * `param int` $position xpath index * `return` mixed [See source](https://github.com/Codeception/Codeception/blob/4.1/src/Codeception/Util/Locator.php#L318) #### find() *public static* find($element, array $attributes) Finds element by it's attribute(s) {% highlight php %} seeElement(Locator::find('img', ['title' => 'diagram'])); {% endhighlight %} * `static` * `param` $element * `param` $attributes * `return` string [See source](https://github.com/Codeception/Codeception/blob/4.1/src/Codeception/Util/Locator.php#L159) #### firstElement() *public static* firstElement($element) Locates first element of group elements. Either CSS or XPath locator can be passed as locator, Equal to `Locator::elementAt($locator, 1)` {% highlight php %} see('Log In', Locator::href('/login.php')); ?>

{% endhighlight %}

• static
• param $url
• return string

See source

humanReadableString()

public static humanReadableString($selector)

Transforms strict locator, \Facebook\WebDriver\WebDriverBy into a string represenation

• param $selector
• return string

See source

isCSS()

public static isCSS($selector)

Checks that provided string is CSS selector

{% highlight php %}

true Locator::isCSS('body') => true Locator::isCSS('//body/p/user') => false {% endhighlight %} * `param` $selector * `return` bool [See source](https://github.com/Codeception/Codeception/blob/4.1/src/Codeception/Util/Locator.php#L186) #### isClass() *public static* isClass($class) Checks that a string is valid CSS class {% highlight php %} true Locator::isClass('body') => false Locator::isClass('//body/p/user') => false {% endhighlight %} * `param` $class * `return` bool [See source](https://github.com/Codeception/Codeception/blob/4.1/src/Codeception/Util/Locator.php#L270) #### isID() *public static* isID($id) Checks that a string is valid CSS ID {% highlight php %} true Locator::isID('body') => false Locator::isID('//body/p/user') => false {% endhighlight %} * `param` $id * `return` bool [See source](https://github.com/Codeception/Codeception/blob/4.1/src/Codeception/Util/Locator.php#L252) #### isPrecise() *public static* isPrecise($locator) * `param` $locator * `return` bool [See source](https://github.com/Codeception/Codeception/blob/4.1/src/Codeception/Util/Locator.php#L221) #### isXPath() *public static* isXPath($locator) Checks that locator is an XPath {% highlight php %} false Locator::isXPath('body') => false Locator::isXPath('//body/p/user') => true {% endhighlight %} * `param` $locator * `return` bool [See source](https://github.com/Codeception/Codeception/blob/4.1/src/Codeception/Util/Locator.php#L210) #### lastElement() *public static* lastElement($element) Locates last element of group elements. Either CSS or XPath locator can be passed as locator, Equal to `Locator::elementAt($locator, -1)` {% highlight php %} seeElement(Locator::option('Male'), '#select-gender'); {% endhighlight %} * `param` $value * `return` string [See source](https://github.com/Codeception/Codeception/blob/4.1/src/Codeception/Util/Locator.php#L124) #### tabIndex() *public static* tabIndex($index) Matches the element with given tab index Do you often use the `TAB` key to navigate through the web page? How do your site respond to this navigation? You could try to match elements by their tab position using `tabIndex` method of `Locator` class. {% highlight php %} fillField(Locator::tabIndex(1), 'davert'); $I->fillField(Locator::tabIndex(2) , 'qwerty'); $I->click('Login'); ?>

{% endhighlight %}

• static
• param $index
• return string

See source

 

Reference is taken from the source code. Help us to improve documentation. Edit module reference