JsHelper Class Info:

Class Declaration:

class JsHelper extends AppHelper

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

Javascript Generator helper class for easy use of JavaScript.

JsHelper provides an abstract interface for authoring JavaScript with a given client-side library.

Class Inheritance

AppHelper Helper Object

Package
Cake.View.Helper
Property

HtmlHelper $Html

FormHelper $Form

Properties:

Show/Hide parent properties
  • _association string

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

  • _attributeFormat string

    Format to attribute

  • _bufferedScripts array

    Scripts that are queued for output

  • bufferScripts boolean

    Whether or not you want scripts to be buffered or output.

  • _cleaned mixed

    Holds the cleaned content.

  • _engineName string

    Current Javascript Engine that is being used

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

    Helper dependencies

  • _jsVars array

    Variables to pass to Javascript.

  • _minimizedAttributeFormat string

    Format to attribute

  • _minimizedAttributes array

    Minimized attributes

  • _modelScope string

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

  • plugin string

    Plugin path

  • request CakeRequest

    Request object

  • setVariable string

    The javascript variable created by set() variables.

  • 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

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

buffer

top

Write a script to the buffered scripts.

Parameters:
  • string $script required

    Script string to add to the buffer.

  • boolean $top optional false

    If true the script will be added to the top of the buffered scripts array. If false the bottom.

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

__call

top

call__ Allows for dispatching of methods to the Engine Helper. methods in the Engines bufferedMethods list will be automatically buffered. You can control buffering with the buffer param as well. By setting the last parameter to any engine method to a boolean you can force or disable buffering.

e.g. $js->get('#foo')->effect('fadeIn', array('speed' => 'slow'), true);

Will force buffering for the effect method. If the method takes an options array you may also add a 'buffer' param to the options array and control buffering there as well.

e.g. $js->get('#foo')->event('click', $functionContents, array('buffer' => true));

The buffer parameter will not be passed onto the EngineHelper.

Parameters:
  • string $method required

    Method to be called

  • array $params required

    Parameters for the method being called.

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

mixed Depends on the return of the dispatched method, or it could be an instance of the EngineHelper

_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

__construct

top

Constructor - determines engine helper

Parameters:
  • View $View required

    the view object the helper is attached to.

  • array $settings optional array ( )

    Settings array contains name of engine helper.

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

_createVars

top

Generates the object string for variables passed to javascript.

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

string Generated JSON object of all set vars

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.

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

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

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

getBuffer

top

Get all the buffered scripts

Parameters:
  • boolean $clear optional true

    Whether or not to clear the script caches (default true)

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

array Array of scripts added to the request.

Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/js.html#JsHelper::getBuffer

_getHtmlOptions

top

Parse a set of Options and extract the Html options. Extracted Html Options are removed from the $options param.

Parameters:
  • array $options required

    Options to filter.

  • array $additional optional array ( )

    Array of additional keys to extract and include in the return options array.

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

array Array of js options and Htmloptions

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

link

top

Generate an 'Ajax' link. Uses the selected JS engine to create a link element that is enhanced with Javascript. Options can include both those for HtmlHelper::link() and JsBaseEngine::request(), JsBaseEngine::event();

Options

  • confirm - Generate a confirm() dialog before sending the event.
  • id - use a custom id.
  • htmlAttributes - additional non-standard htmlAttributes. Standard attributes are class, id, rel, title, escape, onblur and onfocus.
  • buffer - Disable the buffering and return a script tag in addition to the link.

Parameters:
  • string $title required

    Title for the link.

  • mixed $url optional NULL

    Mixed either a string URL or an cake url array.

  • array $options optional array ( )

    Options for both the HTML element and Js::request()

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

string Completed link. If buffering is disabled a script tag will be returned as well.

Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/js.html#JsHelper::link

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

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

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

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

set

top

Pass variables into Javascript. Allows you to set variables that will be output when the buffer is fetched with JsHelper::getBuffer() or JsHelper::writeBuffer() The Javascript variable used to output set variables can be controlled with JsHelper::$setVariable

Parameters:
  • mixed $one required

    Either an array of variables to set, or the name of the variable to set.

  • mixed $two optional NULL

    If $one is a string, $two is the value for that key.

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

_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

__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

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

_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

submit

top

Uses the selected JS engine to create a submit input element that is enhanced with Javascript. Options can include both those for FormHelper::submit() and JsBaseEngine::request(), JsBaseEngine::event();

Forms submitting with this method, cannot send files. Files do not transfer over XmlHttpRequest and require an iframe or flash.

Options

  • url The url you wish the XHR request to submit to.
  • confirm A string to use for a confirm() message prior to submitting the request.
  • method The method you wish the form to send by, defaults to POST
  • buffer Whether or not you wish the script code to be buffered, defaults to true.
  • Also see options for JsHelper::request() and JsHelper::event()

Parameters:
  • string $caption optional NULL

    The display text of the submit button.

  • array $options optional array ( )

    Array of options to use. See the options for the above mentioned methods.

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

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

value

top

Overwrite inherited Helper::value() See JsBaseEngineHelper::value() for more information on this method.

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/JsHelper.php on line 165
Return

string a JavaScript-safe/JSON representation of $val

Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/js.html#JsHelper::value

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.

writeBuffer

top

Writes all Javascript generated so far to a code block or caches them to a file and returns a linked script. If no scripts have been buffered this method will return null. If the request is an XHR(ajax) request onDomReady will be set to false. As the dom is already 'ready'.

Options

  • inline - Set to true to have scripts output as a script block inline if cache is also true, a script link tag will be generated. (default true)
  • cache - Set to true to have scripts cached to a file and linked in (default false)
  • clear - Set to false to prevent script cache from being cleared (default true)
  • onDomReady - wrap cached scripts in domready event (default true)
  • safe - if an inline block is generated should it be wrapped in <![CDATA[ ... ]]> (default true)

Parameters:
  • array $options optional array ( )

    options for the code block

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

mixed Completed javascript tag if there are scripts, if there are no buffered scripts null will be returned.

Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/js.html#JsHelper::writeBuffer