You are here

Home » API reference » Key 8 » ConfigKeyProvider.php

class ConfigKeyProvider in Key 8

Adds a key provider that allows a key to be stored in configuration.

Plugin annotation


@KeyProvider(
  id = "config",
  label = @Translation("Configuration"),
  description = @Translation("The Configuration key provider stores the key in Drupal's configuration system."),
  storage_method = "config",
  key_value = {
    "accepted" = TRUE,
    "required" = FALSE
  }
)

Hierarchy

Expanded class hierarchy of ConfigKeyProvider

1 file declares its use of ConfigKeyProvider
KeyEntityTest.php in tests/src/Unit/Entity/KeyEntityTest.php

File

src/Plugin/KeyProvider/ConfigKeyProvider.php, line 26

Namespace

Drupal\key\Plugin\KeyProvider
View source 
class ConfigKeyProvider extends KeyProviderBase implements KeyPluginFormInterface, KeyProviderSettableValueInterface {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'base64_encoded' => FALSE,
    ];
  }

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

    // If this key type is for an encryption key.
    if ($form_state
      ->getFormObject()
      ->getEntity()
      ->getKeyType()
      ->getPluginDefinition()['group'] == 'encryption') {

      // Add an option to indicate that the value is stored Base64-encoded.
      $form['base64_encoded'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Base64-encoded'),
        '#description' => $this
          ->t('Checking this will store the key with Base64 encoding.'),
        '#default_value' => isset($this
          ->getConfiguration()['base64_encoded']) ? $this
          ->getConfiguration()['base64_encoded'] : $this
          ->defaultConfiguration()['base64_encoded'],
      ];
    }
    return $form;
  }

  /**
   * {@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 getKeyValue(KeyInterface $key) {
    $key_value = isset($this->configuration['key_value']) ? $this->configuration['key_value'] : '';
    if (isset($this->configuration['base64_encoded']) && $this->configuration['base64_encoded'] == TRUE) {
      $key_value = base64_decode($key_value);
    }
    return $key_value;
  }

  /**
   * {@inheritdoc}
   */
  public function setKeyValue(KeyInterface $key, $key_value) {
    if (isset($this->configuration['base64_encoded']) && $this->configuration['base64_encoded'] == TRUE) {
      $key_value = base64_encode($key_value);
    }
    $this->configuration['key_value'] = $key_value;
    if (isset($this->configuration['key_value'])) {
      return TRUE;
    }
    else {
      throw new KeyValueNotSetException();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function deleteKeyValue(KeyInterface $key) {

    // Nothing needs to be done, since the value will have been deleted
    // with the Key entity.
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public static function obscureKeyValue($key_value, array $options = []) {

    // Key values are not obscured when this provider is used.
    return $key_value;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigKeyProvider::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
ConfigKeyProvider::defaultConfiguration public function Gets default configuration for this plugin. Overrides KeyPluginBase::defaultConfiguration
ConfigKeyProvider::deleteKeyValue public function Deletes the value of a key. Overrides KeyProviderSettableValueInterface::deleteKeyValue
ConfigKeyProvider::getKeyValue public function Returns the value of a key. Overrides KeyProviderInterface::getKeyValue
ConfigKeyProvider::obscureKeyValue public static function Obscures a key value. Overrides KeyProviderBase::obscureKeyValue
ConfigKeyProvider::setKeyValue public function Sets the value of a key. Overrides KeyProviderSettableValueInterface::setKeyValue
ConfigKeyProvider::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ConfigKeyProvider::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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
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::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
KeyProviderBase::obscureValue protected static function Helper method to obscure a value.
KeyProviderBase::postSave public function Allows a key provider to perform actions after a key entity is saved. Overrides KeyProviderInterface::postSave
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.
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.