You are here

Home » API reference » UI Patterns Settings 8.2 » TokenSettingTypeBase.php

abstract class TokenSettingTypeBase in UI Patterns Settings 8.2

Same name and namespace in other branches
  1. 8 src/Plugin/TokenSettingTypeBase.php \Drupal\ui_patterns_settings\Plugin\TokenSettingTypeBase

Base class for setting types with tokens.

Hierarchy

Expanded class hierarchy of TokenSettingTypeBase

2 files declare their use of TokenSettingTypeBase
TokenSettingType.php in src/Plugin/UiPatterns/SettingType/TokenSettingType.php
UrlSettingType.php in src/Plugin/UiPatterns/SettingType/UrlSettingType.php

File

src/Plugin/TokenSettingTypeBase.php, line 14

Namespace

Drupal\ui_patterns_settings\Plugin
View source 
abstract class TokenSettingTypeBase extends PatternSettingTypeBase implements ContainerFactoryPluginInterface {

  /**
   * The token service.
   *
   * @var \Drupal\Core\Utility\Token
   */
  protected $tokenService;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $plugin = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $plugin
      ->setTokenService($container
      ->get('token'));
    return $plugin;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, $value, PatternDefinitionSetting $def, $form_type) {
    $def = $this
      ->getPatternSettingDefinition();
    $value = $this
      ->getValue($value);
    $description = $def
      ->getDescription() != NULL ? $def
      ->getDescription() : "";
    $form[$def
      ->getName()] = [
      '#type' => 'container',
    ];
    $form[$def
      ->getName()]['input'] = [
      '#type' => 'textfield',
      '#title' => $def
        ->getLabel(),
      '#description' => $description,
      '#default_value' => $this
        ->getValue($value),
      '#attributes' => [
        'class' => [
          'js-ui-patterns-settings-show-token-link',
        ],
      ],
    ];
    $this
      ->handleInput($form[$def
      ->getName()]['input'], $def, $form_type);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsPreprocess($value, array $context, PatternDefinitionSetting $def) {
    $return_value = '';
    if (isset($value['input'])) {
      $value = $value['input'];
    }
    if (is_string($value)) {
      $token_data = [];

      /** @var \Drupal\Core\Entity\EntityInterface $entity */
      $entity = isset($context['entity']) ? $context['entity'] : NULL;
      if ($entity !== NULL) {
        $token_data[$entity
          ->getEntityTypeId()] = $entity;
      }
      try {
        $return_value = $this
          ->getTokenService()
          ->replace($value, $token_data, [
          'clear' => TRUE,
        ]);
      } catch (EntityMalformedException $e) {
        if (!ui_patterns_settings_is_layout_builder_route()) {
          throw $e;
        }

        // Do nothing inside layout builder.
      }
    }
    return $return_value;
  }

  /**
   * Sets the token service.
   *
   * @param \Drupal\Core\Utility\Token $token_service
   *   The token service.
   *
   * @return self
   *   The token service.
   */
  public function setTokenService(Token $token_service) {
    $this->tokenService = $token_service;
    return $this;
  }

  /**
   * Gets the token service.
   *
   * @return \Drupal\Core\Utility\Token
   *   The token service.
   */
  public function getTokenService() {
    if (!$this->tokenService) {
      $this->tokenService = \Drupal::token();
    }
    return $this->tokenService;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PatternSettingTypeBase::$entityTypeManager protected property Return pattern definitions for setting .
PatternSettingTypeBase::$moduleHandler private property The module handler.
PatternSettingTypeBase::$patternDefinition private property Return pattern definitions for setting .
PatternSettingTypeBase::$patternSettingDefinition private property Return pattern definitions for setting .
PatternSettingTypeBase::alterFieldStorage public function Alter the storage of a connected field storage. Overrides PatternSettingTypeInterface::alterFieldStorage 1
PatternSettingTypeBase::buildConfigurationForm public function Creates a generic configuration form for all settings types. Individual settings plugins can add elements to this form by overriding PatternSettingTypeBaseInterface::settingsForm(). Most plugins should not override this method unless they need to… Overrides PatternSettingTypeInterface::buildConfigurationForm
PatternSettingTypeBase::calculateDependencies public function
PatternSettingTypeBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
PatternSettingTypeBase::fieldStorageExposableTypes public function Returns the list to matching field types. Overrides PatternSettingTypeInterface::fieldStorageExposableTypes 2
PatternSettingTypeBase::formGroupProcess public static function Set the right group before drupal #group attribute is processed.
PatternSettingTypeBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PatternSettingTypeBase::getDescription public function
PatternSettingTypeBase::getPatternSettingDefinition protected function Return pattern setting definition.
PatternSettingTypeBase::getSettingTypeDependencies protected function Returns a list of plugin dependencies. 2
PatternSettingTypeBase::getValue protected function Return value if set otherwise take the default value. 1
PatternSettingTypeBase::handleInput protected function Add validation and basics classes to the raw input field. 1
PatternSettingTypeBase::label public function
PatternSettingTypeBase::preprocess public function Returns the processed setting variable. Overrides PatternSettingTypeInterface::preprocess 1
PatternSettingTypeBase::preprocessExposedField public function Returns the processed setting variable for an exposed field. Overrides PatternSettingTypeInterface::preprocessExposedField 1
PatternSettingTypeBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
PatternSettingTypeBase::tokenForm protected function Returns the bind form field.
PatternSettingTypeBase::validateLayout public static function Check required input fields in layout forms.
PatternSettingTypeBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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 3
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.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.
TokenSettingTypeBase::$tokenService protected property The token service.
TokenSettingTypeBase::create public static function Creates an instance of the plugin. Overrides PatternSettingTypeBase::create
TokenSettingTypeBase::getTokenService public function Gets the token service.
TokenSettingTypeBase::settingsForm public function Returns the configuration form elements specific to this settings plugin.. Overrides PatternSettingTypeInterface::settingsForm
TokenSettingTypeBase::settingsPreprocess public function Preprocess setting variable. Overrides PatternSettingTypeBase::settingsPreprocess 1
TokenSettingTypeBase::setTokenService public function Sets the token service.