class AccordionBlockFormatter in Accordion Blocks 8
Plugin implementation of the 'accordion_widget_formatter' formatter.
Plugin annotation
@FieldFormatter(
id = "accordion_widget_formatter",
label = @Translation("Accordion Widget"),
field_types = {
"entity_reference",
}
)
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\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
- class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceEntityFormatter implements ContainerFactoryPluginInterface
- class \Drupal\accordion_blocks\Plugin\Field\FieldFormatter\AccordionBlockFormatter
- class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceEntityFormatter implements ContainerFactoryPluginInterface
- class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
- 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 AccordionBlockFormatter
File
- src/
Plugin/ Field/ FieldFormatter/ AccordionBlockFormatter.php, line 25 - Contains Drupal\accordion_blocks\Plugin\Field\FieldFormatter\AccordionBlockFormatter.
Namespace
Drupal\accordion_blocks\Plugin\Field\FieldFormatterView source
class AccordionBlockFormatter extends EntityReferenceEntityFormatter {
public function viewElements(FieldItemListInterface $items, $langcode) {
$view_mode = $this
->getSetting('view_mode');
$elements = array();
foreach ($this
->getEntitiesToView($items, $langcode) as $delta => $entity) {
$label = $entity
->label();
// Protect ourselves from recursive rendering.
static $depth = 0;
$depth++;
if ($depth > 20) {
$this->loggerFactory
->get('entity')
->error('Recursive rendering detected when rendering entity @entity_type @entity_id. Aborting rendering.', array(
'@entity_type' => $entity
->getEntityTypeId(),
'@entity_id' => $entity
->id(),
));
return $elements;
}
if ($entity
->id()) {
$view_builder = \Drupal::entityManager()
->getViewBuilder($entity
->getEntityTypeId());
$elements[$delta] = $view_builder
->view($entity, $view_mode, $entity
->language()
->getId());
$items[$delta]->_attributes += array(
'resource' => $entity
->url(),
'title' => $label,
);
}
else {
// This is an "auto_create" item.
$elements[$delta] = array(
'#markup' => $label,
);
}
$depth = 0;
}
return $elements;
}
public function view(FieldItemListInterface $items, $langcode = NULL) {
$elements = parent::view($items, $langcode);
$elements['#theme'] = 'accordion_block_formatter';
$elements['#attached']['library'][] = 'accordion_blocks/accordion-widget';
$blocks = array();
foreach ($items as $key => $value) {
$blocks[$key] = array(
'content' => $elements[$key],
'title' => $items[$key]->_attributes['title'],
);
}
$elements['#blocks'] = $blocks;
return $elements;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccordionBlockFormatter:: |
public | function |
Builds a renderable array for a fully themed field. Overrides EntityReferenceFormatterBase:: |
|
AccordionBlockFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides EntityReferenceEntityFormatter:: |
|
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 | |
EntityReferenceEntityFormatter:: |
protected | property | The entity display repository. | |
EntityReferenceEntityFormatter:: |
protected | property | The entity type manager. | |
EntityReferenceEntityFormatter:: |
protected | property | The logger factory. | |
EntityReferenceEntityFormatter:: |
protected static | property | An array of counters for the recursive rendering protection. | |
EntityReferenceEntityFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
|
EntityReferenceEntityFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsBase:: |
|
EntityReferenceEntityFormatter:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterBase:: |
|
EntityReferenceEntityFormatter:: |
constant | The number of times this formatter allows rendering the same entity. | ||
EntityReferenceEntityFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides FormatterBase:: |
|
EntityReferenceEntityFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides FormatterBase:: |
|
EntityReferenceEntityFormatter:: |
public | function |
Constructs a EntityReferenceEntityFormatter instance. Overrides FormatterBase:: |
|
EntityReferenceFormatterBase:: |
protected | function | Checks access to the given entity. | 3 |
EntityReferenceFormatterBase:: |
protected | function | Returns the referenced entities for display. | 1 |
EntityReferenceFormatterBase:: |
protected | function | Returns whether the entity referenced by an item needs to be loaded. | 1 |
EntityReferenceFormatterBase:: |
public | function |
Loads the entities referenced in that field across all the entities being
viewed. Overrides FormatterBase:: |
|
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:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
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. |