JsHelper Class Reference

Inheritance diagram for JsHelper:

List of all members.

Public Member Functions
	__construct ()
	__object ($name, $var)
	alert_ ($message)
	call__ ($method, $params)
	confirm_ ($message)
	escape ($string)
	get__ ($name)
	if_ ($if, $then, $else=null, $elseIf=array())
	load_ ($url=null, $options=array())
	object ($data=array(), $block=false, $prefix= '', $postfix= '', $stringKeys=array(), $quoteKeys=true, $q="\"")
	prompt_ ($message, $default= '')
	real ($var)
	redirect_ ($url=null)
	select ($pattern)
	tryThese_ ($expr1, $expr2, $expr3)
Public Attributes
	$__objects = array()
	$action = null
	$base = null
	$data = null
	$effectMap
	$helpers = array()
	$here = null
	$hook = null
	$output = false
	$params = null
	$plugin = null
	$themeWeb = null
	$webroot = null

---

Detailed Description

Definition at line 34 of file js.php.

---

Constructor & Destructor Documentation

JsHelper::__construct

(

)

Constructor

private

Reimplemented from Overloadable2.

Definition at line 57 of file js.php.

References __construct().

---

Member Function Documentation

JsHelper::__object	(	$	name,
		$	var
	)

Definition at line 197 of file js.php.

Referenced by get__(), real(), and select().

JsHelper::alert_

(

$

message

)

Definition at line 74 of file js.php.

JsHelper::call__	(	$	method,
		$	params
	)

Definition at line 65 of file js.php.

References $params, and Object::dispatchMethod().

JsHelper::confirm_

(

$

message

)

Definition at line 97 of file js.php.

JsHelper::escape

(

$

string

)

Escape a string to be JavaScript friendly.

List of escaped ellements: + "\r\n" => '
' + "\r" => '
' + "\n" => '
' + '"' => '\"' + "'" => "\\'"

Parameters:

string

$script String that needs to get escaped.

Returns:

string Escaped string.

Definition at line 180 of file js.php.

JsHelper::get__

(

$

name

)

Definition at line 185 of file js.php.

References __object().

JsHelper::if_	(	$	if,
		$	then,
		$	else = null,
		$	elseIf = array()
	)

Definition at line 78 of file js.php.

References $out.

JsHelper::load_	(	$	url = null,
		$	options = array()
	)

Loads a remote URL

Parameters:

	string	$url
	array	$options

Returns:

string

Definition at line 119 of file js.php.

References $url, and Router::url().

JsHelper::object	(	$	data = array(),
		$	block = false,
		$	prefix = '',
		$	postfix = '',
		$	stringKeys = array(),
		$	quoteKeys = true,
		$	q = "\""
	)

Generates a JavaScript object in JavaScript Object Notation (JSON) from an array

Parameters:

	array	$data Data to be converted
	boolean	$block Wraps return value in a <script> block if true
	string	$prefix Prepends the string to the returned data
	string	$postfix Appends the string to the returned data
	array	$stringKeys A list of array keys to be treated as a string
	boolean	$quoteKeys If false, treats $stringKey as a list of keys *not* to be quoted
	string	$q The type of quote to use

Returns:

string A JSON code block

Definition at line 217 of file js.php.

References $data, and $out.

JsHelper::prompt_	(	$	message,
		$	default = ''
	)

Definition at line 101 of file js.php.

JsHelper::real

(

$

var

)

Definition at line 193 of file js.php.

References __object().

JsHelper::redirect_

(

$

url = null

)

Redirects to a URL

Parameters:

	mixed	$url
	array	$options

Returns:

string

Definition at line 164 of file js.php.

JsHelper::select

(

$

pattern

)

Definition at line 189 of file js.php.

References __object().

JsHelper::tryThese_	(	$	expr1,
		$	expr2,
		$	expr3
	)

Definition at line 110 of file js.php.

---

Member Data Documentation

JsHelper::$__objects = array()

Definition at line 48 of file js.php.

JsHelper::$action = null

Definition at line 39 of file js.php.

JsHelper::$base = null

Definition at line 35 of file js.php.

JsHelper::$data = null

Definition at line 40 of file js.php.

Referenced by object().

JsHelper::$effectMap

Initial value:

 array(
        'Appear', 'Fade', 'Puff', 'BlindDown', 'BlindUp', 'SwitchOff', 'SlideDown', 'SlideUp',
        'DropOut', 'Shake', 'Pulsate', 'Squish', 'Fold', 'Grow', 'Shrink', 'Highlight', 'toggle'
    )

Definition at line 50 of file js.php.

JsHelper::$helpers = array()

Definition at line 44 of file js.php.

JsHelper::$here = null

Definition at line 37 of file js.php.

JsHelper::$hook = null

Definition at line 46 of file js.php.

JsHelper::$output = false

Definition at line 55 of file js.php.

JsHelper::$params = null

Definition at line 38 of file js.php.

Referenced by call__().

JsHelper::$plugin = null

Definition at line 42 of file js.php.

JsHelper::$themeWeb = null

Definition at line 41 of file js.php.

JsHelper::$webroot = null

Definition at line 36 of file js.php.

---

The documentation for this class was generated from the following file:

• libs/view/helpers/js.php

---