123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219 |
- <?php
- namespace Drupal\Core\Field\Plugin\Field\FieldFormatter;
- use Drupal\Core\Entity\EntityDisplayRepositoryInterface;
- use Drupal\Core\Entity\EntityTypeManagerInterface;
- use Drupal\Core\Field\FieldDefinitionInterface;
- use Drupal\Core\Field\FieldItemListInterface;
- use Drupal\Core\Form\FormStateInterface;
- use Drupal\Core\Logger\LoggerChannelFactoryInterface;
- use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
- use Symfony\Component\DependencyInjection\ContainerInterface;
- /**
- * Plugin implementation of the 'entity reference rendered entity' formatter.
- *
- * @FieldFormatter(
- * id = "entity_reference_entity_view",
- * label = @Translation("Rendered entity"),
- * description = @Translation("Display the referenced entities rendered by entity_view()."),
- * field_types = {
- * "entity_reference"
- * }
- * )
- */
- class EntityReferenceEntityFormatter extends EntityReferenceFormatterBase implements ContainerFactoryPluginInterface {
- /**
- * The number of times this formatter allows rendering the same entity.
- *
- * @var int
- */
- const RECURSIVE_RENDER_LIMIT = 20;
- /**
- * The logger factory.
- *
- * @var \Drupal\Core\Logger\LoggerChannelFactoryInterface
- */
- protected $loggerFactory;
- /**
- * The entity type manager.
- *
- * @var \Drupal\Core\Entity\EntityTypeManagerInterface
- */
- protected $entityTypeManager;
- /**
- * The entity display repository.
- *
- * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
- */
- protected $entityDisplayRepository;
- /**
- * An array of counters for the recursive rendering protection.
- *
- * Each counter takes into account all the relevant information about the
- * field and the referenced entity that is being rendered.
- *
- * @see \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceEntityFormatter::viewElements()
- *
- * @var array
- */
- protected static $recursiveRenderDepth = [];
- /**
- * Constructs a EntityReferenceEntityFormatter instance.
- *
- * @param string $plugin_id
- * The plugin_id for the formatter.
- * @param mixed $plugin_definition
- * The plugin implementation definition.
- * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
- * The definition of the field to which the formatter is associated.
- * @param array $settings
- * The formatter settings.
- * @param string $label
- * The formatter label display setting.
- * @param string $view_mode
- * The view mode.
- * @param array $third_party_settings
- * Any third party settings settings.
- * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
- * The logger factory.
- * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
- * The entity type manager.
- * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
- * The entity display repository.
- */
- public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, LoggerChannelFactoryInterface $logger_factory, EntityTypeManagerInterface $entity_type_manager, EntityDisplayRepositoryInterface $entity_display_repository) {
- parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
- $this->loggerFactory = $logger_factory;
- $this->entityTypeManager = $entity_type_manager;
- $this->entityDisplayRepository = $entity_display_repository;
- }
- /**
- * {@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_type.manager'),
- $container->get('entity_display.repository')
- );
- }
- /**
- * {@inheritdoc}
- */
- public static function defaultSettings() {
- return [
- 'view_mode' => 'default',
- 'link' => FALSE,
- ] + parent::defaultSettings();
- }
- /**
- * {@inheritdoc}
- */
- public function settingsForm(array $form, FormStateInterface $form_state) {
- $elements['view_mode'] = [
- '#type' => 'select',
- '#options' => $this->entityDisplayRepository->getViewModeOptions($this->getFieldSetting('target_type')),
- '#title' => t('View mode'),
- '#default_value' => $this->getSetting('view_mode'),
- '#required' => TRUE,
- ];
- return $elements;
- }
- /**
- * {@inheritdoc}
- */
- public function settingsSummary() {
- $summary = [];
- $view_modes = $this->entityDisplayRepository->getViewModeOptions($this->getFieldSetting('target_type'));
- $view_mode = $this->getSetting('view_mode');
- $summary[] = t('Rendered as @mode', ['@mode' => isset($view_modes[$view_mode]) ? $view_modes[$view_mode] : $view_mode]);
- return $summary;
- }
- /**
- * {@inheritdoc}
- */
- public function viewElements(FieldItemListInterface $items, $langcode) {
- $view_mode = $this->getSetting('view_mode');
- $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()
- // We include the referencing entity, so we can render default images
- // without hitting recursive protections.
- . $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;
- }
- $view_builder = $this->entityTypeManager->getViewBuilder($entity->getEntityTypeId());
- $elements[$delta] = $view_builder->view($entity, $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;
- }
- /**
- * {@inheritdoc}
- */
- public static function isApplicable(FieldDefinitionInterface $field_definition) {
- // This formatter is only available for entity types that have a view
- // builder.
- $target_type = $field_definition->getFieldStorageDefinition()->getSetting('target_type');
- return \Drupal::entityManager()->getDefinition($target_type)->hasViewBuilderClass();
- }
- }
|