Navigation Class Reference

Inheritance diagram for Navigation:

Public Member Functions
	clearAll ()
	getFilters ()
	applyFilter ($filter, $linkPattern)
	isCategoryVisible (Category $category, $qty)
	getFilterContents ($attributeLabel)

Protected Attributes
	$loadedNarrowByList = '#narrow-by-list[role="tablist"]'
	$clearAll = '.action.clear'
	$optionTitle = './/div[@class="filter-options-title" and contains(text(),"%s")]'
	$filterLink = './/div[@class="filter-options-title" and contains(text(),"%s")]/following-sibling::div//a'
	$expandFilterButton = '[data]'

Detailed Description

Catalog layered navigation view block.

Definition at line 16 of file Navigation.php.

Member Function Documentation

applyFilter()

applyFilter	(		$filter,
			$linkPattern
	)

Apply Layered Navigation filter.

Parameters

string	$filter
string	$linkPattern

Returns

void

Exceptions

Definition at line 103 of file Navigation.php.

    {
        $links = sprintf($this->filterLink, $filter);
        $this->openFilterContainer($filter, $links);

        $links = $this->_rootElement->getElements($links, Locator::SELECTOR_XPATH);
        foreach ($links as $link) {
            if (preg_match($linkPattern, trim($link->getText()))) {
                $link->click();
                return;
            }
        }
        throw new \Exception("Can't find {$filter} filter link by pattern: {$linkPattern}");
    }

clearAll()

clearAll

(

)

Remove all applied filters.

Returns

void

Definition at line 72 of file Navigation.php.

    {
        $this->_rootElement->find($this->clearAll)->click();
    }

getFilterContents()

getFilterContents

(

$attributeLabel

)

Get Layered Navigation filter options.

Parameters

string

$attributeLabel

Returns

array

Definition at line 139 of file Navigation.php.

    {
        $data = [];

        if (trim($attributeLabel) === '') {
            return $data;
        }

        $link = sprintf($this->filterLink, $attributeLabel);
        $this->openFilterContainer($attributeLabel, $link);

        $optionContents = $this->_rootElement->getElements($link, Locator::SELECTOR_XPATH);

        foreach ($optionContents as $optionContent) {
            $data[] = trim(strtoupper($optionContent->getText()));
        }

        return $data;
    }

getFilters()

getFilters

(

)

Get all available filters.

Returns

array

Definition at line 82 of file Navigation.php.

    {
        $this->waitForElementVisible($this->loadedNarrowByList);

        $options = $this->_rootElement->getElements(sprintf($this->optionTitle, ''), Locator::SELECTOR_XPATH);
        $data = [];
        foreach ($options as $option) {
            $data[] = strtoupper($option->getText());
        }

        return $data;
    }

isCategoryVisible()

isCategoryVisible	(	Category	$category,
			$qty
	)

Check that category with product quantity can be displayed on layered navigation.

Parameters

Category	$category
int	$qty

Returns

bool

Definition at line 125 of file Navigation.php.

    {
        return $this->_rootElement->find(
            sprintf($this->categoryName, $category->getName()) . sprintf($this->productQty, $qty),
            Locator::SELECTOR_XPATH
        )->isVisible();
    }

Field Documentation

$clearAll

$clearAll = '.action.clear'

protected

Definition at line 30 of file Navigation.php.

$expandFilterButton

$expandFilterButton = '[data]'

protected

Definition at line 51 of file Navigation.php.

$filterLink

$filterLink = './/div[@class="filter-options-title" and contains(text(),"%s")]/following-sibling::div//a'

protected

Definition at line 44 of file Navigation.php.

$loadedNarrowByList

$loadedNarrowByList = '#narrow-by-list[role="tablist"]'

protected

Definition at line 23 of file Navigation.php.

$optionTitle

$optionTitle = './/div[@class="filter-options-title" and contains(text(),"%s")]'

protected

Definition at line 37 of file Navigation.php.

---

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

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