W3cubDocs

/CakePHP 4.1

Interface PaginatorInterface

This interface describes the methods for paginator instance.

Namespace: Cake\Datasource

Method Summary

Method Detail

getPagingParams() public 

getPagingParams()

Get paging params after pagination operation.

Returns

array

paginate() public 

paginate(object $object, array $params, array $settings)

Handles 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\ResultSetInterface

Query results

© 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.1/interface-Cake.Datasource.PaginatorInterface.html