Class PaginatorHelper
Pagination Helper class for easy generation of pagination links.
PaginationHelper encloses all methods needed when working with pagination.
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Link: http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html
Located at Cake/View/Helper/PaginatorHelper.php
Method Detail
__constructsource 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
$settingsoptional array() - Array of settings.
Throws
CakeExceptionWhen the AjaxProvider helper does not implement a link method.
Overrides
Helper::__construct() _convertUrlKeyssource 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
arrayconverted URL params.
_hasPagesource 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
booleanWhether model has $page
_pagingLinksource 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
$titleoptional null - Link title.
- array
$optionsoptional array() - Options list.
- string
$disabledTitleoptional null - Disabled link title.
- array
$disabledOptionsoptional array() - Disabled link options.
Returns
stringstring
beforeRendersource public
beforeRender( string $viewFile )
Before render callback. Overridden to merge passed args with URL options.
Parameters
- string
$viewFile - View file name.
Overrides
Helper::beforeRender() countersource public
counter( array $options array() )
Returns a counter string for the paged result set
Options
-
modelThe model to use, defaults to PaginatorHelper::defaultModel(); -
formatThe 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. -
separatorThe 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
$optionsoptional array() - Options for the counter string. See #options for list of keys.
Returns
stringCounter string.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::countercurrentsource public
current( string $model null )
Gets the current page of the recordset for the given model
Parameters
- string
$modeloptional null - Optional model name. Uses the default if none is specified.
Returns
stringThe current page number of the recordset.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::currentdefaultModelsource public
defaultModel( )
Gets the default model of the paged sets
Returns
string|nullModel name or null if the pagination isn't initialized.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::defaultModelfirstsource 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:
-
tagThe tag wrapping tag you want to use, defaults to 'span' -
afterContent to insert after the link/tag -
modelThe model to use defaults to PaginatorHelper::defaultModel() -
separatorContent between the generated links, defaults to ' | ' -
ellipsisContent for ellipsis, defaults to '...'
Parameters
- string|integer
$firstoptional '<< 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
$optionsoptional array() - An array of options.
Returns
stringNumbers string.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::firsthasNextsource public
hasNext( string $model null )
Returns true if the given result set is not at the last page
Parameters
- string
$modeloptional null - Optional model name. Uses the default if none is specified.
Returns
booleanTrue if the result set is not at the last page.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::hasNexthasPagesource public
hasPage( string $model null , integer $page 1 )
Returns true if the given result set has the page number given by $page
Parameters
- string
$modeloptional null - Optional model name. Uses the default if none is specified.
- integer
$pageoptional 1 - The page number - if not set defaults to 1.
Returns
booleanTrue if the given result set has the specified page number.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::hasPagehasPrevsource public
hasPrev( string $model null )
Returns true if the given result set is not at the first page
Parameters
- string
$modeloptional null - Optional model name. Uses the default if none is specified.
Returns
booleanTrue if the result set is not at the first page.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::hasPrevlastsource 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:
-
tagThe tag wrapping tag you want to use, defaults to 'span' -
beforeContent to insert before the link/tag -
modelThe model to use defaults to PaginatorHelper::defaultModel() -
separatorContent between the generated links, defaults to ' | ' -
ellipsisContent for ellipsis, defaults to '...'
Parameters
- string|integer
$lastoptional 'last >>' - if string use as label for the link, if numeric print page numbers
- array
$optionsoptional array() - Array of options
Returns
stringNumbers string.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::lastlinksource public
link( string $title , string|array $url array() , array $options array() )
Generates a plain or Ajax link with pagination parameters
Options
-
updateThe Id of the DOM element you wish to update. Creates Ajax enabled links with the AjaxHelper. -
escapeWhether you want the contents html entity encoded, defaults to true -
modelThe model to use, defaults to PaginatorHelper::defaultModel()
Parameters
- string
$title - Title for the link.
- string|array
$urloptional array() - URL for the action. See Router::url()
- array
$optionsoptional array() - Options for the link. See #options for list of keys.
Returns
stringA link with pagination parameters.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::linkmetasource 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:
-
modelThe model to use defaults to PaginatorHelper::defaultModel() -
blockThe block name to append the output to, or false/absent to return as a string
Parameters
- array
$optionsoptional array() - Array of options.
Returns
string|nullMeta links.
nextsource 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:
-
urlAllows sending routing parameters such as controllers, actions or passed arguments. -
tagThe tag wrapping tag you want to use, defaults to 'span'. Set this to false to disable this option -
escapeWhether you want the contents html entity encoded, defaults to true -
modelThe model to use, defaults to PaginatorHelper::defaultModel() -
disabledTagTag to use instead of A tag when there is no next page
Parameters
- string
$titleoptional 'Next >>' - Title for the link. Defaults to 'Next >>'.
- array
$optionsoptional array() - Options for pagination link. See above for list of keys.
- string
$disabledTitleoptional null - Title when the link is disabled.
- array
$disabledOptionsoptional array() - Options for the disabled pagination link. See above for list of keys.
Returns
stringA "next" link or $disabledTitle text if the link is disabled.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::nextnumberssource 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
-
beforeContent to be inserted before the numbers -
afterContent to be inserted after the numbers -
modelModel to create numbers for, defaults to PaginatorHelper::defaultModel() -
modulushow many numbers to include on either side of the current page, defaults to 8. -
separatorSeparator content defaults to ' | ' -
tagThe tag to wrap links in, defaults to 'span' -
firstWhether 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. -
lastWhether 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. -
ellipsisEllipsis content, defaults to '...' -
classClass for wrapper tag -
currentClassClass for wrapper tag on current active page, defaults to 'current' -
currentTagTag to use for current page number, defaults to null
Parameters
- array|boolean
$optionsoptional array() - Options for the numbers, (before, after, model, modulus, separator)
Returns
stringNumbers string.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::numbersoptionssource public
options( array|string $options array() )
Sets default options for all pagination links
Parameters
- array|string
$optionsoptional 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::optionsparamsource 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
$modeloptional null - Optional model name. Uses the default if none is specified.
Returns
mixedContent of the requested param.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::paramsparamssource public
params( string $model null )
Gets the current paging parameters from the resultset for the given model
Parameters
- string
$modeloptional null - Optional model name. Uses the default if none is specified.
Returns
arrayThe array of paging parameters for the paginated resultset.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::paramsprevsource 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:
-
urlAllows sending routing parameters such as controllers, actions or passed arguments. -
tagThe tag wrapping tag you want to use, defaults to 'span'. Set this to false to disable this option -
escapeWhether you want the contents html entity encoded, defaults to true -
modelThe model to use, defaults to PaginatorHelper::defaultModel() -
disabledTagTag to use instead of A tag when there is no previous page
Parameters
- string
$titleoptional '<< Previous' - Title for the link. Defaults to '<< Previous'.
- array
$optionsoptional array() - Options for pagination link. See #options for list of keys.
- string
$disabledTitleoptional null - Title when the link is disabled.
- array
$disabledOptionsoptional array() - Options for the disabled pagination link. See #options for list of keys.
Returns
stringA "previous" link or $disabledTitle text if the link is disabled.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::prevsortsource 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:
-
escapeWhether you want the contents html entity encoded, defaults to true. -
modelThe model to use, defaults to PaginatorHelper::defaultModel(). -
directionThe default direction to use when this link isn't active. -
lockLock 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
$titleoptional null - Title for the link. If $title is null $key will be used for the title and will be generated by inflection.
- array
$optionsoptional array() - Options for sorting link. See above for list of keys.
Returns
stringA 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::sortsortDirsource public
sortDir( string $model null , array $options array() )
Gets the current direction the recordset is sorted
Parameters
- string
$modeloptional null - Optional model name. Uses the default if none is specified.
- array
$optionsoptional array() - Options for pagination links. See #options for list of keys.
Returns
stringThe 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::sortDirsortKeysource public
sortKey( string $model null , array $options array() )
Gets the current key by which the recordset is sorted
Parameters
- string
$modeloptional null - Optional model name. Uses the default if none is specified.
- array
$optionsoptional array() - Options for pagination links. See #options for list of keys.
Returns
string|nullThe 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::sortKeyurlsource 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
$optionsoptional array() - Pagination/URL options array
- boolean
$asArrayoptional false - Return the URL as an array, or a URI string
- string
$modeloptional null - Which model to paginate on
Returns
mixedBy 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::urlOverrides
Helper::url() Methods inherited from Helper
__callsource 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.
__getsource 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
mixedHelper or property found at $name
__setsource 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.0Parameters
- string
$name - Name of the property being accessed.
- mixed
$value - Value to set.
_confirmsource 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
$cancelCodeoptional '' - Code to be executed after user chose 'Cancel'
- array
$optionsoptional array() - Array of options
Returns
stringonclick JS code
_encodeUrlsource protected
_encodeUrl( string $url )
Encodes a URL for use in HTML attributes.
Parameters
- string
$url - The URL to encode.
Returns
stringThe URL encoded for both URL & HTML contexts.
_formatAttributesource 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.0Parameters
- string
$key - The name of the attribute to create
- string
$value - The value of the attribute to create.
- boolean
$escapeoptional true - Define if the value must be escaped
Returns
stringThe composed attribute.
_initInputFieldsource 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
$optionsoptional array() - Array of options to use while initializing an input field.
Returns
arrayArray options for the form input.
_namesource 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
$optionsoptional 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
$fieldoptional null - Field name.
- string
$keyoptional 'name' - The name of the attribute to be set, defaults to 'name'
Returns
mixedIf an array was given for $options, an array with $key set will be returned. If a string was supplied a string will be returned.
_parseAttributessource 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.0Parameters
- array
$options - Array of options.
- array
$excludeoptional null - Array of options to be excluded, the options here will not be part of the return.
- string
$insertBeforeoptional ' ' - String to be inserted before options.
- string
$insertAfteroptional null - String to be inserted after options.
Returns
stringComposed attributes.
_selectedArraysource 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
$keyoptional 'id' - Field name.
Returns
arrayarray
addClasssource public
addClass( array $options array() , string $class null , string $key 'class' )
Adds the given class to the element options
Parameters
- array
$optionsoptional array() - Array options/attributes to add a class to
- string
$classoptional null - The class name being added.
- string
$keyoptional 'class' - the key to use for class.
Returns
arrayArray of options with $key set.
afterLayoutsource 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.
afterRendersource 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.
afterRenderFilesource 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.
assetTimestampsource 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
stringPath with a timestamp added, or not.
assetUrlsource 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
$optionsoptional array() - Options array. Possible keys:
fullBaseReturn full URL with domain namepathPrefixPath prefix for relative URLsextAsset extension to appendpluginFalse value will prevent parsing path as a plugin
Returns
stringGenerated URL
beforeLayoutsource 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.
beforeRenderFilesource 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.
cleansource 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.0Parameters
- string|array
$output - Either an array of strings to clean or a single string to clean.
Returns
string|array|nullCleaned content for output
domIdsource 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
$optionsoptional 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
$idoptional 'id' - The name of the 'id' attribute.
Returns
mixedIf $options was an array, an array will be returned with $id set. If a string was supplied, a string will be returned.
entitysource public
entity( )
Returns the entity reference of the current context as an array of identity parts
Returns
arrayAn array containing the identity elements of an entity
fieldsource 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
stringstring
modelsource public
model( )
Gets the currently-used model of the rendering context.
Returns
stringstring
outputsource 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
stringstring
setEntitysource 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
$setScopeoptional false - Sets the view scope to the model specified in $tagValue
valuesource public
value( array|string $options array() , string $field null , string $key 'value' )
Gets the data for the current tag
Parameters
- array|string
$optionsoptional 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
$fieldoptional null - Field name.
- string
$keyoptional 'value' - The name of the attribute to be set, defaults to 'value'
Returns
mixedIf an array was given for $options, an array with $key set will be returned. If a string was supplied a string will be returned.
webrootsource 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
stringWeb accessible path to file.
Methods inherited from Object
_mergeVarssource 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
$normalizeoptional true - Set to true to run the properties through Hash::normalize() before merging.
_setsource 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
$propertiesoptional array() - An associative array containing properties and corresponding values.
_stopsource protected
_stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
Parameters
- integer|string
$statusoptional 0 - see http://php.net/exit for values
dispatchMethodsource 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
$paramsoptional array() - Parameter list to use when calling $method
Returns
mixedReturns the result of the method call
logsource 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
$typeoptional LOG_ERR - Error type constant. Defined in app/Config/core.php.
- null|string|array
$scopeoptional null - The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.
Returns
booleanSuccess of log write
requestActionsource 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
$extraoptional 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
mixedBoolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toStringsource public
toString( )
Object-to-string conversion. Each class can override this method as necessary.
Returns
stringThe name of this class
Properties summary
Properties inherited from Helper
$_associationsource
protected string
The name of the current model association entities are in scope of.
See
Helper::setEntity()$_entityPathsource
protected string
The dot separated list of elements the current field entity is for.
See
Helper::setEntity()$_fieldSuffixessource
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' )
$_minimizedAttributessource
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' )
$_modelScopesource
protected string
The name of the current model entities are in scope of.
See
Helper::setEntity()$fieldsetsource
public array
Holds the fields array('field_name' => array('type' => 'string', 'length' => 100), primaryKey and validates array('field_name')
array() Magic properties summary
$Htmlsource
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