You are here

public function JsAttachmentsProcessor::processAttachments in JS Callback Handler 8.3

Processes the attachments of a response that has attachments.

Libraries, JavaScript settings, feeds, HTML <head> tags, HTML <head> links, HTTP headers, and the HTTP status code are attached to render arrays using the #attached property. The #attached property is an associative array, where the keys are the attachment types and the values are the attached data. For example:

$build['#attached']['library'][] = [
  'library' => [
    'core/jquery',
  ],
];
$build['#attached']['http_header'] = [
  [
    'Content-Type',
    'application/rss+xml; charset=utf-8',
  ],
];

The available keys are:

  • 'library' (asset libraries)
  • 'drupalSettings' (JavaScript settings)
  • 'feed' (RSS feeds)
  • 'html_head' (tags in HTML <head>)
  • 'html_head_link' (<link> tags in HTML <head>)
  • 'http_header' (HTTP headers and status code)

Parameters

\Drupal\Core\Render\AttachmentsInterface $response: The response to process.

Return value

\Drupal\Core\Render\AttachmentsInterface The processed response, with the attachments updated to reflect their final values.

Throws

\InvalidArgumentException Thrown when the $response parameter is not the type of response object the processor expects.

Overrides AjaxResponseAttachmentsProcessor::processAttachments

File

src/JsAttachmentsProcessor.php, line 19

Class

JsAttachmentsProcessor
Processes attachments of AJAX responses.

Namespace

Drupal\js

Code

public function processAttachments(AttachmentsInterface $response) {
  assert('$response instanceof \\Drupal\\js\\JsResponse');

  /** @var \Drupal\js\JsResponse $response */
  $data = $response
    ->getData();
  if (!isset($data['commands'])) {
    $data['commands'] = [];
  }
  $data['commands'] = array_merge($data['commands'], $this
    ->buildAttachmentsCommands($response, $this->requestStack
    ->getCurrentRequest()));
  $response
    ->setData($data);
  return $response;
}