ActivityEntityReferenceFormatter.php in Open Social 10.0.x

Namespace

Drupal\activity_viewer\Plugin\Field\FieldFormatter

File

modules/custom/activity_viewer/src/Plugin/Field/FieldFormatter/ActivityEntityReferenceFormatter.php

<?php

namespace Drupal\activity_viewer\Plugin\Field\FieldFormatter;

use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\dynamic_entity_reference\Plugin\Field\FieldFormatter\DynamicEntityReferenceEntityFormatter;

/**
 * Provides a custom dynamic entity reference formatter.
 *
 * @FieldFormatter(
 *   id = "activity_viewer_entity_reference_formatter",
 *   module = "activity_viewer",
 *   label = @Translation("Custom dynamic entity reference formatter for activities"),
 *   field_types = {
 *     "dynamic_entity_reference"
 *   }
 * )
 */
class ActivityEntityReferenceFormatter extends DynamicEntityReferenceEntityFormatter {

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

      // 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.', [
          '@entity_type' => $entity
            ->getEntityTypeId(),
          '@entity_id' => $entity
            ->id(),
        ]);
        return $elements;
      }
      if ($entity
        ->id()) {
        $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)) {
          $items[$delta]->_attributes += [
            'resource' => $entity
              ->toUrl(),
          ];
        }
      }
      else {

        // This is an "auto_create" item.
        $elements[$delta] = [
          '#markup' => $entity
            ->label(),
        ];
      }
      $depth = 0;
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $options = $this->entityDisplayRepository
      ->getAllViewModes();
    $only_view_modes = [];
    foreach ($options as $entity) {
      foreach ($entity as $key => $view_mode) {
        $only_view_modes[$key] = $view_mode['label'];
      }
    }
    $elements['view_mode'] = [
      '#type' => 'select',
      '#options' => $only_view_modes,
      '#title' => t('View mode'),
      '#default_value' => $this
        ->getSetting('view_mode'),
      '#required' => TRUE,
    ];
    return $elements;
  }

}

Classes

Name	Description
ActivityEntityReferenceFormatter	Provides a custom dynamic entity reference formatter.