Magento 2: Создание грида в adminhtml19.09.2016 19:48

Краткая памятка по созданию гридов в админке Magento 2. В качестве примера я взял простой грид из трех колонок, данные для которого (коды стран по ISO 3166) поставляются из прописанного в коде массива. Для того, чтобы сфокусироваться на основных аспектах построения грида я отбросил из дескриптора UI-компонента максимум возможного (дополнительные кнопки, фильтры, сортировка, bookmarks, …) и часть настроек перенес в конструктор провайдера данных для грида. Если можно сделать еще короче без потери читабельности — с максимальным удовлетворением внесу соответствующие правки. Код примера на github’е — flancer32/sample_mage2_admin_grid.


adfa4b09eed6443aac0033fabcbd6369.png

ACL


Создаем запись в ACL (./etc/acl.xml) для контроля доступа к гриду:

Menu


Добавляем в меню админки (./etc/adminhtml/menu.xml) дополнительные пункты:

Адрес перенаправления определяется в action="...", доступ к пунктам меню — в resource="...".


Routes


В файле ./etc/adminhtml/routes.xml регистрируем маршурт fl32_sample_route (внутренний идентификатор) с именем sample (видимый идентификатор, часть URL’а):

Controller


Обработчики запросов по адресу .../index.php/admin/sample/grid/* размещаем в каталоге ./src/Controller/Adminhtml/Grid/. Обработчик по-умолчанию: Index.php: 


namespace Flancer32\Sample\Controller\Adminhtml\Grid;

class Index
    extends \Magento\Backend\App\Action
{
    const ACL_RESOURCE = 'Flancer32_Sample::sample_grid';
    const MENU_ITEM = 'Flancer32_Sample::sample_grid';
    const TITLE = 'Sample Grid';

    protected $_resultPageFactory;

    public function __construct(
        \Magento\Backend\App\Action\Context $context,
        \Magento\Framework\View\Result\PageFactory $resultPageFactory
    ) {
        parent::__construct($context);
        $this->_resultPageFactory = $resultPageFactory;
    }

    protected function _isAllowed()
    {
        $result = $this->_authorization->isAllowed(self::ACL_RESOURCE);
        return $result;
    }

    public function execute()
    {
        /** @var \Magento\Backend\Model\View\Result\Page $resultPage */
        $resultPage = $this->_resultPageFactory->create();
        $resultPage->setActiveMenu(self::MENU_ITEM);
        $resultPage->getConfig()->getTitle()->prepend(__(self::TITLE));
        return $resultPage;
    }
}

Все, что делает обработчик — проверяет права пользователя на доступ к гриду и формирует страницу в соответствии с заданным для данного маршрута laout’ом.


Layout


Описание layout’а находится в каталоге ./src/view/adminhtml/layout/ в файле fl32_sample_route_grid_index, название которого состоит из трех частей:


  • fl32_sample_route: внтуренний идентификатор маршрута (см. route.id в ./etc/adminhtml/routes.xml);
  • grid: вторая часть адреса перенаправления (см. action в ./etc/adminhtml/menu.xml);
  • index: имя обработчика по-умолчанию для запросов по адресу …/index.php/admin/sample/grid/ (см. ./src/Controller/Adminhtml/Grid/Index.php);

В описании задано, что в качестве контента на странице нужно вывести UI-компонент с именем sample_grid.


UI Component


Дескриптор компонента находится в файле ./src/view/adminhtml/ui_component/sample_grid.xml



    
        
            sample_grid.sample_grid_data_source
            sample_grid.sample_grid_data_source
        
        sample_grid_columns
    
    
        
            Flancer32\Sample\Ui\Component\DataProvider\Grid
            sample_grid_data_source
        
    
    
        
            
                
                    asc
                    Alpha-2
                
            
        
        
            
                
                    Alpha-3
                
            
        
        
            
                
                    Numeric

Я постарался сделать код компонента как можно меньше (сравните с аналогичным для CMS Pages).


На что следует обратить внимание:


  • имя компонента `sample_grid` совпадает с именем файла и используется в описании `js_config` (provider & deps);
  • в настройках spinner’а указывается имя `columns`-компонента, после заполнения данными которого spinner скрывается;
  • настройки data source’а спрятаны в конструкторе класса `Flancer32\Sample\Ui\Component\DataProvider\Grid`;
  • имена столбцов грида совпадают с именами полей в данных;
  • без указания настроек сортировки (`sorting`) хотя бы для одного столбца грид не загружается;

DataProvider


За поставку данных отвечает класс \Flancer32\Sample\Ui\Component\DataProvider\Grid. Конструктор принимает из дескриптора компонента только один параметр (name), все остальные либо инжектятся Object Manager’ом при создании провайдера данных, либо создаются в нем же. Данные не зависят от фильтров/сортировки и всегда возвращаются одни и те же (захардкожены в самом провайдере).


namespace Flancer32\Sample\Ui\Component\DataProvider;

class Grid
    extends \Magento\Framework\View\Element\UiComponent\DataProvider\DataProvider
{
    public function __construct(
        $name,
        \Magento\Framework\Api\Search\ReportingInterface $reporting,
        \Magento\Framework\Api\Search\SearchCriteriaBuilder $searchCriteriaBuilder,
        \Magento\Framework\App\RequestInterface $request,
        \Magento\Framework\Api\FilterBuilder $filterBuilder,
        \Magento\Framework\UrlInterface $url
    ) {
        $primaryFieldName = 'id';
        $requestFieldName = 'id';
        $meta = [];
        $updateUrl = $url->getRouteUrl('mui/index/render');
        $data = [
            'config' => [
                'component' => 'Magento_Ui/js/grid/provider',
                'update_url' => $updateUrl
            ]
        ];
        parent::__construct($name, $primaryFieldName, $requestFieldName, $reporting, $searchCriteriaBuilder, $request,
            $filterBuilder, $meta, $data);
    }

    public function getData()
    {
        $result = [
            'items' => [
                ['code2' => 'AU', 'code3' => 'AUS', 'code_num' => '036'],
                ['code2' => 'AT', 'code3' => 'AUT', 'code_num' => '040'],
                ['code2' => 'AZ', 'code3' => 'AZE', 'code_num' => '031']
            ],
            'totalRecords' => 3
        ];
        return $result;
    }

}

Резюме


Создание гридов в Magento 2 — это увлекательное занятие, которому можно посвятить не только свободные часы, но дни, а может быть даже и недели. Конечно, со временем оно станет менее увлекательным и более обыденным, но пока все еще остается возможность добавить в админку свой собственный грид не в пару кликов, а путем вдумчивого и кропотливого изменения если и не десятка файлов, то около того (если бы я трусливо не захаркодил данные в провайдере — точно достиг бы этого уровня, а может быть даже и превысил). Возможно кто-то окажется более смелым и захочет использовать встроенный \Magento\Framework\View\Element\UiComponent\DataProvider\DataProvider и зарегистрировать для него в ./src/etc/di.xml соответствующую коллекцию: 



    
        
            Vendor\Module\Model\ResourceModel\Grid\Collection

Пожелаю ему в этом удачи. Я, к сожалению, на данный момент свой лимит увлекательности исчерпал.


Всем счастливого Magento 2 coding’а!

Комментарии (0)

© Habrahabr.ru