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.
$_defaultConfig
protected array
$_paginator
protected Merges the various options that Pagination uses. Pulls settings together from the following places:
__call( string $method , array $args )
Proxy method calls to Paginator.
$method
$args
__construct( Cake\Controller\ComponentRegistry $registry , array $config [] )
Constructor
Cake\Controller\ComponentRegistry
$registry
$config
optional [] Cake\Controller\Component::__construct()
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Proxy getting/setting config options to Paginator.
$key
optional null $value
optional null $merge
optional true Cake\Core\Exception\Exception
Cake\Core\InstanceConfigTrait::config()
configShallow( string|array $key , mixed|null $value null )
Proxy setting config options to Paginator.
$key
$value
optional null Cake\Core\InstanceConfigTrait::configShallow()
getConfig( string|null $key null , mixed $default null )
Proxy getting config options to Paginator.
$key
optional null $default
optional null Cake\Core\InstanceConfigTrait::getConfig()
getPaginator( )
Get paginator instance.
Cake\Datasource\Paginator
implementedEvents( )
Events supported by this component.
Cake\Controller\Component::implementedEvents()
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 whitelist
to modify which options/values can be set using request parameters.
$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.
$settings
paginate( Cake\Datasource\RepositoryInterface|Cake\Datasource\QueryInterface $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 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
$settings
optional [] Cake\Datasource\ResultSetInterface
Cake\Network\Exception\NotFoundException
setConfig( string|array $key , mixed|null $value null , boolean $merge true )
Proxy setting config options to Paginator.
$key
$value
optional null $merge
optional true Cake\Core\Exception\Exception
Cake\Core\InstanceConfigTrait::setConfig()
setPaginator( Cake\Datasource\Paginator $paginator )
Set paginator instance.
Cake\Datasource\Paginator
$paginator
Cake\Controller\Component\PaginatorComponent
__debugInfo( )
Returns an array that can be used to describe the internal state of this object.
__get( string $name )
Magic method for lazy loading $components.
$name
getController( )
Get the controller this component is bound to.
Cake\Controller\Controller
initialize( array $config )
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
$config
_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
log( mixed $msg , integer|string $level LogLevel::ERROR , string|array $context [] )
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
$msg
$level
optional LogLevel::ERROR $context
optional [] 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–2017 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.4/class-Cake.Controller.Component.PaginatorComponent.html