JsBaseEngineHelper Class Info:

Class Declaration:

abstract class JsBaseEngineHelper extends AppHelper

File name:
Cake/View/Helper/JsBaseEngineHelper.php
Description:

JsEngineBaseClass

Abstract Base Class for All JsEngines to extend. Provides generic methods.

Class Inheritance

AppHelper Helper Object

Properties:

Show/Hide parent properties
  • _association string

    The name of the current model association entities are in scope of.

  • _attributeFormat string

    Format to attribute

  • bufferedMethods array

    An array of lowercase method names in the Engine that are buffered unless otherwise disabled. This allows specific 'end point' methods to be automatically buffered by the JsHelper.

  • _callbackArguments array

    Contains a list of callback names -> default arguments.

  • _cleaned mixed

    Holds the cleaned content.

  • _entityPath string

    The dot separated list of elements the current field entity is for.

  • fieldset array

    Holds the fields array('field_name' => array('type' => 'string', 'length' => 100), primaryKey and validates array('field_name')

  • _fieldSuffixes 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.

  • _helperMap array

    A helper lookup table used to lazy load helper objects.

  • helpers array

    List of helpers used by this helper

  • _minimizedAttributeFormat string

    Format to attribute

  • _minimizedAttributes array

    Minimized attributes

  • _modelScope string

    The name of the current model entities are in scope of.

  • _optionMap array

    Collection of option maps. Option maps allow other helpers to use generic names for engine callbacks and options. Allowing uniform code access for all engine types. Their use is optional for end user use though.

  • plugin string

    Plugin path

  • request CakeRequest

    Request object

  • selection string

    The js snippet for the current selection.

  • tags array

    Holds tag templates.

  • _tainted mixed

    Holds the content to be cleaned.

  • theme string

    The current theme name if any.

  • _View View

    The View instance this helper is attached to

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/View/Helper.php on line 746
Return

array Array of options with $key set.

afterLayout

top

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

Overridden in subclasses.

Parameters:
  • string $layoutFile required

    The layout file that was rendered.

Method defined in:
Cake/View/Helper.php on line 810
Return

void

afterRender

top

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 required

    The view file that was rendered.

Method defined in:
Cake/View/Helper.php on line 788
Return

void

afterRenderFile

top

After render file callback. Called after any view fragment is rendered.

Overridden in subclasses.

Parameters:
  • $viewfile required

  • string $content required

    The content that was rendered.

Method defined in:
Cake/View/Helper.php on line 835
Return

void

alert

top

Create an alert() message in Javascript

Parameters:
  • string $message required

    Message you want to alter.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 64
Return

string completed alert()

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/View/Helper.php on line 331
Return

string Path with a timestamp added, or not.

assetUrl

top

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:
  • $path required

  • 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

Method defined in:
Cake/View/Helper.php on line 293
Return

string Generated url

beforeLayout

top

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

Overridden in subclasses.

Parameters:
  • string $layoutFile required

    The layout about to be rendered.

Method defined in:
Cake/View/Helper.php on line 799
Return

void

beforeRender

top

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

Overridden in subclasses.

Parameters:
  • string $viewFile required

    The view file that is going to be rendered

Method defined in:
Cake/View/Helper.php on line 776
Return

void

beforeRenderFile

top

Before render file callback. Called before any view fragment is rendered.

Overridden in subclasses.

Parameters:
  • $viewfile required

Method defined in:
Cake/View/Helper.php on line 822
Return

void

__call

top

Provide non fatal errors on missing method calls.

Parameters:
  • string $method required

    Method to invoke

  • array $params required

    Array of params for the method.

Method defined in:
Cake/View/Helper.php on line 178
Return

void

_clean

top

Removes harmful content from output

Method defined in:
Cake/View/Helper.php on line 882
Return

void

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 possibilities. 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/View/Helper.php on line 366
Return

string|array cleaned content for output

confirm

top

Create a confirm() message

Parameters:
  • string $message required

    Message you want confirmed.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 86
Return

string completed confirm()

confirmReturn

top

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

Parameters:
  • string $message required

    Message to use in the confirm dialog.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 97
Return

string completed confirm with return script

__construct

top

Default Constructor

Parameters:
  • View $View required

    The View this helper is being attached to.

  • array $settings optional array ( )

    Configuration settings for the helper.

Method defined in:
Cake/View/Helper.php on line 163

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/Core/Object.php on line 110
Return

mixed Returns the result of the method call

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/View/Helper.php on line 593
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.

domReady

top

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

Parameters:
  • string $functionBody required

    The code to run on domReady

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 313
Return

string completed domReady method

drag

top

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.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 394
Return

string Completed drag script

drop

top

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.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 414
Return

string Completed drop script

each

top

Create an iteration over the current selection result.

Parameters:
  • string $callback required

    The function body you wish to apply during the iteration.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 321
Return

string completed iteration

effect

top

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 required

    The name of the effect to trigger.

  • array $options optional array ( )

    Array of options for the effect.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 346
Return

string completed string with effect.

entity

top

Returns the entity reference of the current context as an array of identity parts

Method defined in:
Cake/View/Helper.php on line 549
Return

array An array containing the identity elements of an entity

escape

top

Escape a string to be JSON friendly.

List of escaped elements:

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

Parameters:
  • string $string required

    String that needs to get escaped.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 185
Return

string Escaped string.

event

top

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 required

    Type of event to bind to the current dom id

  • string $callback required

    The Javascript function you wish to trigger or the function literal

  • array $options optional array ( )

    Options for the event.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 305
Return

string completed event handler

field

top

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.

Method defined in:
Cake/View/Helper.php on line 572
Return

string

_formatAttribute

top

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'

Parameters:
  • string $key required

    The name of the attribute to create

  • string $value required

    The value of the attribute to create.

  • boolean $escape optional true

    Define if the value must be escaped

Method defined in:
Cake/View/Helper.php on line 456
Return

string The composed attribute.

Deprecated

This method will be moved to HtmlHelper in 3.0

get

top

Create javascript selector for a CSS rule

Parameters:
  • string $selector required

    The selector that is targeted

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 290
Return

JsBaseEngineHelper instance of $this. Allows chained methods.

__get

top

Lazy loads helpers. Provides access to deprecated request properties as well.

Parameters:
  • string $name required

    Name of the property being accessed.

Method defined in:
Cake/View/Helper.php on line 188
Return

mixed Helper or property found at $name

_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/View/Helper.php on line 727
Return

array Array options for the form input.

log

top

Convenience 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/Core/Object.php on line 149
Return

boolean Success of log write

_mapOptions

top

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

Parameters:
  • string $method required

    Name of method whose options are being worked with.

  • array $options required

    Array of options to map.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 508
Return

array Array of mapped options.

_mergeVars

top

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 required

    The name of the properties to merge.

  • string $class required

    The class to merge the property with.

  • boolean $normalize optional true

    Set to true to run the properties through Set::normalize() before merging.

Method defined in:
Cake/Core/Object.php on line 187
Return

void

model

top

Gets the currently-used model of the rendering context.

Method defined in:
Cake/View/Helper.php on line 558
Return

string

_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/View/Helper.php on line 626
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.

Todo

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

object

top

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.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 127
Return

string A JSON code block

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/View/Helper.php on line 764
Return

string

Deprecated

This method will be removed in future versions.

_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/View/Helper.php on line 422
Return

string Composed attributes.

Deprecated

This method will be moved to HtmlHelper in 3.0

_parseOptions

top

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

Parameters:
  • array $options required

    Options to be converted

  • array $safeKeys optional array ( )

    Keys that should not be escaped.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 487
Return

string Parsed JSON options without enclosing { }.

_prepareCallbacks

top

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

Parameters:
  • string $method required

    Name of the method you are preparing callbacks for.

  • array $options required

    Array of options being parsed

  • array $callbacks optional array ( )

    Additional Keys that contain callbacks

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 530
Return

array Array of options with callbacks added.

_processOptions

top

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

Parameters:
  • string $method required

    Name of method processing options for.

  • array $options required

    Array of options to process.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 566
Return

string Parsed options string.

prompt

top

Create a prompt() Javascript function

Parameters:
  • string $message required

    Message you want to prompt.

  • string $default optional ''

    Default message

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 110
Return

string completed prompt()

redirect

top

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

Parameters:
  • mixed $url optional NULL

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 76
Return

string completed redirect in javascript

request

top

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

    Array or String URL to target with the request.

  • array $options optional array ( )

    Array of options. See above for cross library supported options

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 373
Return

string XHR request.

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.

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

    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.

Method defined in:
Cake/Core/Object.php on line 66
Return

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

_reset

top

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

Method defined in:
Cake/View/Helper.php on line 872
Return

void

_selectedArray

top

Transforms a recordset from a hasAndBelongsToMany association to a list of selected options for a multiple select element

Parameters:
  • mixed $data required

  • string $key optional 'id'

Method defined in:
Cake/View/Helper.php on line 846
Return

array

serializeForm

top

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.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 476
Return

string completed form serialization script

__set

top

Provides backwards compatibility access for setting values to the request object.

Parameters:
  • string $name required

    Name of the property being accessed.

  • mixed $value required

    Name of the property being accessed.

Method defined in:
Cake/View/Helper.php on line 216
Return

mixed Return the $value

_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/Core/Object.php on line 164
Return

void

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/View/Helper.php on line 481
Return

void

slider

top

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.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 460
Return

string Completed slider script

sortable

top

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.

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 437
Return

string Completed sortable script.

_stop

top

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

Parameters:
Method defined in:
Cake/Core/Object.php on line 137
Return

void

_toQuerystring

top

Convert an array of data into a query string

Parameters:
  • array $parameters required

    Array of parameters to convert to a query string

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 579
Return

string Querystring fragment

toString

top

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

Method defined in:
Cake/Core/Object.php on line 41
Return

string The name of this class

url

top

Finds URL for specified action.

Returns a URL pointing at the provided parameters.

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

Method defined in:
Cake/View/Helper.php on line 241
Return

string Full translated URL with base path.

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

_utf8ToHex

top

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

Parameters:
  • string $string required

    The string that needs to be utf8->hex encoded

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 195
Return

void

value

top

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

  • $key optional 'value'

Method defined in:
Cake/View/Helper/JsBaseEngineHelper.php on line 143
Return

string a JavaScript-safe/JSON representation of $val

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/View/Helper.php on line 251
Return

string Web accessible path to file.