$helpers
$helpers : array
List of helpers used by this helper
Pagination Helper class for easy generation of pagination links.
PaginationHelper encloses all methods needed when working with pagination.
$_templater : \Cake\View\StringTemplate
StringTemplate instance.
$_defaultConfig : array
Default config for this class
Options: Holds the default options for pagination links
The values that may be specified are:
url Url of the action. See Router::url()url['sort'] the key that the recordset is sorted.url['direction'] Direction of the sorting (default: 'asc').url['page'] Page number to use in links.model The name of the model.escape Defines if the title field for the link should be escaped (default: true).Templates: the templates used by this class
$_View : \Cake\View\View
The View instance this helper is attached to
templater() : \Cake\View\StringTemplate
Returns the templater instance.
__construct(\Cake\View\View $View, array $config = array())
Constructor. Overridden to merge passed args with URL options.
| \Cake\View\View | $View | The View this helper is being attached to. |
| array | $config | Configuration settings for the helper. |
__get(string $name) : \Cake\View\Helper|null
Lazy loads helpers.
| string | $name | Name of the property being accessed. |
Helper instance if helper with provided name exists
getView() : \Cake\View\View
Get the view instance this helper is bound to.
The bound view instance.
addClass(array $options = array(), string|null $class = null, string $key = 'class') : array
Adds the given class to the element options
| array | $options | Array options/attributes to add a class to |
| string|null | $class | The class name being added. |
| string | $key | the key to use for class. |
Array of options with $key set.
implementedEvents() : array
Event listeners.
By defining one of the callback methods a helper is assumed to be interested in the related event.
Override this method if you need to add non-conventional event listeners. Or if you want helpers to listen to non-standard events.
setConfig(string|array $key, mixed|null $value = null, boolean $merge = true) : $this
Sets the config.
Setting a specific value:
$this->setConfig('key', $value);Setting a nested value:
$this->setConfig('some.nested.key', $value);Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);| string|array | $key | The key to set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
getConfig(string|null $key = null, mixed $default = null) : mixed
Returns the config.
Reading the whole config:
$this->getConfig();Reading a specific value:
$this->getConfig('key');Reading a nested value:
$this->getConfig('some.nested.key');Reading with default value:
$this->getConfig('some-key', 'default-value');| string|null | $key | The key to get or null for the whole config. |
| mixed | $default | The return value when the key does not exist. |
Config value being read.
config(string|array|null $key = null, mixed|null $value = null, boolean $merge = true) : mixed
Gets/Sets the config.
Reading the whole config:
$this->config();Reading a specific value:
$this->config('key');Reading a nested value:
$this->config('some.nested.key');Setting a specific value:
$this->config('key', $value);Setting a nested value:
$this->config('some.nested.key', $value);Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);| string|array|null | $key | The key to get/set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
Config value being read, or the object itself on write operations.
configShallow(string|array $key, mixed|null $value = null) : $this
Merge provided config with existing config. Unlike `config()` which does a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);Setting a nested value:
$this->configShallow('some.nested.key', $value);Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);| string|array | $key | The key to set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
param(string $key, string|null $model = null) : mixed
Convenience access to any of the paginator params.
| string | $key | Key of the paginator params array to retrieve. |
| string|null | $model | Optional model name. Uses the default if none is specified. |
Content of the requested param.
sortKey(string|null $model = null, array $options = array()) : string|null
Gets the current key by which the recordset is sorted
| string|null | $model | Optional model name. Uses the default if none is specified. |
| array | $options | Options for pagination links. See #options for list of keys. |
The name of the key by which the recordset is being sorted, or null if the results are not currently sorted.
sortDir(string|null $model = null, array $options = array()) : string
Gets the current direction the recordset is sorted
| string|null | $model | Optional model name. Uses the default if none is specified. |
| array | $options | Options for pagination links. See #options for list of keys. |
The direction by which the recordset is being sorted, or null if the results are not currently sorted.
prev(string $title = '<< Previous', array $options = array()) : string
Generates a "previous" link for a set of paged records
disabledTitle The text to used when the link is disabled. This
defaults to the same text at the active link. Setting to false will cause
this method to return ''.escape Whether you want the contents html entity encoded, defaults to truemodel The model to use, defaults to PaginatorHelper::defaultModel()url An array of additional URL options to use for link generation.templates An array of templates, or template file name containing the
templates you'd like to use when generating the link for previous page.
The helper's original templates will be restored once prev() is done.| string | $title | Title for the link. Defaults to '<< Previous'. |
| array | $options | Options for pagination link. See above for list of keys. |
A "previous" link or a disabled link.
next(string $title = 'Next >>', array $options = array()) : string
Generates a "next" link for a set of paged records
disabledTitle The text to used when the link is disabled. This
defaults to the same text at the active link. Setting to false will cause
this method to return ''.escape Whether you want the contents html entity encoded, defaults to truemodel The model to use, defaults to PaginatorHelper::defaultModel()url An array of additional URL options to use for link generation.templates An array of templates, or template file name containing the
templates you'd like to use when generating the link for next page.
The helper's original templates will be restored once next() is done.| string | $title | Title for the link. Defaults to 'Next >>'. |
| array | $options | Options for pagination link. See above for list of keys. |
A "next" link or $disabledTitle text if the link is disabled.
sort(string $key, string|null $title = null, array $options = array()) : string
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.| string | $key | The name of the key that the recordset should be sorted. |
| string|null | $title | Title for the link. If $title is null $key will be used for the title and will be generated by inflection. |
| array | $options | Options for sorting link. See above for list of keys. |
A link sorting default by 'asc'. If the resultset is sorted 'asc' by the specified key the returned link will sort by 'desc'.
generateUrl(array $options = array(), string|null $model = null, array $urlOptions = array()) : string
Merges passed URL options with current pagination state to generate a pagination URL.
escape: If false, the URL will be returned unescaped, do only use if it is manually
escaped afterwards before being displayed.fullBase: If true, the full base URL will be prepended to the result| array | $options | Pagination/URL options array |
| string|null | $model | Which model to paginate on |
| array | $urlOptions | Array of options The bool version of this argument is deprecated and will be removed in 4.0.0 |
By default, returns a full pagination URL string for use in non-standard contexts (i.e. JavaScript)
generateUrlParams(array $options = array(), string|null $model = null) : array
Merges passed URL options with current pagination state to generate a pagination URL.
| array | $options | Pagination/URL options array |
| string|null | $model | Which model to paginate on |
An array of URL parameters
hasPage(string|null $model = null, integer $page = 1) : boolean
Returns true if the given result set has the page number given by $page
| string|null | $model | Optional model name. Uses the default if none is specified. |
| integer | $page | The page number - if not set defaults to 1. |
True if the given result set has the specified page number.
counter(string|array $options = array()) : string
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.| string|array | $options | Options for the counter string. See #options for list of keys. If string it will be used as format. |
Counter string.
numbers(array $options = array()) : string|false
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(['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 numbers, but after the first links.after Content to be inserted after the numbers, but before the last links.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.
Set to false to disable and to show all numbers.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.templates An array of templates, or template file name containing the templates you'd like to
use when generating the numbers. The helper's original templates will be restored once
numbers() is done.url An array of additional URL options to use for link generation.The generated number links will include the 'ellipsis' template when the first and last options
and the number of pages exceed the modulus. For example if you have 25 pages, and use the first/last
options and a modulus of 8, ellipsis content will be inserted after the first and last link sets.
| array | $options | Options for the numbers. |
Numbers string.
first(string|integer $first = '<< first', array $options = array()) : string|false
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.
model The model to use defaults to PaginatorHelper::defaultModel()escape Whether or not to HTML escape the text.url An array of additional URL options to use for link generation.| string|integer | $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 | An array of options. |
Numbers string.
last(string|integer $last = 'last >>', array $options = array()) : string|false
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.
model The model to use defaults to PaginatorHelper::defaultModel()escape Whether or not to HTML escape the text.url An array of additional URL options to use for link generation.| string|integer | $last | if string use as label for the link, if numeric print page numbers |
| array | $options | Array of options |
Numbers string.
meta(array $options = array()) : string|null
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(['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 stringprev (default True) True to generate meta for previous pagenext (default True) True to generate meta for next pagefirst (default False) True to generate meta for first pagelast (default False) True to generate meta for last page| array | $options | Array of options |
Meta links
limitControl(array $limits = array(), integer|null $default = null, array $options = array()) : string
Dropdown select for pagination limit.
This will generate a wrapping form.
| array | $limits | The options array. |
| integer|null | $default | Default option for pagination limit. Defaults to |
| array | $options | Options for Select tag attributes like class, id or event |
html output.
_confirm(string $message, string $okCode, string $cancelCode = '', array $options = array()) : string
Returns a string to be used as onclick handler for confirm dialogs.
| string | $message | Message to be displayed |
| string | $okCode | Code to be executed after user chose 'OK' |
| string | $cancelCode | Code to be executed after user chose 'Cancel' |
| array | $options | Array of options |
onclick JS code
_configWrite(string|array $key, mixed $value, boolean|string $merge = false) : void
Writes a config key.
| string|array | $key | Key to write to. |
| mixed | $value | Value to write. |
| boolean|string | $merge | True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false. |
if attempting to clobber existing config
_toggledLink(string|boolean $text, boolean $enabled, array $options, array $templates) : string
Generate an active/inactive link for next/prev methods.
| string|boolean | $text | The enabled text for the link. |
| boolean | $enabled | Whether or not the enabled/disabled version should be created. |
| array | $options | An array of options from the calling method. |
| array | $templates | An array of templates with the 'active' and 'disabled' keys. |
Generated HTML
_getNumbersStartAndEnd(array $params, array $options) : array
Calculates the start and end for the pagination numbers.
| array | $params | Params from the numbers() method. |
| array | $options | Options from the numbers() method. |
An array with the start and end numbers.
_formatNumber(\Cake\View\StringTemplate $templater, array $options) : string
Formats a number for the paginator number output.
| \Cake\View\StringTemplate | $templater | StringTemplate instance. |
| array | $options | Options from the numbers() method. |
_modulusNumbers(\Cake\View\StringTemplate $templater, array $params, array $options) : string
Generates the numbers for the paginator numbers() method.
| \Cake\View\StringTemplate | $templater | StringTemplate instance. |
| array | $params | Params from the numbers() method. |
| array | $options | Options from the numbers() method. |
Markup output.
_firstNumber(string $ellipsis, array $params, integer $start, array $options) : string
Generates the first number for the paginator numbers() method.
| string | $ellipsis | Ellipsis character. |
| array | $params | Params from the numbers() method. |
| integer | $start | Start number. |
| array | $options | Options from the numbers() method. |
Markup output.
_lastNumber(string $ellipsis, array $params, integer $end, array $options) : string
Generates the last number for the paginator numbers() method.
| string | $ellipsis | Ellipsis character. |
| array | $params | Params from the numbers() method. |
| integer | $end | End number. |
| array | $options | Options from the numbers() method. |
Markup output.
_numbers(\Cake\View\StringTemplate $templater, array $params, array $options) : string
Generates the numbers for the paginator numbers() method.
| \Cake\View\StringTemplate | $templater | StringTemplate instance. |
| array | $params | Params from the numbers() method. |
| array | $options | Options from the numbers() method. |
Markup output.