How are the rows data retrieved for the backend's orders grid?

dmitry_fedyuk · July 28, 2016, 10:07am

magento/magento2/blob/2db9e0f/lib/internal/Magento/Framework/View/Layout/Generic.php#L75-L75


$dataSources = $component->getContext()->getDataSourceData($component);

github.com

magento/magento2/blob/2db9e0f/lib/internal/Magento/Framework/View/Element/UiComponent/Context.php#L225-L245


public function getDataSourceData(UiComponentInterface $component)
{
    $dataSource = $component->getDataSourceData();
    $this->prepareDataSource($dataSource, $component);
    $dataProviderConfig = $this->getDataProvider()->getConfigData();
    return [
        $this->getDataProvider()->getName() => [
            'type' => 'dataSource',
            'name' => $this->getDataProvider()->getName(),
            'dataScope' => $this->getNamespace(),
            'config' => array_replace_recursive(
                array_merge($dataSource, $dataProviderConfig),
                [
                    'params' => [
                        'namespace' => $this->getNamespace()
                    ],
                ]
            )
        ]
    ];
}

github.com

magento/magento2/blob/2db9e0f/app/code/Magento/Ui/Component/Listing.php#L32-L38


/**
 * {@inheritdoc}
 */
public function getDataSourceData()
{
    return ['data' => $this->getContext()->getDataProvider()->getData()];
}

github.com

magento/magento2/blob/2db9e0f/lib/internal/Magento/Framework/View/Element/UiComponent/DataProvider/DataProvider.php#L277-L285


/**
 * Get data
 *
 * @return array
 */
public function getData()
{
    return $this->searchResultToOutput($this->getSearchResult());
}

Details: How is \Magento\Framework\View\Element\UiComponent\DataProvider\DataProvider::searchResultToOutput() implemented?

github.com

magento/magento2/blob/2db9e0f/lib/internal/Magento/Framework/View/Element/UiComponent/DataProvider/DataProvider.php#L308-L316


/**
 * Returns Search result
 *
 * @return SearchResultInterface
 */
public function getSearchResult()
{
    return $this->reporting->search($this->getSearchCriteria());
}

github.com

magento/magento2/blob/2db9e0f/lib/internal/Magento/Framework/View/Element/UiComponent/DataProvider/Reporting.php#L39-L55


/**
 * @param SearchCriteriaInterface $searchCriteria
 * @return SearchResultInterface
 */
public function search(SearchCriteriaInterface $searchCriteria)
{
    $collection = $this->collectionFactory->getReport($searchCriteria->getRequestName());
    $collection->setPageSize($searchCriteria->getPageSize());
    $collection->setCurPage($searchCriteria->getCurrentPage());
    $this->filterPool->applyFilters($collection, $searchCriteria);
    foreach ($searchCriteria->getSortOrders() as $sortOrder) {
        if ($sortOrder->getField()) {
            $collection->setOrder($sortOrder->getField(), $sortOrder->getDirection());
        }
    }
    return $collection;
}

github.com

magento/magento2/blob/2db9e0f/lib/internal/Magento/Framework/View/Element/UiComponent/DataProvider/CollectionFactory.php#L39-L56


/**
 * Get report collection
 *
 * @param string $requestName
 * @return Collection
 * @throws \Exception
 */
public function getReport($requestName)
{
    if (!isset($this->collections[$requestName])) {
        throw new \Exception(sprintf('Not registered handle %s', $requestName));
    }
    $collection = $this->objectManager->create($this->collections[$requestName]);
    if (!$collection instanceof Collection) {
        throw new \Exception(sprintf('%s is not of Collection type.', $requestName));
    }
    return $collection;
}

github.com

magento/magento2/blob/2db9e0f/app/code/Magento/Sales/Model/ResourceModel/Order/Grid/Collection.php#L18-L37


/**
 * Initialize dependencies.
 *
 * @param EntityFactory $entityFactory
 * @param Logger $logger
 * @param FetchStrategy $fetchStrategy
 * @param EventManager $eventManager
 * @param string $mainTable
 * @param string $resourceModel
 */
public function __construct(
    EntityFactory $entityFactory,
    Logger $logger,
    FetchStrategy $fetchStrategy,
    EventManager $eventManager,
    $mainTable = 'sales_order_grid',
    $resourceModel = '\Magento\Sales\Model\ResourceModel\Order'
) {
    parent::__construct($entityFactory, $logger, $fetchStrategy, $eventManager, $mainTable, $resourceModel);
}