class BeforeCommand
Same name in other branches
- 9 core/lib/Drupal/Core/Ajax/BeforeCommand.php \Drupal\Core\Ajax\BeforeCommand
- 8.9.x core/lib/Drupal/Core/Ajax/BeforeCommand.php \Drupal\Core\Ajax\BeforeCommand
- 11.x core/lib/Drupal/Core/Ajax/BeforeCommand.php \Drupal\Core\Ajax\BeforeCommand
An AJAX command for calling the jQuery before() method.
The 'insert/before' command instructs the client to use jQuery's before() method to insert the given render array or HTML content before each of elements matched by the given selector.
This command is implemented by Drupal.AjaxCommands.prototype.insert() defined in misc/ajax.js.
Hierarchy
- class \Drupal\Core\Ajax\InsertCommand implements \Drupal\Core\Ajax\CommandInterface, \Drupal\Core\Ajax\CommandWithAttachedAssetsInterface uses \Drupal\Core\Ajax\CommandWithAttachedAssetsTrait
- class \Drupal\Core\Ajax\BeforeCommand extends \Drupal\Core\Ajax\InsertCommand
Expanded class hierarchy of BeforeCommand
See also
http://docs.jquery.com/Manipulation/before#content
Related topics
2 files declare their use of BeforeCommand
- 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.
File
-
core/
lib/ Drupal/ Core/ Ajax/ BeforeCommand.php, line 19
Namespace
Drupal\Core\AjaxView source
class BeforeCommand extends InsertCommand {
/**
* Implements Drupal\Core\Ajax\CommandInterface:render().
*/
public function render() {
return [
'command' => 'insert',
'method' => 'before',
'selector' => $this->selector,
'data' => $this->getRenderedContent(),
'settings' => $this->settings,
];
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
BeforeCommand::render | public | function | Implements Drupal\Core\Ajax\CommandInterface:render(). | Overrides InsertCommand::render |
CommandWithAttachedAssetsTrait::$attachedAssets | protected | property | The attached assets for this Ajax command. | |
CommandWithAttachedAssetsTrait::getAttachedAssets | public | function | Gets the attached assets. | |
CommandWithAttachedAssetsTrait::getRenderedContent | protected | function | Processes the content for output. | |
InsertCommand::$content | protected | property | The content for the matched element(s). | |
InsertCommand::$selector | protected | property | A CSS selector string. | |
InsertCommand::$settings | protected | property | A settings array to be passed to any attached JavaScript behavior. | |
InsertCommand::__construct | public | function | Constructs an InsertCommand object. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.