\CJAX\CoreFormat

The Format class, a utility class for generating formatted AJAX messages.

Summary

Methods
Properties
Constants
output()
prompt()
message()
code()
jsCode()
No public properties found
CSS_SUCCESS
CSS_WARNING
CSS_INFO
CSS_ERROR
CSS_PROCESS
CSS_LOADING
No protected methods found
No protected properties found
N/A
No private methods found
$prompts
N/A

Constants

CSS_SUCCESS

CSS_SUCCESS

The CSS_SUCCESS constant, defines the integer value for AJAX success message.

CSS_WARNING

CSS_WARNING

The CSS_SUCCESS constant, defines the integer value for AJAX warning message.

CSS_INFO

CSS_INFO

The CSS_INFO constant, defines the integer value for AJAX info message.

CSS_ERROR

CSS_ERROR

The CSS_ERROR constant, defines the integer value for AJAX error message.

CSS_PROCESS

CSS_PROCESS

The CSS_PROCESS constant, defines the integer value for AJAX process message.

CSS_LOADING

CSS_LOADING

The CSS_LOADING constant, defines the integer value for AJAX loading message.

Properties

$prompts

$prompts : integer

The prompts property, stores the number of time message is prompted.

Type

integer

Methods

output()

output(string  $content = null, string  $title = null) : string

The output method, writes an AJAX dialog on the screen.

Parameters

string $content
string $title

Returns

string

prompt()

prompt(string  $msg, string  $title = null, string  $id = 'cjax_prompt_box') : string

The prompt method, show an AJAX prompt message on the screen.

Parameters

string $msg
string $title
string $id

Returns

string

message()

message(string  $text, string  $type = self::CSS_SUCCESS) : string

The message method, show a custom CJAX message on the screen.

Parameters

string $text
string $type

Returns

string

code()

code(  $data,   $tags = true) 

Parameters

$data
$tags

jsCode()

jsCode(  $data,   $tags = false,   $output = null) 

Parameters

$data
$tags
$output