__construct()source public

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

Parameters

View $View

the view object the helper is attached to.

array $settings optional array()

Array of settings.

Throws

CakeException
When the AjaxProvider helper does not implement a link method.

Overrides

Helper::__construct()

_convertUrlKeys()source protected

_convertUrlKeys( array $url , string $type )

Converts the keys being used into the format set by options.paramType

Parameters

array $url

Array of URL params to convert

string $type

Keys type.

Returns

array
converted URL params.

_hasPage()source protected

_hasPage( string $model , integer $page )

Does $model have $page in its range?

Parameters

string $model

Model name to get parameters for.

integer $page

Page number you are checking.

Returns

boolean
Whether model has $page

_pagingLink()source protected

_pagingLink( string $which , string $title null , array $options array() , string $disabledTitle null , array $disabledOptions array() )

Protected method for generating prev/next links

Parameters

string $which

Link type: 'Prev', 'Next'.

string $title optional null

Link title.

array $options optional array()

Options list.

string $disabledTitle optional null

Disabled link title.

array $disabledOptions optional array()

Disabled link options.

Returns

string

beforeRender()source public

beforeRender( string $viewFile )

Before render callback. Overridden to merge passed args with URL options.

Parameters

string $viewFile

View file name.

Overrides

Helper::beforeRender()

counter()source public

counter( array $options array() )

Returns a counter string for the paged result set

Options

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

Parameters

array $options optional array()

Options for the counter string. See #options for list of keys.

Returns

string
Counter string.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::counter

current()source public

current( string $model null )

Gets the current page of the recordset for the given model

Parameters

string $model optional null

Optional model name. Uses the default if none is specified.

Returns

string
The current page number of the recordset.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::current

defaultModel()source public

defaultModel( )

Gets the default model of the paged sets

Returns

string|null
Model name or null if the pagination isn't initialized.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::defaultModel

first()source public

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

Options:

• tag The tag wrapping tag you want to use, defaults to 'span'
• after Content to insert after the link/tag
• model The model to use defaults to PaginatorHelper::defaultModel()
• separator Content between the generated links, defaults to ' | '
• ellipsis Content for ellipsis, defaults to '...'

Parameters

string|integer $first optional '<< first'

if string use as label for the link. If numeric, the number of page links you want at the beginning of the range.

array $options optional array()

An array of options.

Returns

string
Numbers string.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::first

hasNext()source public

hasNext( string $model null )

Returns true if the given result set is not at the last page

Parameters

string $model optional null

Optional model name. Uses the default if none is specified.

Returns

boolean
True if the result set is not at the last page.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::hasNext

hasPage()source public

hasPage( string $model null , integer $page 1 )

Returns true if the given result set has the page number given by $page

Parameters

string $model optional null

Optional model name. Uses the default if none is specified.

integer $page optional 1

The page number - if not set defaults to 1.

Returns

boolean
True if the given result set has the specified page number.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::hasPage

hasPrev()source public

hasPrev( string $model null )

Returns true if the given result set is not at the first page

Parameters

string $model optional null

Optional model name. Uses the default if none is specified.

Returns

boolean
True if the result set is not at the first page.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::hasPrev

last()source public

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

Options:

• tag The tag wrapping tag you want to use, defaults to 'span'
• before Content to insert before the link/tag
• model The model to use defaults to PaginatorHelper::defaultModel()
• separator Content between the generated links, defaults to ' | '
• ellipsis Content for ellipsis, defaults to '...'

Parameters

string|integer $last optional 'last >>'

if string use as label for the link, if numeric print page numbers

array $options optional array()

Array of options

Returns

string
Numbers string.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::last

link()source public

link( string $title , string|array $url array() , array $options array() )

Generates a plain or Ajax link with pagination parameters

Options

• 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 true
• model The model to use, defaults to PaginatorHelper::defaultModel()

Parameters

string $title

Title for the link.

string|array $url optional array()

URL for the action. See Router::url()

array $options optional array()

Options for the link. See #options for list of keys.

Returns

string
A link with pagination parameters.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::link

meta()source public

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

Options:

• 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

Parameters

array $options optional array()

Array of options.

Returns

string|null
Meta links.

next()source public

next( string $title 'Next >>' , array $options array() , string $disabledTitle null , array $disabledOptions array() )

Generates a "next" link for a set of paged records

Options:

• 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 option
• escape Whether you want the contents html entity encoded, defaults to true
• model The model to use, defaults to PaginatorHelper::defaultModel()
• disabledTag Tag to use instead of A tag when there is no next page

Parameters

string $title optional 'Next >>'

Title for the link. Defaults to 'Next >>'.

array $options optional array()

Options for pagination link. See above for list of keys.

string $disabledTitle optional null

Title when the link is disabled.

array $disabledOptions optional array()

Options for the disabled pagination link. See above for list of keys.

Returns

string
A "next" link or $disabledTitle text if the link is disabled.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::next

numbers()source public

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

Options

• before Content to be inserted before the numbers
• after Content to be inserted after the numbers
• model 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 tag
• currentClass Class for wrapper tag on current active page, defaults to 'current'
• currentTag Tag to use for current page number, defaults to null

Parameters

array|boolean $options optional array()

Options for the numbers, (before, after, model, modulus, separator)

Returns

string
Numbers string.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::numbers

options()source public

options( array|string $options array() )

Sets default options for all pagination links

Parameters

array|string $options optional array()

Default options for pagination links. If a string is supplied - it is used as the DOM id element to update. See PaginatorHelper::$options for list of keys.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::options

param()source public

param( string $key , string $model null )

Convenience access to any of the paginator params.

Parameters

string $key

Key of the paginator params array to retrieve.

string $model optional null

Optional model name. Uses the default if none is specified.

Returns

mixed
Content of the requested param.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::params

params()source public

params( string $model null )

Gets the current paging parameters from the resultset for the given model

Parameters

string $model optional null

Optional model name. Uses the default if none is specified.

Returns

array
The array of paging parameters for the paginated resultset.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::params

prev()source public

prev( string $title '<< Previous' , array $options array() , string $disabledTitle null , array $disabledOptions array() )

Generates a "previous" link for a set of paged records

Options:

• 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 option
• escape Whether you want the contents html entity encoded, defaults to true
• model The model to use, defaults to PaginatorHelper::defaultModel()
• disabledTag Tag to use instead of A tag when there is no previous page

Parameters

string $title optional '<< Previous'

Title for the link. Defaults to '<< Previous'.

array $options optional array()

Options for pagination link. See #options for list of keys.

string $disabledTitle optional null

Title when the link is disabled.

array $disabledOptions optional array()

Options for the disabled pagination link. See #options for list of keys.

Returns

string
A "previous" link or $disabledTitle text if the link is disabled.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::prev

sort()source public

sort( string $key , string $title null , array $options array() )

Generates a sorting link. Sets named parameters for the sort and direction. Handles direction switching automatically.

Options:

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

Parameters

string $key

The name of the key that the recordset should be sorted.

string $title optional null

Title for the link. If $title is null $key will be used for the title and will be generated by inflection.

array $options optional array()

Options for sorting link. See above for list of keys.

Returns

string

A link sorting default by 'asc'. If the resultset is sorted 'asc' by the specified key the returned link will sort by 'desc'.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::sort

sortDir()source public

sortDir( string $model null , array $options array() )

Gets the current direction the recordset is sorted

Parameters

string $model optional null

Optional model name. Uses the default if none is specified.

array $options optional array()

Options for pagination links. See #options for list of keys.

Returns

string

The direction by which the recordset is being sorted, or null if the results are not currently sorted.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::sortDir

sortKey()source public

sortKey( string $model null , array $options array() )

Gets the current key by which the recordset is sorted

Parameters

string $model optional null

Optional model name. Uses the default if none is specified.

array $options optional array()

Options for pagination links. See #options for list of keys.

Returns

string|null

The name of the key by which the recordset is being sorted, or null if the results are not currently sorted.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::sortKey

url()source public

url( array $options array() , boolean $asArray false , string $model null )

Merges passed URL options with current pagination state to generate a pagination URL.

Parameters

array $options optional array()

Pagination/URL options array

boolean $asArray optional false

Return the URL as an array, or a URI string

string $model optional null

Which model to paginate on

Returns

mixed
By default, returns a full pagination URL string for use in non-standard contexts (i.e. JavaScript)

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::url

Overrides

Helper::url()

__call()source public

__call( string $method , array $params )

Provide non fatal errors on missing method calls.

Parameters

string $method

Method to invoke

array $params

Array of params for the method.

__get()source public

__get( string $name )

Lazy loads helpers. Provides access to deprecated request properties as well.

Deprecated

3.0.0 Accessing request properties through this method is deprecated and will be removed in 3.0.

Parameters

string $name

Name of the property being accessed.

Returns

mixed
Helper or property found at $name

__set()source public

__set( string $name , mixed $value )

Provides backwards compatibility access for setting values to the request object.

Deprecated

3.0.0 This method will be removed in 3.0

Parameters

string $name

Name of the property being accessed.

mixed $value

Value to set.

_clean()source protected

_clean( )

Removes harmful content from output

_confirm()source protected

_confirm( string $message , string $okCode , string $cancelCode '' , array $options array() )

Returns a string to be used as onclick handler for confirm dialogs.

Parameters

string $message

Message to be displayed

string $okCode

Code to be executed after user chose 'OK'

string $cancelCode optional ''

Code to be executed after user chose 'Cancel', also executed when okCode doesn't return

array $options optional array()

Array of options

Returns

string
onclick JS code

_encodeUrl()source protected

_encodeUrl( string $url )

Encodes a URL for use in HTML attributes.

Parameters

string $url

The URL to encode.

Returns

string
The URL encoded for both URL & HTML contexts.

_formatAttribute()source protected

_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'

Deprecated

3.0.0 This method will be moved to HtmlHelper in 3.0

Parameters

string $key

The name of the attribute to create

string $value

The value of the attribute to create.

boolean $escape optional true

Define if the value must be escaped

Returns

string
The composed attribute.

_initInputField()source protected

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

Parameters

string $field

The field name to initialize.

array $options optional array()

Array of options to use while initializing an input field.

Returns

array
Array options for the form input.

_name()source protected

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

Parameters

array|string $options optional array()

If an array, should be an array of attributes that $key needs to be added to. If a string or null, will be used as the View entity.

string $field optional null

Field name.

string $key optional 'name'

The name of the attribute to be set, defaults to 'name'

Returns

mixed

If an array was given for $options, an array with $key set will be returned. If a string was supplied a string will be returned.

_parseAttributes()source protected

_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:

• '1' (string)
• 1 (integer)
• true (boolean)
• 'true' (string)

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.

Deprecated

3.0.0 This method will be moved to HtmlHelper in 3.0

Parameters

array $options

Array of options.

array $exclude optional null

Array of options to be excluded, the options here will not be part of the return.

string $insertBefore optional ' '

String to be inserted before options.

string $insertAfter optional null

String to be inserted after options.

Returns

string
Composed attributes.

_reset()source protected

_reset( )

Resets the vars used by Helper::clean() to null

_selectedArray()source protected

_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

Parameters

string|array $data

Data array or model name.

string $key optional 'id'

Field name.

Returns

array

addClass()source public

addClass( array $options array() , string $class null , string $key 'class' )

Adds the given class to the element options

Parameters

array $options optional array()

Array options/attributes to add a class to

string $class optional null

The class name being added.

string $key optional 'class'

the key to use for class.

Returns

array
Array of options with $key set.

afterLayout()source public

afterLayout( string $layoutFile )

After layout callback. afterLayout is called after the layout has rendered.

Overridden in subclasses.

Parameters

string $layoutFile

The layout file that was rendered.

afterRender()source public

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.

Parameters

string $viewFile

The view file that was rendered.

afterRenderFile()source public

afterRenderFile( string $viewFile , string $content )

After render file callback. Called after any view fragment is rendered.

Overridden in subclasses.

Parameters

string $viewFile

The file just be rendered.

string $content

The content that was rendered.

assetTimestamp()source public

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.

Parameters

string $path

The file path to timestamp, the path must be inside WWW_ROOT

Returns

string
Path with a timestamp added, or not.

assetUrl()source public

assetUrl( 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

Parameters

string|array $path

Path string or URL array

array $options optional array()

Options array. Possible keys: 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 plugin

Returns

string
Generated URL

beforeLayout()source public

beforeLayout( string $layoutFile )

Before layout callback. beforeLayout is called before the layout is rendered.

Overridden in subclasses.

Parameters

string $layoutFile

The layout about to be rendered.

beforeRenderFile()source public

beforeRenderFile( string $viewFile )

Before render file callback. Called before any view fragment is rendered.

Overridden in subclasses.

Parameters

string $viewFile

The file about to be rendered.

clean()source public

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.

Deprecated

3.0.0 This method will be removed in 3.0

Parameters

string|array $output

Either an array of strings to clean or a single string to clean.

Returns

string|array|null
Cleaned content for output

domId()source public

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

Parameters

array|string $options optional null

Either an array of html attributes to add $id into, or a string with a view entity path to get a domId for.

string $id optional 'id'

The name of the 'id' attribute.

Returns

mixed

If $options was an array, an array will be returned with $id set. If a string was supplied, a string will be returned.

entity()source public

entity( )

Returns the entity reference of the current context as an array of identity parts

Returns

array
An array containing the identity elements of an entity

field()source public

field( )

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.

Returns

string

model()source public

model( )

Gets the currently-used model of the rendering context.

Returns

string

output()source public

output( string $str )

Returns a string generated by a helper method

This method can be overridden in subclasses to do generalized output post-processing

Deprecated

3.0.0 This method will be removed in future versions.

Parameters

string $str

String to be output.

Returns

string

setEntity()source public

setEntity( string $entity , boolean $setScope false )

Sets this helper's model and field properties to the dot-separated value-pair in $entity.

Parameters

string $entity

A field name, like "ModelName.fieldName" or "ModelName.ID.fieldName"

boolean $setScope optional false

Sets the view scope to the model specified in $tagValue

value()source public

value( array|string $options array() , string $field null , string $key 'value' )

Gets the data for the current tag

Parameters

array|string $options optional array()

If an array, should be an array of attributes that $key needs to be added to. If a string or null, will be used as the View entity.

string $field optional null

Field name.

string $key optional 'value'

The name of the attribute to be set, defaults to 'value'

Returns

mixed

If an array was given for $options, an array with $key set will be returned. If a string was supplied a string will be returned.

webroot()source public

webroot( string $file )

Checks if a file exists when theme is used, if no file is found default location is returned

Parameters

string $file

The file to create a webroot path to.

Returns

string
Web accessible path to file.

_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( )

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

Returns

string
The name of this class

'Js'

array('Html')

array(
    'convertKeys' => array('page', 'limit', 'sort', 'direction')
)