Pool.php

Go to the documentation of this file.

<?php
namespace Magento\Ui\DataProvider\Modifier;

use Magento\Framework\Exception\LocalizedException;

class Pool implements \Magento\Ui\DataProvider\Modifier\PoolInterface
{
    protected $modifiers = [];

    protected $modifiersInstances = [];

    protected $factory;

    public function __construct(
        ModifierFactory $factory,
        array $modifiers = []
    ) {
        $this->factory = $factory;
        $this->modifiers = $this->sort($modifiers);
    }

    public function getModifiers()
    {
        return $this->modifiers;
    }

    public function getModifiersInstances()
    {
        if ($this->modifiersInstances) {
            return $this->modifiersInstances;
        }

        foreach ($this->modifiers as $modifier) {
            if (empty($modifier['class'])) {
                throw new LocalizedException(__('The parameter "class" is missing. Set the "class" and try again.'));
            }

            if (empty($modifier['sortOrder'])) {
                throw new LocalizedException(
                    __('The parameter "sortOrder" is missing. Set the "sortOrder" and try again.')
                );
            }

            $this->modifiersInstances[$modifier['class']] = $this->factory->create($modifier['class']);
        }

        return $this->modifiersInstances;
    }

    protected function sort(array $data)
    {
        usort($data, function (array $a, array $b) {
            $a['sortOrder'] = $this->getSortOrder($a);
            $b['sortOrder'] = $this->getSortOrder($b);

            if ($a['sortOrder'] == $b['sortOrder']) {
                return 0;
            }

            return ($a['sortOrder'] < $b['sortOrder']) ? -1 : 1;
        });

        return $data;
    }

    protected function getSortOrder(array $variable)
    {
        return !empty($variable['sortOrder']) ? $variable['sortOrder'] : 0;
    }
}