Docs For Class JResponseJson

JResponseJson

Description

JSON Response class.

This class serves to provide the Joomla Platform with a common interface to access response variables for e.g. Ajax requests.

Variable Summary

mixed $data

string $message

array $messages

boolean $success

Method Summary

JResponseJson __construct ([mixed $response = null], [string $message = null], [boolean $error = false], [boolean $ignoreMessages = false])

string __toString ()

Variables

mixed $data = null (line 54)

The response data

string $message = null (line 38)

The main response message

array $messages = null (line 46)

Array of messages gathered in the JApplication object

boolean $success = true (line 30)

Determines whether the request was successful

Methods

Constructor __construct (line 66)

Constructor

JResponseJson __construct ([mixed $response = null], [string $message = null], [boolean $error = false], [boolean $ignoreMessages = false])

mixed $response: The Response data
string $message: The main response message
boolean $error: True, if the success flag shall be set to false, defaults to false
boolean $ignoreMessages: True, if the message queue shouldn't be included, defaults to false

__toString (line 118)

Magic toString method for sending the response in JSON format

string __toString ()

Documentation generated on Tue, 19 Nov 2013 15:06:18 +0100 by phpDocumentor 1.4.3