Class Paginator

This class is used to handle automatic model data pagination.

Namespace: Cake\Datasource

Property Summary

$_config protected

array

Runtime config
$_configInitialized protected

bool

Whether the config property has already been configured with defaults
$_defaultConfig protected

array

Default pagination settings.
$_pagingParams protected

array

Paging params after pagination operation is done.

Method Summary

_configDelete() protected

Deletes a single config key.
_configRead() protected

Reads a config key.
_configWrite() protected

Writes a config key.
_extractFinder() protected

Extracts the finder name and options out of the provided pagination options.
_prefix() protected

Prefixes the field with the table alias if possible.
_removeAliases() protected

Remove alias if needed.
addPageCountParams() protected

Add "page" and "pageCount" params.
addPrevNextParams() protected

Add "prevPage" and "nextPage" params.
addSortingParams() protected

Add sorting / ordering params.
addStartEndParams() protected

Add "start" and "end" params.
buildParams() protected

Build pagination params.
checkLimit() public

Check the limit parameter and ensure it's within the maxLimit bounds.
config() public deprecated

Gets/Sets the config.
configShallow() public

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
extractData() protected

Extract pagination data needed
getConfig() public

Returns the config.
getConfigOrFail() public

Returns the config for this specific key.
getCount() protected

Get total count of records.
getDefaults() public

Get the settings for a $model. If there are no settings for a specific repository, the general settings will be used.
getPagingParams() public

Get paging params after pagination operation.
getQuery() protected

Get query for fetching paginated results.
mergeOptions() public

Merges the various options that Paginator uses. Pulls settings together from the following places:
paginate() public

Handles automatic pagination of model records.
setConfig() public

Sets the config.
validateSort() public

Validate that the desired sorting can be performed on the $object.

Method Detail

_configDelete() ¶ protected

_configDelete(string $key): void

Deletes a single config key.

Parameters

string $key: Key to delete.

Returns

void

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead() ¶ protected

_configRead(string|null $key): mixed

Reads a config key.

Parameters

string|null $key: Key to read.

Returns

mixed

_configWrite() ¶ protected

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Writes a config key.

Parameters

string|array $key: Key to write to.
mixed $value: Value to write.
bool|string $merge optional: True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Returns

void

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_extractFinder() ¶ protected

_extractFinder(array $options): array

Extracts the finder name and options out of the provided pagination options.

Parameters

array $options: the pagination options.

Returns

array

_prefix() ¶ protected

_prefix(Cake\Datasource\RepositoryInterface $object, array $order, bool $whitelisted = false): array

Prefixes the field with the table alias if possible.

Parameters

Cake\Datasource\RepositoryInterface $object: Repository object.
array $order: Order array.
bool $whitelisted optional: Whether or not the field was whitelisted.

Returns

array

_removeAliases() ¶ protected

_removeAliases(array $fields, string $model): array

Remove alias if needed.

Parameters

array $fields: Current fields
string $model: Current model alias

Returns

array

addPageCountParams() ¶ protected

addPageCountParams(array $params, array $data): array

Add "page" and "pageCount" params.

Parameters

array $params: Paging params.
array $data: Paginator data.

Returns

array

addPrevNextParams() ¶ protected

addPrevNextParams(array $params, array $data): array

Add "prevPage" and "nextPage" params.

Parameters

array $params: Paginator params.
array $data: Paging data.

Returns

array

addSortingParams() ¶ protected

addSortingParams(array $params, array $data): array

Add sorting / ordering params.

Parameters

array $params: Paginator params.
array $data: Paging data.

Returns

array

addStartEndParams() ¶ protected

addStartEndParams(array $params, array $data): array

Add "start" and "end" params.

Parameters

array $params: Paging params.
array $data: Paginator data.

Returns

array

buildParams() ¶ protected

buildParams(array $data): array

Build pagination params.

Parameters

array $data: Paginator data containing keys 'options', 'count', 'defaults', 'finder', 'numResults'.

Returns

array

checkLimit() ¶ public

checkLimit(array $options): array

Check the limit parameter and ensure it's within the maxLimit bounds.

Parameters

array $options: An array of options with a limit key to be checked.

Returns

array

config() ¶ public

config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixed

Gets/Sets the config.

Usage

Reading the whole config:

$this->config();

Reading a specific value:

$this->config('key');

Reading a nested value:

$this->config('some.nested.key');

Setting a specific value:

$this->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);

Parameters

string|array|null $key optional: The key to get/set, or a complete array of configs.
mixed|null $value optional: The value to set.
bool $merge optional: Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow() ¶ public

configShallow(string|array $key, mixed|null $value = null): $this

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

Setting a specific value:

$this->configShallow('key', $value);

Setting a nested value:

$this->configShallow('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key: The key to set, or a complete array of configs.
mixed|null $value optional: The value to set.

Returns

$this

extractData() ¶ protected

extractData(Cake\Datasource\RepositoryInterface $object, array $params, array $settings): array

Extract pagination data needed

Parameters

Cake\Datasource\RepositoryInterface $object: The repository object.
array $params: Request params
array $settings: The settings/configuration used for pagination.

Returns

array

getConfig() ¶ public

getConfig(string|null $key = null, mixed|null $default = null): mixed|null

Returns the config.

Usage

Reading the whole config:

$this->getConfig();

Reading a specific value:

$this->getConfig('key');

Reading a nested value:

$this->getConfig('some.nested.key');

Reading with default value:

$this->getConfig('some-key', 'default-value');

Parameters

string|null $key optional: The key to get or null for the whole config.
mixed|null $default optional: The return value when the key does not exist.

Returns

mixed|null

getConfigOrFail() ¶ public

getConfigOrFail(string|null $key): mixed

Returns the config for this specific key.

The config value for this key must exist, it can never be null.

Parameters

string|null $key: The key to get.

Returns

mixed

Throws

InvalidArgumentException

getCount() ¶ protected

getCount(Cake\Datasource\QueryInterface $query, array $data): int|null

Get total count of records.

Parameters

Cake\Datasource\QueryInterface $query: Query instance.
array $data: Pagination data.

Returns

int|null

getDefaults() ¶ public

getDefaults(string $alias, array $settings): array

Get the settings for a $model. If there are no settings for a specific repository, the general settings will be used.

Parameters

string $alias: Model name to get settings for.
array $settings: The settings which is used for combining.

Returns

array

getPagingParams() ¶ public

getPagingParams(): array

Get paging params after pagination operation.

Returns

array

getQuery() ¶ protected

getQuery(Cake\Datasource\RepositoryInterface $object, Cake\Datasource\QueryInterface|null $query = null, array $data): Cake\Datasource\QueryInterface

Get query for fetching paginated results.

Parameters

Cake\Datasource\RepositoryInterface $object: Repository instance.
Cake\Datasource\QueryInterface|null $query optional: Query Instance.
array $data: Pagination data.

Returns

Cake\Datasource\QueryInterface

mergeOptions() ¶ public

mergeOptions(array $params, array $settings): array

Merges the various options that Paginator uses. Pulls settings together from the following places:

General pagination settings
Model specific settings.
Request parameters

The result of this method is the aggregate of all the option sets combined together. You can change config value whitelist to modify which options/values can be set using request parameters.

Parameters

array $params: Request params.
array $settings: The settings to merge with the request data.

Returns

array

paginate() ¶ public

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

Handles automatic pagination of model records.

Configuring pagination

When calling paginate() you can use the $settings parameter to pass in pagination settings. These settings are used to build the queries made and control other pagination settings.

If your settings contain a key with the current table's alias. The data inside that key will be used. Otherwise the top level configuration will be used.

 $settings = [
   'limit' => 20,
   'maxLimit' => 100
 ];
 $results = $paginator->paginate($table, $settings);

The above settings will be used to paginate any repository. You can configure repository specific settings by keying the settings with the repository alias.

 $settings = [
   'Articles' => [
     'limit' => 20,
     'maxLimit' => 100
   ],
   'Comments' => [ ... ]
 ];
 $results = $paginator->paginate($table, $settings);

This would allow you to have different pagination settings for Articles and Comments repositories.

Controlling sort fields

By default CakePHP will automatically allow sorting on any column on the repository object being paginated. Often times you will want to allow sorting on either associated columns or calculated fields. In these cases you will need to define a whitelist of all the columns you wish to allow sorting on. You can define the whitelist in the $settings parameter:

$settings = [
  'Articles' => [
    'finder' => 'custom',
    'sortWhitelist' => ['title', 'author_id', 'comment_count'],
  ]
];

Passing an empty array as whitelist disallows sorting altogether.

Paginating with custom finders

You can paginate with any find type defined on your table using the finder option.

 $settings = [
   'Articles' => [
     'finder' => 'popular'
   ]
 ];
 $results = $paginator->paginate($table, $settings);

Would paginate using the find('popular') method.

You can also pass an already created instance of a query to this method:

$query = $this->Articles->find('popular')->matching('Tags', function ($q) {
  return $q->where(['name' => 'CakePHP'])
});
$results = $paginator->paginate($query);

Scoping Request parameters

By using request parameter scopes you can paginate multiple queries in the same controller action:

$articles = $paginator->paginate($articlesQuery, ['scope' => 'articles']);
$tags = $paginator->paginate($tagsQuery, ['scope' => 'tags']);

Each of the above queries will use different query string parameter sets for pagination data. An example URL paginating both results would be:

/dashboard?articles[page]=1&tags[page]=2

Parameters

Cake\Datasource\RepositoryInterfaceCake\Datasource\QueryInterface $object: The table or query to paginate.
array $params optional: Request params
array $settings optional: The settings/configuration used for pagination.

Returns

Cake\Datasource\ResultSetInterface

Throws

Cake\Datasource\Exception\PageOutOfBoundsException

setConfig() ¶ public

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

Sets the config.

Usage

Setting a specific value:

$this->setConfig('key', $value);

Setting a nested value:

$this->setConfig('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key: The key to set, or a complete array of configs.
mixed|null $value optional: The value to set.
bool $merge optional: Whether to recursively merge or overwrite existing config, defaults to true.

Returns

$this

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

validateSort() ¶ public

validateSort(Cake\Datasource\RepositoryInterface $object, array $options): array

Validate that the desired sorting can be performed on the $object.

Only fields or virtualFields can be sorted on. The direction param will also be sanitized. Lastly sort + direction keys will be converted into the model friendly order key.

You can use the whitelist parameter to control which columns/fields are available for sorting via URL parameters. This helps prevent users from ordering large result sets on un-indexed values.

If you need to sort on associated columns or synthetic properties you will need to use a whitelist.

Any columns listed in the sort whitelist will be implicitly trusted. You can use this to sort on synthetic columns, or columns added in custom find operations that may not exist in the schema.

The default order options provided to paginate() will be merged with the user's requested sorting field/direction.

Parameters

Cake\Datasource\RepositoryInterface $object: Repository object.
array $options: The pagination options being used for this request.

Returns

array

Property Detail

`$_config` ¶ protected

Runtime config

Type

array

`$_configInitialized` ¶ protected

Whether the config property has already been configured with defaults

Type

bool

`$_defaultConfig` ¶ protected

Default pagination settings.

When calling paginate() these settings will be merged with the configuration you provide.

maxLimit - The maximum limit users can choose to view. Defaults to 100
limit - The initial number of items per page. Defaults to 20.
page - The starting page, defaults to 1.
whitelist - A list of parameters users are allowed to set using request parameters. Modifying this list will allow users to have more influence over pagination, be careful with what you permit.

Type

array

`$_pagingParams` ¶ protected

Paging params after pagination operation is done.

Type

array

Namespaces

Class Paginator

Property Summary

Method Summary

_configDelete() protected

_configRead() protected

_configWrite() protected

_extractFinder() protected

_prefix() protected

_removeAliases() protected

addPageCountParams() protected

addPrevNextParams() protected

addSortingParams() protected

addStartEndParams() protected

buildParams() protected

checkLimit() public

config() public deprecated

configShallow() public

extractData() protected

getConfig() public

getConfigOrFail() public

getCount() protected

getDefaults() public

getPagingParams() public

getQuery() protected

mergeOptions() public

paginate() public

setConfig() public

validateSort() public

Method Detail

_configDelete() ¶ protected

Parameters

Returns

Throws

_configRead() ¶ protected

Parameters

Returns

_configWrite() ¶ protected

Parameters

Returns

Throws

_extractFinder() ¶ protected

Parameters

Returns

_prefix() ¶ protected

Parameters

Returns

_removeAliases() ¶ protected

Parameters

Returns

addPageCountParams() ¶ protected

Parameters

Returns

addPrevNextParams() ¶ protected

Parameters

Returns

addSortingParams() ¶ protected

Parameters

Returns

addStartEndParams() ¶ protected

Parameters

Returns

buildParams() ¶ protected

Parameters

Returns

checkLimit() ¶ public

Parameters

Returns

config() ¶ public

Usage

Parameters

Returns

Throws

configShallow() ¶ public

Parameters

Returns

extractData() ¶ protected

Parameters

Returns

getConfig() ¶ public

`$_config` ¶ protected

`$_configInitialized` ¶ protected

`$_defaultConfig` ¶ protected

`$_pagingParams` ¶ protected