Class PaginatorComponent

__call(string $method, array $args): mixed

Proxy method calls to Paginator.

Parameters

Returns

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

Constructor

Parameters

__debugInfo(): array

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

Returns

__get(string $name): Cake\Controller\Component|null

Magic method for lazy loading $components.

Parameters

Returns

_configDelete(string $key): void

Deletes a single config key.

Parameters

Returns

Throws

_configRead(string|null $key): mixed

Reads a config key.

Parameters

Returns

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Writes a config key.

Parameters

Returns

Throws

_setPagingParams(): void

Set paging params to request instance.

Returns

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

Proxy setting config options to Paginator.

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

Parameters

Returns

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

Proxy getting config options to Paginator.

Usage

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

Parameters

Returns

getConfigOrFail(string $key): mixed

Returns the config for this specific key.

The config value for this key must exist, it can never be null.

Parameters

Returns

Throws

getController(): Cake\Controller\Controller

Get the controller this component is bound to.

Returns

getPaginator(): Cake\Datasource\Paginator

Get paginator instance.

Returns

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.

Returns

initialize(array $config): void

Constructor hook method.

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

Parameters

Returns

log(string $message, int|string $level = LogLevel::ERROR, string|array $context = []): bool

Convenience method to write a message to Log. See Log::write() for more information on writing to logs.

Parameters

Returns

mergeOptions(string $alias, array $settings): array

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

Returns

paginate(Cake\Datasource\RepositoryInterfaceCake\Datasource\QueryInterface $object, array $settings = []): Cake\Datasource\ResultSetInterface

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

Returns

Throws

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

Proxy setting config options to Paginator.

Usage

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

Parameters

Returns

setPaginator(Cake\Datasource\Paginator $paginator): $this

Set paginator instance.

Parameters

Returns