PaginatorInterface
in
This interface describes the methods for paginator instance.
Table of Contents
Methods
- getPagingParams() : array<string|int, mixed>
- Get paging params after pagination operation.
- paginate() : ResultSetInterface
- Handles pagination of datasource records.
Methods
getPagingParams()
Get paging params after pagination operation.
public
getPagingParams() : array<string|int, mixed>
Return values
array<string|int, mixed>paginate()
Handles pagination of datasource records.
public
paginate(RepositoryInterface|QueryInterface $object[, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $settings = [] ]) : ResultSetInterface
Parameters
- $object : RepositoryInterface|QueryInterface
-
The repository or query to paginate.
- $params : array<string|int, mixed> = []
-
Request params
- $settings : array<string|int, mixed> = []
-
The settings/configuration used for pagination.
Return values
ResultSetInterface —Query results