Interface PaginatorInterface
This interface describes the methods for paginator instance.
Namespace: Cake\Datasource
Method Summary
-
getPagingParams() public
Get paging params after pagination operation.
-
paginate() public
Handles pagination of datasource records.
Method Detail
getPagingParams() ¶ public
getPagingParams(): arrayGet paging params after pagination operation.
Returns
arraypaginate() ¶ public
paginate(Cake\Datasource\RepositoryInterface|Cake\Datasource\QueryInterface $object, array $params = [], array $settings = []): Cake\Datasource\ResultSetInterfaceHandles pagination of datasource records.
Parameters
-
Cake\Datasource\RepositoryInterface|Cake\Datasource\QueryInterface$object The repository or query to paginate.
-
array$params optional Request params
-
array$settings optional The settings/configuration used for pagination.
Returns
Cake\Datasource\ResultSetInterfaceQuery results