ILIAS
release_5-4 Revision v5.4.26-12-gabc799a52e6
◀ ilDoc Overview
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 */
3
namespace
ILIAS\UI\Component\ViewControl
;
4
5
use \ILIAS\UI\Component as
C
;
6
use
ILIAS\UI\Component\JavaScriptBindable
;
7
use
ILIAS\UI\Component\Triggerer
;
8
12
interface
Pagination
extends
C\Component
,
JavaScriptBindable
,
Triggerer
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
}
ILIAS\UI\Component\ViewControl\Pagination\getDropdownAt
getDropdownAt()
Below this value, the options are directly rendered as shy-buttons, on and above this value a dropdow...
$size
$size
Definition:
RandomTest.php:84
JavaScriptBindable
ILIAS\UI\Component\ViewControl\Pagination\withDropdownAt
withDropdownAt($amount)
Layout; when number of page-entries reaches $amount, the options will be rendered as dropdown...
ILIAS\UI\Component\ViewControl\Pagination\getOffset
getOffset()
Get the data's offset according to current page and page size.
ILIAS\UI\Component\ViewControl\Pagination\getMaxPaginationButtons
getMaxPaginationButtons()
Get the maximum amount of page-entries (not records per page!) to be shown.
Triggerer
ILIAS\UI\Component\ViewControl\Pagination\withTotalEntries
withTotalEntries($total)
Initialize with the total amount of entries of the controlled data-list.
ILIAS\UI\Component
ILIAS\UI\Implementation\Component\JavaScriptBindable
trait JavaScriptBindable
Trait for components implementing JavaScriptBindable providing standard implementation.
Definition:
JavaScriptBindable.php:12
ILIAS\UI\Component\ViewControl\Pagination\withTargetURL
withTargetURL($url, $parameter_name)
Get a Pagination with this target-url.
ILIAS\UI\Component\ViewControl\Pagination\getTargetURL
getTargetURL()
Get the url this instance should trigger.
ILIAS\UI\Component\ViewControl\Pagination\getCurrentPage
getCurrentPage()
Get the currently slected page.
ILIAS\UI\Component\ViewControl\Pagination\withCurrentPage
withCurrentPage($page)
Set the selected page.
ILIAS\UI\Component\ViewControl
Definition:
Factory.php:5
ILIAS\UI\Component\Component
A component is the most general form of an entity in the UI.
Definition:
Component.php:13
ILIAS\UI\Component\ViewControl\Pagination\getPageSize
getPageSize()
Get the numebr of entries per page.
ILIAS\UI\Implementation\Component\Triggerer
trait Triggerer
Definition:
Triggerer.php:17
$total
$total
Definition:
Utf8Test.php:87
ILIAS\UI\Component\ViewControl\Pagination
This describes a Pagination Control.
Definition:
Pagination.php:12
ILIAS\UI\Component\ViewControl\Pagination\getNumberOfPages
getNumberOfPages()
Calculate the total number of pages.
ILIAS\UI\Component\ViewControl\Pagination\withPageSize
withPageSize($size)
Set the amount of entries per page.
ILIAS\UI\Component\Signal
Definition:
Signal.php:13
ILIAS\UI\Component\ViewControl\Pagination\withOnSelect
withOnSelect(C\Signal $signal)
Register a signal with the control.
ILIAS\UI\Component\ViewControl\Pagination\getParameterName
getParameterName()
Get the parameter this instance uses.
php
$url
$url
Definition:
proxy_ylocal.php:28
ILIAS\UI\Component\ViewControl\Pagination\withMaxPaginationButtons
withMaxPaginationButtons($amount)
Layout; define, how many page-options are shown (max).
src
UI
Component
ViewControl
Pagination.php
Generated on Thu Feb 27 2025 19:02:11 for ILIAS by
1.8.13 (using
Doxyfile
)