This class is used to handle automatic model data pagination.
$_defaultConfig
protected array
$_pagingParams
protected array
Get the settings for a $model. If there are no settings for a specific repository, the general settings will be used.
Merges the various options that Paginator uses. Pulls settings together from the following places:
_extractFinder( array $options )
Extracts the finder name and options out of the provided pagination options.
$options
An array containing in the first position the finder name and in the second the options to be passed to it.
_prefix( Cake\Datasource\RepositoryInterface $object , array $order , boolean $whitelisted false )
Prefixes the field with the table alias if possible.
Cake\Datasource\RepositoryInterface
$object
$order
$whitelisted
optional false checkLimit( array $options )
Check the limit parameter and ensure it's within the maxLimit bounds.
$options
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.
$alias
$settings
An array of pagination settings for a model, or the general settings.
getPagingParams( )
Get paging params after pagination operation.
Cake\Datasource\PaginatorInterface::getPagingParams()
mergeOptions( array $params , array $settings )
Merges the various options that Paginator uses. Pulls settings together from the following places:
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.
$params
$settings
paginate( Cake\Datasource\RepositoryInterface|Cake\Datasource\QueryInterface $object , array $params [] , array $settings [] )
Handles automatic pagination of model records.
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.
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.
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);
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
Cake\Datasource\RepositoryInterface
|Cake\Datasource\QueryInterface
$object
$params
optional [] $settings
optional [] Cake\Datasource\ResultSetInterface
Cake\Datasource\Exception\PageOutOfBoundsException
Cake\Datasource\PaginatorInterface::paginate()
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.
Cake\Datasource\RepositoryInterface
$object
$options
An array of options with sort + direction removed and replaced with order if possible.
_configDelete( string $key )
Deletes a single config key.
$key
Cake\Core\Exception\Exception
_configRead( string|null $key )
Reads a config key.
$key
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Writes a config key.
$key
$value
$merge
optional false True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Gets/Sets the config.
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']);
$key
optional null $value
optional null $merge
optional true Cake\Core\Exception\Exception
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']);
$key
$value
optional null getConfig( string|null $key null , mixed $default null )
Returns the config.
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');
$key
optional null $default
optional null setConfig( string|array $key , mixed|null $value null , boolean $merge true )
Sets the config.
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']);
$key
$value
optional null $merge
optional true Cake\Core\Exception\Exception
protected array
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'] ]
© 2005–2018 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/3.6/class-Cake.Datasource.Paginator.html