RaxanClientExtension - Raxan User Guide

Class RaxanClientExtension

Description

Create a wrapper around client-side jQuery and native JavaScript function calls

Located in /raxan.clientextension.php (line 44)

Variable Summary

static mixed $scripts

mixed $chain

Method Summary

static void encodeVar ( $v)

RaxanClientExtension __construct ( $ss, [ $context = null])

RaxanClientExtension alert ( $msg)

object browser ()

RaxanClientExtension confirm ( $msg, [ $okFn = null], [ $cancelFn = null])

RaxanClientExtension console (mixed $var, [boolean $halt = false])

string escapeString ( $txt)

RaxanClientExtension evaluate ( $s)

RaxanClientExtension hoverClass ( $cls)

RaxanClientExtension loadCSS ( $src, [ $ext = false])

RaxanClientExtension loadScript ( $src, [ $ext = false], [ $fn = null])

RaxanClientExtension popup ( $url, [ $name = ''], [ $attributes = ''], [ $errorMsg = ''])

RaxanClientExtension prompt ( $msg, [ $default = ''], [ $fn = null])

void redirectTo ( $url)

void redirectToView (string $view, [string $url = null])

void __call ( $name, $args)

void __toString ()

Variables

static mixed $scripts = array() (line 46)

access: protected

mixed $chain (line 48)

access: protected

Methods

static encodeVar (line 251)

Returned encoded javascript value

access: public

static void encodeVar ( $v)

Constructor __construct (line 51)

access: public

RaxanClientExtension __construct ( $ss, [ $context = null])

$ss
$context

alert (line 88)

Displays a client-side alert message

access: public

RaxanClientExtension alert ( $msg)

$msg

browser (line 98)

Returns client usergabgent object

access: public

object browser ()

confirm (line 118)

Displays a client-side confirmation message with calback

access: public

RaxanClientExtension confirm ( $msg, [ $okFn = null], [ $cancelFn = null])

$msg
$okFn
$cancelFn

console (line 135)

Writes the value of a server-side variable or object to the client-side console

access: public

RaxanClientExtension console (mixed $var, [boolean $halt = false])

mixed $var: Variable to be displayed inside console
boolean $halt: Halt servide operations

escapeString (line 241)

Returned javascript escaped string

access: protected

string escapeString ( $txt)

$txt

evaluate (line 150)

Evaluates JavaScript code and return a new RaxanClientExtension object

access: public

RaxanClientExtension evaluate ( $s)

hoverClass (line 160)

Toggle class on mouse over and out

access: public

RaxanClientExtension hoverClass ( $cls)

$cls

loadCSS (line 169)

Dynamically Load CSS files from client-side

access: public

RaxanClientExtension loadCSS ( $src, [ $ext = false])

$src
$ext

loadScript (line 180)

Dynamically Load script files from client-side

access: public

RaxanClientExtension loadScript ( $src, [ $ext = false], [ $fn = null])

$src
$ext
$fn

popup (line 192)

Opens a popup window and returns reference to window document

access: public

RaxanClientExtension popup ( $url, [ $name = ''], [ $attributes = ''], [ $errorMsg = ''])

$url
$name
$attributes
$errorMsg

prompt (line 207)

Displays a client-side prompt (input box) with callback

access: public

RaxanClientExtension prompt ( $msg, [ $default = ''], [ $fn = null])

$msg
$default
$fn

redirectTo (line 221)

Redirect client to the sepecified url

access: public

void redirectTo ( $url)

$url

redirectToView (line 230)

Redirect to new page view

access: public

void redirectToView (string $view, [string $url = null])

string $view: View mode
string $url: Optional page url

__call (line 74)

access: public

void __call ( $name, $args)

$name
$args

__toString (line 68)

access: public

void __toString ()