class EditResponse implements JsonSerializable (View source)

The result of an edit operation.

Properties

ErrorList|Exception|string|null $error The error(s) of the response.
string $time The date/time of the response in ISO-9075 format (YYYY-MM-DD hh:mm:ss).
string|null $title The title of the response.
string|null $message The message of the response.
string|URLInterface|null $redirectURL The redirect URL of the response.
protected array $additionalData Additional response data.

Methods

__construct(ErrorList|Exception|string|false $e = false)

No description

ErrorList|Exception|string|null
getError()

Get the error(s) of the response.

$this
setError(ErrorList|Exception|string|null $error)

Set the error(s) of the response.

bool
hasError()

Does this response contain an error?

string
getTime()

Get the date/time of the response in ISO-9075 format (YYYY-MM-DD hh:mm:ss).

$this
setTitle(string|null $title)

Set the title of the response.

string|null
getTitle()

Get the title of the response.

$this
setMessage(string|null $message)

Set the message of the response.

string|null
getMessage()

Get the message of the response.

$this
setRedirectURL(string|URLInterface|null $url)

Set the redirect URL of the response.

string|URLInterface|null
getRedirectURL()

Get the redirect URL of the response.

setAdditionalDataAttribute(string $key, mixed $value)

Set additional response data.

string
getJSON()

Get the JSON representation of the data of this instance.

getJSONObject()

Get an stdClass instance containing the serialized data of this instance.

getBaseJSONObject()

Get an stdClass instance containing the serialized data of this instance.

jsonSerialize()

{@inheritdoc}

outputJSON() deprecated

No description

Details

__construct(ErrorList|Exception|string|false $e = false)

Parameters

ErrorList|Exception|string|false $e

ErrorList|Exception|string|null getError()

Get the error(s) of the response.

Return Value

ErrorList|Exception|string|null

$this setError(ErrorList|Exception|string|null $error)

Set the error(s) of the response.

Parameters

ErrorList|Exception|string|null $error

Return Value

$this

bool hasError()

Does this response contain an error?

Return Value

bool

string getTime()

Get the date/time of the response in ISO-9075 format (YYYY-MM-DD hh:mm:ss).

Return Value

string

$this setTitle(string|null $title)

Set the title of the response.

Parameters

string|null $title

Return Value

$this

string|null getTitle()

Get the title of the response.

Return Value

string|null

$this setMessage(string|null $message)

Set the message of the response.

Parameters

string|null $message

Return Value

$this

string|null getMessage()

Get the message of the response.

Return Value

string|null

$this setRedirectURL(string|URLInterface|null $url)

Set the redirect URL of the response.

Parameters

string|URLInterface|null $url

Return Value

$this

string|URLInterface|null getRedirectURL()

Get the redirect URL of the response.

Return Value

string|URLInterface|null

setAdditionalDataAttribute(string $key, mixed $value)

Set additional response data.

Parameters

string $key
mixed $value

string getJSON()

Get the JSON representation of the data of this instance.

Return Value

string

stdClass getJSONObject()

Get an stdClass instance containing the serialized data of this instance.

Return Value

stdClass

stdClass getBaseJSONObject()

Get an stdClass instance containing the serialized data of this instance.

Return Value

stdClass

jsonSerialize()

{@inheritdoc}

See also

\JsonSerializable::jsonSerialize()

outputJSON() deprecated

deprecated since concrete5 8.5.0a3 This method sends the response directly to the cliend and ends the execution: you should build a Response instance.