1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. Ajax
  7. \
  8. AjaxResponse

AjaxResponse

class AjaxResponse extends JsonResponse implements AttachmentsInterface (View source)

JSON response object for AJAX requests.

Traits

AttachmentsTrait

Provides an implementation of AttachmentsInterface.

Properties

protected array $attachments

The attachments for this response.

 from  AttachmentsTrait
protected array $commands

The array of ajax commands.

Methods

getAttachments()

{@inheritdoc}

from  AttachmentsTrait
addAttachments(array $attachments)

{@inheritdoc}

from  AttachmentsTrait
setAttachments(array $attachments)

{@inheritdoc}

from  AttachmentsTrait
$this
addCommand(CommandInterface $command, bool $prepend = FALSE)

Add an AJAX command to the response.

array
getCommands()

Gets all AJAX commands.

Details

in AttachmentsTrait at line 22
getAttachments()

{@inheritdoc}

in AttachmentsTrait at line 29
addAttachments(array $attachments)

{@inheritdoc}

Parameters

array $attachments

in AttachmentsTrait at line 37
setAttachments(array $attachments)

{@inheritdoc}

Parameters

array $attachments

at line 38
$this addCommand(CommandInterface $command, bool $prepend = FALSE)

Add an AJAX command to the response.

Parameters

CommandInterface $command

An AJAX command object implementing CommandInterface.
bool $prepend

A boolean which determines whether the new command should be executed before previously added commands. Defaults to FALSE.

Return Value

$this

The current AjaxResponse.

at line 64
array getCommands()

Gets all AJAX commands.

Return Value

array

Returns render arrays for all previously added commands.