You are here

Home » API reference » Entity Extra Field 2.0.x » ExtraFieldTypePluginBase.php

abstract class ExtraFieldTypePluginBase in Entity Extra Field 2.0.x

Same name and namespace in other branches
  1. 8 src/ExtraFieldTypePluginBase.php \Drupal\entity_extra_field\ExtraFieldTypePluginBase

Define extra field type plugin base.

Hierarchy

Expanded class hierarchy of ExtraFieldTypePluginBase

4 files declare their use of ExtraFieldTypePluginBase
ExtraFieldBlockPlugin.php in src/Plugin/ExtraFieldType/ExtraFieldBlockPlugin.php
ExtraFieldEntityLinkPlugin.php in src/Plugin/ExtraFieldType/ExtraFieldEntityLinkPlugin.php
ExtraFieldTokenPlugin.php in src/Plugin/ExtraFieldType/ExtraFieldTokenPlugin.php
ExtraFieldViewsPlugin.php in src/Plugin/ExtraFieldType/ExtraFieldViewsPlugin.php

File

src/ExtraFieldTypePluginBase.php, line 23

Namespace

Drupal\entity_extra_field
View source 
abstract class ExtraFieldTypePluginBase extends PluginBase implements ExtraFieldTypePluginInterface {
  use PluginDependencyTrait;

  /**
   * @var \Drupal\Core\Utility\Token
   */
  protected $token;

  /**
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $currentRouteMatch;

  /**
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * Extra field type view constructor.
   *
   * @param array $configuration
   *   The plugin configuration.
   * @param string $plugin_id
   *   The plugin identifier.
   * @param array $plugin_definition
   *   The plugin definition.
   * @param \Drupal\Core\Utility\Token $token
   *   The token service.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param \Drupal\Core\Routing\RouteMatchInterface $current_route_match
   *   The current route match service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager service.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   */
  public function __construct(array $configuration, string $plugin_id, array $plugin_definition, Token $token, ModuleHandlerInterface $module_handler, RouteMatchInterface $current_route_match, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->token = $token;
    $this->moduleHandler = $module_handler;
    $this->currentRouteMatch = $current_route_match;
    $this->entityTypeManager = $entity_type_manager;
    $this->entityFieldManager = $entity_field_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('token'), $container
      ->get('module_handler'), $container
      ->get('current_route_match'), $container
      ->get('entity_type.manager'), $container
      ->get('entity_field.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function label() : string {
    return $this->pluginDefinition['label'];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) : array {
    $form['#prefix'] = '<div id="extra-field-plugin">';
    $form['#suffix'] = '</div>';
    $form['#parents'] = [
      'field_type_config',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) : void {

    // Intentionally left empty on base class.
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) : void {
    $this->configuration = $form_state
      ->cleanValues()
      ->getValues();
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) : void {
    $this->configuration = $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() : array {
    return $this->configuration + $this
      ->defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() : array {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() : array {
    return $this->dependencies;
  }

  /**
   * Get extra field plugin ajax.
   *
   * @param array $form
   *   An array of form elements.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state instance.
   *
   * @return array
   *   An array of form elements.
   */
  public function extraFieldPluginAjaxCallback(array $form, FormStateInterface $form_state) : array {
    return $form['field_type_config'];
  }

  /**
   * Get extra field plugin ajax properties.
   *
   * @return array
   *   An array of common AJAX plugin properties.
   */
  protected function extraFieldPluginAjax() : array {
    return [
      'wrapper' => 'extra-field-plugin',
      'callback' => [
        $this,
        'extraFieldPluginAjaxCallback',
      ],
    ];
  }

  /**
   * Get target entity type identifier.
   *
   * @return string|null
   *   A target entity type identifier; otherwise NULL.
   */
  protected function getTargetEntityTypeId() : ?string {
    return $this->currentRouteMatch
      ->getParameter('entity_type_id') ?: NULL;
  }

  /**
   * Get target entity type bundle.
   *
   * @return \Drupal\Core\Entity\EntityInterface
   *   The target entity type bundle object.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function getTargetEntityTypeBundle() : EntityInterface {
    $entity_type_id = $this
      ->getTargetEntityTypeId();
    $bundle_entity_type = $bundle_entity_type = $this->entityTypeManager
      ->getDefinition($entity_type_id)
      ->getBundleEntityType();
    return $this->currentRouteMatch
      ->getParameter($bundle_entity_type);
  }

  /**
   * Get target entity type definition.
   *
   * @return \Drupal\Core\Entity\EntityTypeInterface
   *   The target entity type definition.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function getTargetEntityTypeDefinition() : EntityTypeInterface {
    return $this->entityTypeManager
      ->getDefinition($this
      ->getTargetEntityTypeId());
  }

  /**
   * Process the entity token text.
   *
   * @param string $text
   *   The text that contains the token.
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The entity that's related to the text; references are based off this.
   *
   * @return string
   *   The process entity token.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function processEntityToken(string $text, ContentEntityInterface $entity) : string {
    return $this->token
      ->replace($text, $this
      ->getEntityTokenData($entity), [
      'clear' => TRUE,
    ]);
  }

  /**
   * Get entity token types.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param string $entity_bundle
   *   The entity bundle name.
   *
   * @return array
   *   An array of the entity token types.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function getEntityTokenTypes(EntityTypeInterface $entity_type, string $entity_bundle) : array {
    $types = array_values($this
      ->getEntityFieldReferenceTypes($entity_type
      ->id(), $entity_bundle));
    $token_type = $entity_type
      ->get('token_type') ?? $entity_type
      ->id();
    if (!in_array($token_type, $types, TRUE)) {
      $types[] = $token_type;
    }
    return $types;
  }

  /**
   * Get entity token data.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The content entity instance.
   *
   * @return array
   *   An array of token data.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function getEntityTokenData(ContentEntityInterface $entity) : array {
    $token_type = $entity
      ->getEntityType()
      ->get('token_type') ?? $entity
      ->getEntityTypeId();
    $data[$token_type] = $entity;
    $field_references = $this
      ->getEntityFieldReferenceTypes($entity
      ->getEntityTypeId(), $entity
      ->bundle());
    foreach ($field_references as $field_name => $target_type) {
      if (isset($data[$target_type]) || !$entity
        ->hasField($field_name)) {
        continue;
      }
      $data[$target_type] = $entity->{$field_name}->entity;
    }
    return array_filter($data);
  }

  /**
   * Get entity field reference types.
   *
   * @param string $entity_type_id
   *   The entity type identifier.
   * @param string $entity_bundle
   *   The entity bundle name.
   *
   * @return array
   *   An array of reference types.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function getEntityFieldReferenceTypes(string $entity_type_id, string $entity_bundle) : array {
    $types = [];
    $fields = $this->entityFieldManager
      ->getFieldDefinitions($entity_type_id, $entity_bundle);
    foreach ($fields as $field_name => $field) {
      if ($field
        ->getType() !== 'entity_reference') {
        continue;
      }
      $definition = $field
        ->getFieldStorageDefinition();
      $target_type = $definition
        ->getSetting('target_type');
      if (!isset($target_type) || in_array($target_type, $types, TRUE)) {
        continue;
      }
      $type_definition = $this->entityTypeManager
        ->getDefinition($target_type);
      if (!$type_definition instanceof ContentEntityTypeInterface) {
        continue;
      }
      $types[$field_name] = $type_definition
        ->get('token_type') ?? $target_type;
    }
    return $types;
  }

  /**
   * Get plugin form state value.
   *
   * @param string|array $key
   *   The element key.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state instance.
   * @param mixed $default
   *   The default value if nothing is found.
   *
   * @return mixed
   *   The form value; otherwise FALSE if the value can't be found.
   */
  protected function getPluginFormStateValue($key, FormStateInterface $form_state, $default = NULL) {
    $key = !is_array($key) ? [
      $key,
    ] : $key;
    $inputs = [
      $form_state
        ->cleanValues()
        ->getValues(),
      $this
        ->getConfiguration(),
    ];
    foreach ($inputs as $input) {
      $value = NestedArray::getValue($input, $key, $key_exists);
      if (!isset($value) && !$key_exists) {
        continue;
      }
      return $value;
    }
    return $default;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
ExtraFieldTypePluginBase::$currentRouteMatch protected property
ExtraFieldTypePluginBase::$entityFieldManager protected property
ExtraFieldTypePluginBase::$entityTypeManager protected property
ExtraFieldTypePluginBase::$moduleHandler protected property
ExtraFieldTypePluginBase::$token protected property
ExtraFieldTypePluginBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 4
ExtraFieldTypePluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 2
ExtraFieldTypePluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 2
ExtraFieldTypePluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 4
ExtraFieldTypePluginBase::extraFieldPluginAjax protected function Get extra field plugin ajax properties.
ExtraFieldTypePluginBase::extraFieldPluginAjaxCallback public function Get extra field plugin ajax.
ExtraFieldTypePluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ExtraFieldTypePluginBase::getEntityFieldReferenceTypes protected function Get entity field reference types.
ExtraFieldTypePluginBase::getEntityTokenData protected function Get entity token data.
ExtraFieldTypePluginBase::getEntityTokenTypes protected function Get entity token types.
ExtraFieldTypePluginBase::getPluginFormStateValue protected function Get plugin form state value.
ExtraFieldTypePluginBase::getTargetEntityTypeBundle protected function Get target entity type bundle.
ExtraFieldTypePluginBase::getTargetEntityTypeDefinition protected function Get target entity type definition.
ExtraFieldTypePluginBase::getTargetEntityTypeId protected function Get target entity type identifier.
ExtraFieldTypePluginBase::label public function Display the extra field plugin label. Overrides ExtraFieldTypePluginInterface::label
ExtraFieldTypePluginBase::processEntityToken protected function Process the entity token text.
ExtraFieldTypePluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ExtraFieldTypePluginBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 1
ExtraFieldTypePluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
ExtraFieldTypePluginBase::__construct public function Extra field type view constructor. Overrides PluginBase::__construct 2
ExtraFieldTypePluginInterface::build public function Build the render array of the extra field type contents. 4
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.