class ChangedCommand
Same name in other branches
- 9 core/lib/Drupal/Core/Ajax/ChangedCommand.php \Drupal\Core\Ajax\ChangedCommand
- 8.9.x core/lib/Drupal/Core/Ajax/ChangedCommand.php \Drupal\Core\Ajax\ChangedCommand
- 11.x core/lib/Drupal/Core/Ajax/ChangedCommand.php \Drupal\Core\Ajax\ChangedCommand
An AJAX command for marking HTML elements as changed.
This command instructs the client to mark each of the elements matched by the given selector as 'ajax-changed'.
This command is implemented by Drupal.AjaxCommands.prototype.changed() defined in misc/ajax.js.
Hierarchy
- class \Drupal\Core\Ajax\ChangedCommand implements \Drupal\Core\Ajax\CommandInterface
Expanded class hierarchy of ChangedCommand
Related topics
2 files declare their use of ChangedCommand
- 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/ ChangedCommand.php, line 16
Namespace
Drupal\Core\AjaxView source
class ChangedCommand implements CommandInterface {
/**
* A CSS selector string.
*
* If the command is a response to a request from an #ajax form element then
* this value can be NULL.
*
* @var string
*/
protected $selector;
/**
* An optional CSS selector for elements to which asterisks will be appended.
*
* @var string
*/
protected $asterisk;
/**
* Constructs a ChangedCommand object.
*
* @param string $selector
* CSS selector for elements to be marked as changed.
* @param string $asterisk
* CSS selector for elements to which an asterisk will be appended.
*/
public function __construct($selector, $asterisk = '') {
$this->selector = $selector;
$this->asterisk = $asterisk;
}
/**
* Implements Drupal\Core\Ajax\CommandInterface:render().
*/
public function render() {
return [
'command' => 'changed',
'selector' => $this->selector,
'asterisk' => $this->asterisk,
];
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
ChangedCommand::$asterisk | protected | property | An optional CSS selector for elements to which asterisks will be appended. | |
ChangedCommand::$selector | protected | property | A CSS selector string. | |
ChangedCommand::render | public | function | Implements Drupal\Core\Ajax\CommandInterface:render(). | Overrides CommandInterface::render |
ChangedCommand::__construct | public | function | Constructs a ChangedCommand object. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.