class Ajax
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/Render/Element/Ajax.php \Drupal\Core\Render\Element\Ajax
- 8.9.x core/lib/Drupal/Core/Render/Element/Ajax.php \Drupal\Core\Render\Element\Ajax
- 10 core/lib/Drupal/Core/Render/Element/Ajax.php \Drupal\Core\Render\Element\Ajax
Provides a render element for adding Ajax to a render element.
Holds an array whose values control the Ajax behavior of the element.
Plugin annotation
@RenderElement("ajax");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Render\Element\RenderElement implements \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\Ajax implements \Drupal\Core\Render\Element\RenderElement
- class \Drupal\Core\Render\Element\RenderElement implements \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of Ajax
Deprecated
in drupal:10.1.0 and is removed from drupal:11.0.0. Return an \Drupal\Core\Ajax\AjaxResponse instead.
See also
https://www.drupal.org/node/3068104
Related topics
17 string references to 'Ajax'
- AjaxRenderer::renderResponse in core/
lib/ Drupal/ Core/ Render/ MainContent/ AjaxRenderer.php - Renders the main content render array into a response.
- AjaxResponseTest::testMergeWithOtherAjaxResponse in core/
tests/ Drupal/ Tests/ Core/ Ajax/ AjaxResponseTest.php - Tests the mergeWith() method.
- DisplayPluginBase::buildOptionsForm in core/
modules/ views/ src/ Plugin/ views/ display/ DisplayPluginBase.php - Provide a form to edit options for this plugin.
- EntitySerializationTest::testSerialize in core/
modules/ serialization/ tests/ src/ Kernel/ EntitySerializationTest.php - Tests entity serialization for core's formats by a registered Serializer.
- ExposedFormPluginBase::renderExposedForm in core/
modules/ views/ src/ Plugin/ views/ exposed_form/ ExposedFormPluginBase.php - Renders the exposed form.
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ Ajax.php, line 19
Namespace
Drupal\Core\Render\ElementView source
class Ajax extends RenderElement {
/**
* {@inheritdoc}
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
@trigger_error('\\Drupal\\Core\\Render\\Element\\Ajax is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Return an \\Drupal\\Core\\Ajax\\AjaxResponse instead. See https://www.drupal.org/node/3068104', E_USER_DEPRECATED);
}
/**
* {@inheritdoc}
*/
public function getInfo() {
// By default, we don't want Ajax commands being rendered in the context of
// an HTML page, so we don't provide defaults for #theme or #theme_wrappers.
// However, modules can set these properties (for example, to provide an
// HTML debugging page that displays rather than executes Ajax commands).
return [
'#header' => TRUE,
'#commands' => [],
'#error' => NULL,
];
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
Ajax::getInfo | public | function | Returns the element properties for this element. | Overrides ElementInterface::getInfo | ||
Ajax::__construct | public | function | Constructs a new render element object. | Overrides RenderElement::__construct | ||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
PluginBase::$pluginId | protected | property | The plugin ID. | |||
PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | ||
PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | ||
PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 | |
PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
RenderElement::preRenderAjaxForm | public static | function | Adds Ajax information about an element to communicate with JavaScript. | Overrides RenderElementBase::preRenderAjaxForm | ||
RenderElement::preRenderGroup | public static | function | Adds members of this group as actual elements for rendering. | Overrides RenderElementBase::preRenderGroup | ||
RenderElement::processAjaxForm | public static | function | Form element processing handler for the #ajax form property. | Overrides RenderElementBase::processAjaxForm | ||
RenderElement::processGroup | public static | function | Arranges elements into groups. | Overrides RenderElementBase::processGroup | ||
RenderElement::setAttributes | public static | function | Sets a form element's class attribute. | Overrides RenderElementBase::setAttributes | ||
RenderElementBase::$renderParent | protected | property | The parent element. | |||
RenderElementBase::$renderParentName | protected | property | The parent key. | |||
RenderElementBase::$storage | protected | property | The storage. | |||
RenderElementBase::addChild | public | function | Adds a child render element. | Overrides ElementInterface::addChild | ||
RenderElementBase::changeType | public | function | Change the type of the element. | Overrides ElementInterface::changeType | ||
RenderElementBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 2 | |
RenderElementBase::createChild | public | function | Creates a render object and attaches it to the current render object. | Overrides ElementInterface::createChild | ||
RenderElementBase::elementInfoManager | protected | function | Returns the element info manager. | |||
RenderElementBase::getChild | public | function | Gets a child. | Overrides ElementInterface::getChild | ||
RenderElementBase::getChildren | public | function | Returns child elements. | Overrides ElementInterface::getChildren | ||
RenderElementBase::initializeInternalStorage | public | function | Initialize storage. | Overrides ElementInterface::initializeInternalStorage | ||
RenderElementBase::removeChild | public | function | Removes a child. | Overrides ElementInterface::removeChild | ||
RenderElementBase::setType | protected | function | Set type on initialize. | 1 | ||
RenderElementBase::toRenderable | public | function | Returns a render array. | Overrides ElementInterface::toRenderable | ||
RenderElementBase::__get | public | function | Magic method: gets a property value. | |||
RenderElementBase::__isset | public | function | Magic method: checks if a property value is set. | |||
RenderElementBase::__set | public | function | Magic method: Sets a property value. | |||
RenderElementBase::__sleep | public | function | Overrides DependencySerializationTrait::__sleep | |||
RenderElementBase::__unset | public | function | Magic method: unsets a property value. | |||
RenderElementBase::__wakeup | public | function | Overrides DependencySerializationTrait::__wakeup | |||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.