PaginationTrait
Table of Contents
Constants
- LIMIT = 'limit'
- The attribute key for the 'limit' property.
- MAX_LIMIT = 'maxLimit'
- The attribute key for the 'maxLimit' property.
- MIN_LIMIT = 'minLimit'
- The attribute key for the 'minLimit' property.
- NUMBER_OF_PAGES = 'numberOfPages'
- The attribute key for the 'numberOfPages' property.
- OFFSET = 'offset'
- The attribute key for the 'offset' property.
- PAGE = 'page'
- The attribute key for the 'page' property.
Constants
LIMIT
The attribute key for the 'limit' property.
public
mixed
LIMIT
= 'limit'
Used to identify the maximum number of items to return per page in an array, JSON, or other structured representation.
MAX_LIMIT
The attribute key for the 'maxLimit' property.
public
mixed
MAX_LIMIT
= 'maxLimit'
Represents the upper bound on the number of items that can be requested per page.
MIN_LIMIT
The attribute key for the 'minLimit' property.
public
mixed
MIN_LIMIT
= 'minLimit'
Represents the lower bound on the number of items that can be requested per page.
NUMBER_OF_PAGES
The attribute key for the 'numberOfPages' property.
public
mixed
NUMBER_OF_PAGES
= 'numberOfPages'
Represents the total number of pages in the paginated collection. Can be used to generate pagination controls or metadata.
OFFSET
The attribute key for the 'offset' property.
public
mixed
OFFSET
= 'offset'
Indicates the number of items to skip before starting to collect the result set.
PAGE
The attribute key for the 'page' property.
public
mixed
PAGE
= 'page'
Indicates the current page number in the paginated collection.