DataGrid.php

Go to the documentation of this file.

<?php
namespace Magento\Ui\Test\Block\Adminhtml;

use Magento\Mtf\Client\Locator;
use Magento\Backend\Test\Block\Widget\Grid;
use Magento\Mtf\Client\Element\SimpleElement;

class DataGrid extends Grid
{
    protected $editLink = '.action-menu-item[href*="edit"]';

    protected $appliedFiltersList = '[data-role="filter-list"]';

    protected $filterButton = '[data-action="grid-filter-expand"]';

    protected $selectItem = 'tbody tr [data-action="select-row"]';

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

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

    protected $massActionToggleButton = '//th//button[@data-toggle="dropdown"]';

    protected $massActionToggleList = './/span[contains(@class, "action-menu-item") and .= "%s"]';

    protected $actionButton = '.action-select';

    protected $actionList = './/span[contains(@class, "action-menu-item") and .= "%s"]';

    protected $columnHeader = './/*[@data-role="grid-wrapper"]//th/span[.="%s"]';

    protected $rowById = ".//tr[td//input[@data-action='select-row' and @value='%s']]";

    protected $columnNumber = ".//th[span[.='%s']][not(ancestor::*[@class='sticky-header'])]/preceding-sibling::th";

    protected $cellByHeader = "//td[%s+1]";

    // @codingStandardsIgnoreStart
    private $gridHeader = './/div[@class="admin__data-grid-header"][(not(ancestor::*[@class="sticky-header"]) and not(contains(@style,"visibility: hidden"))) or (ancestor::*[@class="sticky-header" and not(contains(@style,"display: none"))])]';
    // @codingStandardsIgnoreEnd

    protected $fullTextSearchField = '.data-grid-search-control-wrap .data-grid-search-control';

    protected $fullTextSearchButton = '.data-grid-search-control-wrap .action-submit';

    protected $noRecords = '[class$=no-data]';

    protected $alertModal = '._show[data-role=modal]';

    protected $sortLink = './/div[@data-role="grid-wrapper"]//th[contains(@class, "%s")]/span[contains(text(), "%s")]';

    protected $currentPage = ".//*[@data-ui-id='current-page-input'][not(ancestor::*[@class='sticky-header'])]";

    public function resetFilter()
    {
        $chipsHolder = $this->getGridHeaderElement()->find($this->appliedFiltersList);
        if ($chipsHolder->isVisible()) {
            parent::resetFilter();
        }
        $this->waitLoader();
    }

    protected function waitFilterToLoad()
    {
        $this->getTemplateBlock()->waitLoader();
        $browser = $this->_rootElement;
        $selector = $this->filterButton . ', ' . $this->resetButton;
        $browser->waitUntil(
            function () use ($browser, $selector) {
                $filter = $browser->find($selector);
                return $filter->isVisible() == true ? true : null;
            }
        );
    }

    protected function openFilterBlock()
    {
        $this->waitFilterToLoad();

        $toggleFilterButton = $this->_rootElement->find($this->filterButton);
        $searchButton = $this->_rootElement->find($this->searchButton);
        if ($toggleFilterButton->isVisible() && !$searchButton->isVisible()) {
            $toggleFilterButton->click();
            $browser = $this->_rootElement;
            $browser->waitUntil(
                function () use ($searchButton) {
                    return $searchButton->isVisible() ? true : null;
                }
            );
        }
    }

    protected function clickEditLink(SimpleElement $rowItem)
    {
        $rowItem->find($this->editLink)->click();
    }

    public function search(array $filter)
    {
        $this->openFilterBlock();
        parent::search($filter);
        $this->waitForElementNotVisible($this->searchButton);
        $this->waitLoader();
    }

    public function searchAndOpen(array $filter)
    {
        $this->search($filter);
        $rowItem = $this->getRow($filter);
        if ($rowItem->isVisible()) {
            $this->clickEditLink($rowItem);
        } else {
            throw new \Exception("Searched item was not found by filter\n" . print_r($filter, true));
        }
        $this->waitLoader();
    }

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

    public function massaction(array $items, $action, $acceptAlert = false, $massActionSelection = '')
    {
        $this->waitLoader();
        $this->resetFilter();
        if ($this->_rootElement->find($this->noRecords)->isVisible()) {
            return;
        }
        $this->selectItems($items);
        if ($massActionSelection) {
            $this->selectMassAction($massActionSelection);
        }
        $this->selectAction($action);
        if ($acceptAlert) {
            $element = $this->browser->find($this->alertModal);
            $modal = $this->blockFactory->create(
                \Magento\Ui\Test\Block\Adminhtml\Modal::class,
                ['element' => $element]
            );
            $modal->acceptAlert();
        }
    }

    public function selectMassAction($massActionSelection)
    {
        //Checks which dropdown is visible and uses it.
        for ($i = 1; $i <= 2; $i++) {
            $massActionButton = '(' . $this->massActionToggleButton . ")[$i]";
            $massActionList = '(' . $this->massActionToggleList . ")[$i]";
            if ($this->_rootElement->find($massActionButton, Locator::SELECTOR_XPATH)->isVisible()) {
                $this->_rootElement->find($massActionButton, Locator::SELECTOR_XPATH)->click();
                $this->_rootElement
                    ->find(sprintf($massActionList, $massActionSelection), Locator::SELECTOR_XPATH)
                    ->click();
                break;
            }
        }
    }

    public function selectAction($action)
    {
        $actionType = is_array($action) ? key($action) : $action;
        $this->getGridHeaderElement()->find($this->actionButton)->click();
        $toggle = $this->getGridHeaderElement()->find(sprintf($this->actionList, $actionType), Locator::SELECTOR_XPATH);
        $toggle->hover();
        if ($toggle->isVisible() === false) {
            $this->getGridHeaderElement()->find($this->actionButton)->click();
        }
        $toggle->click();
        if (is_array($action)) {
            $locator = sprintf($this->actionList, end($action));
            $this->getGridHeaderElement()->find($locator, Locator::SELECTOR_XPATH)->hover();
            $this->getGridHeaderElement()->find($locator, Locator::SELECTOR_XPATH)->click();
        }
    }

    public function selectItems(array $items, $isSortable = true)
    {
        if ($isSortable) {
            $this->sortGridByField('ID');
        }
        foreach ($items as $item) {
            $this->_rootElement->find($this->currentPage, Locator::SELECTOR_XPATH)->setValue('');
            $this->waitLoader();
            $selectItem = $this->getRow($item)->find($this->selectItem);
            do {
                if ($selectItem->isVisible()) {
                    if (!$selectItem->isSelected()) {
                        $selectItem->click();
                    }
                    break;
                }
            } while ($this->nextPage());
            if (!$selectItem->isVisible()) {
                throw new \Exception("Searched item was not found\n" . print_r($item, true));
            }
        }
    }

    public function sortGridByField($field, $sort = "desc")
    {
        $reverseSort = $sort == 'desc' ? 'asc' : 'desc';
        $sortBlock = $this->_rootElement->find(sprintf($this->sortLink, $reverseSort, $field), Locator::SELECTOR_XPATH);
        if ($sortBlock->isVisible()) {
            $sortBlock->click();
            $this->waitLoader();
        }
    }

    public function sortByColumn($columnLabel)
    {
        $this->waitLoader();
        $this->getTemplateBlock()->waitForElementNotVisible($this->loader);
        $this->_rootElement->find(sprintf($this->columnHeader, $columnLabel), Locator::SELECTOR_XPATH)->click();
        $this->waitLoader();
    }

    public function getFirstItemId()
    {
        $this->waitLoader();
        $this->getTemplateBlock()->waitForElementNotVisible($this->loader);
        return $this->_rootElement->find($this->selectItem)->getValue();
    }

    public function getAllIds()
    {
        $this->waitLoader();
        $this->getTemplateBlock()->waitForElementNotVisible($this->loader);
        $rowsCheckboxes = $this->_rootElement->getElements($this->selectItem);
        $ids = [];
        foreach ($rowsCheckboxes as $checkbox) {
            $ids[] = $checkbox->getValue();
        }
        return $ids;
    }

    public function getColumnValue($id, $headerLabel)
    {
        $this->waitLoader();
        $this->getTemplateBlock()->waitForElementNotVisible($this->loader);
        $columnNumber = count(
            $this->_rootElement->getElements(sprintf($this->columnNumber, $headerLabel), Locator::SELECTOR_XPATH)
        );
        $selector = sprintf($this->rowById, $id) . sprintf($this->cellByHeader, $columnNumber);

        return $this->_rootElement->find($selector, Locator::SELECTOR_XPATH)->getText();
    }

    public function fullTextSearch($text)
    {
        $this->waitLoader();
        $this->getTemplateBlock()->waitForElementNotVisible($this->loader);
        $this->_rootElement->find($this->fullTextSearchField)->setValue($text);
        $this->_rootElement->find($this->fullTextSearchButton)->click();
    }

    public function getRowsData(array $columns)
    {
        $data = [];
        $rows = $this->_rootElement->getElements($this->rowItem);
        foreach ($rows as $row) {
            $rowData = [];
            foreach ($columns as $columnName) {
                $rowData[$columnName] = trim($row->find('div[data-index="' . $columnName . '"]')->getText());
            }

            $data[] = $rowData;
        }

        return $data;
    }

    private function getGridHeaderElement()
    {
        return $this->_rootElement->find($this->gridHeader, Locator::SELECTOR_XPATH);
    }
}