Simplified paginator which avoids potentially expensives queries to get the total count of records.
When using a simple paginator you will not be able to generate page numbers. Instead use only the prev/next pagination controls, and handle 404 errors when pagination goes past the available result set.
arrayRuntime config
boolWhether the config property has already been configured with defaults
arrayDefault pagination settings.
arrayPaging params after pagination operation is done.
Extracts the finder name and options out of the provided pagination options.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Shim method for reading the deprecated whitelist or allowedParameters options
Simple pagination does not perform any count query, so this method returns null.
Get the settings for a $model. If there are no settings for a specific repository, the general settings will be used.
Shim method for reading the deprecated sortWhitelist or sortableFields options.
_configDelete(string $key)
Deletes a single config key.
string $key Key to delete.
Cake\Core\Exception\Exception_configRead(?string $key)
Reads a config key.
string|null $key Key to read.
mixed_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
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.
Cake\Core\Exception\Exception_extractFinder(array $options)
Extracts the finder name and options out of the provided pagination options.
array $options the pagination options.
arrayAn 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, bool $allowed)
Prefixes the field with the table alias if possible.
\Cake\Datasource\RepositoryInterface $object Repository object.
array $order Order array.
bool $allowed optional Whether or not the field was allowed.
arrayFinal order array.
_removeAliases(array $fields, string $model)
Remove alias if needed.
array $fields Current fields
string $model Current model alias
array$fields Unaliased fields where applicable
addPageCountParams(array $params, array $data)
Add "page" and "pageCount" params.
array $params Paging params.
array $data Paginator data.
arrayUpdated params.
addPrevNextParams(array $params, array $data)
Add "prevPage" and "nextPage" params.
array $params Paginator params.
array $data Paging data.
arrayUpdated params.
addSortingParams(array $params, array $data)
Add sorting / ordering params.
array $params Paginator params.
array $data Paging data.
arrayUpdated params.
addStartEndParams(array $params, array $data)
Add "start" and "end" params.
array $params Paging params.
array $data Paginator data.
arrayUpdated params.
buildParams(array $data)
Build pagination params.
array $data Paginator data containing keys 'options', 'count', 'defaults', 'finder', 'numResults'.
arrayPaging params.
checkLimit(array $options)
Check the limit parameter and ensure it's within the maxLimit bounds.
array $options An array of options with a limit key to be checked.
arrayAn array of options for pagination.
configShallow(mixed $key, mixed $value)
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']);
string|array $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thisextractData(\Cake\Datasource\RepositoryInterface $object, array $params, array $settings)
Extract pagination data needed
\Cake\Datasource\RepositoryInterface $object The repository object.
array $params Request params
array $settings The settings/configuration used for pagination.
arrayArray with keys 'defaults', 'options' and 'finder'
getAllowedParameters()
Shim method for reading the deprecated whitelist or allowedParameters options
string[]getConfig(?string $key, mixed $default)
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'); string|null $key optional The key to get or null for the whole config.
mixed $default optional The return value when the key does not exist.
mixedConfiguration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string $key The key to get.
mixedConfiguration data at the named key
InvalidArgumentExceptiongetCount(\Cake\Datasource\QueryInterface $query, array $data)
Simple pagination does not perform any count query, so this method returns null.
\Cake\Datasource\QueryInterface $query Query instance.
array $data Pagination data.
int|nullgetDefaults(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.
string $alias Model name to get settings for.
array $settings The settings which is used for combining.
arrayAn array of pagination settings for a model, or the general settings.
getPagingParams()
Get paging params after pagination operation.
arraygetQuery(\Cake\Datasource\RepositoryInterface $object, ?\Cake\Datasource\QueryInterface $query, array $data)
Get query for fetching paginated results.
\Cake\Datasource\RepositoryInterface $object Repository instance.
\Cake\Datasource\QueryInterface|null $query optional Query Instance.
array $data Pagination data.
\Cake\Datasource\QueryInterfacegetSortableFields(array $config)
Shim method for reading the deprecated sortWhitelist or sortableFields options.
array $config The configuration data to coalesce and emit warnings on.
string[]|nullmergeOptions(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 allowedParameters to modify which options/values can be set using request parameters.
array $params Request params.
array $settings The settings to merge with the request data.
arrayArray of merged options.
paginate(object $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 an allowed list of all the columns you wish to allow sorting on. You can define the allowed sort fields in the $settings parameter:
$settings = [
'Articles' => [
'finder' => 'custom',
'sortableFields' => ['title', 'author_id', 'comment_count'],
]
]; Passing an empty array as sortableFields 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 The repository or query to paginate.
array $params optional Request params
array $settings optional The settings/configuration used for pagination.
\Cake\Datasource\ResultSetInterfaceQuery results
Cake\Datasource\Exception\PageOutOfBoundsExceptionsetConfig(mixed $key, mixed $value, mixed $merge)
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']);
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.
$thisCake\Core\Exception\ExceptionvalidateSort(\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 allowedParameters option 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 the sortableFields option.
Any columns listed in the allowed sort fields 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 Repository object.
array $options The pagination options being used for this request.
arrayAn array of options with sort + direction removed and replaced with order if possible.
Runtime config
arrayWhether the config property has already been configured with defaults
boolDefault 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.allowedParameters - 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.arrayPaging params after pagination operation is done.
array
© 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/class-Cake.Datasource.SimplePaginator.html