class EnvironmentIndicator in Environment Indicator 8.3
Same name in this branch
- 8.3 src/Element/EnvironmentIndicator.php \Drupal\environment_indicator\Element\EnvironmentIndicator
- 8.3 src/Entity/EnvironmentIndicator.php \Drupal\environment_indicator\Entity\EnvironmentIndicator
Same name and namespace in other branches
- 4.x src/Element/EnvironmentIndicator.php \Drupal\environment_indicator\Element\EnvironmentIndicator
Provides a render element to add the environment indicator to the page.
Usage example:
$page_top['indicator'] = [
'#type' => 'environment_indicator',
'#title' => t('Acceptance'),
'#description' => t('Sprint 9'),
'#attributes' => [
'class' => 'custom-class',
],
'#fg_color' => '#123412',
'#bg_color' => 'FEDCBA9',
];
Plugin annotation
@RenderElement("environment_indicator");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Render\Element\Container
- class \Drupal\environment_indicator\Element\EnvironmentIndicator
- class \Drupal\Core\Render\Element\Container
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of EnvironmentIndicator
1 #type use of EnvironmentIndicator
- environment_indicator_page_top in ./
environment_indicator.module - Implements hook_page_top().
File
- src/
Element/ EnvironmentIndicator.php, line 24
Namespace
Drupal\environment_indicator\ElementView source
class EnvironmentIndicator extends Container {
/**
* {@inheritdoc}
*/
public function getInfo() {
$info = parent::getInfo();
$info['#theme_wrappers'][] = 'environment_indicator';
return $info;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Container:: |
public static | function | Prevents optional containers from rendering if they have no children. | |
Container:: |
public static | function | Processes a container element. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EnvironmentIndicator:: |
public | function |
Returns the element properties for this element. Overrides Container:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |