PaginatorHelper Class Info:

Class Declaration:

class PaginatorHelper extends AppHelper

File name:
cake/libs/view/helpers/paginator.php
Description:

Pagination Helper class for easy generation of pagination links.

PaginationHelper encloses all methods needed when working with pagination.

Class Inheritance

AppHelper Helper Overloadable Object

Properties:

Show/Hide parent properties
  • action string

    Current action.

  • _ajaxHelperClass string

    The class used for 'Ajax' pagination links.

  • argSeparator string

    URL argument separator character

  • base string

    Base URL

  • data array

    POST data for models

  • __defaultModel string

    Holds the default model for paged recordsets

  • helpers array

    Helper dependencies

  • here string

    URL to current action.

  • namedArgs array

    List of named arguments

  • options array

    Holds the default options for pagination links

    The values that may be specified are:

    • $options['format'] Format of the counter. Supported formats are 'range' and 'pages' and custom (default). In the default mode the supplied string is parsed and constants are replaced by their actual values. Constants: %page%, %pages%, %current%, %count%, %start%, %end% .
    • $options['separator'] The separator of the actual page and number of pages (default: ' of ').
    • $options['url'] Url of the action. See Router::url()
    • $options['url']['sort'] the key that the recordset is sorted.
    • $options['url']['direction'] Direction of the sorting (default: 'asc').
    • $options['url']['page'] Page

      to display.

    • $options['model'] The name of the model.
    • $options['escape'] Defines if the title field for the link should be escaped (default: true).
    • $options['update'] DOM id of the element updated with the results of the AJAX call. If this key isn't specified Paginator will use plain HTML links.
    • $options['indicator'] DOM id of the element that will be shown when doing AJAX requests. **Only supported by AjaxHelper**

  • params array

    Parameter array.

  • plugin string

    Plugin path

  • tags array

    Holds tag templates.

  • theme string

    The current theme name if any.

  • validationErrors array

    Contains model validation errors of form post-backs

  • webroot string

    Webroot path

Method Summary:

Show/Hide parent methods

addClass

top

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 classname being added.

  • string $key optional 'class'

    the key to use for class.

Method defined in:
cake/libs/view/helper.php on line 774
Return

array Array of options with $key set.

Access

public

afterLayout

top

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

Overridden in subclasses.

Method defined in:
cake/libs/view/helper.php on line 838
Return

void

Access

public

afterRender

top

After render callback. afterRender is called after the view file is rendered but before the layout has been rendered.

Overridden in subclasses.

Method defined in:
cake/libs/view/helper.php on line 816
Return

void

Access

public

assetTimestamp

top

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 required

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

Method defined in:
cake/libs/view/helper.php on line 242
Return

string Path with a timestamp added, or not.

Access

public

beforeLayout

top

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

Overridden in subclasses.

Method defined in:
cake/libs/view/helper.php on line 827
Return

void

Access

public

beforeRender

top

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

Method defined in:
cake/libs/view/helpers/paginator.php on line 109
Return

void

Access

public

cakeError

top

Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.

Parameters:
  • string $method required

    Method to be called in the error class (AppError or ErrorHandler classes)

  • array $messages optional array ( )

    Message that is to be displayed by the error class

Method defined in:
cake/libs/object.php on line 187
Return

error message

Access

public

call__

top

Parameters:
  • $method required

  • $params required

Method defined in:
cake/libs/view/helper.php on line 153

clean

top

Used to remove harmful tags from content. Removes a number of well known XSS attacks from content. However, is not guaranteed to remove all possiblities. Escaping content is the best way to prevent all possible attacks.

Parameters:
  • mixed $output required

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

Method defined in:
cake/libs/view/helper.php on line 278
Return

cleaned content for output

Access

public

__construct

top

Constructor for the helper. Sets up the helper that is used for creating 'AJAX' links.

Use var $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:
  • $config optional array ( )

Method defined in:
cake/libs/view/helpers/paginator.php on line 90
Return

void

counter

top

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%, %start%, %end% and any custom content you would like.
  • separator The separator string to use, default to ' of '

Parameters:
  • mixed $options optional array ( )

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

Method defined in:
cake/libs/view/helpers/paginator.php on line 525
Return

string Counter string.

Access

public

current

top

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.

Method defined in:
cake/libs/view/helpers/paginator.php on line 173
Return

string The current page number of the recordset.

Access

public

defaultModel

top

Gets the default model of the paged sets

Method defined in:
cake/libs/view/helpers/paginator.php on line 498
Return

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

Access

public

dispatchMethod

top

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

Parameters:
  • string $method required

    Name of the method to call

  • array $params optional array ( )

    Parameter list to use when calling $method

Method defined in:
cake/libs/object.php on line 107
Return

mixed Returns the result of the method call

Access

public

domId

top

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:
  • mixed $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.

Method defined in:
cake/libs/view/helper.php on line 604
Return

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

Todo

Refactor this method to not have as many input/output options.

field

top

Gets the currently-used model field of the rendering context.

Method defined in:
cake/libs/view/helper.php on line 570
Return

string

Access

public

first

top

Returns a first or set of numbers for the first pages

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

Parameters:
  • mixed $first optional '<< first'

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

  • mixed $options optional array ( )

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

Method defined in:
cake/libs/view/helpers/paginator.php on line 719
Return

string numbers string.

Access

public

get__

top

Default overload methods

Parameters:
  • $name required

Method defined in:
cake/libs/view/helper.php on line 151
Access

protected

hasNext

top

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.

Method defined in:
cake/libs/view/helpers/paginator.php on line 453
Return

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

Access

public

hasPage

top

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.

  • int $page optional 1

    The page number - if not set defaults to 1.

Method defined in:
cake/libs/view/helpers/paginator.php on line 465
Return

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

Access

public

__hasPage

top

Does $model have $page in its range?

Parameters:
  • string $model required

    Model name to get parameters for.

  • integer $page required

    Page number you are checking.

Method defined in:
cake/libs/view/helpers/paginator.php on line 482
Return

boolean Whether model has $page

Access

protected

hasPrev

top

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.

Method defined in:
cake/libs/view/helpers/paginator.php on line 442
Return

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

Access

public

_initInputField

top

Sets the defaults for an input tag. Will set the name, value, and id attributes for an array of html attributes. Will also add a 'form-error' class if the field contains validation errors.

Parameters:
  • string $field required

    The field name to initialize.

  • array $options optional array ( )

    Array of options to use while initializing an input field.

Method defined in:
cake/libs/view/helper.php on line 751
Return

array Array options for the form input.

Access

protected

last

top

Returns a last or set of numbers for the last pages

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

Parameters:
  • mixed $last optional 'last >>'

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

  • mixed $options optional array ( )

    Array of options

Method defined in:
cake/libs/view/helpers/paginator.php on line 773
Return

string numbers string.

Access

public

link

top

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 required

    Title for the link.

  • mixed $url optional array ( )

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

  • array $options optional array ( )

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

Method defined in:
cake/libs/view/helpers/paginator.php on line 346
Return

string A link with pagination parameters.

Access

public

loadConfig

top

Parses tag templates into $this->tags.

Parameters:
  • $name optional 'tags'

Method defined in:
cake/libs/view/helper.php on line 164
Return

array merged tags from config/$name.php

Access

public

log

top

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

Parameters:
  • string $msg required

    Log message

  • integer $type optional 2

    Error type constant. Defined in app/config/core.php.

Method defined in:
cake/libs/object.php on line 148
Return

boolean Success of log write

Access

public

model

top

Gets the currently-used model of the rendering context.

Method defined in:
cake/libs/view/helper.php on line 544
Return

string

Access

public

modelID

top

Gets the ID of the currently-used model of the rendering context.

Method defined in:
cake/libs/view/helper.php on line 559
Return

mixed

Access

public

_name

top

Gets the input field name for the current tag. Creates input name attributes using CakePHP's data[Model][field] formatting.

Parameters:
  • mixed $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

    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 $key optional 'name'

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

Method defined in:
cake/libs/view/helper.php on line 640
Return

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.

Access

protected

Todo

Refactor this method to not have as many input/output options.

next

top

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

Options:

  • tag The tag wrapping tag you want to use, defaults to 'span'
  • escape Whether you want the contents html entity encoded, defaults to true
  • model The model to use, defaults to PaginatorHelper::defaultModel()

Parameters:
  • string $title optional 'Next >>'

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

  • mixed $options optional array ( )

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

  • string $disabledTitle optional NULL

    Title when the link is disabled.

  • mixed $disabledOptions optional array ( )

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

Method defined in:
cake/libs/view/helpers/paginator.php on line 272
Return

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

Access

public

numbers

top

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)

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
  • last Whether you want last links generated, set to an integer to define the number of 'last' links to generate

Parameters:
  • mixed $options optional array ( )

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

Method defined in:
cake/libs/view/helpers/paginator.php on line 603
Return

string numbers string.

Access

public

Object

top

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

Method defined in:
cake/libs/object.php on line 43
Return

Object

options

top

Sets default options for all pagination links

Parameters:
  • mixed $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.

Method defined in:
cake/libs/view/helpers/paginator.php on line 140
Return

void

Access

public

output

top

Returns a string generated by a helper method

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

Parameters:
  • string $str required

    String to be output.

Method defined in:
cake/libs/view/helper.php on line 792
Return

string

Deprecated

This method will be removed in future versions.

overload

top

Overload implementation. No need for implementation in PHP5.

Method defined in:
cake/libs/overloadable_php5.php on line 36
Access

public

__pagingLink

top

Protected method for generating prev/next links

Parameters:
  • $which required

  • $title optional NULL

  • $options optional array ( )

  • $disabledTitle optional NULL

  • $disabledOptions optional array ( )

Method defined in:
cake/libs/view/helpers/paginator.php on line 401
Access

protected

params

top

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.

Method defined in:
cake/libs/view/helpers/paginator.php on line 122
Return

array The array of paging parameters for the paginated resultset.

Access

public

_parseAttributes

top

Returns a space-delimited string with items of the $options array. If a key of $options array happens to be one of:

  • 'compact'
  • 'checked'
  • 'declare'
  • 'readonly'
  • 'disabled'
  • 'selected'
  • 'defer'
  • 'ismap'
  • 'nohref'
  • 'noshade'
  • 'nowrap'
  • 'multiple'
  • 'noresize'

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.

Parameters:
  • array $options required

    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.

Method defined in:
cake/libs/view/helper.php on line 334
Return

string Composed attributes.

Access

public

_persist

top

Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples

Parameters:
  • string $name required

    name of the class to persist

  • $return required

  • string $object required

    the object to persist

  • $type optional NULL

Method defined in:
cake/libs/object.php on line 218
Return

boolean Success

Access

protected

Todo

add examples to manual

prev

top

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

Options:

  • tag The tag wrapping tag you want to use, defaults to 'span'
  • escape Whether you want the contents html entity encoded, defaults to true
  • model The model to use, defaults to PaginatorHelper::defaultModel()

Parameters:
  • string $title optional '<< Previous'

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

  • mixed $options optional array ( )

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

  • string $disabledTitle optional NULL

    Title when the link is disabled.

  • mixed $disabledOptions optional array ( )

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

Method defined in:
cake/libs/view/helpers/paginator.php on line 252
Return

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

Access

public

requestAction

top

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.

Parameters:
  • mixed $url required

    String or array-based url.

  • array $extra optional array ( )

    if array includes the key "return" it sets the AutoRender to true.

Method defined in:
cake/libs/object.php on line 80
Return

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

Access

public

_savePersistent

top

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

Parameters:
  • string $name required

    name used for object to cache

  • object $object required

    the object to persist

Method defined in:
cake/libs/object.php on line 247
Return

boolean true on save, throws error if file can not be created

Access

protected

_set

top

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.

Method defined in:
cake/libs/object.php on line 166
Return

void

Access

protected

set__

top

Parameters:
  • $name required

  • $value required

Method defined in:
cake/libs/view/helper.php on line 152

setEntity

top

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

Parameters:
  • mixed $entity required

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

  • boolean $setScope optional false

    Sets the view scope to the model specified in $tagValue

Method defined in:
cake/libs/view/helper.php on line 394
Return

void

Access

public

sort

top

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

Options:

Parameters:
  • string $title required

    Title for the link.

  • string $key optional NULL

    The name of the key that the recordset should be sorted. If $key is null $title will be used for the key, and a title will be generated by inflection.

  • array $options optional array ( )

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

Method defined in:
cake/libs/view/helpers/paginator.php on line 293
Return

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

Access

public

sortDir

top

Gets the current direction the recordset is sorted

Parameters:
  • string $model optional NULL

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

  • mixed $options optional array ( )

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

Method defined in:
cake/libs/view/helpers/paginator.php on line 216
Return

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

Access

public

sortKey

top

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.

  • mixed $options optional array ( )

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

Method defined in:
cake/libs/view/helpers/paginator.php on line 191
Return

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

Access

public

_stop

top

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

Parameters:
  • $status optional 0

Method defined in:
cake/libs/object.php on line 135
Return

void

Access

public

tagIsInvalid

top

Returns false if given FORM field has no errors. Otherwise it returns the constant set in the array Model->validationErrors.

Parameters:
  • string $model optional NULL

    Model name as a string

  • string $field optional NULL

    Fieldname as a string

  • integer $modelID optional NULL

    Unique index identifying this record within the form

Method defined in:
cake/libs/view/helper.php on line 584
Return

boolean True on errors.

toString

top

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

Method defined in:
cake/libs/object.php on line 64
Return

string The name of this class

Access

public

url

top

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

Method defined in:
cake/libs/view/helpers/paginator.php on line 375
Return

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

Access

public

value

top

Gets the data for the current tag

Parameters:
  • mixed $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

    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 $key optional 'value'

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

Method defined in:
cake/libs/view/helper.php on line 686
Return

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.

Access

public

Todo

Refactor this method to not have as many input/output options.

webroot

top

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

Parameters:
  • string $file required

    The file to create a webroot path to.

Method defined in:
cake/libs/view/helper.php on line 198
Return

string Web accessible path to file.

Access

public