Class JqueryEngineHelper

jQuery Engine Helper for JsHelper

Object

Overloadable

Helper

AppHelper

JsBaseEngineHelper

JqueryEngineHelper

Package: cake\cake\libs\view\helpers
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc.
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: view/helpers/jquery_engine.php

Properties summary

$_callbackArguments public

string

Callback arguments lists
$_optionMap public

array

Option mappings for jQuery
$jQueryObject public

string

The variable name of the jQuery Object, useful when jQuery is put into noConflict() mode.

Inherited Properties

bufferedMethods, selection, useNative __cleaned, __tainted, action, argSeparator, base, data, helpers, here, namedArgs, params, plugin, tags, theme, validationErrors, webroot

Method Summary

_methodTemplate() public

Helper function to wrap repetitive simple method templating.
domReady() public

Create a domReady event. For jQuery. This method does not bind a 'traditional event' as $(document).bind('ready', fn) Works in an entirely different fashion than $(document).ready() The first will not run the function when eval()'d as part of a response The second will. Because of the way that ajax pagination is done $().ready() is used.
drag() public

Create a Draggable element
drop() public

Create a Droppable element
each() public

Create an iteration over the current selection result.
effect() public

Trigger an Effect.
event() public

Add an event to the script cache. Operates on the currently selected elements.
get() public

Create javascript selector for a CSS rule
request() public

Create an $.ajax() call.
serializeForm() public

Serialize a form attached to $selector. If the current selection is not an input or form, errors will be created in the Javascript.
slider() public

Create a Slider element
sortable() public

Create a sortable element.

Method Detail

_methodTemplate() public ¶

_methodTemplate( string $method , string $template , string $options , string $extraSafeKeys = array() , string $callbacks ,… )

Helper function to wrap repetitive simple method templating.

Parameters

string $method: The method name being generated.
string $template: The method template
string $options: $selection the selection to apply
string $extraSafeKeys optional array(): $options Array of options for method
string $callbacks ,…: Array of callback / special options.

Returns

string
Composed method string

domReady() public ¶

domReady( string $functionBody )

Create a domReady event. For jQuery. This method does not bind a 'traditional event' as $(document).bind('ready', fn) Works in an entirely different fashion than $(document).ready() The first will not run the function when eval()'d as part of a response The second will. Because of the way that ajax pagination is done $().ready() is used.

Parameters

string $functionBody: The code to run on domReady

Returns

string
completed domReady method

Overrides

JsBaseEngineHelper::domReady()

drag() public ¶

drag( array $options = array() )

Create a Draggable element

Requires both Ui.Core and Ui.Draggable to be loaded.

Parameters

array $options optional array(): Array of options for the draggable element.

Returns

string
Completed Draggable script.

See

JsBaseEngineHelper::drag() for options list.

Overrides

JsBaseEngineHelper::drag()

drop() public ¶

drop( array $options = array() )

Create a Droppable element

Requires both Ui.Core and Ui.Droppable to be loaded.

Parameters

array $options optional array(): Array of options for the droppable element.

Returns

string
Completed Droppable script.

See

JsBaseEngineHelper::drop() for options list.

Overrides

JsBaseEngineHelper::drop()

each() public ¶

each( string $callback , string $callback ,… )

Create an iteration over the current selection result.

Parameters

string $callback: $method The method you want to apply to the selection
string $callback ,…: The function body you wish to apply during the iteration.

Returns

string
completed iteration

Overrides

JsBaseEngineHelper::each()

effect() public ¶

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

Trigger an Effect.

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.

See

JsBaseEngineHelper::effect()

Overrides

JsBaseEngineHelper::effect()

event() 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 true)
'stop' - Whether you want the event to stopped. (defaults 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

Overrides

JsBaseEngineHelper::event()

get() public ¶

get( string $selector )

Create javascript selector for a CSS rule

Parameters

string $selector: The selector that is targeted

Returns

object
instance of $this. Allows chained methods.

Overrides

JsBaseEngineHelper::get()

request() public ¶

request( mixed $url , array $options = array() )

Create an $.ajax() call.

If the 'update' key is set, success callback will be overridden.

Parameters

mixed $url
array $options optional array(): See JsHelper::request() for options.

Returns

string
The completed ajax call.

See

JsBaseEngineHelper::request() for options list.

Overrides

JsBaseEngineHelper::request()

serializeForm() public ¶

serializeForm( array $options = array() )

Serialize a form attached to $selector. If the current selection is not an input or form, errors will be created in the Javascript.

Parameters

array $options optional array(): Options for the serialization

Returns

string
completed form serialization script.

See

JsBaseEngineHelper::serializeForm() for option list.

Overrides

JsBaseEngineHelper::serializeForm()

slider() public ¶

slider( array $options = array() )

Create a Slider element

Requires both Ui.Core and Ui.Slider to be loaded.

Parameters

array $options optional array(): Array of options for the droppable element.

Returns

string
Completed Slider script.

See

JsBaseEngineHelper::slider() for options list.

Overrides

JsBaseEngineHelper::slider()

sortable() public ¶

sortable( array $options = array() )

Create a sortable element.

Requires both Ui.Core and Ui.Sortables to be loaded.

Parameters

array $options optional array(): Array of options for the sortable.

Returns

string
Completed sortable script.

See

JsBaseEngineHelper::sortable() for options list.

Overrides

JsBaseEngineHelper::sortable()

Methods inherited from JsBaseEngineHelper

__construct() public ¶

__construct( )

string $string: The string that needs to be utf8->hex encoded

alert() public ¶

alert( string $message )

Create an alert() message in Javascript

Parameters

string $message: Message you want to alter.

Returns

string
completed alert()

confirm() public ¶

confirm( string $message )

Create a confirm() message

Parameters

string $message: Message you want confirmed.

Returns

string
completed confirm()

confirmReturn() 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

escape() public ¶

escape( string $string )

Escape a string to be JSON friendly.

List of escaped elements:

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

Parameters

string $string: $script String that needs to get escaped.

Returns

string
Escaped string.

object() 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

prompt() 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()

redirect() public ¶

redirect( mixed $url = null , array $options ,… )

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

Parameters

mixed $url optional null
array $options ,…

Returns

string
completed redirect in javascript

value() public ¶

value( mixed $val , boolean $quoteString = true )

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

Parameters

mixed $val: A PHP variable to be converted to JSON
boolean $quoteString optional true: $quoteStrings If false, leaves string values unquoted

Returns

string
a JavaScript-safe/JSON representation of $val

Overrides

Helper::value()

Methods inherited from Helper

__clean() public ¶

__clean( )

Removes harmful content from output

__formatAttribute() public ¶

__formatAttribute( string $key , string $value , $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'

Parameters

string $key: The name of the attribute to create
string $value: The value of the attribute to create.
$escape optional true

Returns

string
The composed attribute.

__reset() public ¶

__reset( )

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

__selectedArray() public ¶

__selectedArray( mixed $data , string $key = 'id' )

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

Parameters

mixed $data
string $key optional 'id'

Returns

array

_initInputField() public ¶

_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. Will also add a 'form-error' class if the field contains validation errors.

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.

_name() public ¶

_name( mixed $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

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

_parseAttributes() public ¶

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

'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: 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.

addClass() 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 classname being added.
string $key optional 'class': the key to use for class.

Returns

array
Array of options with $key set.

afterLayout() public ¶

afterLayout( )

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

Overridden in subclasses.

afterRender() public ¶

afterRender( )

After render callback. afterRender is called after the view file is rendered but before the layout has been rendered.

Overridden in subclasses.

assetTimestamp() 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.

beforeLayout() public ¶

beforeLayout( )

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

Overridden in subclasses.

beforeRender() public ¶

beforeRender( )

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

Overridden in subclasses.

call__() public ¶

call__( $method , $params )

clean() public ¶

clean( mixed $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 possiblities. Escaping content is the best way to prevent all possible attacks.

Parameters

mixed $output: Either an array of strings to clean or a single string to clean.

Returns

cleaned
content for output

domId() public ¶

domId( mixed $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

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.

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.

field() public ¶

field( )

Gets the currently-used model field of the rendering context.

Returns

string

get__() public ¶

get__( $name )

Default overload methods

loadConfig() public ¶

loadConfig( $name = 'tags' )

Parses tag templates into $this->tags.

Parameters

$name optional 'tags': name inside app/config to load.

This method can be overridden in subclasses to do generalized output post-processing

Deprecated

This method will be removed in future versions.

Parameters

string $str: String to be output.

Returns

string

setEntity() public ¶

setEntity( mixed $entity , boolean $setScope = false )

Sets this helper's model and field properties to the dot-separated value-pair in $entity.

Parameters

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

set__() public ¶

set__( $name , $value )

tagIsInvalid() public ¶

tagIsInvalid( string $model = null , string $field = null , integer $modelID = null )

Returns null if given FORM field has no errors. Otherwise it returns the constant set in the array Model->validationErrors.

Parameters

string $model optional null: Model name as a string
string $field optional null: Fieldname as a string
integer $modelID optional null: Unique index identifying this record within the form

Returns

mixed
Null if no errors, string with error otherwhise.

url() public ¶

url( mixed $url = null , boolean $full = false )

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

Returns

string
Full translated URL with base path.

Link

http://book.cakephp.org/view/1448/url

webroot() 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.

Methods inherited from Overloadable

__call() public ¶

__call( string $method , array $params )

Magic method handler.

Parameters

string $method: Method name
array $params: Parameters to send to method

Returns

mixed
Return value from method

overload() public ¶

overload( )

Overload implementation. No need for implementation in PHP5.

Methods inherited from Object

Object() public ¶

Object( )

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

Returns

Object

__openPersistent() public ¶

__openPersistent( string $name , string $type = null )

Open the persistent class file for reading Used by Object::_persist()

Parameters

string $name: Name of persisted class
string $type optional null: Type of persistance (e.g: registry)

_persist() public ¶

_persist( string $name , string $return , $object , $type = null )

Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples

Parameters

string $name: name of the class to persist
string $return: $object the object to persist
$object
$type optional null

Returns

boolean
Success

_savePersistent() public ¶

_savePersistent( string $name , object $object )

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

Parameters

string $name: name used for object to cache
object $object: the object to persist

Returns

boolean
true on save, throws error if file can not be created

_set() public ¶

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

_stop() public ¶

_stop( $status = 0 )

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

Parameters

$status optional 0: http://php.net/exit for values

cakeError() public ¶

cakeError( string $method , array $messages = array() )

Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.

Parameters

string $method: Method to be called in the error class (AppError or ErrorHandler classes)
array $messages optional array(): Message that is to be displayed by the error class

Returns

error
message

dispatchMethod() 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

log() public ¶

log( string $msg , integer $type = LOG_ERROR )

Convience 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_ERROR: Error type constant. Defined in app/config/core.php.

Returns

boolean
Success of log write

requestAction() public ¶

requestAction( mixed $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.

Parameters

mixed $url: String or array-based url.
array $extra optional array(): if array includes the key "return" it sets the AutoRender to true.

Returns

mixed

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

toString() public ¶

toString( )

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

Returns

string
The name of this class

Properties detail

`$_callbackArguments` ¶

public string

Callback arguments lists

array(
    'slider' => array(
        'start' => 'event, ui',
        'slide' => 'event, ui',
        'change' => 'event, ui',
        'stop' => 'event, ui'
    ),
    'sortable' => array(
        'start' => 'event, ui',
        'sort' => 'event, ui',
        'change' => 'event, ui',
        'beforeStop' => 'event, ui',
        'stop' => 'event, ui',
        'update' => 'event, ui',
        'receive' => 'event, ui',
        'remove' => 'event, ui',
        'over' => 'event, ui',
        'out' => 'event, ui',
        'activate' => 'event, ui',
        'deactivate' => 'event, ui'
    ),
    'drag' => array(
        'start' => 'event, ui',
        'drag' => 'event, ui',
        'stop' => 'event, ui',
    ),
    'drop' => array(
        'activate' => 'event, ui',
        'deactivate' => 'event, ui',
        'over' => 'event, ui',
        'out' => 'event, ui',
        'drop' => 'event, ui'
    ),
    'request' => array(
        'beforeSend' => 'XMLHttpRequest',
        'error' => 'XMLHttpRequest, textStatus, errorThrown',
        'success' => 'data, textStatus',
        'complete' => 'XMLHttpRequest, textStatus',
        'xhr' => ''
    )
)

`$_optionMap` ¶

public array

Option mappings for jQuery

array(
    'request' => array(
        'type' => 'dataType',
        'before' => 'beforeSend',
        'method' => 'type',
    ),
    'sortable' => array(
        'complete' => 'stop',
    ),
    'drag' => array(
        'snapGrid' => 'grid',
        'container' => 'containment',
    ),
    'drop' => array(
        'leave' => 'out',
        'hover' => 'over'
    ),
    'slider' => array(
        'complete' => 'stop',
        'direction' => 'orientation'
    )
)

`$jQueryObject` ¶

public string

The variable name of the jQuery Object, useful when jQuery is put into noConflict() mode.

'$'

Classes

Functions

Class JqueryEngineHelper

Properties summary

Inherited Properties

Method Summary

_methodTemplate() public

domReady() public

drag() public

drop() public

each() public

effect() public

event() public

get() public

request() public

serializeForm() public

slider() public

sortable() public

Method Detail

_methodTemplate() public ¶

Parameters

Returns

domReady() public ¶

Parameters

Returns

Overrides

drag() public ¶

Parameters

Returns

See

Overrides

drop() public ¶

Parameters

Returns

See

Overrides

each() public ¶

Parameters

Returns

Overrides

effect() public ¶

Parameters

Returns

See

Overrides

event() public ¶

Options

Parameters

Returns

Overrides

get() public ¶

Parameters

Returns

Overrides

request() public ¶

Parameters

Returns

See

Overrides

serializeForm() public ¶

Parameters

Returns

See

Overrides

slider() public ¶

Parameters

Returns

See

Overrides

sortable() public ¶

Parameters

Returns

See

Overrides

Methods inherited from JsBaseEngineHelper

__construct() public ¶

Overrides

_mapOptions() public ¶

Parameters

Returns