You are here

Home » API reference » Dynamic Entity Reference 8 » DynamicEntityReferenceEntityFormatter.php

class DynamicEntityReferenceEntityFormatter in Dynamic Entity Reference 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/Field/FieldFormatter/DynamicEntityReferenceEntityFormatter.php \Drupal\dynamic_entity_reference\Plugin\Field\FieldFormatter\DynamicEntityReferenceEntityFormatter

Plugin implementation of the 'rendered entity' formatter.

Plugin annotation


@FieldFormatter(
  id = "dynamic_entity_reference_entity_view",
  label = @Translation("Rendered entity"),
  description = @Translation("Display the referenced entities rendered by entity_view()."),
  field_types = {
    "dynamic_entity_reference"
  }
)

Hierarchy

Expanded class hierarchy of DynamicEntityReferenceEntityFormatter

File

src/Plugin/Field/FieldFormatter/DynamicEntityReferenceEntityFormatter.php, line 23

Namespace

Drupal\dynamic_entity_reference\Plugin\Field\FieldFormatter
View source 
class DynamicEntityReferenceEntityFormatter extends EntityReferenceEntityFormatter {
  use DynamicEntityReferenceFormatterTrait;

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $labels = \Drupal::service('entity_type.repository')
      ->getEntityTypeLabels(TRUE);
    $options = array_keys($labels[(string) t('Content', [], [
      'context' => 'Entity type group',
    ])]);
    return array_fill_keys($options, [
      'view_mode' => 'default',
      'link' => FALSE,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $labels = \Drupal::service('entity_type.repository')
      ->getEntityTypeLabels(TRUE);
    $options = $labels[(string) t('Content', [], [
      'context' => 'Entity type group',
    ])];
    $entity_type_ids = DynamicEntityReferenceItem::getTargetTypes($this
      ->getFieldSettings());
    $available = [];
    foreach ($this
      ->getSettings() as $key => $value) {
      if (in_array($key, array_values($entity_type_ids))) {
        $available[$key] = $value;
      }
    }
    if (!empty($available)) {
      return array_map(function ($entity_type_id, $settings) use ($options) {
        $view_mode = $this->entityDisplayRepository
          ->getViewModeOptions($entity_type_id);
        return t('@entity view mode: @mode', [
          '@entity' => $options[$entity_type_id],
          '@mode' => $view_mode[$settings['view_mode']],
        ]);
      }, array_keys($available), $available);
    }
    else {
      return [];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $labels = \Drupal::service('entity_type.repository')
      ->getEntityTypeLabels(TRUE);
    $options = $labels[(string) t('Content', [], [
      'context' => 'Entity type group',
    ])];
    $entity_type_ids = DynamicEntityReferenceItem::getTargetTypes($this
      ->getFieldSettings());
    $elements['view_mode'] = [];
    foreach ($entity_type_ids as $entity_type_id) {
      $elements[$entity_type_id] = [
        '#type' => 'container',
      ];
      $elements[$entity_type_id]['view_mode'] = [
        '#type' => 'select',
        '#options' => $this->entityDisplayRepository
          ->getViewModeOptions($entity_type_id),
        '#title' => t('View mode for %entity', [
          '%entity' => $options[$entity_type_id],
        ]),
        '#default_value' => $this
          ->getSetting($entity_type_id)['view_mode'],
        '#required' => TRUE,
      ];
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $entity) {

      // Due to render caching and delayed calls, the viewElements() method
      // will be called later in the rendering process through a '#pre_render'
      // callback, so we need to generate a counter that takes into account
      // all the relevant information about this field and the referenced
      // entity that is being rendered.
      $recursive_render_id = $items
        ->getFieldDefinition()
        ->getTargetEntityTypeId() . $items
        ->getFieldDefinition()
        ->getTargetBundle() . $items
        ->getName() . $items
        ->getEntity()
        ->id() . $entity
        ->getEntityTypeId() . $entity
        ->id();
      if (isset(static::$recursiveRenderDepth[$recursive_render_id])) {
        static::$recursiveRenderDepth[$recursive_render_id]++;
      }
      else {
        static::$recursiveRenderDepth[$recursive_render_id] = 1;
      }

      // Protect ourselves from recursive rendering.
      if (static::$recursiveRenderDepth[$recursive_render_id] > static::RECURSIVE_RENDER_LIMIT) {
        $this->loggerFactory
          ->get('entity')
          ->error('Recursive rendering detected when rendering entity %entity_type: %entity_id, using the %field_name field on the %bundle_name bundle. Aborting rendering.', [
          '%entity_type' => $entity
            ->getEntityTypeId(),
          '%entity_id' => $entity
            ->id(),
          '%field_name' => $items
            ->getName(),
          '%bundle_name' => $items
            ->getFieldDefinition()
            ->getTargetBundle(),
        ]);
        return $elements;
      }
      $entity_type_id = $entity
        ->getEntityTypeId();
      $view_builder = $this->entityTypeManager
        ->getViewBuilder($entity_type_id);
      $elements[$delta] = $view_builder
        ->view($entity, $this
        ->getSetting($entity_type_id)['view_mode'], $entity
        ->language()
        ->getId());

      // Add a resource attribute to set the mapping property's value to the
      // entity's url. Since we don't know what the markup of the entity will
      // be, we shouldn't rely on it for structured data such as RDFa.
      if (!empty($items[$delta]->_attributes) && !$entity
        ->isNew() && $entity
        ->hasLinkTemplate('canonical')) {
        $items[$delta]->_attributes += [
          'resource' => $entity
            ->toUrl()
            ->toString(),
        ];
      }
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description 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.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DynamicEntityReferenceEntityFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides EntityReferenceEntityFormatter::defaultSettings
DynamicEntityReferenceEntityFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides EntityReferenceEntityFormatter::isApplicable
DynamicEntityReferenceEntityFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides EntityReferenceEntityFormatter::settingsForm
DynamicEntityReferenceEntityFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides EntityReferenceEntityFormatter::settingsSummary
DynamicEntityReferenceEntityFormatter::viewElements public function Builds a renderable array for a field value. Overrides EntityReferenceEntityFormatter::viewElements
DynamicEntityReferenceFormatterTrait::prepareView public function Overrides EntityReferenceFormatterBase::prepareView().
EntityReferenceEntityFormatter::$entityDisplayRepository protected property The entity display repository.
EntityReferenceEntityFormatter::$entityTypeManager protected property The entity type manager.
EntityReferenceEntityFormatter::$loggerFactory protected property The logger factory.
EntityReferenceEntityFormatter::$recursiveRenderDepth protected static property An array of counters for the recursive rendering protection.
EntityReferenceEntityFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
EntityReferenceEntityFormatter::RECURSIVE_RENDER_LIMIT constant The number of times this formatter allows rendering the same entity.
EntityReferenceEntityFormatter::__construct public function Constructs a EntityReferenceEntityFormatter instance. Overrides FormatterBase::__construct
EntityReferenceFormatterBase::checkAccess protected function Checks access to the given entity. 3
EntityReferenceFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. 1
EntityReferenceFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. 1
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.