class LockrKeyProvider in Lockr 8.2

Same name and namespace in other branches

8.4 src/Plugin/KeyProvider/LockrKeyProvider.php \Drupal\lockr\Plugin\KeyProvider\LockrKeyProvider
8.3 src/Plugin/KeyProvider/LockrKeyProvider.php \Drupal\lockr\Plugin\KeyProvider\LockrKeyProvider
4.x src/Plugin/KeyProvider/LockrKeyProvider.php \Drupal\lockr\Plugin\KeyProvider\LockrKeyProvider

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

Plugin annotation


@KeyProvider(
  id = "lockr",
  label = "Lockr",
  description = @Translation("The Lockr key provider stores the key in Lockr key management service."),
  storage_method = "lockr",
  key_value = {
    "accepted" = TRUE,
    "required" = TRUE
  }
)

View source

class LockrKeyProvider extends KeyProviderBase implements KeyProviderSettableValueInterface, KeyPluginFormInterface {
  protected $client;
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ClientFactory $client_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->clientFactory = $client_factory;
  }
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('lockr.client_factory'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $site_client = $this->clientFactory
      ->getSiteClient();
    $status = $site_client
      ->exists();
    if (!$status['exists']) {
      $form['need_register'] = [
        '#prefix' => '<p>',
        '#markup' => $this
          ->t('This site has not yet registered with Lockr, please <a href="@link">click here to register</a>.', [
          '@link' => Url::fromRoute('lockr.admin')
            ->toString(),
        ]),
        '#suffix' => '</p>',
      ];
    }
    return $form;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getKeyValue(KeyInterface $key) {
    $name = $key
      ->id();
    $encoded = $this
      ->getConfiguration()['encoded'];
    $key_client = $this->clientFactory
      ->getKeyClient();
    return $key_client
      ->encrypted($encoded)
      ->get($name);
  }

  /**
   * {@inheritdoc}
   */
  public function setKeyValue(KeyInterface $key, $key_value) {
    $name = $key
      ->id();
    $label = $key
      ->label();
    $encoded = $this
      ->getConfiguration()['encoded'] ?: NULL;
    $key_client = $this->clientFactory
      ->getKeyClient();
    $encoded = $key_client
      ->encrypted()
      ->set($name, $key_value, $label, $encoded);
    if ($encoded) {
      $this
        ->setConfiguration([
        'encoded' => $encoded,
      ]);
      return TRUE;
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function deleteKeyValue(KeyInterface $key) {
    $name = $key
      ->id();
    $key_client = $this->clientFactory
      ->getKeyClient();
    return $key_client
      ->delete($name);
  }

}

Members

Name	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::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
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
LockrKeyProvider::$client	protected	property
LockrKeyProvider::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
LockrKeyProvider::create	public static	function	Creates an instance of the plugin. Overrides KeyPluginBase::create
LockrKeyProvider::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides KeyPluginBase::defaultConfiguration
LockrKeyProvider::deleteKeyValue	public	function	Deletes the value of a key. Overrides KeyProviderSettableValueInterface::deleteKeyValue
LockrKeyProvider::getKeyValue	public	function	Returns the value of a key. Overrides KeyProviderInterface::getKeyValue
LockrKeyProvider::setKeyValue	public	function	Sets the value of a key. Overrides KeyProviderSettableValueInterface::setKeyValue
LockrKeyProvider::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
LockrKeyProvider::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
LockrKeyProvider::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides KeyPluginBase::__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.
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.

You are here

class LockrKeyProvider in Lockr 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation