Class PaginatorComponent

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.

Configuring pagination

You configure pagination when calling paginate(). See that method for more details.

Cake\Controller\Component implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait , Cake\Log\LogTrait

Cake\Controller\Component\PaginatorComponent

Namespace: Cake\Controller\Component
Link: https://book.cakephp.org/3.0/en/controllers/components/pagination.html
Mixin: \Cake\Datasource\Paginator
Location: Controller/Component/PaginatorComponent.php

Properties summary

$_defaultConfig protected

array

Default pagination settings.
$_paginator protected

Cake\Datasource\Paginator

Datasource paginator instance.

Inherited Properties

_componentMap, _registry, components, request, response _config, _configInitialized

Method Summary

__call() public

Proxy method calls to Paginator.
__construct() public

Constructor
_setPagingParams() protected

Set paging params to request instance.
config() public deprecated

Proxy getting/setting config options to Paginator.
configShallow() public

Proxy setting config options to Paginator.
getConfig() public

Proxy getting config options to Paginator.
getPaginator() public

Get paginator instance.
implementedEvents() public

Events supported by this component.
mergeOptions() public

Merges the various options that Pagination uses. Pulls settings together from the following places:
paginate() public

Handles automatic pagination of model records.
setConfig() public

Proxy setting config options to Paginator.
setPaginator() public

Set paginator instance.

Method Detail

__call() public ¶

__call( string $method , array $args )

Proxy method calls to Paginator.

Parameters

string $method: Method name.
array $args: Method arguments.

Returns

mixed

__construct() public ¶

__construct( Cake\Controller\ComponentRegistry $registry , array $config = [] )

Constructor

Parameters

Cake\Controller\ComponentRegistry $registry: A ComponentRegistry this component can use to lazy load its components
array $config optional []: Array of configuration settings.

Overrides

Cake\Controller\Component::__construct()

_setPagingParams() protected ¶

_setPagingParams( )

Set paging params to request instance.

config() public deprecated ¶

config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )

Proxy getting/setting config options to Paginator.

Deprecated

3.5.0 use setConfig()/getConfig() instead.

Parameters

string|array|null $key optional null: The key to get/set, or a complete array of configs.
mixed|null $value optional null: The value to set.
boolean $merge optional true: Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed
Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

Overrides

Cake\Core\InstanceConfigTrait::config()

configShallow() public ¶

configShallow( string|array $key , mixed|null $value = null )

Proxy setting config options to Paginator.

Parameters

string|array $key: The key to set, or a complete array of configs.
mixed|null $value optional null: The value to set.

Returns

$this

Overrides

Cake\Core\InstanceConfigTrait::configShallow()

getConfig() public ¶

getConfig( string|null $key = null , mixed $default = null )

Proxy getting config options to Paginator.

Parameters

string|null $key optional null: The key to get or null for the whole config.
mixed $default optional null: The return value when the key does not exist.

Returns

mixed
Config value being read.

Overrides

Cake\Core\InstanceConfigTrait::getConfig()

getPaginator() public ¶

getPaginator( )

Get paginator instance.

Returns

Cake\Datasource\Paginator

implementedEvents() public ¶

implementedEvents( )

Events supported by this component.

Returns

array

Overrides

Cake\Controller\Component::implementedEvents()

mergeOptions() public ¶

mergeOptions( string $alias , array $settings )

Merges the various options that Pagination uses. Pulls settings together from the following places:

General pagination settings
Model specific settings.
Request parameters

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.

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.

Returns

array
Array of merged options.

paginate() public ¶

paginate( Cake\Datasource\RepositoryInterface|Cake\Datasource\QueryInterface $object , array $settings = [] )

Handles automatic pagination of model records.

Configuring pagination

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.

Controlling sort fields

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.

Paginating with custom finders

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);

Scoping Request parameters

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

Parameters

Cake\Datasource\RepositoryInterface|Cake\Datasource\QueryInterface $object: The table or query to paginate.
array $settings optional []: The settings/configuration used for pagination.

Returns

Cake\Datasource\ResultSetInterface
Query results

Throws

Cake\Http\Exception\NotFoundException

setConfig() public ¶

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

Proxy setting config options to Paginator.

Parameters

string|array $key: The key to set, or a complete array of configs.
mixed|null $value optional null: The value to set.
boolean $merge optional true: Whether to recursively merge or overwrite existing config, defaults to true.

Returns

$this

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

Overrides

Cake\Core\InstanceConfigTrait::setConfig()

setPaginator() public ¶

setPaginator( Cake\Datasource\Paginator $paginator )

Set paginator instance.

Parameters

Cake\Datasource\Paginator $paginator: Paginator instance.

Returns

Cake\Controller\Component\PaginatorComponent

Methods inherited from Cake\Controller\Component

__debugInfo() public ¶

__debugInfo( )

Returns an array that can be used to describe the internal state of this object.

Returns

array

__get() public ¶

__get( string $name )

Magic method for lazy loading $components.

Parameters

string $name: Name of component to get.

Returns

Cake\Controller\Component|null
A Component object or null.

getController() public ¶

getController( )

Get the controller this component is bound to.

Returns

Cake\Controller\Controller
The bound controller.

initialize() public ¶

initialize( array $config )

Constructor hook method.

Implement this method to avoid having to overwrite the constructor and call parent.

Parameters

array $config: The configuration settings provided to this component.

Methods used from Cake\Core\InstanceConfigTrait

_configDelete() protected ¶

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key: Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead() protected ¶

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key: Key to read.

Returns

mixed

_configWrite() protected ¶

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

Writes a config key.

Parameters

string|array $key: Key to write to.
mixed $value: Value to write.
boolean|string $merge optional false: True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

Methods used from Cake\Log\LogTrait

log() public ¶

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.

Parameters

mixed $msg: Log message.
integer|string $level optional LogLevel::ERROR: Error level.
string|array $context optional []: Additional log data relevant to this message.

Returns

boolean
Success of log write.

Properties detail

`$_defaultConfig` ¶

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 100
limit - 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']
]

`$_paginator` ¶

protected Cake\Datasource\Paginator

Datasource paginator instance.

Namespaces

Classes

Class PaginatorComponent

Configuring pagination

Properties summary

Inherited Properties

Method Summary

__call() public

__construct() public

_setPagingParams() protected

config() public deprecated

configShallow() public

getConfig() public

getPaginator() public

implementedEvents() public

mergeOptions() public

paginate() public

setConfig() public

setPaginator() public

Method Detail

__call() public ¶

Parameters

Returns

__construct() public ¶

Parameters

Overrides

_setPagingParams() protected ¶

config() public deprecated ¶

Deprecated

Parameters

Returns

Throws

Overrides

configShallow() public ¶

Parameters

Returns

Overrides

getConfig() public ¶

Parameters

Returns

Overrides

getPaginator() public ¶

Returns

implementedEvents() public ¶

Returns

Overrides

mergeOptions() public ¶

Parameters

Returns

paginate() public ¶

Configuring pagination

Controlling sort fields

Paginating with custom finders

Scoping Request parameters

Parameters

Returns

Throws

setConfig() public ¶

Parameters

Returns

Throws

Overrides

setPaginator() public ¶

Parameters

Returns

Methods inherited from Cake\Controller\Component

__debugInfo() public ¶

Returns

__get() public ¶

Parameters

Returns

getController() public ¶

Returns

initialize() public ¶

Parameters

Methods used from Cake\Core\InstanceConfigTrait

_configDelete() protected ¶

Parameters

Throws

_configRead() protected ¶

`$_defaultConfig` ¶

`$_paginator` ¶