Class JsHelper
Javascript Generator helper class for easy use of JavaScript.
JsHelper provides an abstract interface for authoring JavaScript with a given client-side library.
- Object
-
Overloadable2
-
JsHelper
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc.
License: The MIT License
Location: view/helpers/js.php
Properties summary
Inherited Properties
Method Summary
-
__construct() public
Class constructor, overridden in descendant classes. -
__object() public
-
alert_() public
-
call__() public
-
confirm_() public
-
escape() public
Escape a string to be JavaScript friendly. -
get__() public
-
if_() public
-
load_() public
Loads a remote URL -
object() public
Generates a JavaScript object in JavaScript Object Notation (JSON) from an array
-
prompt_() public
-
real() public
-
redirect_() public
Redirects to a URL -
select() public
-
tryThese_() public
Method Detail
escape() public ¶
escape( string $string )
Escape a string to be JavaScript friendly.
List of escaped ellements: + "\r\n" => '\n' + "\r" => '\n' + "\n" => '\n' + '"' => '\"' + "'" => "\'"
Parameters
- string $string
- $script String that needs to get escaped.
Returns
Escaped string.
load_() public ¶
load_( string $url = null , array $options = array() )
Loads a remote URL
Parameters
- string $url optional null
- array $options optional array()
Returns
object() public ¶
object( array $data = array() , boolean $block = false , string $prefix = '' , string $postfix = '' , array $stringKeys = array() , boolean $quoteKeys = true , string $q = "\"" )
Generates a JavaScript object in JavaScript Object Notation (JSON) from an array
Parameters
- array $data optional array()
- Data to be converted
- boolean $block optional false
- Wraps return value in a block if true
- string $prefix optional ''
- Prepends the string to the returned data
- string $postfix optional ''
- Appends the string to the returned data
- array $stringKeys optional array()
- A list of array keys to be treated as a string
- boolean $quoteKeys optional true
- If false, treats $stringKey as a list of keys not to be quoted
- string $q optional "\""
- The type of quote to use
Returns
A JSON code block
redirect_() public ¶
redirect_( mixed $url = null , array $options ,… )
Redirects to a URL
Parameters
- mixed $url optional null
- array $options ,…
Returns
Methods inherited from Overloadable2
__call() public ¶
__call( string $method , array $params )
Magic method handler.
Parameters
- string $method
- Method name
- array $params
- Parameters to send to method
Returns
Return value from method
__get() public ¶
__get( mixed $name , mixed $value ,… )
Getter.
Parameters
- mixed $name
- What to get
- mixed $value ,…
- Where to store returned value
Returns
Success
Methods inherited from Object
Object() public ¶
Object( )
A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
Returns
__openPersistent() public ¶
__openPersistent( string $name , string $type = null )
Open the persistent class file for reading Used by Object::_persist()
Parameters
- string $name
- Name of persisted class
- string $type optional null
- Type of persistance (e.g: registry)
_persist() public ¶
_persist( string $name , string $return , $object , $type = null )
Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
Parameters
- string $name
- name of the class to persist
- string $return
- $object the object to persist
- $object
- $type optional null
Returns
Success
_savePersistent() public ¶
_savePersistent( string $name , object $object )
You should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
Parameters
- string $name
- name used for object to cache
- object $object
- the object to persist
Returns
true on save, throws error if file can not be created
_set() public ¶
_set( array $properties = array() )
Allows setting of multiple properties of the object in a single line of code.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() public ¶
_stop( $status = 0 )
Stop execution of the current script
Parameters
- $status optional 0
- http://php.net/exit for values
cakeError() public ¶
cakeError( string $method , array $messages = array() )
Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
Parameters
- string $method
- Method to be called in the error class (AppError or ErrorHandler classes)
- array $messages optional array()
- Message that is to be displayed by the error class
Returns
message
dispatchMethod() 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, and improves performance by using straight method calls in most cases.
Parameters
- string $method
- Name of the method to call
- array $params optional array()
- Parameter list to use when calling $method
Returns
Returns the result of the method call
log() public ¶
log( string $msg , integer $type = LOG_ERROR )
API for logging events.
Parameters
- string $msg
- Log message
- integer $type optional LOG_ERROR
- Error type constant. Defined in app/config/core.php.
Returns
Success of log write
requestAction() public ¶
requestAction( mixed $url , array $extra = array() )
Calls a controller's method from any location.
Parameters
- mixed $url
- String or array-based url.
- array $extra optional array()
- if array includes the key "return" it sets the AutoRender to true.
Returns
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString() public ¶
toString( )
Object-to-string conversion. Each class can override this method as necessary.
Returns
The name of this class
Properties detail
$effectMap ¶
array( 'Appear', 'Fade', 'Puff', 'BlindDown', 'BlindUp', 'SwitchOff', 'SlideDown', 'SlideUp', 'DropOut', 'Shake', 'Pulsate', 'Squish', 'Fold', 'Grow', 'Shrink', 'Highlight', 'toggle' )