class DetailsSidebar in Field Group 8.3
Details Sidebar element.
Plugin annotation
@FieldGroupFormatter(
id = "details_sidebar",
label = @Translation("Details Sidebar"),
description = @Translation("Add a details sidebar element"),
supported_contexts = {
"form",
"view"
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\field_group\FieldGroupFormatterBase implements FieldGroupFormatterInterface
- class \Drupal\field_group\Plugin\field_group\FieldGroupFormatter\Details
- class \Drupal\field_group\Plugin\field_group\FieldGroupFormatter\DetailsSidebar
- class \Drupal\field_group\Plugin\field_group\FieldGroupFormatter\Details
- class \Drupal\field_group\FieldGroupFormatterBase implements FieldGroupFormatterInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of DetailsSidebar
File
- src/
Plugin/ field_group/ FieldGroupFormatter/ DetailsSidebar.php, line 18
Namespace
Drupal\field_group\Plugin\field_group\FieldGroupFormatterView source
class DetailsSidebar extends Details {
/**
* {@inheritdoc}
*/
public function process(&$element, $processed_object) {
parent::process($element, $processed_object);
$element['#group'] = 'advanced';
if ($this
->getSetting('weight')) {
$element['#weight'] = $this
->getSetting('weight');
}
}
/**
* {@inheritdoc}
*/
public function settingsForm() {
$form = parent::settingsForm();
$form['weight'] = [
'#type' => 'number',
'#title' => $this
->t('Weight'),
'#default_value' => $this
->getSetting('weight'),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = parent::settingsSummary();
if ($this
->getSetting('weight')) {
$summary[] = $this
->t('Weight: @weight', [
'@weight' => $this
->getSetting('weight'),
]);
}
return $summary;
}
/**
* {@inheritdoc}
*/
public static function defaultContextSettings($context) {
$defaults = parent::defaultContextSettings($context);
$defaults['weight'] = 0;
return $defaults;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
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 | |
Details:: |
public | function |
Allows the field group formatter to manipulate the field group array and attach the formatters rendering element. Overrides FieldGroupFormatterBase:: |
|
DetailsSidebar:: |
public static | function |
Defines the default settings for this plugin. Overrides Details:: |
|
DetailsSidebar:: |
public | function |
Allows the field group formatter to manipulate the field group array and attach the formatters elements.
The process method is called in the #process part of theme layer, and is currently used for forms.
The preRender method is called in the… Overrides Details:: |
|
DetailsSidebar:: |
public | function |
Returns a form to configure settings for the formatter. Overrides Details:: |
|
DetailsSidebar:: |
public | function |
Returns a short summary for the current formatter settings. Overrides Details:: |
|
FieldGroupFormatterBase:: |
protected | property | The context mode. | |
FieldGroupFormatterBase:: |
protected | property | The group this formatter needs to render. | |
FieldGroupFormatterBase:: |
protected | property | The label display setting. | |
FieldGroupFormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FieldGroupFormatterBase:: |
protected | property | The view mode. | |
FieldGroupFormatterBase:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsBase:: |
|
FieldGroupFormatterBase:: |
protected | function | Get the classes to add to the group. | 1 |
FieldGroupFormatterBase:: |
public | function | Get the current label. | |
FieldGroupFormatterBase:: |
public static | function | Validate the entered css class from the submitted format settings. | |
FieldGroupFormatterBase:: |
public static | function | Validate the entered id attribute from the submitted format settings. | |
FieldGroupFormatterBase:: |
public | function |
Constructs a FieldGroupFormatterBase object. Overrides PluginBase:: |
|
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. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
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. |