_mapOptionssource protected

_mapOptions( string $method , array $options )

Maps Abstract options to engine specific option names. If attributes are missing from the map, they are not changed.

Parameters

string $method

Name of method whose options are being worked with.

array $options

Array of options to map.

Returns

array
Array of mapped options.

_parseOptionssource protected

_parseOptions( array $options , array $safeKeys array() )

Parse an options assoc array into a JavaScript object literal. Similar to object() but treats any non-integer value as a string, does not include { }

Parameters

array $options

Options to be converted

array $safeKeys optional array()

Keys that should not be escaped.

Returns

string
Parsed JSON options without enclosing { }.

_prepareCallbackssource protected

_prepareCallbacks( string $method , array $options , array $callbacks array() )

Prepare callbacks and wrap them with function ([args]) { } as defined in _callbackArgs array.

Parameters

string $method

Name of the method you are preparing callbacks for.

array $options

Array of options being parsed

array $callbacks optional array()

Additional Keys that contain callbacks

Returns

array
Array of options with callbacks added.

_processOptionssource protected

_processOptions( string $method , array $options )

Convenience wrapper method for all common option processing steps. Runs _mapOptions, _prepareCallbacks, and _parseOptions in order.

Parameters

string $method

Name of method processing options for.

array $options

Array of options to process.

Returns

string
Parsed options string.

_toQuerystringsource protected

_toQuerystring( array $parameters )

Convert an array of data into a query string

Parameters

array $parameters

Array of parameters to convert to a query string

Returns

string
Querystring fragment

_utf8ToHexsource protected

_utf8ToHex( string $string )

Encode a string into JSON. Converts and escapes necessary characters.

Parameters

string $string

The string that needs to be utf8->hex encoded

alertsource public

alert( string $message )

Create an alert() message in JavaScript

Parameters

string $message

Message you want to alter.

Returns

string
completed alert()

confirmsource public

confirm( string $message )

Create a confirm() message

Parameters

string $message

Message you want confirmed.

Returns

string
completed confirm()

confirmReturnsource public

confirmReturn( string $message )

Generate a confirm snippet that returns false from the current function scope.

Parameters

string $message

Message to use in the confirm dialog.

Returns

string
completed confirm with return script

domReadysource abstract public

domReady( string $functionBody )

Create a domReady event. This is a special event in many libraries

Parameters

string $functionBody

The code to run on domReady

Returns

string
completed domReady method

dragsource abstract public

drag( array $options array() )

Create a draggable element. Works on the currently selected element. Additional options may be supported by the library implementation.

Options

• handle - selector to the handle element.
• snapGrid - The pixel grid that movement snaps to, an array(x, y)
• container - The element that acts as a bounding box for the draggable element.

Event Options

• start - Event fired when the drag starts
• drag - Event fired on every step of the drag
• stop - Event fired when dragging stops (mouse release)

Parameters

array $options optional array()

Options array see above.

Returns

string
Completed drag script

dropsource abstract public

drop( array $options array() )

Create a droppable element. Allows for draggable elements to be dropped on it. Additional options may be supported by the library implementation.

Options

• accept - Selector for elements this droppable will accept.
• hoverclass - Class to add to droppable when a draggable is over.

Event Options

• drop - Event fired when an element is dropped into the drop zone.
• hover - Event fired when a drag enters a drop zone.
• leave - Event fired when a drag is removed from a drop zone without being dropped.

Parameters

array $options optional array()

Array of options for the drop. See above.

Returns

string
Completed drop script

eachsource abstract public

each( string $callback )

Create an iteration over the current selection result.

Parameters

string $callback

The function body you wish to apply during the iteration.

Returns

string
completed iteration

effectsource abstract public

effect( string $name , array $options array() )

Trigger an Effect.

Supported Effects

The following effects are supported by all core JsEngines

• show - reveal an element.
• hide - hide an element.
• fadeIn - Fade in an element.
• fadeOut - Fade out an element.
• slideIn - Slide an element in.
• slideOut - Slide an element out.

Options

• speed - Speed at which the animation should occur. Accepted values are 'slow', 'fast'. Not all effects use the speed option.

Parameters

string $name

The name of the effect to trigger.

array $options optional array()

Array of options for the effect.

Returns

string
completed string with effect.

escapesource public

escape( string $string )

Escape a string to be JSON friendly.

List of escaped elements:

• "\r" => '\n'
• "\n" => '\n'
• '"' => '\"'

Parameters

string $string

String that needs to get escaped.

Returns

string
Escaped string.

eventsource abstract public

event( string $type , string $callback , array $options array() )

Add an event to the script cache. Operates on the currently selected elements.

Options

• wrap - Whether you want the callback wrapped in an anonymous function. (defaults to true)
• stop - Whether you want the event to stopped. (defaults to true)

Parameters

string $type

Type of event to bind to the current dom id

string $callback

The JavaScript function you wish to trigger or the function literal

array $options optional array()

Options for the event.

Returns

string
completed event handler

getsource abstract public

get( string $selector )

Create javascript selector for a CSS rule

Parameters

string $selector

The selector that is targeted

Returns

self
instance of $this. Allows chained methods.

objectsource public

object( array $data array() , array $options array() )

Generates a JavaScript object in JavaScript Object Notation (JSON) from an array. Will use native JSON encode method if available, and $useNative == true

Options:

• prefix - String prepended to the returned data.
• postfix - String appended to the returned data.

Parameters

array $data optional array()

Data to be converted.

array $options optional array()

Set of options, see above.

Returns

string
A JSON code block

promptsource public

prompt( string $message , string $default '' )

Create a prompt() JavaScript function

Parameters

string $message

Message you want to prompt.

string $default optional ''

Default message

Returns

string
completed prompt()

redirectsource public

redirect( string|array $url null )

Redirects to a URL. Creates a window.location modification snippet that can be used to trigger 'redirects' from JavaScript.

Parameters

string|array $url optional null

URL

Returns

string
completed redirect in javascript

requestsource abstract public

request( string|array $url , array $options array() )

Make an XHR request

Event Options

• complete - Callback to fire on complete.
• success - Callback to fire on success.
• before - Callback to fire on request initialization.
• error - Callback to fire on request failure.

Options

• method - The method to make the request with defaults to GET in more libraries
• async - Whether or not you want an asynchronous request.
• data - Additional data to send.
• update - Dom id to update with the content of the request.
• type - Data type for response. 'json' and 'html' are supported. Default is html for most libraries.
• evalScripts - Whether or not <script> tags should be eval'ed.
• dataExpression - Should the data key be treated as a callback. Useful for supplying $options['data'] as another JavaScript expression.

Parameters

string|array $url

Array or String URL to target with the request.

array $options optional array()

Array of options. See above for cross library supported options

Returns

string
XHR request.

serializeFormsource abstract public

serializeForm( array $options array() )

Serialize the form attached to $selector. Pass true for $isForm if the current selection is a form element. Converts the form or the form element attached to the current selection into a string/json object (depending on the library implementation) for use with XHR operations.

Options

• isForm - is the current selection a form, or an input? (defaults to false)
• inline - is the rendered statement going to be used inside another JS statement? (defaults to false)

Parameters

array $options optional array()

options for serialization generation.

Returns

string
completed form serialization script

slidersource abstract public

slider( array $options array() )

Create a slider UI widget. Comprised of a track and knob. Additional options may be supported by the library implementation.

Options

• handle - The id of the element used in sliding.
• direction - The direction of the slider either 'vertical' or 'horizontal'
• min - The min value for the slider.
• max - The max value for the slider.
• step - The number of steps or ticks the slider will have.
• value - The initial offset of the slider.

Events

• change - Fired when the slider's value is updated
• complete - Fired when the user stops sliding the handle

Parameters

array $options optional array()

Array of options for the slider. See above.

Returns

string
Completed slider script

sortablesource abstract public

sortable( array $options array() )

Create a sortable element. Additional options may be supported by the library implementation.

Options

• containment - Container for move action
• handle - Selector to handle element. Only this element will start sort action.
• revert - Whether or not to use an effect to move sortable into final position.
• opacity - Opacity of the placeholder
• distance - Distance a sortable must be dragged before sorting starts.

Event Options

• start - Event fired when sorting starts
• sort - Event fired during sorting
• complete - Event fired when sorting completes.

Parameters

array $options optional array()

Array of options for the sortable. See above.

Returns

string
Completed sortable script.

valuesource public

value( mixed $val array() , boolean $quoteString null , string $key 'value' )

Converts a PHP-native variable of any type to a JSON-equivalent representation

Parameters

mixed $val optional array()

A PHP variable to be converted to JSON

boolean $quoteString optional null

If false, leaves string values unquoted

string $key optional 'value'

Key name.

Returns

string
a JavaScript-safe/JSON representation of $val

Overrides

Helper::value()

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

__constructsource public

__construct( View $View , array $settings array() )

Default Constructor

Parameters

View $View

The View this helper is being attached to.

array $settings optional array()

Configuration settings for the helper.

Overrides

Object::__construct()

__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

mixed
Helper 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.0

Parameters

string $name

Name of the property being accessed.

mixed $value

Value to set.

_cleansource protected

_clean( )

Removes harmful content from output

_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 $cancelCode optional ''

Code to be executed after user chose 'Cancel'

array $options optional array()

Array of options

Returns

string
onclick JS code

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

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

_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 $options optional array()

Array of options to use while initializing an input field.

Returns

array
Array 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 $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.

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

_resetsource protected

_reset( )

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

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

Field name.

Returns

array
array

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

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

string
Path 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 $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

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.

beforeRendersource public

beforeRender( string $viewFile )

Before render callback. beforeRender is called before the view file is rendered.

Overridden in subclasses.

Parameters

string $viewFile

The view file that is going 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.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

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

entitysource 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

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

string
string

modelsource public

model( )

Gets the currently-used model of the rendering context.

Returns

string
string

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

string
string

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 $setScope optional false

Sets the view scope to the model specified in $tagValue

urlsource public

url( string|array $url null , boolean $full false )

Finds URL for specified action.

Returns a URL pointing at the provided parameters.

Parameters

string|array $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.

boolean $full optional false

If true, the full base URL will be prepended to the result

Returns

string
Full translated URL with base path.

Link

http://book.cakephp.org/2.0/en/views/helpers.html

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

string
Web accessible path to file.

_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 $normalize optional 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 $properties optional 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 $status optional 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 $params optional array()

Parameter list to use when calling $method

Returns

mixed
Returns 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 $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

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

toStringsource public

toString( )

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

Returns

string
The name of this class

array()

array()

array('event', 'sortable', 'drag', 'drop', 'slider')

'%s="%s"'

null

array(
    'year', 'month', 'day', 'hour', 'min', 'second', 'meridian'
)

array()

'%s="%s"'

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

null

array()

array()

null

null

array()

array()

null