class EditResponse extends EditResponse (View source)

Properties

ErrorList|Exception|string|null deprecated $error

The error(s) of the response.

from  EditResponse
string deprecated $time

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

from  EditResponse
string|null deprecated $title

The title of the response.

from  EditResponse
string|null deprecated $message

The message of the response.

from  EditResponse
string|UrlInterface|null deprecated $redirectURL

The redirect URL of the response.

from  EditResponse
private bool $reloadCurrentPage

The current page should be reloaded.

from  EditResponse
protected array $additionalData

Additional response data.

from  EditResponse
private Group[] $groups

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.

object
setReloadCurrentPage(bool $value)

The current page should be reloaded?

bool
isReloadCurrentPage()

The current page should be reloaded?

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

setGroup(Group $group)

No description

addGroup(Group $group)

No description

setGroups(array $groups)

No description

addGroups(array $groups)

No description

array
getGroups()

No description

clearGroups()

No description

Details

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

No description

Parameters

ErrorList|Exception|string|false $e

ErrorList|Exception|string|null getError()

Since: concrete5 8.5.0a3

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()

Since: concrete5 8.5.0a3

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

object setReloadCurrentPage(bool $value)

The current page should be reloaded?

Parameters

bool $value

Return Value

object

bool isReloadCurrentPage()

The current page should be reloaded?

Return Value

bool

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

See also

EditResponse::getJSONObject

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.

No description

EditResponse setGroup(Group $group)

No description

Parameters

Group $group

Return Value

EditResponse

EditResponse addGroup(Group $group)

No description

Parameters

Group $group

Return Value

EditResponse

EditResponse setGroups(array $groups)

No description

Parameters

array $groups

Return Value

EditResponse

EditResponse addGroups(array $groups)

No description

Parameters

array $groups

Return Value

EditResponse

array getGroups()

No description

Return Value

array

EditResponse clearGroups()

No description

Return Value

EditResponse