class RenderElement

Same name in this branch
  1. 11.x core/lib/Drupal/Core/Render/Annotation/RenderElement.php \Drupal\Core\Render\Annotation\RenderElement
  2. 11.x core/lib/Drupal/Core/Render/Attribute/RenderElement.php \Drupal\Core\Render\Attribute\RenderElement
Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Render/Element/RenderElement.php \Drupal\Core\Render\Element\RenderElement
  2. 9 core/lib/Drupal/Core/Render/Annotation/RenderElement.php \Drupal\Core\Render\Annotation\RenderElement
  3. 8.9.x core/lib/Drupal/Core/Render/Element/RenderElement.php \Drupal\Core\Render\Element\RenderElement
  4. 8.9.x core/lib/Drupal/Core/Render/Annotation/RenderElement.php \Drupal\Core\Render\Annotation\RenderElement
  5. 10 core/lib/Drupal/Core/Render/Element/RenderElement.php \Drupal\Core\Render\Element\RenderElement
  6. 10 core/lib/Drupal/Core/Render/Annotation/RenderElement.php \Drupal\Core\Render\Annotation\RenderElement
  7. 10 core/lib/Drupal/Core/Render/Attribute/RenderElement.php \Drupal\Core\Render\Attribute\RenderElement

Provides a base class for render element plugins.

Hierarchy

Expanded class hierarchy of RenderElement

Deprecated

in drupal:10.3.0 and is removed from drupal:12.0.0. Use \Drupal\Core\Render\Element\RenderElementBase instead.

See also

https://www.drupal.org/node/3436275

2 files declare their use of RenderElement
ComponentElement.php in core/modules/sdc/src/Element/ComponentElement.php
DeprecatedExtendsRenderElement.php in core/modules/system/tests/modules/element_info_test/src/Element/DeprecatedExtendsRenderElement.php

File

core/lib/Drupal/Core/Render/Element/RenderElement.php, line 15

Namespace

Drupal\Core\Render\Element
View source
abstract class RenderElement extends RenderElementBase {
  
  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    $elementInfoManager = \Drupal::service('plugin.manager.element_info');
    parent::__construct($configuration, $plugin_id, $plugin_definition, $elementInfoManager);
    @trigger_error('\\Drupal\\Core\\Render\\Element\\RenderElement is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\RenderElementBase instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
  }
  
  /**
   * {@inheritdoc}
   */
  public static function setAttributes(&$element, $class = []) {
    @trigger_error('\\Drupal\\Core\\Render\\Element\\RenderElement::setAttributes() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\RenderElementBase::setAttributes() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
    parent::setAttributes($element, $class);
  }
  
  /**
   * {@inheritdoc}
   */
  public static function preRenderGroup($element) {
    @trigger_error('\\Drupal\\Core\\Render\\Element\\RenderElement::preRenderGroup() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\RenderElementBase::preRenderGroup() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
    return parent::preRenderGroup($element);
  }
  
  /**
   * {@inheritdoc}
   */
  public static function processAjaxForm(&$element, FormStateInterface $form_state, &$complete_form) {
    @trigger_error('\\Drupal\\Core\\Render\\Element\\RenderElement::processAjaxForm() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\RenderElementBase::processAjaxForm() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
    return parent::processAjaxForm($element, $form_state, $complete_form);
  }
  
  /**
   * {@inheritdoc}
   */
  public static function preRenderAjaxForm($element) {
    @trigger_error('\\Drupal\\Core\\Render\\Element\\RenderElement::preRenderAjaxForm() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\RenderElementBase::preRenderAjaxForm() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
    return parent::preRenderAjaxForm($element);
  }
  
  /**
   * {@inheritdoc}
   */
  public static function processGroup(&$element, FormStateInterface $form_state, &$complete_form) {
    @trigger_error('\\Drupal\\Core\\Render\\Element\\RenderElement::processGroup() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\RenderElementBase::processGroup() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
    return parent::processGroup($element, $form_state, $complete_form);
  }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
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.
ElementInterface::getInfo public function Returns the element properties for this element. 65
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
RenderElement::__construct public function Constructs a new render element object. Overrides RenderElementBase::__construct 1
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.