psiphp / grid

lib/GridContext.php

<?php

declare(strict_types=1);

namespace Psi\Component\Grid;

use Psi\Component\Grid\Grid;

final class GridContext
{
    /**
     * @var array
     */
    private $options;

    /**
     * @var string
     */
    private $classFqn;

    public function __construct(string $classFqn, array $options)
    {
        $this->classFqn = $classFqn;
        $defaults = [
            'page_size' => 50,
            'page' => 1,
            'groups' => [ Grid::DEFAULT_GROUP ],
            'orderings' => [],
            'filter' => [],
            'variant' => Grid::DEFAULT_VARIANT,
        ];

        // check for invalid keys
        if ($diff = array_diff(array_keys($options), array_keys($defaults))) {

This code seems to be duplicated across your project.

            throw new \InvalidArgumentException(sprintf(
                'Invalid grid context options "%s". Valid options: "%s"',
                implode('", "', $diff), implode('", "', array_keys($defaults))
            ));
        }

        // set defaults
        $options = array_merge($defaults, $options);

        // normalize the orderings
        $options['orderings'] = array_map(function ($order) {
            $order = strtolower($order);

            if (false === in_array($order, ['asc', 'desc'])) {
                throw new \InvalidArgumentException(sprintf(
                    'Order must be either "asc" or "desc" got "%s"',
                    $order
                ));
            }

            return $order;
        }, $options['orderings']);

        // cast integer values where applicable
        foreach (['page', 'page_size'] as $key) {
            $options[$key] = $options[$key] !== null ? (int) $options[$key] : null;
        }

        // ensure current page is > 0
        if ($options['page'] < 1) {
            $options['page'] = 1;
        }

        $this->options = $options;
    }

    public function getCurrentPage(): int
    {
        return $this->options['page'];
    }

    public function isPaginated(): bool
    {
        return null !== $this->options['page_size'];
    }

    public function getPageSize(): int
    {
        return $this->options['page_size'];
    }

    public function getPageOffset(): int
    {
        return $this->isPaginated() ? ($this->getCurrentPage() - 1) * $this->getPageSize() : 0;
    }

    public function getOrderings(): array
    {
        return $this->options['orderings'];
    }

    public function getVariant()
    {
        return $this->options['variant'];
    }

    public function getFilter()
    {
        return $this->options['filter'];
    }

    public function getUrlParameters(): array
    {
        return $this->options;
    }

    public function getClassFqn(): string
    {
        return $this->classFqn;
    }

    public function getGroups(): array
    {
        return $this->options['groups'];
    }
}