class JsCall implements JsonSerializable

Properties

string $sQuoteCharacter A string containing either a single or a double quote character that will be used during the generation of the javascript for this function.

Methods

__construct(string $sFunction)

The constructor.

void
useSingleQuote()

Instruct the request to use single quotes when generating the javascript

void
useSingleQuotes()

Instruct the request to use single quotes when generating the javascript

void
useDoubleQuote()

Instruct the request to use double quotes while generating the javascript

void
useDoubleQuotes()

Instruct the request to use double quotes while generating the javascript

void
clearParameters()

Clear the parameter list associated with this request

void
pushParameter(Parameter $xParameter)

Set the value of the parameter at the given position

void
addParameter(string $sType, string $sValue)

Add a parameter value to the parameter list for this request

void
addParameters(array $aParameters)

Add a set of parameters to this request

string
getScript()

Returns a string representation of the script output (javascript) from this request object

string
__toString()

Convert this request object to string

string
jsonSerialize()

Convert this request object to string, when converting the response into json.

Details

at line line 55
__construct(string $sFunction)

The constructor.

Parameters

string $sFunction The javascript function

at line line 67
void useSingleQuote()

Instruct the request to use single quotes when generating the javascript

Return Value

void

at line line 78
void useSingleQuotes()

Instruct the request to use single quotes when generating the javascript

Return Value

void

at line line 89
void useDoubleQuote()

Instruct the request to use double quotes while generating the javascript

Return Value

void

at line line 99
void useDoubleQuotes()

Instruct the request to use double quotes while generating the javascript

Return Value

void

at line line 109
void clearParameters()

Clear the parameter list associated with this request

Return Value

void

at line line 121
void pushParameter(Parameter $xParameter)

Set the value of the parameter at the given position

Parameters

Parameter $xParameter The value to be used

Return Value

void

at line line 143
void addParameter(string $sType, string $sValue)

Add a parameter value to the parameter list for this request

Parameters

string $sType The type of the value to be used
string $sValue The value to be used

Types should be one of the following , , , , , , . The value should be as follows: - - Use the ID of the form you want to process. - - The string data to be passed. - - A string containing valid javascript (either a javascript variable name that will be in scope at the time of the call or a javascript function call whose return value will become the parameter).

Return Value

void

at line line 155
void addParameters(array $aParameters)

Add a set of parameters to this request

Parameters

array $aParameters The parameters

Return Value

void

at line line 175
string getScript()

Returns a string representation of the script output (javascript) from this request object

Return Value

string

at line line 185
string __toString()

Convert this request object to string

Return Value

string

at line line 197
string jsonSerialize()

Convert this request object to string, when converting the response into json.

This is a method of the JsonSerializable interface.

Return Value

string