JsEngineBaseClass
Abstract Base Class for All JsEngines to extend. Provides generic methods.
_mapOptions( string $method , array $options )
Maps Abstract options to engine specific option names. If attributes are missing from the map, they are not changed.
$method
$options
array
_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 { }
$options
$safeKeys
optional array() string
_prepareCallbacks( string $method , array $options , array $callbacks array() )
Prepare callbacks and wrap them with function ([args]) { } as defined in _callbackArgs array.
$method
$options
$callbacks
optional array() array
_processOptions( string $method , array $options )
Convenience wrapper method for all common option processing steps. Runs _mapOptions, _prepareCallbacks, and _parseOptions in order.
$method
$options
string
_toQuerystring( array $parameters )
Convert an array of data into a query string
$parameters
string
_utf8ToHex( string $string )
Encode a string into JSON. Converts and escapes necessary characters.
$string
alert( string $message )
Create an alert()
message in JavaScript
$message
string
confirm( string $message )
Create a confirm()
message
$message
string
confirmReturn( string $message )
Generate a confirm snippet that returns false from the current function scope.
$message
string
domReady( string $functionBody )
Create a domReady event. This is a special event in many libraries
$functionBody
string
drag( array $options array() )
Create a draggable element. Works on the currently selected element. Additional options may be supported by the library implementation.
handle
- selector to the handle element.snapGrid
- The pixel grid that movement snaps to, an array(x, y)container
- The element that acts as a bounding box for the draggable element.start
- Event fired when the drag startsdrag
- Event fired on every step of the dragstop
- Event fired when dragging stops (mouse release)$options
optional array() string
drop( array $options array() )
Create a droppable element. Allows for draggable elements to be dropped on it. Additional options may be supported by the library implementation.
accept
- Selector for elements this droppable will accept.hoverclass
- Class to add to droppable when a draggable is over.drop
- Event fired when an element is dropped into the drop zone.hover
- Event fired when a drag enters a drop zone.leave
- Event fired when a drag is removed from a drop zone without being dropped.$options
optional array() string
each( string $callback )
Create an iteration over the current selection result.
$callback
string
effect( string $name , array $options array() )
Trigger an Effect.
The following effects are supported by all core JsEngines
show
- reveal an element.hide
- hide an element.fadeIn
- Fade in an element.fadeOut
- Fade out an element.slideIn
- Slide an element in.slideOut
- Slide an element out.speed
- Speed at which the animation should occur. Accepted values are 'slow', 'fast'. Not all effects use the speed option.$name
$options
optional array() string
escape( string $string )
Escape a string to be JSON friendly.
List of escaped elements:
$string
string
event( string $type , string $callback , array $options array() )
Add an event to the script cache. Operates on the currently selected elements.
wrap
- Whether you want the callback wrapped in an anonymous function. (defaults to true)stop
- Whether you want the event to stopped. (defaults to true)$type
$callback
$options
optional array() string
get( string $selector )
Create javascript selector for a CSS rule
$selector
self
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
prefix
- String prepended to the returned data.postfix
- String appended to the returned data.$data
optional array() $options
optional array() string
prompt( string $message , string $default '' )
Create a prompt()
JavaScript function
$message
$default
optional '' string
redirect( string|array $url null )
Redirects to a URL. Creates a window.location modification snippet that can be used to trigger 'redirects' from JavaScript.
$url
optional null string
request( string|array $url , array $options array() )
Make an XHR request
complete
- Callback to fire on complete.success
- Callback to fire on success.before
- Callback to fire on request initialization.error
- Callback to fire on request failure.method
- The method to make the request with defaults to GET in more librariesasync
- Whether or not you want an asynchronous request.data
- Additional data to send.update
- Dom id to update with the content of the request.type
- Data type for response. 'json' and 'html' are supported. Default is html for most libraries.evalScripts
- Whether or not <script> tags should be eval'ed.dataExpression
- Should the data
key be treated as a callback. Useful for supplying $options['data']
as another JavaScript expression.$url
$options
optional array() string
serializeForm( array $options array() )
Serialize the form attached to $selector. Pass true
for $isForm if the current selection is a form element. Converts the form or the form element attached to the current selection into a string/json object (depending on the library implementation) for use with XHR operations.
isForm
- is the current selection a form, or an input? (defaults to false)inline
- is the rendered statement going to be used inside another JS statement? (defaults to false)$options
optional array() string
slider( array $options array() )
Create a slider UI widget. Comprised of a track and knob. Additional options may be supported by the library implementation.
handle
- The id of the element used in sliding.direction
- The direction of the slider either 'vertical' or 'horizontal'min
- The min value for the slider.max
- The max value for the slider.step
- The number of steps or ticks the slider will have.value
- The initial offset of the slider.change
- Fired when the slider's value is updatedcomplete
- Fired when the user stops sliding the handle$options
optional array() string
sortable( array $options array() )
Create a sortable element. Additional options may be supported by the library implementation.
containment
- Container for move actionhandle
- Selector to handle element. Only this element will start sort action.revert
- Whether or not to use an effect to move sortable into final position.opacity
- Opacity of the placeholderdistance
- Distance a sortable must be dragged before sorting starts.start
- Event fired when sorting startssort
- Event fired during sortingcomplete
- Event fired when sorting completes.$options
optional array() string
value( mixed $val array() , boolean $quoteString null , string $key 'value' )
Converts a PHP-native variable of any type to a JSON-equivalent representation
$val
optional array() $quoteString
optional null $key
optional 'value' string
Helper::value()
__call( string $method , array $params )
Provide non fatal errors on missing method calls.
$method
$params
__construct( View $View , array $settings array() )
Default Constructor
View
$View
$settings
optional array() Object::__construct()
__get( string $name )
Lazy loads helpers. Provides access to deprecated request properties as well.
$name
mixed
__set( string $name , mixed $value )
Provides backwards compatibility access for setting values to the request object.
$name
$value
_confirm( string $message , string $okCode , string $cancelCode '' , array $options array() )
Returns a string to be used as onclick handler for confirm dialogs.
$message
$okCode
$cancelCode
optional '' $options
optional array() string
_encodeUrl( string $url )
Encodes a URL for use in HTML attributes.
$url
string
_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'
$key
$value
$escape
optional true string
_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.
$field
$options
optional array() array
_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.
$options
optional array() $field
optional null $key
optional 'name' mixed
_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:
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.
$options
$exclude
optional null $insertBefore
optional ' ' $insertAfter
optional null string
_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
$data
$key
optional 'id' array
addClass( array $options array() , string $class null , string $key 'class' )
Adds the given class to the element options
$options
optional array() $class
optional null $key
optional 'class' array
afterLayout( string $layoutFile )
After layout callback. afterLayout is called after the layout has rendered.
Overridden in subclasses.
$layoutFile
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.
$viewFile
afterRenderFile( string $viewFile , string $content )
After render file callback. Called after any view fragment is rendered.
Overridden in subclasses.
$viewFile
$content
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.
$path
string
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
$path
$options
optional array() 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 pluginstring
beforeLayout( string $layoutFile )
Before layout callback. beforeLayout is called before the layout is rendered.
Overridden in subclasses.
$layoutFile
beforeRender( string $viewFile )
Before render callback. beforeRender is called before the view file is rendered.
Overridden in subclasses.
$viewFile
beforeRenderFile( string $viewFile )
Before render file callback. Called before any view fragment is rendered.
Overridden in subclasses.
$viewFile
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.
$output
string|array|null
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.
$options
optional null $id
optional 'id' mixed
entity( )
Returns the entity reference of the current context as an array of identity parts
array
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.
string
model( )
Gets the currently-used model of the rendering context.
string
output( string $str )
Returns a string generated by a helper method
This method can be overridden in subclasses to do generalized output post-processing
$str
string
setEntity( string $entity , boolean $setScope false )
Sets this helper's model and field properties to the dot-separated value-pair in $entity.
$entity
$setScope
optional false url( string|array $url null , boolean $full false )
Finds URL for specified action.
Returns a URL pointing at the provided parameters.
$url
optional null /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.$full
optional false string
webroot( string $file )
Checks if a file exists when theme is used, if no file is found default location is returned
$file
string
_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.
$properties
$class
$normalize
optional true _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.
$properties
optional array() _stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
$status
optional 0 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
$method
$params
optional array() mixed
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.
$msg
$type
optional LOG_ERR $scope
optional null boolean
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()
POST and GET data can be simulated in requestAction. Use $extra['url']
for GET data. The $extra['data']
parameter allows POST data simulation.
$url
$extra
optional array() mixed
toString( )
Object-to-string conversion. Each class can override this method as necessary.
string
protected string
The name of the current model association entities are in scope of.
Helper::setEntity()
protected string
The dot separated list of elements the current field entity is for.
Helper::setEntity()
protected array
A list of strings that should be treated as suffixes, or sub inputs for a parent input. This is used for date/time inputs primarily.
array( 'year', 'month', 'day', 'hour', 'min', 'second', 'meridian' )
protected array
Minimized attributes
array( 'allowfullscreen', 'async', 'autofocus', 'autoplay', 'checked', 'compact', 'controls', 'declare', 'default', 'defaultchecked', 'defaultmuted', 'defaultselected', 'defer', 'disabled', 'enabled', 'formnovalidate', 'hidden', 'indeterminate', 'inert', 'ismap', 'itemscope', 'loop', 'multiple', 'muted', 'nohref', 'noresize', 'noshade', 'novalidate', 'nowrap', 'open', 'pauseonexit', 'readonly', 'required', 'reversed', 'scoped', 'seamless', 'selected', 'sortable', 'spellcheck', 'truespeed', 'typemustmatch', 'visible' )
protected string
The name of the current model entities are in scope of.
Helper::setEntity()
public array
Holds the fields array('field_name' => array('type' => 'string', 'length' => 100), primaryKey and validates array('field_name')
array()
© 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.7/class-JsBaseEngineHelper.html