ConsentFormatter.php in General Data Protection Regulation 8

Namespace

Drupal\gdpr_consent\Plugin\Field\FieldFormatter

File

modules/gdpr_consent/src/Plugin/Field/FieldFormatter/ConsentFormatter.php

<?php

namespace Drupal\gdpr_consent\Plugin\Field\FieldFormatter;

use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\FormatterBase;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Plugin implementation of the gdpr_consent_formatter formatter.
 *
 * @FieldFormatter(
 *   id = "gdpr_consent_formatter",
 *   label = @Translation("GDPR Consent Formatter"),
 *   field_types = {
 *    "gdpr_user_consent"
 *   }
 * )
 */
class ConsentFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a ConsentFormatter 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\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->entityTypeManager = $entity_type_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('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $output = [];
    $storage = $this->entityTypeManager
      ->getStorage('gdpr_consent_agreement');
    foreach ($items as $delta => $item) {
      $agreement = $storage
        ->loadRevision($item->target_revision_id);
      $link = $this
        ->t('Removed');
      if ($agreement) {
        $link = $agreement
          ->toLink($agreement->title->value, 'revision')
          ->toString();
      }
      $output[$delta] = [
        'name' => [
          '#markup' => $this
            ->t('@title on @date', [
            '@title' => $link,
            '@date' => $item->date,
          ]),
        ],
      ];
    }
    return $output;
  }

}

Classes

Name	Description
ConsentFormatter	Plugin implementation of the gdpr_consent_formatter formatter.