1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Search
  7. \
  8. Response

Response

class Response 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
protected $result

Methods

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

No description

from  EditResponse
ErrorList|Exception|string|null
getError()

Get the error(s) of the response.

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

Set the error(s) of the response.

from  EditResponse
bool
hasError()

Does this response contain an error?

from  EditResponse
string
getTime()

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

from  EditResponse
$this
setTitle(string|null $title)

Set the title of the response.

from  EditResponse
string|null
getTitle()

Get the title of the response.

from  EditResponse
$this
setMessage(string|null $message)

Set the message of the response.

from  EditResponse
string|null
getMessage()

Get the message of the response.

from  EditResponse
$this
setRedirectURL(string|UrlInterface|null $url)

Set the redirect URL of the response.

from  EditResponse
string|UrlInterface|null
getRedirectURL()

Get the redirect URL of the response.

from  EditResponse
object
setReloadCurrentPage(bool $value)

The current page should be reloaded?

from  EditResponse
bool
isReloadCurrentPage()

The current page should be reloaded?

from  EditResponse
setAdditionalDataAttribute(string $key, mixed $value)

Set additional response data.

from  EditResponse
string
getJSON()

Get the JSON representation of the data of this instance.

from  EditResponse
stdClass
getJSONObject()

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

stdClass
getBaseJSONObject()

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

from  EditResponse
jsonSerialize()

{@inheritdoc}

from  EditResponse
outputJSON() deprecated

No description

from  EditResponse
setSearchResult(Result $result)

No description

Details

in EditResponse at line 79
__construct(ErrorList|Exception|string|false $e = false)

No description

Parameters

ErrorList|Exception|string|false $e

in EditResponse at line 105
ErrorList|Exception|string|null getError()

Since: concrete5 8.5.0a3

Get the error(s) of the response.

Return Value

ErrorList|Exception|string|null

in EditResponse at line 117
$this setError(ErrorList|Exception|string|null $error)

Set the error(s) of the response.

Parameters

ErrorList|Exception|string|null $error

Return Value

$this

in EditResponse at line 129
bool hasError()

Does this response contain an error?

Return Value

bool

in EditResponse at line 149
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

in EditResponse at line 161
$this setTitle(string|null $title)

Set the title of the response.

Parameters

string|null $title

Return Value

$this

in EditResponse at line 173
string|null getTitle()

Get the title of the response.

Return Value

string|null

in EditResponse at line 185
$this setMessage(string|null $message)

Set the message of the response.

Parameters

string|null $message

Return Value

$this

in EditResponse at line 197
string|null getMessage()

Get the message of the response.

Return Value

string|null

in EditResponse at line 209
$this setRedirectURL(string|UrlInterface|null $url)

Set the redirect URL of the response.

Parameters

string|UrlInterface|null $url

Return Value

$this

in EditResponse at line 221
string|UrlInterface|null getRedirectURL()

Get the redirect URL of the response.

Return Value

string|UrlInterface|null

in EditResponse at line 231
object setReloadCurrentPage(bool $value)

The current page should be reloaded?

Parameters

bool $value

Return Value

object

in EditResponse at line 241
bool isReloadCurrentPage()

The current page should be reloaded?

Return Value

bool

in EditResponse at line 252
setAdditionalDataAttribute(string $key, mixed $value)

Set additional response data.

Parameters

string $key
mixed $value

in EditResponse at line 262
string getJSON()

Get the JSON representation of the data of this instance.

Return Value

string

at line 16
stdClass getJSONObject()

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

Return Value

stdClass

in EditResponse at line 282
stdClass getBaseJSONObject()

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

Return Value

stdClass

in EditResponse at line 319
jsonSerialize()

{@inheritdoc}

See also

\JsonSerializable::jsonSerialize()

in EditResponse at line 328
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

at line 11
setSearchResult(Result $result)

No description

Parameters

Result $result