Class Paginator

_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

_extractFinder(array $options): array

Extracts the finder name and options out of the provided pagination options.

Parameters

Returns

_prefix(Cake\Datasource\RepositoryInterface $object, array $order, bool $whitelisted = false): array

Prefixes the field with the table alias if possible.

Parameters

Returns

_removeAliases(array $fields, string $model): array

Remove alias if needed.

Parameters

Returns

checkLimit(array $options): array

Check the limit parameter and ensure it's within the maxLimit bounds.

Parameters

Returns

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

Gets/Sets the config.

Usage

Reading the whole config:

$this->config();

Reading a specific value:

$this->config('key');

Reading a nested value:

$this->config('some.nested.key');

Setting a specific value:

$this->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);

Parameters

Returns

Throws

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

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

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

Returns the config.

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

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

Get the settings for a $model. If there are no settings for a specific repository, the general settings will be used.

Parameters

Returns

getPagingParams(): array

Get paging params after pagination operation.

Returns

mergeOptions(array $params, array $settings): array

Merges the various options that Paginator 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 $params = [], 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 repository. You can configure repository specific settings by keying the settings with the repository 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 repositories.

Controlling sort fields

By default CakePHP will automatically allow sorting on any column on the repository 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

Sets the config.

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

Throws

validateSort(Cake\Datasource\RepositoryInterface $object, array $options): array

Validate that the desired sorting can be performed on the $object.

Only fields or virtualFields can be sorted on. The direction param will also be sanitized. Lastly sort + direction keys will be converted into the model friendly order key.

You can use the whitelist parameter to control which columns/fields are available for sorting via URL parameters. This helps prevent users from ordering large result sets on un-indexed values.

If you need to sort on associated columns or synthetic properties you will need to use a whitelist.

Any columns listed in the sort whitelist will be implicitly trusted. You can use this to sort on synthetic columns, or columns added in custom find operations that may not exist in the schema.

The default order options provided to paginate() will be merged with the user's requested sorting field/direction.

Parameters

Returns