Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Ajax/AddCssCommand.php \Drupal\Core\Ajax\AddCssCommand
  2. 9 core/lib/Drupal/Core/Ajax/AddCssCommand.php \Drupal\Core\Ajax\AddCssCommand

An AJAX command for adding css to the page via ajax.

This command is implemented by Drupal.AjaxCommands.prototype.add_css() defined in misc/ajax.js.

Hierarchy

Expanded class hierarchy of AddCssCommand

See also

misc/ajax.js

Related topics

3 files declare their use of AddCssCommand
AjaxCommandsTest.php in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php
ajax_forms_test.module in core/modules/system/tests/modules/ajax_forms_test/ajax_forms_test.module
Mock module for Ajax forms testing.
FrameworkTest.php in core/modules/system/tests/src/Functional/Ajax/FrameworkTest.php

File

core/lib/Drupal/Core/Ajax/AddCssCommand.php, line 15

Namespace

Drupal\Core\Ajax
View source
class AddCssCommand implements CommandInterface {

  /**
   * Arrays containing attributes of the stylesheets to be added to the page.
   *
   * @var string[][]|string
   */
  protected $styles;

  /**
   * Constructs an AddCssCommand.
   *
   * @param string[][]|string $styles
   *   Arrays containing attributes of the stylesheets to be added to the page.
   *   i.e. `['href' => 'someURL']` becomes `<link href="someURL">`.
   */
  public function __construct($styles) {
    if (is_string($styles)) {
      @trigger_error('The ' . __NAMESPACE__ . '\\AddCssCommand with a string argument is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. See http://www.drupal.org/node/3154948', E_USER_DEPRECATED);
    }
    $this->styles = $styles;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    return [
      'command' => 'add_css',
      'data' => $this->styles,
    ];
  }

}

Members

Name Modifiers Typesort descending Description Overrides
AddCssCommand::__construct public function Constructs an AddCssCommand.
AddCssCommand::render public function Return an array to be run through json_encode and sent to the client. Overrides CommandInterface::render
AddCssCommand::$styles protected property Arrays containing attributes of the stylesheets to be added to the page.