\Cake\DatasourcePaginatorInterface

This interface describes the methods for paginator instance.

Summary

Methods
Constants
paginate()
getPagingParams()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

paginate()

paginate(\Cake\Datasource\RepositoryInterface|\Cake\Datasource\QueryInterface  $object, array  $params = array(), array  $settings = array()) : \Cake\Datasource\ResultSetInterface

Handles pagination of datasource records.

Parameters

\Cake\Datasource\RepositoryInterface|\Cake\Datasource\QueryInterface $object

The repository or query to paginate.

array $params

Request params

array $settings

The settings/configuration used for pagination.

Returns

\Cake\Datasource\ResultSetInterface

Query results

getPagingParams()

getPagingParams() : array

Get paging params after pagination operation.

Returns

array