Search Class Reference

Inheritance diagram for Search:

Public Member Functions
	search ($keyword, $length=null)
	fillSearch ($text)
	waitUntilSearchPrepared ()
	isPlaceholderContains ($placeholderText)
	isSuggestSearchVisible ($text, $amount=null)
	clickSuggestedText ($text)

Protected Attributes
	$searchAutocomplete = './/div[@id="search_autocomplete"]//li[span[text()[normalize-space()="%s"]]]'
	$searchItemAmount = '/span[contains(@class,"amount") and text()="%d"]'
	$searchInput = '#search'
	$placeholder = '//input[@id="search" and contains(@placeholder, "%s")]'

Detailed Description

Class Search Block for "Search" section

Definition at line 16 of file Search.php.

Member Function Documentation

clickSuggestedText()

clickSuggestedText

(

$text

)

Click on suggested text.

Parameters

string

$text

Returns

void

Definition at line 155 of file Search.php.

    {
        $searchAutocomplete = sprintf($this->searchAutocomplete, $text);
        $this->_rootElement->find($searchAutocomplete, Locator::SELECTOR_XPATH)->click();
    }

fillSearch()

fillSearch

(

$text

)

Fill "Search" field with correspondent text.

Parameters

string

$text

Returns

void

Definition at line 89 of file Search.php.

    {
        $this->_rootElement->find($this->searchInput)->setValue($text);
        $this->waitUntilSearchPrepared();
    }

isPlaceholderContains()

isPlaceholderContains

(

$placeholderText

)

Check if placeholder contains correspondent text or not.

Parameters

string

$placeholderText

Returns

bool

Definition at line 121 of file Search.php.

    {
        $field = $this->_rootElement->find(sprintf($this->placeholder, $placeholderText), Locator::SELECTOR_XPATH);
        return $field->isVisible();
    }

isSuggestSearchVisible()

isSuggestSearchVisible	(		$text,
			$amount = null
	)

Check if "Suggest Search" block visible or not.

Parameters

string	$text
int | null	$amount

Returns

bool

Definition at line 134 of file Search.php.

    {
        $searchAutocomplete = sprintf($this->searchAutocomplete, $text);
        if ($amount !== null) {
            $searchAutocomplete .= sprintf($this->searchItemAmount, $amount);
        }

        $rootElement = $this->_rootElement;
        return (bool)$this->_rootElement->waitUntil(
            function () use ($rootElement, $searchAutocomplete) {
                return $rootElement->find($searchAutocomplete, Locator::SELECTOR_XPATH)->isVisible() ? true : null;
            }
        );
    }

search()

search	(		$keyword,
			$length = null
	)

Perform search by a keyword.

Parameters

string	$keyword
string | null	$length

Returns

void

Definition at line 74 of file Search.php.

    {
        if ($length) {
            $keyword = substr($keyword, 0, $length);
        }
        $this->fillSearch($keyword);
        $this->_rootElement->find($this->searchButton)->click();
    }

waitUntilSearchPrepared()

waitUntilSearchPrepared

(

)

Wait until "Suggest Search" block will be prepared.

Returns

bool

Definition at line 100 of file Search.php.

    {
        $this->browser->waitUntil(
            function () {
                $count = count($this->_rootElement->getElements($this->searchListItems, Locator::SELECTOR_XPATH));
                usleep(200);
                $newCount = count($this->_rootElement->getElements($this->searchListItems, Locator::SELECTOR_XPATH));
                return $this->browser->find($this->selectorAriaBusy, Locator::SELECTOR_XPATH)->isVisible()
                    && ($newCount == $count)
                    ? true
                    : null;
            }
        );
    }

Field Documentation

$placeholder

$placeholder = '//input[@id="search" and contains(@placeholder, "%s")]'

protected

Definition at line 51 of file Search.php.

$searchAutocomplete

$searchAutocomplete = './/div[@id="search_autocomplete"]//li[span[text()[normalize-space()="%s"]]]'

protected

Definition at line 23 of file Search.php.

$searchInput

$searchInput = '#search'

protected

Definition at line 37 of file Search.php.

$searchItemAmount

$searchItemAmount = '/span[contains(@class,"amount") and text()="%d"]'

protected

Definition at line 30 of file Search.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/dev/tests/functional/tests/app/Magento/Catalog/Test/Block/Search.php