function AjaxResponseAttachmentsProcessor::processAttachments

Same name and namespace in other branches

8.9.x core/lib/Drupal/Core/Ajax/AjaxResponseAttachmentsProcessor.php \Drupal\Core\Ajax\AjaxResponseAttachmentsProcessor::processAttachments()
10 core/lib/Drupal/Core/Ajax/AjaxResponseAttachmentsProcessor.php \Drupal\Core\Ajax\AjaxResponseAttachmentsProcessor::processAttachments()
11.x core/lib/Drupal/Core/Ajax/AjaxResponseAttachmentsProcessor.php \Drupal\Core\Ajax\AjaxResponseAttachmentsProcessor::processAttachments()

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)

Placeholders need to be rendered first in order to have all attachments available for processing. For an example, see \Drupal\Core\Render\HtmlResponseAttachmentsProcessor::renderPlaceholders()

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.

Overrides AttachmentsResponseProcessorInterface::processAttachments

File

core/lib/Drupal/Core/Ajax/AjaxResponseAttachmentsProcessor.php, line 104

Class

AjaxResponseAttachmentsProcessor: Processes attachments of AJAX responses.

Namespace

Drupal\Core\Ajax

Code

public function processAttachments(AttachmentsInterface $response) {
    // @todo Convert to assertion once https://www.drupal.org/node/2408013 lands
    if (!$response instanceof AjaxResponse) {
        throw new \InvalidArgumentException('\\Drupal\\Core\\Ajax\\AjaxResponse instance expected.');
    }
    $request = $this->requestStack
        ->getCurrentRequest();
    if ($response->getContent() == '{}') {
        $response->setData($this->buildAttachmentsCommands($response, $request));
    }
    return $response;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.

Breadcrumb