class TextWithTitleAccordionFormatter in Text with Title Field 8
Plugin implementation of the 'TextWithTitleAccordionFormatter' formatter.
Plugin annotation
@FieldFormatter(
id = "text_with_title_accordion_formatter",
label = @Translation("Accordion"),
field_types = {
"text_with_title_field"
}
)
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\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\text_with_title\Plugin\Field\FieldFormatter\TextWithTitleAccordionFormatter
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of TextWithTitleAccordionFormatter
File
- src/
Plugin/ Field/ FieldFormatter/ TextWithTitleAccordionFormatter.php, line 22
Namespace
Drupal\text_with_title\Plugin\Field\FieldFormatterView source
class TextWithTitleAccordionFormatter extends FormatterBase {
/**
* Overide the view method so we can wrap the result in the accordion markup.
*/
public function view(FieldItemListInterface $items, $langcode = NULL) {
// Default the language to the current content language.
if (empty($langcode)) {
$langcode = \Drupal::languageManager()
->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)
->getId();
}
$entity = $items
->getEntity();
$this->accordion_group_id = $entity
->getEntityTypeId() . '_' . $entity
->bundle() . '_' . $entity
->id();
$elements = $this
->viewElements($items, $langcode);
$build = [
'#theme' => 'text_with_title_accordion',
'#panels' => $elements,
'#id' => $this->accordion_group_id,
];
return $build;
}
/**
* Define how the field type is displayed.
*
* Inside this method we can customize how the field is displayed inside
* pages.
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = [];
foreach ($items as $delta => $item) {
// Generate a unique ID for this item.
$id = $this->accordion_group_id . '--accordion-' . $delta;
$description_attributes = [];
// Body attributes.
$body_attributes = [
'id' => $id,
];
// Heading attributes.
$heading_attributes = [
'data-toggle' => 'collapse',
];
if ($this
->getSetting('only_one_open')) {
// Parent id.
$entity = $items
->getEntity();
$parent_id = $entity
->getEntityTypeId() . '_' . $entity
->bundle() . '_' . $entity
->id();
$heading_attributes['data-parent'] = '#' . $parent_id;
}
$attributes = [];
$elements[$delta] = [
'#theme' => 'text_with_title_panel',
'#heading' => [
'#plain_text' => $item->title,
],
'#heading_attributes' => new Attribute($heading_attributes),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#attributes' => new Attribute($attributes),
'#id' => $id,
'#target' => '#' . $id,
'#description' => [
'attributes' => new Attribute($description_attributes),
'content' => '',
'position' => 'before',
],
'#body' => [
'#type' => 'processed_text',
'#text' => $item->text['value'],
'#format' => $item->text['format'],
'#langcode' => $langcode,
],
'#body_attributes' => new Attribute($body_attributes),
];
}
return $elements;
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'only_one_open' => TRUE,
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$element['only_one_open'] = [
'#title' => $this
->t('Allow only one panel to be open at any one time.'),
'#description' => $this
->t('Disable this option to allow multiple panels to be visible at one time.'),
'#type' => 'checkbox',
'#default_value' => $this
->getSetting('only_one_open'),
];
return $element;
}
}
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 | |
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
11 |
FormatterBase:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
FormatterBase:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterInterface:: |
14 |
FormatterBase:: |
public | function |
Allows formatters to load information for field values being displayed. Overrides FormatterInterface:: |
2 |
FormatterBase:: |
public | function |
Returns a short summary for the current formatter settings. Overrides FormatterInterface:: |
22 |
FormatterBase:: |
public | function |
Constructs a FormatterBase object. Overrides PluginBase:: |
11 |
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. | |
TextWithTitleAccordionFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsBase:: |
|
TextWithTitleAccordionFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides FormatterBase:: |
|
TextWithTitleAccordionFormatter:: |
public | function |
Overide the view method so we can wrap the result in the accordion markup. Overrides FormatterBase:: |
|
TextWithTitleAccordionFormatter:: |
public | function |
Define how the field type is displayed. Overrides FormatterInterface:: |