Pagination Helper class for easy generation of pagination links.
PaginationHelper encloses all methods needed when working with pagination.
__construct( View $View , array $settings array() )
Constructor for the helper. Sets up the helper that is used for creating 'AJAX' links.
Use public $helpers = array('Paginator' => array('ajax' => 'CustomHelper')); to set a custom Helper or choose a non JsHelper Helper. If you want to use a specific library with JsHelper declare JsHelper and its adapter before including PaginatorHelper in your helpers array.
The chosen custom helper must implement a link() method.
View $View $settings optional array() CakeExceptionHelper::__construct() _convertUrlKeys( array $url , string $type )
Converts the keys being used into the format set by options.paramType
$url $type array_hasPage( string $model , integer $page )
Does $model have $page in its range?
$model $page boolean_pagingLink( string $which , string $title null , array $options array() , string $disabledTitle null , array $disabledOptions array() )
Protected method for generating prev/next links
$which $title optional null $options optional array() $disabledTitle optional null $disabledOptions optional array() stringbeforeRender( string $viewFile )
Before render callback. Overridden to merge passed args with URL options.
$viewFile Helper::beforeRender() counter( array $options array() )
Returns a counter string for the paged result set
model The model to use, defaults to PaginatorHelper::defaultModel();format The format string you want to use, defaults to 'pages' Which generates output like '1 of 5' set to 'range' to generate output like '1 - 3 of 13'. Can also be set to a custom string, containing the following placeholders {:page}, {:pages}, {:current}, {:count}, {:model}, {:start}, {:end} and any custom content you would like.separator The separator string to use, default to ' of 'The %page% style placeholders also work, but are deprecated and will be removed in a future version.
$options optional array() stringcurrent( string $model null )
Gets the current page of the recordset for the given model
$model optional null stringdefaultModel( )
Gets the default model of the paged sets
string|nullfirst( string|integer $first '<< first' , array $options array() )
Returns a first or set of numbers for the first pages.
echo $this->Paginator->first('< first');
Creates a single link for the first page. Will output nothing if you are on the first page.
echo $this->Paginator->first(3);
Will create links for the first 3 pages, once you get to the third or greater page. Prior to that nothing will be output.
tag The tag wrapping tag you want to use, defaults to 'span'after Content to insert after the link/tagmodel The model to use defaults to PaginatorHelper::defaultModel()separator Content between the generated links, defaults to ' | 'ellipsis Content for ellipsis, defaults to '...'$first optional '<< first' $options optional array() stringhasNext( string $model null )
Returns true if the given result set is not at the last page
$model optional null booleanhasPage( string $model null , integer $page 1 )
Returns true if the given result set has the page number given by $page
$model optional null $page optional 1 booleanhasPrev( string $model null )
Returns true if the given result set is not at the first page
$model optional null booleanlast( string|integer $last 'last >>' , array $options array() )
Returns a last or set of numbers for the last pages.
echo $this->Paginator->last('last >');
Creates a single link for the last page. Will output nothing if you are on the last page.
echo $this->Paginator->last(3);
Will create links for the last 3 pages. Once you enter the page range, no output will be created.
tag The tag wrapping tag you want to use, defaults to 'span'before Content to insert before the link/tagmodel The model to use defaults to PaginatorHelper::defaultModel()separator Content between the generated links, defaults to ' | 'ellipsis Content for ellipsis, defaults to '...'$last optional 'last >>' $options optional array() stringlink( string $title , string|array $url array() , array $options array() )
Generates a plain or Ajax link with pagination parameters
update The Id of the DOM element you wish to update. Creates Ajax enabled links with the AjaxHelper.escape Whether you want the contents html entity encoded, defaults to truemodel The model to use, defaults to PaginatorHelper::defaultModel()$title $url optional array() $options optional array() stringmeta( array $options array() )
Returns the meta-links for a paginated result set.
echo $this->Paginator->meta();
Echos the links directly, will output nothing if there is neither a previous nor next page.
$this->Paginator->meta(array('block' => true));
Will append the output of the meta function to the named block - if true is passed the "meta" block is used.
model The model to use defaults to PaginatorHelper::defaultModel()block The block name to append the output to, or false/absent to return as a string$options optional array() string|nullnext( string $title 'Next >>' , array $options array() , string $disabledTitle null , array $disabledOptions array() )
Generates a "next" link for a set of paged records
url Allows sending routing parameters such as controllers, actions or passed arguments.tag The tag wrapping tag you want to use, defaults to 'span'. Set this to false to disable this optionescape Whether you want the contents html entity encoded, defaults to truemodel The model to use, defaults to PaginatorHelper::defaultModel()disabledTag Tag to use instead of A tag when there is no next page$title optional 'Next >>' $options optional array() $disabledTitle optional null $disabledOptions optional array() stringnumbers( array|boolean $options array() )
Returns a set of numbers for the paged result set uses a modulus to decide how many numbers to show on each side of the current page (default: 8).
$this->Paginator->numbers(array('first' => 2, 'last' => 2));
Using the first and last options you can create links to the beginning and end of the page set.
before Content to be inserted before the numbersafter Content to be inserted after the numbersmodel Model to create numbers for, defaults to PaginatorHelper::defaultModel()modulus how many numbers to include on either side of the current page, defaults to 8.separator Separator content defaults to ' | 'tag The tag to wrap links in, defaults to 'span'first Whether you want first links generated, set to an integer to define the number of 'first' links to generate. If a string is set a link to the first page will be generated with the value as the title.last Whether you want last links generated, set to an integer to define the number of 'last' links to generate. If a string is set a link to the last page will be generated with the value as the title.ellipsis Ellipsis content, defaults to '...'class Class for wrapper tagcurrentClass Class for wrapper tag on current active page, defaults to 'current'currentTag Tag to use for current page number, defaults to null$options optional array() stringoptions( array|string $options array() )
Sets default options for all pagination links
$options optional array() param( string $key , string $model null )
Convenience access to any of the paginator params.
$key $model optional null mixedparams( string $model null )
Gets the current paging parameters from the resultset for the given model
$model optional null arrayprev( string $title '<< Previous' , array $options array() , string $disabledTitle null , array $disabledOptions array() )
Generates a "previous" link for a set of paged records
url Allows sending routing parameters such as controllers, actions or passed arguments.tag The tag wrapping tag you want to use, defaults to 'span'. Set this to false to disable this optionescape Whether you want the contents html entity encoded, defaults to truemodel The model to use, defaults to PaginatorHelper::defaultModel()disabledTag Tag to use instead of A tag when there is no previous page$title optional '<< Previous' $options optional array() $disabledTitle optional null $disabledOptions optional array() stringsort( string $key , string $title null , array $options array() )
Generates a sorting link. Sets named parameters for the sort and direction. Handles direction switching automatically.
escape Whether you want the contents html entity encoded, defaults to true.model The model to use, defaults to PaginatorHelper::defaultModel().direction The default direction to use when this link isn't active.lock Lock direction. Will only use the default direction then, defaults to false.$key $title optional null $options optional array() stringsortDir( string $model null , array $options array() )
Gets the current direction the recordset is sorted
$model optional null $options optional array() stringsortKey( string $model null , array $options array() )
Gets the current key by which the recordset is sorted
$model optional null $options optional array() string|nullurl( array $options array() , boolean $asArray false , string $model null )
Merges passed URL options with current pagination state to generate a pagination URL.
$options optional array() $asArray optional false $model optional null mixedHelper::url() __call( string $method , array $params )
Provide non fatal errors on missing method calls.
$method $params __get( string $name )
Lazy loads helpers. Provides access to deprecated request properties as well.
$name mixed__set( string $name , mixed $value )
Provides backwards compatibility access for setting values to the request object.
$name $value _confirm( string $message , string $okCode , string $cancelCode '' , array $options array() )
Returns a string to be used as onclick handler for confirm dialogs.
$message $okCode $cancelCode optional '' $options optional array() string_encodeUrl( string $url )
Encodes a URL for use in HTML attributes.
$url string_formatAttribute( string $key , string $value , boolean $escape true )
Formats an individual attribute, and returns the string value of the composed attribute. Works with minimized attributes that have the same value as their name such as 'disabled' and 'checked'
$key $value $escape optional true string_initInputField( string $field , array $options array() )
Sets the defaults for an input tag. Will set the name, value, and id attributes for an array of html attributes.
$field $options optional array() array_name( array|string $options array() , string $field null , string $key 'name' )
Gets the input field name for the current tag. Creates input name attributes using CakePHP's data[Model][field] formatting.
$options optional array() $field optional null $key optional 'name' mixed_parseAttributes( array $options , array $exclude null , string $insertBefore ' ' , string $insertAfter null )
Returns a space-delimited string with items of the $options array. If a key of $options array happens to be one of those listed in Helper::$_minimizedAttributes
And its value is one of:
Then the value will be reset to be identical with key's name. If the value is not one of these 3, the parameter is not output.
'escape' is a special option in that it controls the conversion of attributes to their html-entity encoded equivalents. Set to false to disable html-encoding.
If value for any option key is set to null or false, that option will be excluded from output.
$options $exclude optional null $insertBefore optional ' ' $insertAfter optional null string_selectedArray( string|array $data , string $key 'id' )
Transforms a recordset from a hasAndBelongsToMany association to a list of selected options for a multiple select element
$data $key optional 'id' arrayaddClass( array $options array() , string $class null , string $key 'class' )
Adds the given class to the element options
$options optional array() $class optional null $key optional 'class' arrayafterLayout( string $layoutFile )
After layout callback. afterLayout is called after the layout has rendered.
Overridden in subclasses.
$layoutFile afterRender( string $viewFile )
After render callback. afterRender is called after the view file is rendered but before the layout has been rendered.
Overridden in subclasses.
$viewFile afterRenderFile( string $viewFile , string $content )
After render file callback. Called after any view fragment is rendered.
Overridden in subclasses.
$viewFile $content assetTimestamp( string $path )
Adds a timestamp to a file based resource based on the value of Asset.timestamp in Configure. If Asset.timestamp is true and debug > 0, or Asset.timestamp === 'force' a timestamp will be added.
$path stringassetUrl( string|array $path , array $options array() )
Generate URL for given asset file. Depending on options passed provides full URL with domain name. Also calls Helper::assetTimestamp() to add timestamp to local files
$path $options optional array() fullBase Return full URL with domain name pathPrefix Path prefix for relative URLs ext Asset extension to append plugin False value will prevent parsing path as a pluginstringbeforeLayout( string $layoutFile )
Before layout callback. beforeLayout is called before the layout is rendered.
Overridden in subclasses.
$layoutFile beforeRenderFile( string $viewFile )
Before render file callback. Called before any view fragment is rendered.
Overridden in subclasses.
$viewFile clean( string|array $output )
Used to remove harmful tags from content. Removes a number of well known XSS attacks from content. However, is not guaranteed to remove all possibilities. Escaping content is the best way to prevent all possible attacks.
$output string|array|nulldomId( array|string $options null , string $id 'id' )
Generates a DOM ID for the selected element, if one is not set. Uses the current View::entity() settings to generate a CamelCased id attribute.
$options optional null $id optional 'id' mixedentity( )
Returns the entity reference of the current context as an array of identity parts
arrayfield( )
Gets the currently-used model field of the rendering context. Strips off field suffixes such as year, month, day, hour, min, meridian when the current entity is longer than 2 elements.
stringmodel( )
Gets the currently-used model of the rendering context.
stringoutput( string $str )
Returns a string generated by a helper method
This method can be overridden in subclasses to do generalized output post-processing
$str stringsetEntity( string $entity , boolean $setScope false )
Sets this helper's model and field properties to the dot-separated value-pair in $entity.
$entity $setScope optional false value( array|string $options array() , string $field null , string $key 'value' )
Gets the data for the current tag
$options optional array() $field optional null $key optional 'value' mixedwebroot( string $file )
Checks if a file exists when theme is used, if no file is found default location is returned
$file string_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() mixedlog( 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 booleanrequestAction( 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 $extra optional array() mixedtoString( )
Object-to-string conversion. Each class can override this method as necessary.
stringprotected string
The name of the current model association entities are in scope of.
Helper::setEntity()protected string
The dot separated list of elements the current field entity is for.
Helper::setEntity()protected array
A list of strings that should be treated as suffixes, or sub inputs for a parent input. This is used for date/time inputs primarily.
array( 'year', 'month', 'day', 'hour', 'min', 'second', 'meridian' )
protected array
Minimized attributes
array( 'allowfullscreen', 'async', 'autofocus', 'autoplay', 'checked', 'compact', 'controls', 'declare', 'default', 'defaultchecked', 'defaultmuted', 'defaultselected', 'defer', 'disabled', 'enabled', 'formnovalidate', 'hidden', 'indeterminate', 'inert', 'ismap', 'itemscope', 'loop', 'multiple', 'muted', 'nohref', 'noresize', 'noshade', 'novalidate', 'nowrap', 'open', 'pauseonexit', 'readonly', 'required', 'reversed', 'scoped', 'seamless', 'selected', 'sortable', 'spellcheck', 'truespeed', 'typemustmatch', 'visible' )
protected string
The name of the current model entities are in scope of.
Helper::setEntity()public array
Holds the fields array('field_name' => array('type' => 'string', 'length' => 100), primaryKey and validates array('field_name')
array() public HtmlHelper
© 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.
http://api.cakephp.org/2.7/class-PaginatorHelper.html