Pagination
extends Element
in package
Uses
ElementTrait
This is the Pagination DTO class.
The pagination items will be stored in that class and will remain immutable (only get methods are available).
This class extends SDK\Core\Dtos\Element, see this class.
Tags
Table of Contents
| AFTER_CLASS | = \FWK\Enums\Pagination::AFTER_CLASS | |
|---|---|---|
| AFTER_LABEL | = \FWK\Enums\Pagination::AFTER_LABEL | |
| BEFORE_CLASS | = \FWK\Enums\Pagination::BEFORE_CLASS | |
| BEFORE_LABEL | = \FWK\Enums\Pagination::BEFORE_LABEL | |
| LINK_TARGET | = \FWK\Enums\Pagination::LINK_TARGET | |
| PAGE_CLASS | = \FWK\Enums\Pagination::PAGE_CLASS | |
| PAGE_LABEL | = \FWK\Enums\Pagination::PAGE_LABEL | |
| PAGES_TO_SHOW | = \FWK\Enums\Pagination::PAGES_TO_SHOW | |
| SELECTED_CLASS | = \FWK\Enums\Pagination::SELECTED_CLASS | |
| SEPARATOR_CLASS | = \FWK\Enums\Pagination::SEPARATOR_CLASS | |
| SEPARATOR_LABEL | = \FWK\Enums\Pagination::SEPARATOR_LABEL | |
| getAfterClass() | Returns the class to insert into after link. | : string |
| getAfterLabel() | Returns the label to insert into after link. | : string |
| getBeforeClass() | Returns the class to insert into the before link. | : string |
| getBeforeLabel() | Returns the label to insert into the before link. | : string |
| getLinkTarget() | Returns the link target value. | : string |
| getPageClass() | Returns the class to insert into each page link. | : string |
| getPageLabel() | Returns the label to insert into each page link. | : string |
| getPagesToShow() | Returns the number of linkable pages. | : int |
| getSelectedClass() | Returns the class to insert into selected link. | : string |
| getSeparatorClass() | Returns the class to insert into separator item. | : string |
| getSeparatorLabel() | Returns the label to insert into separator item. | : string |
Constants
AFTER_CLASS
public
mixed
AFTER_CLASS
= \FWK\Enums\Pagination::AFTER_CLASS
AFTER_LABEL
public
mixed
AFTER_LABEL
= \FWK\Enums\Pagination::AFTER_LABEL
BEFORE_CLASS
public
mixed
BEFORE_CLASS
= \FWK\Enums\Pagination::BEFORE_CLASS
BEFORE_LABEL
public
mixed
BEFORE_LABEL
= \FWK\Enums\Pagination::BEFORE_LABEL
LINK_TARGET
public
mixed
LINK_TARGET
= \FWK\Enums\Pagination::LINK_TARGET
PAGE_CLASS
public
mixed
PAGE_CLASS
= \FWK\Enums\Pagination::PAGE_CLASS
PAGE_LABEL
public
mixed
PAGE_LABEL
= \FWK\Enums\Pagination::PAGE_LABEL
PAGES_TO_SHOW
public
mixed
PAGES_TO_SHOW
= \FWK\Enums\Pagination::PAGES_TO_SHOW
SELECTED_CLASS
public
mixed
SELECTED_CLASS
= \FWK\Enums\Pagination::SELECTED_CLASS
SEPARATOR_CLASS
public
mixed
SEPARATOR_CLASS
= \FWK\Enums\Pagination::SEPARATOR_CLASS
SEPARATOR_LABEL
public
mixed
SEPARATOR_LABEL
= \FWK\Enums\Pagination::SEPARATOR_LABEL
Methods
getAfterClass()
Returns the class to insert into after link.
public
getAfterClass() : string
Return values
string —getAfterLabel()
Returns the label to insert into after link.
public
getAfterLabel() : string
Return values
string —getBeforeClass()
Returns the class to insert into the before link.
public
getBeforeClass() : string
Return values
string —getBeforeLabel()
Returns the label to insert into the before link.
public
getBeforeLabel() : string
Return values
string —getLinkTarget()
Returns the link target value.
public
getLinkTarget() : string
Return values
string —getPageClass()
Returns the class to insert into each page link.
public
getPageClass() : string
Return values
string —getPageLabel()
Returns the label to insert into each page link.
public
getPageLabel() : string
Return values
string —getPagesToShow()
Returns the number of linkable pages.
public
getPagesToShow() : int
Return values
int —getSelectedClass()
Returns the class to insert into selected link.
public
getSelectedClass() : string
Return values
string —getSeparatorClass()
Returns the class to insert into separator item.
public
getSeparatorClass() : string
Return values
string —getSeparatorLabel()
Returns the label to insert into separator item.
public
getSeparatorLabel() : string