You are here

Home » API reference » Entity Reference with Layout 8 » EntityReferenceLayoutFormatter.php

class EntityReferenceLayoutFormatter in Entity Reference with Layout 8

Entity Reference with Layout field formatter.

Plugin annotation


@FieldFormatter(
  id = "entity_reference_layout",
  label = @Translation("Entity reference layout"),
  description = @Translation("Display the referenced entities recursively rendered by entity_view()."),
  field_types = {
    "entity_reference_layout",
    "entity_reference_layout_revisioned"
  }
)

Hierarchy

Expanded class hierarchy of EntityReferenceLayoutFormatter

File

src/Plugin/Field/FieldFormatter/EntityReferenceLayoutFormatter.php, line 29

Namespace

Drupal\entity_reference_layout\Plugin\Field\FieldFormatter
View source 
class EntityReferenceLayoutFormatter extends EntityReferenceRevisionsEntityFormatter implements ContainerFactoryPluginInterface {

  /**
   * The layout plugin manager service.
   *
   * @var \Drupal\Core\Layout\LayoutPluginManagerInterface
   */
  protected $layoutPluginManager;

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, LoggerChannelFactoryInterface $logger_factory, EntityDisplayRepositoryInterface $entity_display_repository, LayoutPluginManager $layout_plugin_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $logger_factory, $entity_display_repository);
    $this->layoutPluginManager = $layout_plugin_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('logger.factory'), $container
      ->get('entity_display.repository'), $container
      ->get('plugin.manager.core.layout'));
  }

  /**
   * {@inheritDoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $elements['#theme'] = 'entity_reference_layout';
    $elements['#elements']['field_name'] = $this->fieldDefinition
      ->getName();
    $elements['#elements']['#view_mode'] = $this
      ->getSetting('view_mode');
    try {

      /* @var \Drupal\Core\Field\EntityReferenceFieldItemListInterface $items */
      $elements['#content'] = $this
        ->buildLayoutTree($items, $langcode);
    } catch (\Exception $e) {
      watchdog_exception('Erl formatter, build layout tree', $e);
    }
    return $elements;
  }

  /**
   * Builds the structure for the entire layout.
   *
   * @param \Drupal\Core\Field\EntityReferenceFieldItemListInterface $items
   *   The items to render.
   * @param string $langcode
   *   The current language code.
   *
   * @return array
   *   A render array.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\TypedData\Exception\MissingDataException
   * @see EntityReferenceRevisionsEntityFormatter::viewElements()
   */
  public function buildLayoutTree(EntityReferenceFieldItemListInterface $items, $langcode) {
    $build = [];
    $containerUUID = FALSE;

    /* @var \Drupal\paragraphs\ParagraphInterface $entity */
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $entity) {

      /** @var \Drupal\image\Plugin\Field\FieldType\ImageItem referringItem */
      $referringItem = $entity->_referringItem;

      // Protect ourselves from recursive rendering.
      static $depth = 0;
      $depth++;
      if ($depth > 20) {
        $this->loggerFactory
          ->get('entity')
          ->error($this
          ->t('Recursive rendering detected when rendering entity @entity_type @entity_id. Aborting rendering.', [
          '@entity_type' => $entity
            ->getEntityTypeId(),
          '@entity_id' => $entity
            ->id(),
        ]));
        return $build;
      }

      // Container.
      if ($referringItem
        ->get('layout')
        ->getString()) {
        $containerUUID = $entity
          ->uuid();
        $build[$containerUUID] = $this
          ->buildLayoutContainer($entity);
      }
      else {
        if (!$containerUUID) {
          $messenger = \Drupal::messenger();
          $messenger
            ->addMessage($this
            ->t('No parent container defined'), 'warning');
        }
        else {
          $referringItem = $entity->_referringItem;
          $region = $referringItem
            ->get('region')
            ->getString();
          $build[$containerUUID]['#regions'][$region][] = $this
            ->buildEntityView($entity);
        }
      }
      $depth = 0;
    }
    foreach ($build as &$layout_paragraph) {
      if (isset($layout_paragraph['#layout_instance'])) {
        $regions = $layout_paragraph['#regions'];
        $layout_paragraph['rendered_layout'] = [
          '#weight' => 1000,
        ] + $layout_paragraph['#layout_instance']
          ->build($regions);
      }
    }
    return $build;
  }

  /**
   * Builds the view array for a single paragraph entity.
   *
   * @param \Drupal\paragraphs\ParagraphInterface $entity
   *   The paragraph entity to render.
   *
   * @return array
   *   Returns a render array.
   */
  public function buildEntityView(ParagraphInterface $entity) {
    $view_mode = $this
      ->getSetting('view_mode');
    $view_builder = \Drupal::entityTypeManager()
      ->getViewBuilder($entity
      ->getEntityTypeId());
    return $view_builder
      ->view($entity, $view_mode, $entity
      ->language()
      ->getId());
  }

  /**
   * Builds the structure for a single layout paragraph item.
   *
   * Also adds elements for the layout instance and regions.
   * Regions will be populated with paragraphs further down the line,
   * then rendered in the layout.
   *
   * @param \Drupal\paragraphs\ParagraphInterface $entity
   *   The paragraph to render.
   *
   * @return array
   *   Returns a build array.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\TypedData\Exception\MissingDataException
   */
  public function buildLayoutContainer(ParagraphInterface $entity) {

    /** @var \Drupal\entity_reference_layout\Plugin\Field\FieldType\EntityReferenceLayoutRevisioned $referringItem */
    $referringItem = $entity->_referringItem;
    $layout = $referringItem
      ->get('layout')
      ->getString();
    $config = $referringItem
      ->get('config')
      ->getValue();
    if (!$this->layoutPluginManager
      ->getDefinition($layout, FALSE)) {
      $messenger = \Drupal::messenger();
      $messenger
        ->addMessage($this
        ->t('Layout `%layout_id` is unknown.', [
        '%layout_id' => $layout,
      ]), 'warning');
      return [];
    }
    $layout_instance = $this->layoutPluginManager
      ->createInstance($layout, $config);
    $build = $this
      ->buildEntityView($entity);
    $build['#layout_instance'] = $layout_instance;
    $build['#regions'] = [];
    foreach ($layout_instance
      ->getPluginDefinition()
      ->getRegionNames() as $region_name) {
      $build['#regions'][$region_name] = [];
    }
    return $build;
  }

}

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
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
EntityReferenceLayoutFormatter::$layoutPluginManager protected property The layout plugin manager service.
EntityReferenceLayoutFormatter::buildEntityView public function Builds the view array for a single paragraph entity.
EntityReferenceLayoutFormatter::buildLayoutContainer public function Builds the structure for a single layout paragraph item.
EntityReferenceLayoutFormatter::buildLayoutTree public function Builds the structure for the entire layout.
EntityReferenceLayoutFormatter::create public static function Creates an instance of the plugin. Overrides EntityReferenceRevisionsEntityFormatter::create
EntityReferenceLayoutFormatter::viewElements public function Builds a renderable array for a field value. Overrides EntityReferenceRevisionsEntityFormatter::viewElements
EntityReferenceLayoutFormatter::__construct public function Constructs a StringFormatter instance. Overrides EntityReferenceRevisionsEntityFormatter::__construct
EntityReferenceRevisionsEntityFormatter::$entityDisplayRepository protected property The entity display repository.
EntityReferenceRevisionsEntityFormatter::$loggerFactory protected property The logger factory.
EntityReferenceRevisionsEntityFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
EntityReferenceRevisionsEntityFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
EntityReferenceRevisionsEntityFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
EntityReferenceRevisionsEntityFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
EntityReferenceRevisionsFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being viewed. Overrides EntityReferenceFormatterBase::prepareView
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.