Class JqueryEngineHelper

jQuery Engine Helper for JsHelper

Provides jQuery specific JavaScript for JsHelper.

Implements the JsHelper interface for jQuery. All $options arrays support all options found in the JsHelper, as well as those in the jQuery documentation.

AppHelper

JsBaseEngineHelper

JqueryEngineHelper

Package: Cake\View\Helper
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/View/Helper/JqueryEngineHelper.php

Properties summary

$_callbackArguments protected

string

Callback arguments lists
$_optionMap protected

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

Method Summary

_methodTemplate() protected

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() protected ¶

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

Helper function to wrap repetitive simple method templating.

Parameters

string $method: The method name being generated.
string $template: The method template
array $options: Array of options for method
array $extraSafeKeys optional array(): Extra safe keys

Returns

string
Composed method string

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

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.

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.

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

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

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

get() public ¶

get( string $selector )

Create javascript selector for a CSS rule

Parameters

string $selector: The selector that is targeted

Returns

JqueryEngineHelper

request() public ¶

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

Create an $.ajax() call.

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

Parameters

string|array $url: URL
array $options optional array(): See JsHelper::request() for options.

Returns

string
The completed ajax call.

See

JsBaseEngineHelper::request() for options list.

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.

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.

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.

Methods inherited from JsBaseEngineHelper

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

_parseOptions() 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 { }.

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

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

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

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

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

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

Properties detail

`$_callbackArguments` ¶

protected 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` ¶

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

'$'

Packages

Classes

Class JqueryEngineHelper

Properties summary

Inherited Properties

Method Summary

_methodTemplate() protected

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() protected ¶

Parameters

Returns

domReady() public ¶

Parameters

Returns

drag() public ¶

Parameters

Returns

See

drop() public ¶

Parameters

Returns

See

each() public ¶

Parameters

Returns

effect() public ¶

Parameters

Returns

See

event() public ¶

Options

Parameters

Returns

get() public ¶

Parameters

Returns

request() public ¶

Parameters

Returns

See

serializeForm() public ¶

Parameters

Returns

See

slider() public ¶

Parameters

Returns

See

sortable() public ¶

Parameters

Returns

See

Methods inherited from JsBaseEngineHelper

_mapOptions() protected ¶

Parameters

Returns

_parseOptions() protected ¶

Parameters

Returns

_prepareCallbacks() protected ¶

Parameters

Returns

_processOptions() protected ¶

Parameters

Returns

_toQuerystring() protected ¶

Parameters

Returns

_utf8ToHex() protected ¶

`$_callbackArguments` ¶

`$_optionMap` ¶

`$jQueryObject` ¶