Application helper
Add your application-wide methods in the class below, your helpers will inherit them.
_View
, _association
, _attributeFormat
, _cleaned
, _entityPath
, _fieldSuffixes
, _helperMap
, _minimizedAttributeFormat
, _minimizedAttributes
, _modelScope
, _tainted
, fieldset
, helpers
, plugin
, request
, settings
, tags
, theme
__call( string $method , array $params )
Provide non fatal errors on missing method calls.
$method
$params
__construct( View $View , array $settings array() )
Default Constructor
View
$View
$settings
optional array() Object::__construct()
__get( string $name )
Lazy loads helpers. Provides access to deprecated request properties as well.
$name
__set( string $name , mixed $value )
Provides backwards compatibility access for setting values to the request object.
$name
$value
_confirm( string $message , string $okCode , string $cancelCode '' , array $options array() )
Returns a string to be used as onclick handler for confirm dialogs.
$message
$okCode
$cancelCode
optional '' $options
optional array() _encodeUrl( string $url )
Encodes a URL for use in HTML attributes.
$url
_formatAttribute( string $key , string $value , boolean $escape true )
Formats an individual attribute, and returns the string value of the composed attribute. Works with minimized attributes that have the same value as their name such as 'disabled' and 'checked'
$key
$value
$escape
optional true _initInputField( string $field , array $options array() )
Sets the defaults for an input tag. Will set the name, value, and id attributes for an array of html attributes.
$field
$options
optional array() _name( array|string $options array() , string $field null , string $key 'name' )
Gets the input field name for the current tag. Creates input name attributes using CakePHP's data[Model][field] formatting.
$options
optional array() 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.
$field
optional null $key
optional 'name' 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( array $options , array $exclude null , string $insertBefore ' ' , string $insertAfter null )
Returns a space-delimited string with items of the $options array. If a key of $options array happens to be one of those listed in Helper::$_minimizedAttributes
And its value is one of:
Then the value will be reset to be identical with key's name. If the value is not one of these 3, the parameter is not output.
'escape' is a special option in that it controls the conversion of attributes to their html-entity encoded equivalents. Set to false to disable html-encoding.
If value for any option key is set to null
or false
, that option will be excluded from output.
$options
$exclude
optional null $insertBefore
optional ' ' $insertAfter
optional null _selectedArray( string|array $data , string $key 'id' )
Transforms a recordset from a hasAndBelongsToMany association to a list of selected options for a multiple select element
$data
$key
optional 'id' addClass( array $options array() , string $class null , string $key 'class' )
Adds the given class to the element options
$options
optional array() $class
optional null $key
optional 'class' afterLayout( string $layoutFile )
After layout callback. afterLayout is called after the layout has rendered.
Overridden in subclasses.
$layoutFile
afterRender( string $viewFile )
After render callback. afterRender is called after the view file is rendered but before the layout has been rendered.
Overridden in subclasses.
$viewFile
afterRenderFile( string $viewFile , string $content )
After render file callback. Called after any view fragment is rendered.
Overridden in subclasses.
$viewFile
$content
assetTimestamp( string $path )
Adds a timestamp to a file based resource based on the value of Asset.timestamp
in Configure. If Asset.timestamp is true and debug > 0, or Asset.timestamp === 'force' a timestamp will be added.
$path
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
$path
$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
beforeLayout( string $layoutFile )
Before layout callback. beforeLayout is called before the layout is rendered.
Overridden in subclasses.
$layoutFile
beforeRender( string $viewFile )
Before render callback. beforeRender is called before the view file is rendered.
Overridden in subclasses.
$viewFile
beforeRenderFile( string $viewFile )
Before render file callback. Called before any view fragment is rendered.
Overridden in subclasses.
$viewFile
clean( string|array $output )
Used to remove harmful tags from content. Removes a number of well known XSS attacks from content. However, is not guaranteed to remove all possibilities. Escaping content is the best way to prevent all possible attacks.
$output
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.
$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.
$id
optional 'id' If $options was an array, an array will be returned with $id set. If a string was supplied, a string will be returned.
entity( )
Returns the entity reference of the current context as an array of identity parts
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.
model( )
Gets the currently-used model of the rendering context.
output( string $str )
Returns a string generated by a helper method
This method can be overridden in subclasses to do generalized output post-processing
$str
setEntity( string $entity , boolean $setScope false )
Sets this helper's model and field properties to the dot-separated value-pair in $entity.
$entity
$setScope
optional false url( string|array $url null , boolean $full false )
Finds URL for specified action.
Returns a URL pointing at the provided parameters.
$url
optional null Either a relative string url like /products/view/23
or an array of URL parameters. Using an array for URLs will allow you to leverage the reverse routing features of CakePHP.
$full
optional false value( array|string $options array() , string $field null , string $key 'value' )
Gets the data for the current tag
$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.
$field
optional null $key
optional 'value' 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( string $file )
Checks if a file exists when theme is used, if no file is found default location is returned
$file
_mergeVars( array $properties , string $class , boolean $normalize true )
Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'
This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.
$properties
$class
$normalize
optional true _set( array $properties array() )
Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
$properties
optional array() _stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
$status
optional 0 dispatchMethod( string $method , array $params array() )
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array
$method
$params
optional array() 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.
$msg
$type
optional LOG_ERR $scope
optional null The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.
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()
POST and GET data can be simulated in requestAction. Use $extra['url']
for GET data. The $extra['data']
parameter allows POST data simulation.
$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.
$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.
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString( )
Object-to-string conversion. Each class can override this method as necessary.
© 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.8/class-AppHelper.html