PaginationOptions.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\DataProvider;

final class PaginationOptions
{
    private $paginationEnabled;
    private $paginationPageParameterName;
    private $clientItemsPerPage;
    private $itemsPerPageParameterName;
    private $paginationClientEnabled;
    private $paginationClientEnabledParameterName;
    private int $itemsPerPage;
    private ?int $maximumItemsPerPage;
    private bool $partialPaginationEnabled;
    private bool $clientPartialPaginationEnabled;
    private string $partialPaginationParameterName;

    public function __construct(bool $paginationEnabled = true, string $paginationPageParameterName = 'page', bool $clientItemsPerPage = false, string $itemsPerPageParameterName = 'itemsPerPage', bool $paginationClientEnabled = false, string $paginationClientEnabledParameterName = 'pagination', int $itemsPerPage = 30, ?int $maximumItemsPerPage = null, bool $partialPaginationEnabled = false, bool $clientPartialPaginationEnabled = false, string $partialPaginationParameterName = 'partial')
    {
        $this->paginationEnabled = $paginationEnabled;
        $this->paginationPageParameterName = $paginationPageParameterName;
        $this->clientItemsPerPage = $clientItemsPerPage;
        $this->itemsPerPageParameterName = $itemsPerPageParameterName;
        $this->paginationClientEnabled = $paginationClientEnabled;
        $this->paginationClientEnabledParameterName = $paginationClientEnabledParameterName;
        $this->itemsPerPage = $itemsPerPage;
        $this->maximumItemsPerPage = $maximumItemsPerPage;
        $this->partialPaginationEnabled = $partialPaginationEnabled;
        $this->clientPartialPaginationEnabled = $clientPartialPaginationEnabled;
        $this->partialPaginationParameterName = $partialPaginationParameterName;
    }

    public function isPaginationEnabled(): bool
    {
        return $this->paginationEnabled;
    }

    public function getPaginationPageParameterName(): string
    {
        return $this->paginationPageParameterName;
    }

    public function getClientItemsPerPage(): bool
    {
        return $this->clientItemsPerPage;
    }

    public function getItemsPerPageParameterName(): string
    {
        return $this->itemsPerPageParameterName;
    }

    public function getPaginationClientEnabled(): bool
    {
        return $this->paginationClientEnabled;
    }

    public function isPaginationClientEnabled(): bool
    {
        return $this->paginationClientEnabled;
    }

    public function getPaginationClientEnabledParameterName(): string
    {
        return $this->paginationClientEnabledParameterName;
    }


    public function getItemsPerPage(): int
    {
        return $this->itemsPerPage;
    }

    public function getMaximumItemsPerPage(): ?int
    {
        return $maximumItemsPerPage;
    }

    public function isPartialPaginationEnabled(): bool
    {
        return $this->partialPaginationEnabled;
    }

    public function isClientPartialPaginationEnabled(): bool
    {
        return $this->clientPartialPaginationEnabled;
    }
    
    public function getPartialPaginationParameterName(): string
    {
        return $this->partialPaginationParameterName;
    }
}