Grid Class Reference

Inheritance diagram for Grid:

Public Member Functions
	search (array $filter)
	searchAndOpen (array $filter)
	searchAndSelect (array $filter)
	resetFilter ()
	massaction (array $items, $action, $acceptAlert=false, $massActionSelection='')
	getRowsData (array $columns)
	isRowVisible (array $filter, $isSearchable=true, $isStrict=true)
	sortGridByField ($field, $sort="desc")
	isFirstRowVisible ()
	openFirstRow ()

Protected Member Functions
	getTemplateBlock ()
	prepareForSearch (array $filters)
	waitLoader ()
	getRow (array $filter, $isStrict=true)
	nextPage ()
	xpathEscape ($query, $defaultDelim='"')

Protected Attributes
	$filters = []
	$searchButton = '[data-action="grid-filter-apply"]'
	$sortLink = "[name='%s'][title='%s']"
	$resetButton = '[data-action="grid-filter-reset"]'
	$rowItem = 'tbody tr'
	$lastRowItem = 'tbody tr:last-child'
	$editLink = 'td[class*=col-action] a'
	$selectItem = 'tbody tr [type="checkbox"]'
	$selectAll = '.massaction a[onclick*=".selectAll()"]'
	$massactionSelect = '[id*=massaction-select]'
	$massactionAction = '[data-menu="grid-mass-select"]'
	$massactionSubmit = '[id*=massaction-form] button'
	$templateBlock = './ancestor::body'
	$waitForSelectorType = Locator::SELECTOR_CSS
	$waitForSelectorVisible = true
	$option = '[name="status"]'
	$active = '[class=*_active]'
	$rowTemplate = 'td[contains(.,normalize-space("%s"))]'
	$rowTemplateStrict = 'td[text()[normalize-space()="%s"]]'
	$loader = '[data-role="spinner"]'
	$actionNextPage = '[class*=data-grid-pager] .action-next'
	$actionNextPageDisabled = '[class*=data-grid-pager] .action-next.disabled'
	$firstRowSelector = ''
	$noRecords = '.empty-text'
	$rowPattern = '//tbody/tr[%s]'
	$confirmModal = '.confirm._show[data-role=modal]'

Detailed Description

Abstract class Grid Basic grid actions

@SuppressWarnings(PHPMD.NumberOfChildren) @SuppressWarnings(PHPMD.TooManyFields)

Definition at line 21 of file Grid.php.

Member Function Documentation

getRow()

getRow ( array  $filter,   $isStrict = true  )

protected

Obtain specific row in grid

Parameters

array	$filter
bool	$isStrict

Returns

SimpleElement

Definition at line 369 of file Grid.php.

    {
        $rowTemplate = ($isStrict) ? $this->rowTemplateStrict : $this->rowTemplate;
        $rows = [];
        foreach ($filter as $value) {
            if (strpos($value, '"') !== false) {
                $rowTemplate = str_replace('"', '', $rowTemplate);
                $value = $this->xpathEscape($value);
            }
            $rows[] = sprintf($rowTemplate, $value);
        }
        $location = sprintf($this->rowPattern, implode(' and ', $rows));
        return $this->_rootElement->find($location, Locator::SELECTOR_XPATH);
    }

getRowsData()

getRowsData

(

array

$columns

)

Get rows data

Parameters

array

$columns

Returns

array

Definition at line 390 of file Grid.php.

    {
        $data = [];
        do {
            $rows = $this->_rootElement->getElements($this->rowItem);
            foreach ($rows as $row) {
                $rowData = [];
                foreach ($columns as $columnName) {
                    $rowData[$columnName] = trim($row->find('.col-' . $columnName)->getText());
                }

                $data[] = $rowData;
            }
        } while ($this->nextPage());

        return $data;
    }

getTemplateBlock()

getTemplateBlock ( )

protected

Get backend abstract block

Returns

\Magento\Backend\Test\Block\Template

Definition at line 210 of file Grid.php.

    {
        return Factory::getBlockFactory()->getMagentoBackendTemplate(
            $this->_rootElement->find($this->templateBlock, Locator::SELECTOR_XPATH)
        );
    }

isFirstRowVisible()

isFirstRowVisible

(

)

Check whether first row is visible

Returns

bool

Definition at line 461 of file Grid.php.

    {
        return $this->_rootElement->find($this->firstRowSelector, Locator::SELECTOR_XPATH)->isVisible();
    }

isRowVisible()

isRowVisible	(	array	$filter,
			$isSearchable = true,
			$isStrict = true
	)

Check if specific row exists in grid

Parameters

array	$filter
bool	$isSearchable
bool	$isStrict

Returns

bool

Definition at line 416 of file Grid.php.

    {
        $this->waitLoader();
        if ($isSearchable) {
            $this->search($filter);
        }

        return $this->getRow($filter, $isStrict)->isVisible();
    }

massaction()

massaction	(	array	$items,
			$action,
			$acceptAlert = false,
			$massActionSelection = ''
	)

Perform selected massaction over checked items.

Parameters

array	$items
array | string	$action	[array -> key = value from first select; value => value from subselect]
bool	$acceptAlert	[optional]
string	$massActionSelection	[optional]

Returns

void

Definition at line 319 of file Grid.php.

    {
        if ($this->_rootElement->find($this->noRecords)->isVisible()) {
            return;
        }
        if (!is_array($action)) {
            $action = [$action => '-'];
        }
        foreach ($items as $item) {
            $this->searchAndSelect($item);
        }
        if ($massActionSelection) {
            $this->_rootElement->find($this->massactionAction, Locator::SELECTOR_CSS, 'select')
                ->setValue($massActionSelection);
        }
        $actionType = key($action);
        $this->_rootElement->find($this->massactionSelect, Locator::SELECTOR_CSS, 'select')->setValue($actionType);
        if (isset($action[$actionType]) && $action[$actionType] != '-') {
            $this->_rootElement->find($this->option, Locator::SELECTOR_CSS, 'select')->setValue($action[$actionType]);
        }
        $this->massActionSubmit($acceptAlert);
    }

nextPage()

nextPage ( )

protected

Click to next page action link

Returns

bool

Definition at line 446 of file Grid.php.

    {
        if ($this->_rootElement->find($this->actionNextPageDisabled)->isVisible()) {
            return false;
        }
        $this->_rootElement->find($this->actionNextPage)->click();
        $this->waitLoader();
        return true;
    }

openFirstRow()

openFirstRow

(

)

Open first item in grid

Returns

void

Definition at line 471 of file Grid.php.

    {
        $this->waitLoader();
        $this->_rootElement->find($this->firstRowSelector, Locator::SELECTOR_XPATH)->click();
    }

prepareForSearch()

prepareForSearch ( array  $filters )

protected

Prepare data to perform search, fill in search filter

Parameters

array

$filters

Exceptions

Definition at line 223 of file Grid.php.

    {
        foreach ($filters as $key => $value) {
            if (isset($this->filters[$key])) {
                $selector = $this->filters[$key]['selector'];
                $strategy = isset($this->filters[$key]['strategy'])
                    ? $this->filters[$key]['strategy']
                    : Locator::SELECTOR_CSS;
                $typifiedElement = isset($this->filters[$key]['input'])
                    ? $this->filters[$key]['input']
                    : null;
                $this->_rootElement->find($selector, $strategy, $typifiedElement)->setValue($value);
            } else {
                throw new \Exception("Column $key is absent in the grid or not described yet.");
            }
        }
    }

resetFilter()

resetFilter

(

)

Press 'Reset' button

Definition at line 303 of file Grid.php.

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

search()

search

(

array

$filter

)

Search item via grid filter

Parameters

array

$filter

Definition at line 246 of file Grid.php.

    {
        $this->resetFilter();
        $this->prepareForSearch($filter);
        $this->_rootElement->find($this->searchButton, Locator::SELECTOR_CSS)->click();
        $this->waitLoader();
    }

searchAndOpen()

searchAndOpen

(

array

$filter

)

Search item and open it

Parameters

array

$filter

Exceptions

Definition at line 260 of file Grid.php.

    {
        $this->search($filter);
        $rowItem = $this->getRow($filter);
        if ($rowItem->isVisible()) {
            $rowItem->find($this->editLink, Locator::SELECTOR_CSS)->click();
        } else {
            throw new \Exception("Searched item was not found by filter\n" . print_r($filter, true));
        }
        $this->waitLoader();
    }

searchAndSelect()

searchAndSelect

(

array

$filter

)

Search for item and select it

Parameters

array

$filter

Exceptions

Definition at line 289 of file Grid.php.

    {
        $this->search($filter);
        $selectItem = $this->getRow($filter)->find($this->selectItem);
        if ($selectItem->isVisible()) {
            $selectItem->click();
        } else {
            throw new \Exception("Searched item was not found by filter\n" . print_r($filter, true));
        }
    }

sortGridByField()

sortGridByField	(		$field,
			$sort = "desc"
	)

Sort grid by field

Parameters

	$field
string	$sort

Definition at line 432 of file Grid.php.

    {
        $sortBlock = $this->_rootElement->find(sprintf($this->sortLink, $field, $sort));
        if ($sortBlock->isVisible()) {
            $sortBlock->click();
            $this->waitLoader();
        }
    }

waitLoader()

waitLoader ( )

protected

Wait loader

Returns

void

Definition at line 277 of file Grid.php.

    {
        $this->waitForElementNotVisible($this->loader);
        $this->getTemplateBlock()->waitLoader();
    }

xpathEscape()

xpathEscape (   $query,   $defaultDelim = '"'  )

protected

Escape single and/or double quotes in XPath selector by concat()

Parameters

string	$query
string	$defaultDelim	[optional]

Returns

string

Definition at line 484 of file Grid.php.

    {
        if (strpos($query, $defaultDelim) === false) {
            return $defaultDelim . $query . $defaultDelim;
        }
        preg_match_all("#(?:('+)|[^']+)#", $query, $matches);
        list($parts, $apos) = $matches;
        $delim = '';
        foreach ($parts as $i => &$part) {
            $delim = $apos[$i] ? '"' : "'";
            $part = $delim . $part . $delim;
        }
        if (count($parts) == 1) {
            $parts[] = $delim . $delim;
        }

        return 'concat(' . implode(',', $parts) . ')';
    }

Field Documentation

$actionNextPage

$actionNextPage = '[class*=data-grid-pager] .action-next'

protected

Definition at line 168 of file Grid.php.

$actionNextPageDisabled

$actionNextPageDisabled = '[class*=data-grid-pager] .action-next.disabled'

protected

Definition at line 175 of file Grid.php.

$active

$active = '[class=*_active]'

protected

Definition at line 140 of file Grid.php.

$confirmModal

$confirmModal = '.confirm._show[data-role=modal]'

protected

Definition at line 203 of file Grid.php.

$editLink

$editLink = 'td[class*=col-action] a'

protected

Definition at line 70 of file Grid.php.

$filters

$filters = []

protected

Definition at line 28 of file Grid.php.

$firstRowSelector

$firstRowSelector = ''

protected

Definition at line 182 of file Grid.php.

$lastRowItem

$lastRowItem = 'tbody tr:last-child'

protected

Definition at line 63 of file Grid.php.

$loader

$loader = '[data-role="spinner"]'

protected

Definition at line 161 of file Grid.php.

$massactionAction

$massactionAction = '[data-menu="grid-mass-select"]'

protected

Definition at line 98 of file Grid.php.

$massactionSelect

$massactionSelect = '[id*=massaction-select]'

protected

Definition at line 91 of file Grid.php.

$massactionSubmit

$massactionSubmit = '[id*=massaction-form] button'

protected

Definition at line 105 of file Grid.php.

$noRecords

$noRecords = '.empty-text'

protected

Definition at line 189 of file Grid.php.

$option

$option = '[name="status"]'

protected

Definition at line 133 of file Grid.php.

$resetButton

$resetButton = '[data-action="grid-filter-reset"]'

protected

Definition at line 49 of file Grid.php.

$rowItem

$rowItem = 'tbody tr'

protected

Definition at line 56 of file Grid.php.

$rowPattern

$rowPattern = '//tbody/tr[%s]'

protected

Definition at line 196 of file Grid.php.

$rowTemplate

$rowTemplate = 'td[contains(.,normalize-space("%s"))]'

protected

Definition at line 147 of file Grid.php.

$rowTemplateStrict

$rowTemplateStrict = 'td[text()[normalize-space()="%s"]]'

protected

Definition at line 154 of file Grid.php.

$searchButton

$searchButton = '[data-action="grid-filter-apply"]'

protected

Definition at line 35 of file Grid.php.

$selectAll

$selectAll = '.massaction a[onclick*=".selectAll()"]'

protected

Definition at line 84 of file Grid.php.

$selectItem

$selectItem = 'tbody tr [type="checkbox"]'

protected

Definition at line 77 of file Grid.php.

$sortLink

$sortLink = "[name='%s'][title='%s']"

protected

Definition at line 42 of file Grid.php.

$templateBlock

$templateBlock = './ancestor::body'

protected

Definition at line 112 of file Grid.php.

$waitForSelectorType

$waitForSelectorType = Locator::SELECTOR_CSS

protected

Definition at line 119 of file Grid.php.

$waitForSelectorVisible

$waitForSelectorVisible = true

protected

Definition at line 126 of file Grid.php.

---

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

• vendor/magento/magento2-base/dev/tests/functional/tests/app/Magento/Backend/Test/Block/Widget/Grid.php