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 using the PaginatorComponent::$settings. This allows you to configure the default pagination behavior in general or for a specific model. General settings are used when there are no specific model configuration, or the model you are paginating does not have specific settings.

$this->Paginator->settings = array(
    'limit' => 20,
    'maxLimit' => 100
);

The above settings will be used to paginate any model. You can configure model specific settings by keying the settings with the model name.

$this->Paginator->settings = array(
    'Post' => array(
        'limit' => 20,
        'maxLimit' => 100
    ),
    'Comment' => array( ... )
);

This would allow you to have different pagination settings for Comment and Post models.

Paginating with custom finders

You can paginate with any find type defined on your model using the findType option.

$this->Paginator->settings = array(
    'Post' => array(
        'findType' => 'popular'
    )
);

Would paginate using the find('popular') method.

CakeObject
Extended by Component
Extended by PaginatorComponent
Package: Cake\Controller\Component
Link: https://book.cakephp.org/2.0/en/core-libraries/components/pagination.html
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/Controller/Component/PaginatorComponent.php

Properties summary

  • $settings public
    array

    Pagination settings. These settings control pagination at a general level. You can also define sub arrays for pagination settings for specific models.

  • $whitelist public
    array

    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.

Inherited Properties

Method Summary

  • __construct() public
    Constructor
  • _getObject() protected
    Get the object pagination will occur on.
  • checkLimit() public
    Check the limit parameter and ensure its within the maxLimit bounds.
  • getDefaults() public

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

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

  • paginate() public
    Handles automatic pagination of model records.
  • 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.

Method Detail

__construct()source public

__construct( ComponentCollection $collection , array $settings array() )

Constructor

Parameters

ComponentCollection $collection
A ComponentCollection this component can use to lazy load its components
array $settings optional array()
Array of configuration settings.

Overrides

Component::__construct()

_getObject()source protected

_getObject( string|Model $object )

Get the object pagination will occur on.

Parameters

string|Model $object
The object you are looking for.

Returns

mixed
The model object to paginate on.

checkLimit()source public

checkLimit( array $options )

Check the limit parameter and ensure its within the maxLimit bounds.

Parameters

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

Returns

array
An array of options for pagination

getDefaults()source public

getDefaults( string $alias )

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

Parameters

string $alias
Model name to get default settings for.

Returns

array
An array of pagination defaults for a model, or the general settings.

mergeOptions()source public

mergeOptions( string $alias )

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 PaginatorComponent::$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.

Returns

array
Array of merged options.

paginate()source public

paginate( Model|string $object null , string|array $scope array() , array $whitelist array() )

Handles automatic pagination of model records.

Parameters

Model|string $object optional null
Model to paginate (e.g: model instance, or 'Model', or 'Model.InnerModel')
string|array $scope optional array()
Additional find conditions to use while paginating
array $whitelist optional array()

List of allowed fields for ordering. This allows you to prevent ordering on non-indexed, or undesirable columns. See PaginatorComponent::validateSort() for additional details on how the whitelisting and sort field validation works.

Returns

array
Model query results

Throws

MissingModelException
NotFoundException

validateSort()source public

validateSort( Model $object , array $options , array $whitelist 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. This helps prevent users from ordering large result sets on un-indexed values.

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.

Parameters

Model $object
The model being paginated.
array $options
The pagination options being used for this request.
array $whitelist optional array()
The list of columns that can be used for sorting. If empty all keys are allowed.

Returns

array
An array of options with sort + direction removed and replaced with order if possible.

Methods inherited from Component

__get()source public

__get( string $name )

Magic method for lazy loading $components.

Parameters

string $name
Name of component to get.

Returns

mixed
A Component object or null.

beforeRedirect()source public

beforeRedirect( Controller $controller , string|array $url , integer $status null , boolean $exit true )

Called before Controller::redirect(). Allows you to replace the URL that will be redirected to with a new URL. The return of this method can either be an array or a string.

If the return is an array and contains a 'url' key. You may also supply the following:

  • status The status code for the redirect
  • exit Whether or not the redirect should exit.

If your response is a string or an array that does not contain a 'url' key it will be used as the new URL to redirect to.

Parameters

Controller $controller
Controller with components to beforeRedirect
string|array $url
Either the string or URL array that is being redirected to.
integer $status optional null
The status code of the redirect
boolean $exit optional true
Will the script exit.

Returns

array|null
Either an array or null.

Link

https://book.cakephp.org/2.0/en/controllers/components.html#Component::beforeRedirect

beforeRender()source public

beforeRender( Controller $controller )

Called before the Controller::beforeRender(), and before the view class is loaded, and before Controller::render()

Parameters

Controller $controller
Controller with components to beforeRender

Link

https://book.cakephp.org/2.0/en/controllers/components.html#Component::beforeRender

initialize()source public

initialize( Controller $controller )

Called before the Controller::beforeFilter().

Parameters

Controller $controller
Controller with components to initialize

Link

https://book.cakephp.org/2.0/en/controllers/components.html#Component::initialize

shutdown()source public

shutdown( Controller $controller )

Called after Controller::render() and before the output is printed to the browser.

Parameters

Controller $controller
Controller with components to shutdown

Link

https://book.cakephp.org/2.0/en/controllers/components.html#Component::shutdown

startup()source public

startup( Controller $controller )

Called after the Controller::beforeFilter() and before the controller action

Parameters

Controller $controller
Controller with components to startup

Link

https://book.cakephp.org/2.0/en/controllers/components.html#Component::startup

Methods inherited from CakeObject

_mergeVars()source protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'

This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.

Parameters

array $properties
The name of the properties to merge.
string $class
The class to merge the property with.
boolean $normalize optional true
Set to true to run the properties through Hash::normalize() before merging.

_set()source protected

_set( array $properties array() )

Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.

Parameters

array $properties optional array()
An associative array containing properties and corresponding values.

_stop()source protected

_stop( integer|string $status 0 )

Stop execution of the current script. Wraps exit() making testing easier.

Parameters

integer|string $status optional 0
see http://php.net/exit for values

dispatchMethod()source public

dispatchMethod( string $method , array $params array() )

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array

Parameters

string $method
Name of the method to call
array $params optional array()
Parameter list to use when calling $method

Returns

mixed
Returns the result of the method call

log()source public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

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

Parameters

string $msg
Log message
integer $type optional LOG_ERR
Error type constant. Defined in app/Config/core.php.
null|string|array $scope optional null

The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.

Returns

boolean
Success of log write

requestAction()source public

requestAction( string|array $url , array $extra array() )

Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.

Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()

Passing POST and GET data

POST and GET data can be simulated in requestAction. Use $extra['url'] for GET data. The $extra['data'] parameter allows POST data simulation.

Parameters

string|array $url

String or array-based URL. Unlike other URL arrays in CakePHP, this URL will not automatically handle passed and named arguments in the $url parameter.

array $extra optional array()

if array includes the key "return" it sets the AutoRender to true. Can also be used to submit GET/POST data, and named/passed arguments.

Returns

mixed

Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.


toString()source public

toString( )

CakeObject-to-string conversion. Each class can override this method as necessary.

Returns

string
The name of this class

Properties detail

$settingssource

public array

Pagination settings. These settings control pagination at a general level. You can also define sub arrays for pagination settings for specific models.

  • 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.
  • paramType What type of parameters you want pagination to use?
    • named Use named parameters / routed parameters.
    • querystring Use query string parameters.
  • queryScope By using request parameter scopes you can paginate multiple queries in the same controller action.
$paginator->paginate = array(
'Article' => array('queryScope' => 'articles'),
'Tag' => array('queryScope' => '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
array(
    'page' => 1,
    'limit' => 20,
    'maxLimit' => 100,
    'paramType' => 'named',
    'queryScope' => null
)

$whitelistsource

public array

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.

array(
    '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/2.10/class-PaginatorComponent.html