AbstractDataProvider.php

Go to the documentation of this file.

<?php
namespace Magento\Ui\DataProvider;

use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;
use Magento\Framework\View\Element\UiComponent\DataProvider\DataProviderInterface;

abstract class AbstractDataProvider implements DataProviderInterface, \Countable
{
    protected $name;

    protected $primaryFieldName;

    protected $requestFieldName;

    protected $meta = [];

    protected $data = [];

    protected $collection;

    public function __construct(
        $name,
        $primaryFieldName,
        $requestFieldName,
        array $meta = [],
        array $data = []
    ) {
        $this->name = $name;
        $this->primaryFieldName = $primaryFieldName;
        $this->requestFieldName = $requestFieldName;
        $this->meta = $meta;
        $this->data = $data;
    }

    public function getCollection()
    {
        return $this->collection;
    }

    public function getName()
    {
        return $this->name;
    }

    public function getPrimaryFieldName()
    {
        return $this->primaryFieldName;
    }

    public function getRequestFieldName()
    {
        return $this->requestFieldName;
    }

    public function getMeta()
    {
        return $this->meta;
    }

    public function getFieldSetMetaInfo($fieldSetName)
    {
        return isset($this->meta[$fieldSetName]) ? $this->meta[$fieldSetName] : [];
    }

    public function getFieldsMetaInfo($fieldSetName)
    {
        return isset($this->meta[$fieldSetName]['children']) ? $this->meta[$fieldSetName]['children'] : [];
    }

    public function getFieldMetaInfo($fieldSetName, $fieldName)
    {
        return isset($this->meta[$fieldSetName]['children'][$fieldName])
            ? $this->meta[$fieldSetName]['children'][$fieldName]
            : [];
    }

    public function addFilter(\Magento\Framework\Api\Filter $filter)
    {
        $this->getCollection()->addFieldToFilter(
            $filter->getField(),
            [$filter->getConditionType() => $filter->getValue()]
        );
    }

    public function getSearchCriteria()
    {
        //TODO: Technical dept, should be implemented as part of SearchAPI support for Catalog Grids
        return null;
    }

    public function getSearchResult()
    {
        //TODO: Technical dept, should be implemented as part of SearchAPI support for Catalog Grids
        return $this->getCollection();
    }

    public function addField($field, $alias = null)
    {
        $this->getCollection()->addFieldToSelect($field, $alias);
    }

    public function addOrder($field, $direction)
    {
        $this->getCollection()->addOrder($field, $direction);
    }

    public function setLimit($offset, $size)
    {
        $this->getCollection()->setPageSize($size);
        $this->getCollection()->setCurPage($offset);
    }

    public function removeField($field, $isAlias = false)
    {
        $this->getCollection()->removeFieldFromSelect($field, $isAlias);
    }

    public function removeAllFields()
    {
        $this->getCollection()->removeAllFieldsFromSelect();
    }

    public function getData()
    {
        return $this->getCollection()->toArray();
    }

    public function count()
    {
        return $this->getCollection()->count();
    }

    public function getConfigData()
    {
        return isset($this->data['config']) ? $this->data['config'] : [];
    }

    public function setConfigData($config)
    {
        $this->data['config'] = $config;
    }

    public function getAllIds()
    {
        return  $this->getCollection()->getAllIds();
    }
}