Pagination.php

Go to the documentation of this file.

<?php
/* Copyright (c) 2017 Nils Haagen <nils.haagen@concepts-and-training.de> Extended GPL, see docs/LICENSE */
 
namespace ILIAS\UI\Component\ViewControl;
 
use \ILIAS\UI\Component as C;
use ILIAS\UI\Component\JavaScriptBindable;
use ILIAS\UI\Component\Triggerer;
 
interface Pagination extends C\Component, JavaScriptBindable, Triggerer
{
    const DEFAULT_DROPDOWN_LABEL = 'pagination_label_x_of_y';
 
    public function withTargetURL(string $url, string $parameter_name) : Pagination;
 
    public function getTargetURL();
 
    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 getOffset() : int;
 
    public function withOnSelect(C\Signal $signal) : Pagination;
 
    public function getNumberOfPages() : int;
 
    public function withMaxPaginationButtons(int $amount) : Pagination;
 
    public function getMaxPaginationButtons();
 
    public function withDropdownAt(int $amount) : Pagination;
 
    public function getDropdownAt();
 
    public function withDropdownLabel(string $template) : Pagination;
 
    public function getDropdownLabel() : string;
 
    public function getDefaultDropdownLabel() : string;
 
    public function getPageLength() : int;
}