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.
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.
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.
$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.
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:
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.
__construct( ComponentCollection $collection , array $settings array() )
Constructor
ComponentCollection
$collection
$settings
optional array() Component::__construct()
_getObject( string|Model $object )
Get the object pagination will occur on.
Model
$object
checkLimit( array $options )
Check the limit parameter and ensure its within the maxLimit bounds.
$options
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.
$alias
mergeOptions( string $alias )
Merges the various options that Pagination uses. Pulls settings together from the following places:
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.
$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.
paginate( Model|string $object null , string|array $scope array() , array $whitelist array() )
Handles automatic pagination of model records.
Model
|string $object
optional null $scope
optional 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.
MissingModelException
NotFoundException
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.
Model
$object
$options
$whitelist
optional array() __get( string $name )
Magic method for lazy loading $components.
$name
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 redirectexit
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.
Controller
$controller
$url
$status
optional null $exit
optional true beforeRender( Controller $controller )
Called before the Controller::beforeRender(), and before the view class is loaded, and before Controller::render()
Controller
$controller
initialize( Controller $controller )
Called before the Controller::beforeFilter().
Controller
$controller
shutdown( Controller $controller )
Called after Controller::render() and before the output is printed to the browser.
Controller
$controller
startup( Controller $controller )
Called after the Controller::beforeFilter() and before the controller action
Controller
$controller
_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.
$properties
$class
$normalize
optional true _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.
$properties
optional array() _stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
$status
optional 0 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
$method
$params
optional array() 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.
$msg
$type
optional LOG_ERR $scope
optional null The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.
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()
POST and GET data can be simulated in requestAction. Use $extra['url']
for GET data. The $extra['data']
parameter allows POST data simulation.
$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.
$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.
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString( )
CakeObject-to-string conversion. Each class can override this method as necessary.
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 100limit
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.array( 'page' => 1, 'limit' => 20, 'maxLimit' => 100, 'paramType' => 'named' )
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–2016 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.9/class-PaginatorComponent.html