ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Pagination.php
Go to the documentation of this file.
1<?php
2/* Copyright (c) 2017 Nils Haagen <nils.haagen@concepts-and-training.de> Extended GPL, see docs/LICENSE */
4
5use \ILIAS\UI\Component as C;
8
13{
14
25 public function withTargetURL($url, $parameter_name);
26
32 public function getTargetURL();
33
39 public function getParameterName();
40
49 public function withTotalEntries($total);
50
58 public function withPageSize($size);
59
65 public function getPageSize();
66
74 public function withCurrentPage($page);
75
81 public function getCurrentPage();
82
88 public function getOffset();
89
97 public function withOnSelect(C\Signal $signal);
98
104 public function getNumberOfPages();
105
113 public function withMaxPaginationButtons($amount);
114
121 public function getMaxPaginationButtons();
122
131 public function withDropdownAt($amount);
132
139 public function getDropdownAt();
140}
$size
Definition: RandomTest.php:84
$total
Definition: Utf8Test.php:87
An exception for terminatinating execution or to throw for unit testing.
A component is the most general form of an entity in the UI.
Definition: Component.php:14
Interface to be extended by components that have the possibility to bind to Javascript.
This describes a Pagination Control.
Definition: Pagination.php:13
getDropdownAt()
Below this value, the options are directly rendered as shy-buttons, on and above this value a dropdow...
getNumberOfPages()
Calculate the total number of pages.
withCurrentPage($page)
Set the selected page.
withTargetURL($url, $parameter_name)
Get a Pagination with this target-url.
withDropdownAt($amount)
Layout; when number of page-entries reaches $amount, the options will be rendered as dropdown.
getPageSize()
Get the numebr of entries per page.
withOnSelect(C\Signal $signal)
Register a signal with the control.
getOffset()
Get the data's offset according to current page and page size.
getTargetURL()
Get the url this instance should trigger.
withTotalEntries($total)
Initialize with the total amount of entries of the controlled data-list.
getMaxPaginationButtons()
Get the maximum amount of page-entries (not records per page!) to be shown.
getParameterName()
Get the parameter this instance uses.
withPageSize($size)
Set the amount of entries per page.
withMaxPaginationButtons($amount)
Layout; define, how many page-options are shown (max).
getCurrentPage()
Get the currently slected page.
trait JavaScriptBindable
Trait for components implementing JavaScriptBindable providing standard implementation.
$url