Class PrototypeEngineHelper

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

drag()source public

drag( array $options array() )

Create a Draggable element.

Note: Requires scriptaculous to be loaded.

Parameters

array $options optional array()

Array of options for the draggable.

Returns

string
Completed draggable script.

See

JsBaseEngineHelper::draggable() for options list.

drop()source public

drop( array $options array() )

Create a Droppable element.

Note: Requires scriptaculous to be loaded.

Parameters

array $options optional array()

Array of options for the droppable.

Returns

string
Completed droppable script.

See

JsBaseEngineHelper::droppable() for options list.

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

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

Trigger an Effect.

Note: Effects require Scriptaculous to be loaded.

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()source 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 946 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()source public

get( string $selector )

Create javascript selector for a CSS rule

Parameters

string $selector

The selector that is targeted

Returns

PrototypeEngineHelper

request()source public

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

Create an Ajax or Ajax.Updater call.

Parameters

string|array $url

URL.

array $options optional array()

Options list.

Returns

string
The completed ajax call.

serializeForm()source public

serializeForm( array $options array() )

Serialize the form attached to $selector.

Parameters

array $options optional array()

Array of options.

Returns

string
Completed serializeForm() snippet

See

JsBaseEngineHelper::serializeForm()

slider()source public

slider( array $options array() )

Creates a slider control widget.

Note: Requires scriptaculous to be loaded.

Parameters

array $options optional array()

Array of options for the slider.

Returns

string
Completed slider script.

See

JsBaseEngineHelper::slider() for options list.

sortable()source public

sortable( array $options array() )

Create a sortable element.

Note: Requires scriptaculous to be loaded.

The scriptaculous implementation of sortables does not support the 'start' and 'distance' options.

Parameters

array $options optional array()

Array of options for the sortable.

Returns

string
Completed sortable script.

See

JsBaseEngineHelper::sortable() for options list.

_mapOptions()source 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()source 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()source 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()source 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()source 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()source 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()source public

alert( string $message )

Create an alert() message in JavaScript

Parameters

string $message

Message you want to alter.

Returns

string
completed alert()

confirm()source public

confirm( string $message )

Create a confirm() message

Parameters

string $message

Message you want confirmed.

Returns

string
completed confirm()

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

array(
    'slider' => array(
        'onSlide' => 'value',
        'onChange' => 'value',
    ),
    'drag' => array(
        'onStart' => 'event',
        'onDrag' => 'event',
        'change' => 'draggable',
        'onEnd' => 'event',
    ),
    'drop' => array(
        'onHover' => 'draggable, droppable, event',
        'onDrop' => 'draggable, droppable, event',
    ),
    'request' => array(
        'onCreate' => 'transport',
        'onComplete' => 'transport',
        'onFailure' => 'response, jsonHeader',
        'onRequest' => 'transport',
        'onSuccess' => 'response, jsonHeader'
    ),
    'sortable' => array(
        'onStart' => 'element',
        'onChange' => 'element',
        'onUpdate' => 'element',
    ),
)

false

array(
    'request' => array(
        'async' => 'asynchronous',
        'data' => 'parameters',
        'before' => 'onCreate',
        'success' => 'onSuccess',
        'complete' => 'onComplete',
        'error' => 'onFailure'
    ),
    'sortable' => array(
        'sort' => 'onChange',
        'complete' => 'onUpdate',
    ),
    'drag' => array(
        'snapGrid' => 'snap',
        'container' => 'constraint',
        'stop' => 'onEnd',
        'start' => 'onStart',
        'drag' => 'onDrag',
    ),
    'drop' => array(
        'hover' => 'onHover',
        'drop' => 'onDrop',
        'hoverClass' => 'hoverclass',
    ),
    'slider' => array(
        'direction' => 'axis',
        'change' => 'onSlide',
        'complete' => 'onChange',
        'value' => 'sliderValue',
    )
)