Pagination.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Component\ViewControl;

use ILIAS\UI\Component\Component;
use ILIAS\UI\Component\Signal;
use ILIAS\UI\Component\JavaScriptBindable;
use ILIAS\UI\Component\Triggerer;
use ILIAS\Data\Range;

interface Pagination extends Component, JavaScriptBindable, Triggerer
{
    public const DEFAULT_DROPDOWN_LABEL = 'pagination_label_x_of_y';

    public function withTargetURL(string $url, string $parameter_name): Pagination;

    public function getTargetURL(): ?string;

    public function getParameterName(): string;

    public function withTotalEntries(int $total): Pagination;

    public function withPageSize(int $size): Pagination;

    public function getPageSize(): int;

    public function withCurrentPage(int $page): Pagination;

    public function getCurrentPage(): int;

    public function withOnSelect(Signal $signal): Pagination;

    public function getNumberOfPages(): int;

    public function withMaxPaginationButtons(int $amount): Pagination;

    public function getMaxPaginationButtons(): ?int;

    public function withDropdownAt(int $amount): Pagination;

    public function getDropdownAt(): ?int;

    public function withDropdownLabel(string $template): Pagination;

    public function getDropdownLabel(): string;

    public function getDefaultDropdownLabel(): string;

    public function getRange(): ?Range;
}