W3cubDocs

/CakePHP 4.4

Interface PaginatorInterface

This interface describes the methods for paginator instance.

Method Summary

Method Detail

getPagingParams() public

getPagingParams(): array

Get paging params after pagination operation.

Returns

array

paginate() public

paginate(Cake\Datasource\RepositoryInterfaceCake\Datasource\QueryInterface $object, array $params = [], array $settings = []): Cake\Datasource\ResultSetInterface

Handles pagination of datasource records.

Parameters

Cake\Datasource\RepositoryInterfaceCake\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\ResultSetInterface

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/interface-Cake.Datasource.Paging.PaginatorInterface.html