$request
$request : \Cake\Http\ServerRequest
Request object
This component is used to handle automatic model data pagination. The primary way to use this component is to call the paginate() method. There is a convenience wrapper on Controller as well.
You configure pagination when calling paginate(). See that method for more details.
$request : \Cake\Http\ServerRequest
Request object
$response : \Cake\Http\Response
Response object
$_registry : \Cake\Controller\ComponentRegistry
Component registry class used to lazy load components.
$_defaultConfig : 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.$_paginator : \Cake\Datasource\Paginator
Datasource paginator instance.
__construct(\Cake\Controller\ComponentRegistry $registry, array $config = array())
Constructor
| \Cake\Controller\ComponentRegistry | $registry | A ComponentRegistry this component can use to lazy load its components |
| array | $config | Array of configuration settings. |
getController() : \Cake\Controller\Controller
Get the controller this component is bound to.
The bound controller.
implementedEvents() : array
Events supported by this component.
Uses Conventions to map controller events to standard component callback method names. By defining one of the callback methods a component is assumed to be interested in the related event.
Override this method if you need to add non-conventional event listeners. Or if you want components to listen to non-standard events.
setConfig(string|array $key, mixed|null $value = null, boolean $merge = true) : $this
Proxy setting config options to Paginator.
| string|array | $key | The key to set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
config(string|array|null $key = null, mixed|null $value = null, boolean $merge = true) : mixed
Proxy getting/setting config options to Paginator.
| string|array|null | $key | The key to get/set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
Config value being read, or the object itself on write operations.
log(mixed $msg, integer|string $level = \Psr\Log\LogLevel::ERROR, string|array $context = array()) : boolean
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
| mixed | $msg | Log message. |
| integer|string | $level | Error level. |
| string|array | $context | Additional log data relevant to this message. |
Success of log write.
paginate(\Cake\Datasource\RepositoryInterface|\Cake\Datasource\QueryInterface $object, array $settings = array()) : \Cake\Datasource\ResultSetInterface
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 Table. You can configure Table specific settings by keying the settings with the Table 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 tables.
By default CakePHP will automatically allow sorting on any column on the table 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 | The table or query to paginate. |
| array | $settings | The settings/configuration used for pagination. |
Query results
mergeOptions(string $alias, array $settings) : array
Merges the various options that Pagination 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.
| string | $alias | Model alias being paginated, if the general settings has a key with this value that key's settings will be used for pagination instead of the general ones. |
| array | $settings | The settings to merge with the request data. |
Array of merged options.
setPaginator(\Cake\Datasource\Paginator $paginator) : self
Set paginator instance.
| \Cake\Datasource\Paginator | $paginator | Paginator instance. |
getPaginator() : \Cake\Datasource\Paginator
Get paginator instance.
_configWrite(string|array $key, mixed $value, boolean|string $merge = false) : void
Writes a config key.
| string|array | $key | Key to write to. |
| mixed | $value | Value to write. |
| boolean|string | $merge | True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false. |
if attempting to clobber existing config