CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 2.6 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.6
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Packages

  • Cake
    • Cache
      • Engine
    • Configure
    • Console
      • Command
        • Task
    • Controller
      • Component
        • Acl
        • Auth
    • Core
    • Error
    • Event
    • I18n
    • Log
      • Engine
    • Model
      • Behavior
      • Datasource
        • Database
        • Session
      • Validator
    • Network
      • Email
      • Http
    • Routing
      • Filter
      • Route
    • TestSuite
      • Coverage
      • Fixture
      • Reporter
    • Utility
    • View
      • Helper

Classes

  • CacheHelper
  • FormHelper
  • HtmlHelper
  • JqueryEngineHelper
  • JsBaseEngineHelper
  • JsHelper
  • MootoolsEngineHelper
  • NumberHelper
  • PaginatorHelper
  • PrototypeEngineHelper
  • RssHelper
  • SessionHelper
  • TextHelper
  • TimeHelper

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

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

Inherited Properties

  • bufferedMethods, selection

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.
  • serializeForm() public
    Serialize the form attached to $selector.
  • slider() public
    Create a slider control
  • sortable() public
    Create a sortable element.

Method Detail

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

$this

request() 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() 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() 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() 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() 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 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',
    )
)

$_optionMap ¶

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'
    )
)
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs