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.
array
A component lookup table used to lazy load component objects.
array
Runtime config
bool
Whether the config property has already been configured with defaults
array
Default pagination settings.
\Cake\Datasource\Paginator
Datasource paginator instance.
\Cake\Controller\ComponentRegistry
Component registry class used to lazy load components.
array
Other Components this component uses.
Returns an array that can be used to describe the internal state of this object.
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
__call(string $method, array $args)
Proxy method calls to Paginator.
string
$method Method name.
array
$args Method arguments.
mixed
__construct(\Cake\Controller\ComponentRegistry $registry, array $config)
Constructor
\Cake\Controller\ComponentRegistry
$registry A component registry this component can use to lazy load its components.
array
$config optional Array of configuration settings.
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
array
__get(string $name)
Magic method for lazy loading $components.
string
$name Name of component to get.
\Cake\Controller\Component|null
A Component object or null.
_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
_setPagingParams()
Set paging params to request instance.
configShallow(mixed $key, mixed $value)
Proxy setting config options to Paginator.
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
getConfig(?string $key, mixed $default)
Proxy getting config options to Paginator.
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.
mixed
Config value being read.
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.
mixed
Configuration data at the named key
InvalidArgumentException
getController()
Get the controller this component is bound to.
\Cake\Controller\Controller
The bound controller.
getPaginator()
Get paginator instance.
\Cake\Datasource\Paginator
implementedEvents()
Events supported by this component.
array
initialize(array $config)
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array
$config The configuration settings provided to this component.
log(string $message, mixed $level, mixed $context)
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
string
$message Log message.
int|string
$level optional Error level.
string|array
$context optional Additional log data relevant to this message.
bool
Success of log write.
mergeOptions(string $alias, array $settings)
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 allowedParameters
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
Array of merged options.
paginate(object $object, 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 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 an allowed list of fields you wish to allow sorting on. You can define the allowed fields in the $settings
parameter:
$settings = [ 'Articles' => [ 'finder' => 'custom', 'sortableFields' => ['title', 'author_id', 'comment_count'], ] ];
Passing an empty array as allowed list 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 Table or query to paginate.
array
$settings optional The settings/configuration used for pagination.
\Cake\Datasource\ResultSetInterface
Query results
Cake\Http\Exception\NotFoundException
setConfig(mixed $key, mixed $value, mixed $merge)
Proxy setting config options to Paginator.
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.
$this
setPaginator(\Cake\Datasource\Paginator $paginator)
Set paginator instance.
\Cake\Datasource\Paginator
$paginator Paginator instance.
$this
A component lookup table used to lazy load component objects.
array
Runtime config
array
Whether the config property has already been configured with defaults
bool
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.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.array
Datasource paginator instance.
\Cake\Datasource\Paginator
Component registry class used to lazy load components.
\Cake\Controller\ComponentRegistry
Other Components this component uses.
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.Controller.Component.PaginatorComponent.html