CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 4.4 Strawberry API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 4.4
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
      • Exception
      • Locator
      • Paging
        • Exception
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class NumericPaginator

This class is used to handle automatic model data pagination.

Namespace: Cake\Datasource\Paging

Property Summary

  • $_config protected
    array<string, mixed>

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array<string, mixed>

    Default pagination settings.

  • $_pagingParams protected
    array<string, array>

    Paging params after pagination operation is done.

Method Summary

  • _configDelete() protected

    Deletes a single config key.

  • _configRead() protected

    Reads a config key.

  • _configWrite() protected

    Writes a config key.

  • _extractFinder() protected

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

  • _prefix() protected

    Prefixes the field with the table alias if possible.

  • _removeAliases() protected

    Remove alias if needed.

  • addPageCountParams() protected

    Add "page" and "pageCount" params.

  • addPrevNextParams() protected

    Add "prevPage" and "nextPage" params.

  • addSortingParams() protected

    Add sorting / ordering params.

  • addStartEndParams() protected

    Add "start" and "end" params.

  • buildParams() protected

    Build pagination params.

  • checkLimit() public

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

  • configShallow() public

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

  • extractData() protected

    Extract pagination data needed

  • getAllowedParameters() protected

    Shim method for reading the deprecated whitelist or allowedParameters options

  • getConfig() public

    Returns the config.

  • getConfigOrFail() public

    Returns the config for this specific key.

  • getCount() protected

    Get total count of records.

  • getDefaults() public

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

  • getPagingParams() public

    Get paging params after pagination operation.

  • getQuery() protected

    Get query for fetching paginated results.

  • getSortableFields() protected

    Shim method for reading the deprecated sortWhitelist or sortableFields options.

  • mergeOptions() public

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

  • paginate() public

    Handles automatic pagination of model records.

  • setConfig() public

    Sets the config.

  • validateSort() public

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

Method Detail

_configDelete() ¶ protected

_configDelete(string $key): void

Deletes a single config key.

Parameters
string $key

Key to delete.

Returns
void
Throws
Cake\Core\Exception\CakeException
if attempting to clobber existing config

_configRead() ¶ protected

_configRead(string|null $key): mixed

Reads a config key.

Parameters
string|null $key

Key to read.

Returns
mixed

_configWrite() ¶ protected

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

Writes a config key.

Parameters
array<string, mixed>|string $key

Key to write to.

mixed $value

Value to write.

string|bool $merge optional

True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Returns
void
Throws
Cake\Core\Exception\CakeException
if attempting to clobber existing config

_extractFinder() ¶ protected

_extractFinder(array<string, mixed> $options): array

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

Parameters
array<string, mixed> $options

the pagination options.

Returns
array

_prefix() ¶ protected

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

Prefixes the field with the table alias if possible.

Parameters
Cake\Datasource\RepositoryInterface $object

Repository object.

array $order

Order array.

bool $allowed optional

Whether the field was allowed.

Returns
array

_removeAliases() ¶ protected

_removeAliases(array<string, mixed> $fields, string $model): array<string, mixed>

Remove alias if needed.

Parameters
array<string, mixed> $fields

Current fields

string $model

Current model alias

Returns
array<string, mixed>

addPageCountParams() ¶ protected

addPageCountParams(array<string, mixed> $params, array $data): array<string, mixed>

Add "page" and "pageCount" params.

Parameters
array<string, mixed> $params

Paging params.

array $data

Paginator data.

Returns
array<string, mixed>

addPrevNextParams() ¶ protected

addPrevNextParams(array<string, mixed> $params, array $data): array<string, mixed>

Add "prevPage" and "nextPage" params.

Parameters
array<string, mixed> $params

Paginator params.

array $data

Paging data.

Returns
array<string, mixed>

addSortingParams() ¶ protected

addSortingParams(array<string, mixed> $params, array $data): array<string, mixed>

Add sorting / ordering params.

Parameters
array<string, mixed> $params

Paginator params.

array $data

Paging data.

Returns
array<string, mixed>

addStartEndParams() ¶ protected

addStartEndParams(array<string, mixed> $params, array $data): array<string, mixed>

Add "start" and "end" params.

Parameters
array<string, mixed> $params

Paging params.

array $data

Paginator data.

Returns
array<string, mixed>

buildParams() ¶ protected

buildParams(array<string, mixed> $data): array<string, mixed>

Build pagination params.

Parameters
array<string, mixed> $data

Paginator data containing keys 'options', 'count', 'defaults', 'finder', 'numResults'.

Returns
array<string, mixed>

checkLimit() ¶ public

checkLimit(array<string, mixed> $options): array<string, mixed>

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

Parameters
array<string, mixed> $options

An array of options with a limit key to be checked.

Returns
array<string, mixed>

configShallow() ¶ public

configShallow(array<string, mixed>|string $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
array<string, mixed>|string $key

The key to set, or a complete array of configs.

mixed|null $value optional

The value to set.

Returns
$this

extractData() ¶ protected

extractData(Cake\Datasource\RepositoryInterface $object, array<string, mixed> $params, array<string, mixed> $settings): array

Extract pagination data needed

Parameters
Cake\Datasource\RepositoryInterface $object

The repository object.

array<string, mixed> $params

Request params

array<string, mixed> $settings

The settings/configuration used for pagination.

Returns
array

getAllowedParameters() ¶ protected

getAllowedParameters(): array<string>

Shim method for reading the deprecated whitelist or allowedParameters options

Returns
array<string>

getConfig() ¶ public

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
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.

Returns
mixed

getConfigOrFail() ¶ public

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
string $key

The key to get.

Returns
mixed
Throws
InvalidArgumentException

getCount() ¶ protected

getCount(Cake\Datasource\QueryInterface $query, array $data): int|null

Get total count of records.

Parameters
Cake\Datasource\QueryInterface $query

Query instance.

array $data

Pagination data.

Returns
int|null

getDefaults() ¶ public

getDefaults(string $alias, array<string, mixed> $settings): array<string, mixed>

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

Parameters
string $alias

Model name to get settings for.

array<string, mixed> $settings

The settings which is used for combining.

Returns
array<string, mixed>

getPagingParams() ¶ public

getPagingParams(): array<string, array>

Get paging params after pagination operation.

Returns
array<string, array>

getQuery() ¶ protected

getQuery(Cake\Datasource\RepositoryInterface $object, Cake\Datasource\QueryInterface|null $query, array<string, mixed> $data): Cake\Datasource\QueryInterface

Get query for fetching paginated results.

Parameters
Cake\Datasource\RepositoryInterface $object

Repository instance.

Cake\Datasource\QueryInterface|null $query

Query Instance.

array<string, mixed> $data

Pagination data.

Returns
Cake\Datasource\QueryInterface

getSortableFields() ¶ protected

getSortableFields(array<string, mixed> $config): array<string>|null

Shim method for reading the deprecated sortWhitelist or sortableFields options.

Parameters
array<string, mixed> $config

The configuration data to coalesce and emit warnings on.

Returns
array<string>|null

mergeOptions() ¶ public

mergeOptions(array<string, mixed> $params, array $settings): array<string, mixed>

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 allowedParameters to modify which options/values can be set using request parameters.

Parameters
array<string, mixed> $params

Request params.

array $settings

The settings to merge with the request data.

Returns
array<string, mixed>

paginate() ¶ public

paginate(Cake\Datasource\RepositoryInterface|Cake\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 an allowed list of all the columns you wish to allow sorting on. You can define the allowed sort fields in the $settings parameter:

$settings = [
  'Articles' => [
    'finder' => 'custom',
    'sortableFields' => ['title', 'author_id', 'comment_count'],
  ]
];

Passing an empty array as sortableFields 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 repository or query to paginate.

array $params optional

Request params

array $settings optional

The settings/configuration used for pagination.

Returns
Cake\Datasource\ResultSetInterface
Throws
Cake\Datasource\Paging\Exception\PageOutOfBoundsException

setConfig() ¶ public

setConfig(array<string, mixed>|string $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
array<string, mixed>|string $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.

Returns
$this
Throws
Cake\Core\Exception\CakeException
When trying to set a key that is invalid.

validateSort() ¶ public

validateSort(Cake\Datasource\RepositoryInterface $object, array<string, mixed> $options): array<string, mixed>

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 allowedParameters option 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 the sortableFields option.

Any columns listed in the allowed sort fields 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
Cake\Datasource\RepositoryInterface $object

Repository object.

array<string, mixed> $options

The pagination options being used for this request.

Returns
array<string, mixed>

Property Detail

$_config ¶ protected

Runtime config

Type
array<string, mixed>

$_configInitialized ¶ protected

Whether the config property has already been configured with defaults

Type
bool

$_defaultConfig ¶ protected

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.
  • 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.
  • sortableFields - A list of fields which can be used for sorting. By default all table columns can be used for sorting. You can use this option to restrict sorting only by particular fields. If you want to allow sorting on either associated columns or calculated fields then you will have to explicity specify them (along with other fields). Using an empty array will disable sorting alltogether.
  • finder - The table finder to use. Defaults to all.
Type
array<string, mixed>

$_pagingParams ¶ protected

Paging params after pagination operation is done.

Type
array<string, array>
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs