nnx-framework / data-grid

src/AbstractGrid.php

<?php
/**
 * @company MTE Telecom, Ltd.
 * @author Roman Malashin <malashinr@mte-telecom.ru>
 */

namespace Nnx\DataGrid;

use Nnx\DataGrid\Column\ColumnInterface;
use Nnx\DataGrid\Adapter\AdapterInterface;
use Nnx\DataGrid\NavigationBar\NavigationBarInterface;
use Nnx\DataGrid\Column\GridColumnPluginManager;
use Nnx\DataGrid\Column\GridColumnPluginManagerAwareTrait;
use Nnx\DataGrid\Mutator\GridMutatorPluginManager;
use Nnx\DataGrid\Mutator\GridMutatorPluginManagerAwareTrait;
use Nnx\DataGrid\Mutator\MutatorInterface;
use Traversable;
use ArrayAccess;

/**
 * Class AbstractGrid
 * @package Nnx\DataGrid
 */
abstract class AbstractGrid implements GridInterface
{

    use GridColumnPluginManagerAwareTrait;
    use GridMutatorPluginManagerAwareTrait;
    /**
     * Условия для фильтрации выбираемых данных
     * @var array | Traversable
     */
    protected $conditions;

    /**
     * Адаптер с помощью которого будет осуществляться выборка данных
     * @var AdapterInterface
     */
    protected $adapter;

    /**
     * Коллекция колонок таблицы
     * @var array | Traversable
     */
    protected $columns;

    /**
     * Опции таблицы
     * @var array | Traversable
     */
    protected $options;

    /**
     * Имя таблицы
     * @var string
     */
    protected $name;

    /**
     * Массив атрибутов таблицы для отображения
     * @var array
     */
    protected $attributes = [];

    /**
     * Мутаторы для строк
     * @var array | ArrayAccess
     */
    protected $mutators = [];

    /**
     * @var NavigationBarInterface
     */
    protected $topNavigationBar;

    /**
     * @var NavigationBarInterface
     */
    protected $bottomNavigationBar;


    /**
     * Конструкто класса
     * @param array | ArrayAccess $options
     * @throws Exception\InvalidArgumentException
     */
    public function __construct(array $options = [])
    {
        if (!array_key_exists('adapter', $options) || !$options['adapter']) {
            throw new Exception\InvalidArgumentException(
                'Для корректной работы таблиц в конструктор необходимо передавать адаптер.'
            );
        }
        $adapter = $options['adapter'];
        unset($options['adapter']);

        $name = array_key_exists('name', $options) ? $options['name'] : null;
        unset($options['name']);
        $this->setName($name);

        if (!array_key_exists('columnPluginManager', $options) || !$options['columnPluginManager']) {
            throw new Exception\InvalidArgumentException(
                'Для корректной работы таблиц должна передаваться GridColumnPluginManager в конструктор таблиц.'
            );
        }
        $columnPluginManager = $options['columnPluginManager'];
        unset($options['columnPluginManager']);

        if (!array_key_exists('mutatorPluginManager', $options) || !$options['mutatorPluginManager']) {
            throw new Exception\InvalidArgumentException(
                'Для корректной работы таблиц должна передаваться GridMutatorPluginManager.'
            );
        }
        $mutatorPluginManager = $options['mutatorPluginManager'];
        unset($options['mutatorPluginManager']);

        $topNavigationBar = !empty($options['topNavigationBar']) ? $options['topNavigationBar'] : null;

Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space

        $bottomNavigationBar = !empty($options['bottomNavigationBar']) ? $options['bottomNavigationBar'] : null;
        unset($options['topNavigationBar'], $options['bottomNavigationBar']);

        $this->configure($mutatorPluginManager, $adapter, $columnPluginManager, $topNavigationBar, $bottomNavigationBar);

This line exceeds maximum limit of 120 characters; contains 121 characters

        $this->setOptions($options);
    }

    /**
     * Конфигурируем адаптер грида
     * @param GridMutatorPluginManager $mutatorPluginManager
     * @param AdapterInterface $adapter
     * @param GridColumnPluginManager $columnPluginManager
     * @param NavigationBarInterface $topNavigationBar

Should the type for parameter $topNavigationBar not be null|NavigationBarInterface?

     * @param NavigationBarInterface $bottomNavigationBar

Should the type for parameter $bottomNavigationBar not be null|NavigationBarInterface?

     * @internal param array $options
     */
    protected function configure(
        GridMutatorPluginManager $mutatorPluginManager,
        AdapterInterface $adapter,
        GridColumnPluginManager $columnPluginManager,
        NavigationBarInterface $topNavigationBar = null,
        NavigationBarInterface $bottomNavigationBar = null)
    {
        $this->setMutatorPluginManager($mutatorPluginManager);
        $this->setAdapter($adapter);
        $this->setColumnPluginManager($columnPluginManager);
        $this->setTopNavigationBar($topNavigationBar);

It seems like $topNavigationBar defined by parameter $topNavigationBar on line 138 can be null; however, Nnx\DataGrid\AbstractGrid::setTopNavigationBar() does not accept null, maybe add an additional type check?

        $this->setBottomNavigationBar($bottomNavigationBar);

It seems like $bottomNavigationBar defined by parameter $bottomNavigationBar on line 139 can be null; however, Nnx\DataGrid\AbstractGrid::setBottomNavigationBar() does not accept null, maybe add an additional type check?

    }


    /**
     * Условия для фильтрации выбираемых данных
     * @param array | Traversable $conditions
     * @return $this
     */
    public function setConditions($conditions)
    {
        $this->conditions = $conditions;
        $this->getAdapter()->setConditions($conditions);
        return $this;
    }

    /**
     * Возвращает набор условий по которым фильтровать выборку
     * @return array
     */
    public function getConditions()
    {
        return $this->conditions;
    }

    /**
     * Устанавливает адаптер
     * @param AdapterInterface  $adapter
     * @return $this
     */
    public function setAdapter($adapter)
    {
        $this->adapter = $adapter;
        return $this;
    }

    /**
     * Возвращает адаптер с помощью которого будет осуществляться выборка данных
     * @return AdapterInterface
     */
    public function getAdapter()
    {
        return $this->adapter;
    }

    /**
     * Возвращает коллекцию колонок
     * @return array | Traversable
     */
    public function getColumns()
    {
        return $this->columns;
    }

    /**
     * Добавление колонок в таблицу
     * @param array | Traversable $columns
     * @return $this
     */
    public function setColumns($columns)
    {
        $this->columns = $columns;
        return $this;
    }

    /**
     * Добавление колонки в таблицу
     * @param ColumnInterface|array|ArrayAccess $column
     * @return $this
     * @throws Column\Exception\InvalidColumnException
     * @throws Exception\InvalidArgumentException
     * @throws Exception\RuntimeException
     */
    public function add($column)
    {
        if (is_array($column) || $column instanceof ArrayAccess) {
            if (!array_key_exists('type', $column)) {
                throw new Column\Exception\InvalidColumnException(
                    'Не передан тип создаваемого столбца.'
                );
            }
            $column['columnPluginManager'] = $this->getColumnPluginManager();
            if (!$this->getColumnPluginManager()->has($column['type'])) {
                throw new Exception\RuntimeException(sprintf('Колонка с именем %s не найдена', $column['type']));
            }
            /** @var ColumnInterface $column */
            $column = $this->getColumnPluginManager()->get($column['type'], $column);

$column is of type object<Nnx\DataGrid\Column\ColumnInterface>, but the function expects a array.

        } elseif (!$column instanceof ColumnInterface) {
            throw new Exception\InvalidArgumentException(
                sprintf('Column должен быть массивом или реализовывать %s', ColumnInterface::class)
            );
        }
        $this->columns[$column->getName()] = $column;
        return $this;
    }

    /**
     * Удаляет колонку с именем $name из таблицы
     * @param string $name
     * @return $this
     */
    public function remove($name)
    {
        $name = strtolower($name);
        if (array_key_exists($name, $this->columns)) {
            unset($this->columns[$name]);
        }
        return $this;
    }

    /**
     * Возвращает колонку грида
     * @param string $name
     * @return ColumnInterface
     * @throws Exception\InvalidArgumentException
     */
    public function get($name)
    {
        if (!is_string($name)) {
            throw new Exception\InvalidArgumentException('Имя получаемой колонки должно быть строкой.');
        }
        $name = strtolower($name);

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

        $column = null;
        if (array_key_exists($name, $this->columns)) {
            $column = $this->columns[$name];
        }
        return $column;
    }

    /**
     * Опции таблицы
     * @param array | Traversable $options
     * @return $this
     */
    public function setOptions($options)
    {
        $this->options = $options;
        return $this;
    }

    /**
     * Возвращает массив опции таблицы
     * @return array | Traversable
     */
    public function getOptions()
    {
        return $this->options;
    }

    /**
     * Устанавливает имя таблицы
     * @param string $name
     * @return $this
     */
    public function setName($name)
    {
        $this->name = $name;
        return $this;
    }

    /**
     * Возвращает имя таблицы
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Возвращает атрибуты используемые при отображении грида
     * @return array
     */
    public function getAttributes()
    {
        return $this->attributes;
    }

    /**
     * Устанавливает используемые для отображения грида
     * @param array $attributes
     * @return $this
     */
    public function setAttributes(array $attributes)
    {
        $this->attributes = $attributes;
        return $this;
    }

    /**
     * Добавляет атрибут для таблицы
     * @param string $key
     * @param mixed $value
     * @return $this
     */
    public function addAttribute($key, $value)
    {
        $this->attributes[$key] = $value;
        return $this;
    }

    /**
     * Возвращает набор мутаторов для строк таблицы
     * @return array|ArrayAccess
     */
    public function getMutators()
    {
        return $this->mutators;
    }

    /**
     * Устанавливает набор мутаторов для строк таблицы
     * @param array|ArrayAccess $mutators
     * @return $this
     */
    public function setMutators(array $mutators)
    {
        $this->mutators = $mutators;
        return $this;
    }

    /**
     * Добавляет мутатор для строк таблицы
     * @param MutatorInterface|array|ArrayAccess $mutator
     * @return $this
     * @throws Mutator\Exception\RuntimeException
     */
    public function addMutator($mutator)
    {
        if (is_array($mutator) || $mutator instanceof MutatorInterface) {
            if (!array_key_exists('type', $mutator) || !$mutator['type']) {
                throw new Mutator\Exception\RuntimeException('Не задан тип мутатора.');
            }
            $mutator = $this->getMutatorPluginManager()->get($mutator['type'], $mutator);

It seems like $mutator defined by $this->getMutatorPluginManager()->get($mutator['type'], $mutator) on line 378 can also be of type object<Nnx\DataGrid\Mutator\MutatorInterface>; however, Zend\ServiceManager\AbstractPluginManager::get() does only seem to accept array, maybe add an additional type check?

        }
        $this->mutators[] = $mutator;
        return $this;
    }

    /**
     * Возвращвет верхнюю навигационную панель
     * @return NavigationBarInterface
     */
    public function getTopNavigationBar()
    {
        return $this->topNavigationBar;
    }

    /**
     * Устанавливает верхнюю навигационную панель
     * @param NavigationBarInterface $topNavigationBar
     * @return $this
     */
    public function setTopNavigationBar($topNavigationBar)
    {
        $this->topNavigationBar = $topNavigationBar;
        return $this;
    }

    /**
     * Возвращвет верхнюю навигационную панель
     * @return NavigationBarInterface
     */
    public function getBottomNavigationBar()
    {
        return $this->bottomNavigationBar;
    }

    /**
     * Устанавливает верхнюю навигационную панель
     * @param NavigationBarInterface $bottomNavigationBar
     * @return $this
     */
    public function setBottomNavigationBar($bottomNavigationBar)
    {
        $this->bottomNavigationBar = $bottomNavigationBar;
        return $this;
    }
    /**
     * Функция инициализации колонок
     * @return void
     */
    abstract public function init();

    /**
     * Возвращает массив строк
     * @return array
     */
    abstract public function getRowSet();
}

As per coding style, files should not end with a newline character.