You are here

Home » API reference » Key 8 » KeyProviderBase.php

abstract class KeyProviderBase in Key 8

Defines a base class for Key Provider plugins.

Hierarchy

Expanded class hierarchy of KeyProviderBase

4 files declare their use of KeyProviderBase
ConfigKeyProvider.php in src/Plugin/KeyProvider/ConfigKeyProvider.php
EnvKeyProvider.php in src/Plugin/KeyProvider/EnvKeyProvider.php
FileKeyProvider.php in src/Plugin/KeyProvider/FileKeyProvider.php
State.php in tests/modules/key_test/src/Plugin/KeyProvider/State.php

File

src/Plugin/KeyProviderBase.php, line 11

Namespace

Drupal\key\Plugin
View source 
abstract class KeyProviderBase extends KeyPluginBase implements KeyProviderInterface {

  /**
   * {@inheritdoc}
   */
  public static function obscureKeyValue($key_value, array $options = []) {
    switch ($options['key_type_group']) {
      case 'authentication':
        $options['visible_right'] = 4;
        $obscured_value = static::obscureValue($key_value, $options);
        break;
      case 'encryption':
        $options['visible_right'] = 0;
        $options['fixed_length'] = 30;
        $obscured_value = static::obscureValue($key_value, $options);
        break;
      default:
        $obscured_value = $key_value;
    }
    return $obscured_value;
  }

  /**
   * Helper method to obscure a value.
   *
   * @param string $key_value
   *   The key value to obscure.
   * @param array $options
   *   Options to use when obscuring the value.
   *
   * @return string
   *   The obscured key value.
   */
  protected static function obscureValue($key_value, array $options = []) {

    // Add default options.
    $options += [
      'replacement_character' => '*',
      'fixed_length' => '',
      'visible_right' => 4,
    ];
    if ($options['visible_right'] > 0) {
      $visible_right_chars = substr($key_value, $options['visible_right'] * -1);
    }
    else {
      $visible_right_chars = '';
    }
    $obscured_chars = '';
    if ($options['fixed_length']) {
      $obscured_chars = str_repeat($options['replacement_character'], $options['fixed_length'] - $options['visible_right']);
    }
    elseif (strlen($key_value) - $options['visible_right'] > 0) {
      $obscured_chars = str_repeat($options['replacement_character'], strlen($key_value) - $options['visible_right']);
    }
    return $obscured_chars . $visible_right_chars;
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(KeyInterface $key, EntityStorageInterface $storage, $update = TRUE) {

    // Post-save actions are optional.
  }

}

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
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
KeyProviderBase::obscureKeyValue public static function Obscures a key value. Overrides KeyProviderInterface::obscureKeyValue 1
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
KeyProviderInterface::getKeyValue public function Returns the value of a key. 4
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.