interface AttachedAssetsInterface in Drupal 9

The attached assets collection for the current response.

Allows for storage of:

• an ordered list of asset libraries (to be loaded for the current response)
• attached JavaScript settings (to be loaded for the current response)
• a set of asset libraries that the client already has loaded (as indicated in the request, to *not* be loaded for the current response)

Hierarchy

• interface \Drupal\Core\Asset\AttachedAssetsInterface

See also

\Drupal\Core\Asset\AssetResolverInterface

8 files declare their use of AttachedAssetsInterface

AssetResolverTest.php in core/tests/Drupal/Tests/Core/Asset/AssetResolverTest.php

Contains \Drupal\Tests\Core\Asset\AssetResolverTest.

BigPipe.php in core/modules/big_pipe/src/Render/BigPipe.php

common_test.module in core/modules/system/tests/modules/common_test/common_test.module

Helper module for the Common tests.

HtmlResponseAttachmentsProcessor.php in core/lib/Drupal/Core/Render/HtmlResponseAttachmentsProcessor.php

locale.module in core/modules/locale/locale.module

Enables the translation of the user interface to languages other than English.

... See full list

File

core/lib/Drupal/Core/Asset/AttachedAssetsInterface.php, line 16

Namespace

Drupal\Core\Asset

interface AttachedAssetsInterface {

  /**
   * Creates an AttachedAssetsInterface object from a render array.
   *
   * @param array $render_array
   *   A render array.
   *
   * @return static
   *
   * @throws \LogicException
   */
  public static function createFromRenderArray(array $render_array);

  /**
   * Sets the asset libraries attached to the current response.
   *
   * @param string[] $libraries
   *   A list of libraries, in the order they should be loaded.
   *
   * @return $this
   */
  public function setLibraries(array $libraries);

  /**
   * Returns the asset libraries attached to the current response.
   *
   * @return string[]
   */
  public function getLibraries();

  /**
   * Sets the JavaScript settings that are attached to the current response.
   *
   * @param array $settings
   *   The needed JavaScript settings.
   *
   * @return $this
   */
  public function setSettings(array $settings);

  /**
   * Returns the settings attached to the current response.
   *
   * @return array
   */
  public function getSettings();

  /**
   * Sets the asset libraries that the current request marked as already loaded.
   *
   * @param string[] $libraries
   *   The set of already loaded libraries.
   *
   * @return $this
   */
  public function setAlreadyLoadedLibraries(array $libraries);

  /**
   * Returns the set of already loaded asset libraries.
   *
   * @return string[]
   */
  public function getAlreadyLoadedLibraries();

}

Members

Name	Modifiers	Type	Description	Overrides
AttachedAssetsInterface::createFromRenderArray	public static	function	Creates an AttachedAssetsInterface object from a render array.	1
AttachedAssetsInterface::getAlreadyLoadedLibraries	public	function	Returns the set of already loaded asset libraries.	1
AttachedAssetsInterface::getLibraries	public	function	Returns the asset libraries attached to the current response.	1
AttachedAssetsInterface::getSettings	public	function	Returns the settings attached to the current response.	1
AttachedAssetsInterface::setAlreadyLoadedLibraries	public	function	Sets the asset libraries that the current request marked as already loaded.	1
AttachedAssetsInterface::setLibraries	public	function	Sets the asset libraries attached to the current response.	1
AttachedAssetsInterface::setSettings	public	function	Sets the JavaScript settings that are attached to the current response.	1