Vtiger_Response
in package
Table of Contents
- $EMIT_HTML : mixed
- Emit response wrapper as html string.
- $EMIT_JSON : mixed
- Emit response wrapper as json string.
- $EMIT_JSONP : mixed
- Emit response wrapper as padded-json.
- $EMIT_JSONTEXT : mixed
- Emit response wrapper as string/jsonstring.
- $EMIT_RAW : mixed
- Emit response wrapper as raw string.
- $emitJSONPFn : mixed
- $emitType : mixed
- $error : mixed
- Error data.
- $headers : mixed
- $result : mixed
- Result data.
- emit() : mixed
- Send response to client.
- getError() : mixed
- Get the error data.
- getResult() : mixed
- Get the result data.
- hasError() : mixed
- Check the presence of error data.
- isJSON() : mixed
- Is emit type configured to JSON?
- setEmitJSONP() : mixed
- Set padding method name for JSONP emit type.
- setEmitType() : mixed
- Set emit type.
- setError() : void
- Set error data to send.
- setException() : void
- Set exception error to send.
- setHeader() : mixed
- Set headers to send.
- setResult() : mixed
- Set the result data.
- updateResult() : mixed
- Update the result data.
- emitJSON() : mixed
- Emit response wrapper as JSONString.
- emitRaw() : mixed
- Emit response wrapper as String.
- emitText() : mixed
- Emit response wrapper as String/JSONString.
- prepareResponse() : mixed
- Prepare the response wrapper.
Properties
$EMIT_HTML
Emit response wrapper as html string.
public
static mixed
$EMIT_HTML
= 2
$EMIT_JSON
Emit response wrapper as json string.
public
static mixed
$EMIT_JSON
= 1
$EMIT_JSONP
Emit response wrapper as padded-json.
public
static mixed
$EMIT_JSONP
= 4
$EMIT_JSONTEXT
Emit response wrapper as string/jsonstring.
public
static mixed
$EMIT_JSONTEXT
= 3
$EMIT_RAW
Emit response wrapper as raw string.
public
static mixed
$EMIT_RAW
= 0
$emitJSONPFn
private
mixed
$emitJSONPFn
= \false
$emitType
private
mixed
$emitType
= 1
$error
Error data.
private
mixed
$error
$headers
private
mixed
$headers
= []
$result
Result data.
private
mixed
$result
Methods
emit()
Send response to client.
public
emit() : mixed
Return values
mixed —getError()
Get the error data.
public
getError() : mixed
Return values
mixed —getResult()
Get the result data.
public
getResult() : mixed
Return values
mixed —hasError()
Check the presence of error data.
public
hasError() : mixed
Return values
mixed —isJSON()
Is emit type configured to JSON?
public
isJSON() : mixed
Return values
mixed —setEmitJSONP()
Set padding method name for JSONP emit type.
public
setEmitJSONP(mixed $fn) : mixed
Parameters
- $fn : mixed
Return values
mixed —setEmitType()
Set emit type.
public
setEmitType(mixed $type) : mixed
Parameters
- $type : mixed
Return values
mixed —setError()
Set error data to send.
public
setError([mixed $code = 500 ][, mixed|null $message = null ][, mixed $trace = false ]) : void
Parameters
- $code : mixed = 500
- $message : mixed|null = null
- $trace : mixed = false
Return values
void —setException()
Set exception error to send.
public
setException(Throwable $e) : void
Parameters
- $e : Throwable
Return values
void —setHeader()
Set headers to send.
public
setHeader(mixed $header) : mixed
Parameters
- $header : mixed
Return values
mixed —setResult()
Set the result data.
public
setResult(mixed $result) : mixed
Parameters
- $result : mixed
Return values
mixed —updateResult()
Update the result data.
public
updateResult(mixed $key, mixed $value) : mixed
Parameters
- $key : mixed
- $value : mixed
Return values
mixed —emitJSON()
Emit response wrapper as JSONString.
protected
emitJSON() : mixed
Return values
mixed —emitRaw()
Emit response wrapper as String.
protected
emitRaw() : mixed
Return values
mixed —emitText()
Emit response wrapper as String/JSONString.
protected
emitText() : mixed
Return values
mixed —prepareResponse()
Prepare the response wrapper.
protected
prepareResponse() : mixed