class AddJsCommand
Same name in other branches
- 10 core/lib/Drupal/Core/Ajax/AddJsCommand.php \Drupal\Core\Ajax\AddJsCommand
- 11.x core/lib/Drupal/Core/Ajax/AddJsCommand.php \Drupal\Core\Ajax\AddJsCommand
An AJAX command for adding JS to the page via AJAX.
This command will make sure all the files are loaded before continuing executing the next AJAX command. This command is implemented by Drupal.AjaxCommands.prototype.add_js() defined in misc/ajax.js.
Hierarchy
- class \Drupal\Core\Ajax\AddJsCommand implements \Drupal\Core\Ajax\CommandInterface
Expanded class hierarchy of AddJsCommand
See also
misc/ajax.js
Related topics
1 file declares its use of AddJsCommand
- FrameworkTest.php in core/
modules/ system/ tests/ src/ Functional/ Ajax/ FrameworkTest.php
File
-
core/
lib/ Drupal/ Core/ Ajax/ AddJsCommand.php, line 16
Namespace
Drupal\Core\AjaxView source
class AddJsCommand implements CommandInterface {
/**
* An array containing attributes of the scripts to be added to the page.
*
* @var string[]
*/
protected $scripts;
/**
* A CSS selector string.
*
* If the command is a response to a request from an #ajax form element then
* this value will default to 'body'.
*
* @var string
*/
protected $selector;
/**
* Constructs an AddJsCommand.
*
* @param array $scripts
* An array containing the attributes of the 'script' tags to be added to
* the page. i.e. `['src' => 'someURL', 'defer' => TRUE]` becomes
* `<script src="someURL" defer>`.
* @param string $selector
* A CSS selector of the element where the script tags will be appended.
*/
public function __construct(array $scripts, string $selector = 'body') {
$this->scripts = $scripts;
$this->selector = $selector;
}
/**
* {@inheritdoc}
*/
public function render() {
return [
'command' => 'add_js',
'selector' => $this->selector,
'data' => $this->scripts,
];
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
AddJsCommand::$scripts | protected | property | An array containing attributes of the scripts to be added to the page. | |
AddJsCommand::$selector | protected | property | A CSS selector string. | |
AddJsCommand::render | public | function | Return an array to be run through json_encode and sent to the client. | Overrides CommandInterface::render |
AddJsCommand::__construct | public | function | Constructs an AddJsCommand. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.