W3cubDocs

/CakePHP 2.8

Class MootoolsEngineHelper

MooTools Engine Helper for JsHelper

Provides MooTools specific JavaScript for JsHelper. Assumes that you have the following MooTools packages

  • Remote, Remote.HTML, Remote.JSON
  • Fx, Fx.Tween, Fx.Morph
  • Selectors, DomReady,
  • Drag, Drag.Move
Object
Extended by Helper
Extended by AppHelper
Extended by JsBaseEngineHelper
Extended by MootoolsEngineHelper
Package: Cake\View\Helper
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/View/Helper/MootoolsEngineHelper.php

Properties summary

  • array
    Contains a list of callback names -> default arguments.
  • $_optionMap protected
    array
    Option mappings for MooTools

Inherited Properties

Method Summary

  • domReady() public
    Create a domReady event. This is a special event in many libraries
  • 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 a new Request.
  • Serialize the form attached to $selector.
  • slider() public
    Create a slider control
  • sortable() public
    Create a sortable element.

Method Detail

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.

Requires the Drag plugin from MootoolsMore

Parameters

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

Returns

string
Completed draggable script.

See

JsHelper::drag() for options list.

drop()source public

drop( array $options array() )

Create a Droppable element.

Requires the Drag and Drag.Move plugins from MootoolsMore

Droppables in Mootools function differently from other libraries. Droppables are implemented as an extension of Drag. So in addition to making a get() selection for the droppable element. You must also provide a selector rule to the draggable element. Furthermore, Mootools droppables inherit all options from Drag.

Parameters

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

Returns

string
Completed droppable script.

See

JsBaseEngineHelper::drop() 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.

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

get( string $selector )

Create javascript selector for a CSS rule

Parameters

string $selector
The selector that is targeted

Returns

MootoolsEngineHelper

request()source public

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

Create a new Request.

Requires Request. If you wish to use 'update' key you must have Request.HTML if you wish to do Json requests you will need JSON and Request.JSON.

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

Create a slider control

Requires Slider from MootoolsMore

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.

Requires the Sortables plugin from MootoolsMore

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

Overrides

Helper::value()

Methods inherited from Helper

__call()source public

__call( string $method , array $params )

Provide non fatal errors on missing method calls.

Parameters

string $method
Method to invoke
array $params
Array of params for the method.

__construct()source public

__construct( View $View , array $settings array() )

Default Constructor

Parameters

View $View
The View this helper is being attached to.
array $settings optional array()
Configuration settings for the helper.

Overrides

Object::__construct()

__get()source public

__get( string $name )

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

Deprecated

3.0.0 Accessing request properties through this method is deprecated and will be removed in 3.0.

Parameters

string $name
Name of the property being accessed.

Returns

mixed
Helper or property found at $name

__set()source public

__set( string $name , mixed $value )

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

Deprecated

3.0.0 This method will be removed in 3.0

Parameters

string $name
Name of the property being accessed.
mixed $value
Value to set.

_clean()source protected

_clean( )

Removes harmful content from output

_confirm()source protected

_confirm( string $message , string $okCode , string $cancelCode '' , array $options array() )

Returns a string to be used as onclick handler for confirm dialogs.

Parameters

string $message
Message to be displayed
string $okCode
Code to be executed after user chose 'OK'
string $cancelCode optional ''
Code to be executed after user chose 'Cancel', also executed when okCode doesn't return
array $options optional array()
Array of options

Returns

string
onclick JS code

_encodeUrl()source protected

_encodeUrl( string $url )

Encodes a URL for use in HTML attributes.

Parameters

string $url
The URL to encode.

Returns

string
The URL encoded for both URL & HTML contexts.

_formatAttribute()source protected

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

Deprecated

3.0.0 This method will be moved to HtmlHelper in 3.0

Parameters

string $key
The name of the attribute to create
string $value
The value of the attribute to create.
boolean $escape optional true
Define if the value must be escaped

Returns

string
The composed attribute.

_initInputField()source protected

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

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

_name( array|string $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

array|string $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
Field name.
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()source protected

_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 those listed in Helper::$_minimizedAttributes

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.

Deprecated

3.0.0 This method will be moved to HtmlHelper in 3.0

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.

_reset()source protected

_reset( )

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

_selectedArray()source protected

_selectedArray( string|array $data , string $key 'id' )

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

Parameters

string|array $data
Data array or model name.
string $key optional 'id'
Field name.

Returns

array

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

Returns

array
Array of options with $key set.

afterLayout()source public

afterLayout( string $layoutFile )

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

Overridden in subclasses.

Parameters

string $layoutFile
The layout file that was rendered.

afterRender()source public

afterRender( string $viewFile )

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
The view file that was rendered.

afterRenderFile()source public

afterRenderFile( string $viewFile , string $content )

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

Overridden in subclasses.

Parameters

string $viewFile
The file just be rendered.
string $content
The content that was rendered.

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

assetUrl()source public

assetUrl( string|array $path , array $options array() )

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

string|array $path
Path string or URL array
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

Returns

string
Generated URL

beforeLayout()source public

beforeLayout( string $layoutFile )

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

Overridden in subclasses.

Parameters

string $layoutFile
The layout about to be rendered.

beforeRender()source public

beforeRender( string $viewFile )

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

Overridden in subclasses.

Parameters

string $viewFile
The view file that is going to be rendered

beforeRenderFile()source public

beforeRenderFile( string $viewFile )

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

Overridden in subclasses.

Parameters

string $viewFile
The file about to be rendered.

clean()source public

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

Deprecated

3.0.0 This method will be removed in 3.0

Parameters

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

Returns

string|array|null
Cleaned content for output

domId()source public

domId( array|string $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

array|string $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.


entity()source public

entity( )

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

Returns

array
An array containing the identity elements of an entity

field()source public

field( )

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.

Returns

string

model()source public

model( )

Gets the currently-used model of the rendering context.

Returns

string

output()source public

output( string $str )

Returns a string generated by a helper method

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

Deprecated

3.0.0 This method will be removed in future versions.

Parameters

string $str
String to be output.

Returns

string

setEntity()source public

setEntity( string $entity , boolean $setScope false )

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

Parameters

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

url()source public

url( string|array $url null , boolean $full false )

Finds URL for specified action.

Returns a URL pointing at the provided parameters.

Parameters

string|array $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/2.0/en/views/helpers.html

webroot()source 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 Object

_mergeVars()source protected

_mergeVars( array $properties , string $class , boolean $normalize true )

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
The name of the properties to merge.
string $class
The class to merge the property with.
boolean $normalize optional true
Set to true to run the properties through Hash::normalize() before merging.

_set()source protected

_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()source protected

_stop( integer|string $status 0 )

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

Parameters

integer|string $status optional 0
see http://php.net/exit for values

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

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Convenience 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_ERR
Error type constant. Defined in app/Config/core.php.
null|string|array $scope optional null

The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.

Returns

boolean
Success of log write

requestAction()source public

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

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

string|array $url

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.

Returns

mixed

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


toString()source public

toString( )

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

Returns

string
The name of this class

Properties detail

$_callbackArgumentssource

protected array

Contains a list of callback names -> default arguments.

array(
    'slider' => array(
        'onTick' => 'position',
        'onChange' => 'step',
        'onComplete' => 'event'
    ),
    'request' => array(
        'onRequest' => '',
        'onComplete' => '',
        'onCancel' => '',
        'onSuccess' => 'responseText, responseXML',
        'onFailure' => 'xhr',
        'onException' => 'headerName, value',
    ),
    'drag' => array(
        'onBeforeStart' => 'element',
        'onStart' => 'element',
        'onSnap' => 'element',
        'onDrag' => 'element, event',
        'onComplete' => 'element, event',
        'onCancel' => 'element',
    ),
    'drop' => array(
        'onBeforeStart' => 'element',
        'onStart' => 'element',
        'onSnap' => 'element',
        'onDrag' => 'element, event',
        'onComplete' => 'element, event',
        'onCancel' => 'element',
        'onDrop' => 'element, droppable, event',
        'onLeave' => 'element, droppable',
        'onEnter' => 'element, droppable',
    ),
    'sortable' => array(
        'onStart' => 'element, clone',
        'onSort' => 'element, clone',
        'onComplete' => 'element',
    )
)

$_optionMapsource

protected array

Option mappings for MooTools

array(
    'request' => array(
        'complete' => 'onComplete',
        'success' => 'onSuccess',
        'before' => 'onRequest',
        'error' => 'onFailure'
    ),
    'sortable' => array(
        'distance' => 'snap',
        'containment' => 'constrain',
        'sort' => 'onSort',
        'complete' => 'onComplete',
        'start' => 'onStart',
    ),
    'drag' => array(
        'snapGrid' => 'snap',
        'start' => 'onStart',
        'drag' => 'onDrag',
        'stop' => 'onComplete',
    ),
    'drop' => array(
        'drop' => 'onDrop',
        'hover' => 'onEnter',
        'leave' => 'onLeave',
    ),
    'slider' => array(
        'complete' => 'onComplete',
        'change' => 'onChange',
        'direction' => 'mode',
        'step' => 'steps'
    )
)

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.8/class-MootoolsEngineHelper.html