interface AttachmentsResponseProcessorInterface

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Render/AttachmentsResponseProcessorInterface.php \Drupal\Core\Render\AttachmentsResponseProcessorInterface
  2. 10 core/lib/Drupal/Core/Render/AttachmentsResponseProcessorInterface.php \Drupal\Core\Render\AttachmentsResponseProcessorInterface
  3. 11.x core/lib/Drupal/Core/Render/AttachmentsResponseProcessorInterface.php \Drupal\Core\Render\AttachmentsResponseProcessorInterface

Defines an interface for processing attachments of responses that have them.

Hierarchy

Expanded class hierarchy of AttachmentsResponseProcessorInterface

All classes that implement AttachmentsResponseProcessorInterface

See also

\Drupal\Core\Ajax\AjaxResponse

\Drupal\Core\Ajax\AjaxResponseAttachmentsProcessor

\Drupal\Core\Render\HtmlResponse

\Drupal\Core\Render\HtmlResponseAttachmentsProcessor

5 files declare their use of AttachmentsResponseProcessorInterface
AjaxResponseAttachmentsProcessor.php in core/lib/Drupal/Core/Ajax/AjaxResponseAttachmentsProcessor.php
AjaxResponseSubscriber.php in core/lib/Drupal/Core/EventSubscriber/AjaxResponseSubscriber.php
BigPipeResponseAttachmentsProcessor.php in core/modules/big_pipe/src/Render/BigPipeResponseAttachmentsProcessor.php
BigPipeResponseAttachmentsProcessorTest.php in core/modules/big_pipe/tests/src/Unit/Render/BigPipeResponseAttachmentsProcessorTest.php
HtmlResponseSubscriber.php in core/lib/Drupal/Core/EventSubscriber/HtmlResponseSubscriber.php

File

core/lib/Drupal/Core/Render/AttachmentsResponseProcessorInterface.php, line 13

Namespace

Drupal\Core\Render
View source 
interface AttachmentsResponseProcessorInterface {
    
    /**
     * 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:
     *
     * @code
     * $build['#attached']['library'][] = [
     *   'library' => ['core/jquery']
     * ];
     * $build['#attached']['http_header'] = [
     *   ['Content-Type', 'application/rss+xml; charset=utf-8'],
     * ];
     * @endcode
     *
     * 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()
     *
     * @param \Drupal\Core\Render\AttachmentsInterface $response
     *   The response to process.
     *
     * @return \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.
     */
    public function processAttachments(AttachmentsInterface $response);

}

Members

Title Modifiers Object type Summary Overrides
AttachmentsResponseProcessorInterface::processAttachments public function Processes the attachments of a response that has attachments. 2

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