Class Paginator
This class is used to handle automatic model data pagination.
- Cake\Datasource\Paginator implements Cake\Datasource\PaginatorInterface uses Cake\Core\InstanceConfigTrait
Properties summary
-
$_defaultConfig
protectedarray
Default pagination settings. -
$_pagingParams
protectedarray
Paging params after pagination operation is done.
Inherited Properties
Method Summary
-
_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. -
checkLimit() public
Check the limit parameter and ensure it's within the maxLimit bounds. -
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. -
mergeOptions() public
Merges the various options that Paginator uses. Pulls settings together from the following places:
-
paginate() public
Handles automatic pagination of model records. -
validateSort() public
Validate that the desired sorting can be performed on the $object.
Method Detail
_extractFinder() protected ¶
_extractFinder( array $options )
Extracts the finder name and options out of the provided pagination options.
Parameters
- array $options
- the pagination options.
Returns
An array containing in the first position the finder name and in the second the options to be passed to it.
_prefix() protected ¶
_prefix( Cake\Datasource\RepositoryInterface
$object , array $order , boolean $whitelisted false )
Prefixes the field with the table alias if possible.
Parameters
-
Cake\Datasource\RepositoryInterface
$object - Repository object.
- array $order
- Order array.
- boolean $whitelisted optional false
- Whether or not the field was whitelisted.
Returns
Final order array.
_removeAliases() protected ¶
_removeAliases( array $fields , string $model )
Remove alias if needed.
Parameters
- array $fields
- Current fields
- string $model
- Current model alias
Returns
$fields Unaliased fields where applicable
checkLimit() public ¶
checkLimit( array $options )
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
An array of options for pagination.
getDefaults() public ¶
getDefaults( string $alias , array $settings )
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
An array of pagination settings for a model, or the general settings.
getPagingParams() public ¶
getPagingParams( )
Get paging params after pagination operation.
Returns
Implementation of
mergeOptions() public ¶
mergeOptions( array $params , array $settings )
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 of merged options.
paginate() public ¶
paginate( Cake\Datasource\RepositoryInterface
|Cake\Datasource\QueryInterface
$object , array $params [] , array $settings [] )
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\RepositoryInterface
|Cake\Datasource\QueryInterface
$object - The table or query to paginate.
- array $params optional []
- Request params
- array $settings optional []
- The settings/configuration used for pagination.
Returns
Throws
Implementation of
validateSort() public ¶
validateSort( Cake\Datasource\RepositoryInterface
$object , array $options )
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
An array of options with sort + direction removed and replaced with order if possible.
Methods used from Cake\Core\InstanceConfigTrait
_configDelete() protected ¶
_configDelete( string $key )
Deletes a single config key.
Parameters
- string $key
- Key to delete.
Throws
_configRead() protected ¶
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null $key
- Key to read.
Returns
_configWrite() protected ¶
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Writes a config key.
Parameters
- string|array $key
- Key to write to.
- mixed $value
- Value to write.
- boolean|string $merge optional false
True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Throws
config() public ¶
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
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']);
Deprecated
Parameters
- string|array|null $key optional null
- The key to get/set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
Config value being read, or the object itself on write operations.
Throws
configShallow() public ¶
configShallow( string|array $key , mixed|null $value null )
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 null
- The value to set.
Returns
$this
getConfig() public ¶
getConfig( string|null $key null , mixed $default 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 null
- The key to get or null for the whole config.
- mixed $default optional null
- The return value when the key does not exist.
Returns
Config value being read.
setConfig() public ¶
setConfig( string|array $key , mixed|null $value null , boolean $merge true )
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 null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$this
Throws
Properties detail
$_defaultConfig ¶
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 100limit
- 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.
[ 'page' => 1, 'limit' => 20, 'maxLimit' => 100, 'whitelist' => ['limit', 'sort', 'page', 'direction'] ]