symfony-doge/veslo

<?php

/*
 * This file is part of the Veslo project <https://github.com/symfony-doge/veslo>.
 *
 * (C) 2019 Pavel Petrov <itnelo@gmail.com>.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license https://opensource.org/licenses/GPL-3.0 GPL-3.0
 */

declare(strict_types=1);

namespace Veslo\AppBundle\Dto\Paginator;

use Knp\Component\Pager\PaginatorInterface;

/**
 * Pagination criteria
 *
 * @see PaginatorInterface
 */
class CriteriaDto
{
    /**
     * Page number
     *
     * @var int|null
     */
    private $page;

    /**
     * Number of items per page
     *
     * @var int|null
     */
    private $limit;

    /**
     * Additional options for pagination
     *
     * @var array
     */
    private $options;

    /**
     * A set of additional hints for query building
     * Usage of this parameter depends on a concrete PaginatorInterface implementer
     *
     * @var array
     */
    private $hints;

    /**
     * CriteriaDto constructor.
     */
    public function __construct()
    {
        $this->options = [];
        $this->hints   = [];
    }

    /**
     * Returns page number
     *
     * @return int|null
     */
    public function getPage(): ?int
    {
        return $this->page;
    }

    /**
     * Sets page number
     *
     * @param int|null $page Page number
     *
     * @return void
     */
    public function setPage(?int $page): void
    {
        $this->page = $page;
    }

    /**
     * Returns number of items per page
     *
     * @return int|null
     */
    public function getLimit(): ?int
    {
        return $this->limit;
    }

    /**
     * Sets number of items per page
     *
     * @param int|null $limit Number of items per page
     *
     * @return void
     */
    public function setLimit(?int $limit): void
    {
        $this->limit = $limit;
    }

    /**
     * Returns additional options for pagination
     *
     * @return array
     */
    public function getOptions(): array
    {
        return $this->options;
    }

    /**
     * Sets additional options for pagination
     *
     * @param array $options Additional options for pagination
     *
     * @return void
     */
    public function setOptions(array $options): void
    {
        $this->options = $options;
    }

    /**
     * Returns a set of additional hints for query building
     *
     * @return array
     */
    public function getHints(): array
    {
        return $this->hints;
    }

    /**
     * Adds an additional hint for query building
     *
     * @param string $name Hint name
     * @param mixed  $data Hint data
     *
     * @return void
     */
    public function addHint(string $name, $data): void
    {
        $this->hints[$name] = $data;
    }
}