class ExtraFieldTokenPlugin in Entity Extra Field 2.0.x

Same name and namespace in other branches

8 src/Plugin/ExtraFieldType/ExtraFieldTokenPlugin.php \Drupal\entity_extra_field\Plugin\ExtraFieldType\ExtraFieldTokenPlugin

Define extra field token plugin.

Plugin annotation


@ExtraFieldType(
  id = "token",
  label = @Translation("Token")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\entity_extra_field\ExtraFieldTypePluginBase implements ExtraFieldTypePluginInterface uses PluginDependencyTrait
    class \Drupal\entity_extra_field\Plugin\ExtraFieldType\ExtraFieldTokenPlugin

Expanded class hierarchy of ExtraFieldTokenPlugin

File

src/Plugin/ExtraFieldType/ExtraFieldTokenPlugin.php, line 19

Namespace

Drupal\entity_extra_field\Plugin\ExtraFieldType

View source

class ExtraFieldTokenPlugin extends ExtraFieldTypePluginBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() : array {
    return [
      'type' => NULL,
      'token' => NULL,
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) : array {
    $form = parent::buildConfigurationForm($form, $form_state);
    $type = $this
      ->getPluginFormStateValue('type', $form_state);
    $form['type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Type'),
      '#required' => TRUE,
      '#options' => [
        'textfield' => $this
          ->t('Text Field'),
        'text_format' => $this
          ->t('Text Format'),
      ],
      '#empty_empty' => $this
        ->t('- Select -'),
      '#default_value' => $type,
      '#ajax' => [
        'event' => 'change',
        'method' => 'replace',
      ] + $this
        ->extraFieldPluginAjax(),
    ];
    if (isset($type) && !empty($type)) {
      $configuration = $this
        ->getConfiguration();
      $form['token'] = [
        '#type' => $type,
        '#title' => $this
          ->t('Token Value'),
        '#default_value' => is_array($configuration['token']) ? $configuration['token']['value'] : $configuration['token'],
      ];
      if ($type === 'text_format' && isset($configuration['token']['format'])) {
        $form['token']['#format'] = $configuration['token']['format'];
      }
      if ($this->moduleHandler
        ->moduleExists('token')) {
        $form['token_replacements'] = [
          '#theme' => 'token_tree_link',
          '#token_types' => $this
            ->getEntityTokenTypes($this
            ->getTargetEntityTypeDefinition(), $this
            ->getTargetEntityTypeBundle()
            ->id()),
        ];
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function build(EntityInterface $entity, EntityDisplayInterface $display) : array {
    $build = [];
    if ($entity instanceof ContentEntityInterface) {
      $token_value = $this
        ->getProcessedTokenValue($entity);
      switch ($this
        ->getTokenTextType()) {
        case 'textfield':
          $build = [
            '#plain_text' => $token_value,
          ];
          break;
        case 'text_format':
          $build = [
            '#type' => 'processed_text',
            '#text' => $token_value,
            '#format' => $this
              ->getTokenTextFormat(),
          ];
          break;
      }
    }
    return $build;
  }

  /**
   * Get token text type.
   *
   * @return string
   *   The token text type.
   */
  protected function getTokenTextType() : ?string {
    return $this
      ->getConfiguration()['type'] ?? NULL;
  }

  /**
   * Get token text format.
   *
   * @return string
   *   The token text format.
   */
  protected function getTokenTextFormat() : ?string {
    return $this
      ->getConfiguration()['token']['format'] ?? NULL;
  }

  /**
   * Get processed token value token.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The content entity.
   *
   * @return string
   *   The process token value.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function getProcessedTokenValue(ContentEntityInterface $entity) : string {
    $configuration = $this
      ->getConfiguration();
    $token_value = is_array($configuration['token']) ? $configuration['token']['value'] : $configuration['token'];
    return $this
      ->processEntityToken($token_value, $entity);
  }

}

Members

Name	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.
ExtraFieldTokenPlugin::build	public	function	Build the render array of the extra field type contents. Overrides ExtraFieldTypePluginInterface::build
ExtraFieldTokenPlugin::buildConfigurationForm	public	function	Form constructor. Overrides ExtraFieldTypePluginBase::buildConfigurationForm
ExtraFieldTokenPlugin::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ExtraFieldTypePluginBase::defaultConfiguration
ExtraFieldTokenPlugin::getProcessedTokenValue	protected	function	Get processed token value token.
ExtraFieldTokenPlugin::getTokenTextFormat	protected	function	Get token text format.
ExtraFieldTokenPlugin::getTokenTextType	protected	function	Get token text type.
ExtraFieldTypePluginBase::$currentRouteMatch	protected	property
ExtraFieldTypePluginBase::$entityFieldManager	protected	property
ExtraFieldTypePluginBase::$entityTypeManager	protected	property
ExtraFieldTypePluginBase::$moduleHandler	protected	property
ExtraFieldTypePluginBase::$token	protected	property
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::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
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.

You are here

class ExtraFieldTokenPlugin in Entity Extra Field 2.0.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation