You are here

Home » API reference » Key 8 » KeyInputBase.php

abstract class KeyInputBase in Key 8

Defines a base class for Key Type plugins.

Hierarchy

Expanded class hierarchy of KeyInputBase

4 files declare their use of KeyInputBase
GenerateKeyInput.php in src/Plugin/KeyInput/GenerateKeyInput.php
MutliValueKeyInput.php in tests/modules/key_test/src/Plugin/KeyInput/MutliValueKeyInput.php
NoneKeyInput.php in src/Plugin/KeyInput/NoneKeyInput.php
TextFieldKeyInput.php in src/Plugin/KeyInput/TextFieldKeyInput.php

File

src/Plugin/KeyInputBase.php, line 10

Namespace

Drupal\key\Plugin
View source 
abstract class KeyInputBase extends KeyPluginBase implements KeyInputInterface, KeyPluginFormInterface {

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

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this
      ->setConfiguration($form_state
      ->getValues());
  }

  /**
   * {@inheritdoc}
   */
  public function processSubmittedKeyValue(FormStateInterface $form_state) {

    // This is the default behavior. If a field named 'key_value' exists in
    // the key input settings, remove it from the settings and return it as
    // the submitted value. If the key value is Base64-encoded, decode it and
    // return the result as the processed_submitted value. Input plugins can
    // override this behavior to perform more complex processing.
    $processed_values = [
      'submitted' => NULL,
      'processed_submitted' => NULL,
    ];
    $key_input_settings = $form_state
      ->getValues();
    $key_value_data = $form_state
      ->get('key_value');
    if (isset($key_input_settings['key_value'])) {

      // If the submitted key value is not empty and equal to the obscured
      // value.
      if (!empty($key_input_settings['key_value']) && $key_input_settings['key_value'] == $key_value_data['obscured']) {

        // Use the processed original value as the submitted value.
        $processed_values['submitted'] = $key_value_data['processed_original'];
      }
      else {
        $processed_values['submitted'] = $key_input_settings['key_value'];
      }
      if (isset($key_input_settings['base64_encoded']) && $key_input_settings['base64_encoded'] == TRUE) {
        $processed_values['processed_submitted'] = base64_decode($processed_values['submitted']);
      }
      else {
        $processed_values['processed_submitted'] = $processed_values['submitted'];
      }
      unset($key_input_settings['key_value']);
      $form_state
        ->setValues($key_input_settings);
    }
    return $processed_values;
  }

  /**
   * {@inheritdoc}
   */
  public function processExistingKeyValue($key_value) {

    // This is the default behavior. The key value is Base64-encoded if
    // it was originally submitted with Base64 encoding. Otherwise, it is
    // returned as-is.
    if (isset($this->configuration['base64_encoded']) && $this->configuration['base64_encoded'] == TRUE) {
      $processed_value = base64_encode($key_value);
    }
    else {
      $processed_value = $key_value;
    }
    return $processed_value;
  }

}

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
KeyInputBase::processExistingKeyValue public function Process an existing key value. Overrides KeyInputInterface::processExistingKeyValue 1
KeyInputBase::processSubmittedKeyValue public function Process a submitted key value. Overrides KeyInputInterface::processSubmittedKeyValue 2
KeyInputBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
KeyInputBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
KeyPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
KeyPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
KeyPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 8
KeyPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
KeyPluginBase::getPluginType public function Returns the type of plugin. Overrides KeyPluginInterface::getPluginType
KeyPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
KeyPluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 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.
PluginFormInterface::buildConfigurationForm public function Form constructor. 36
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.