You are here

Home » API reference » Apigee Edge 8 » KeyProviderRequirementsBase.php

abstract class KeyProviderRequirementsBase in Apigee Edge 8

Base class for key providers with pre-requirements.

Hierarchy

Expanded class hierarchy of KeyProviderRequirementsBase

File

src/Plugin/KeyProvider/KeyProviderRequirementsBase.php, line 35

Namespace

Drupal\apigee_edge\Plugin\KeyProvider
View source 
abstract class KeyProviderRequirementsBase extends KeyProviderBase implements KeyProviderRequirementsInterface {

  /**
   * The logger.
   *
   * @var \Drupal\Core\Logger\LoggerChannelInterface
   */
  private $logger;

  /**
   * KeyProviderRequirementsBase constructor.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Psr\Log\LoggerInterface $logger
   *   The logger.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, LoggerInterface $logger) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->logger = $logger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('logger.channel.apigee_edge'));
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    try {
      $this
        ->checkRequirements($form_state
        ->getFormObject()
        ->getEntity());
    } catch (KeyProviderRequirementsException $exception) {
      $form_state
        ->setError($form['settings']['provider_section']['key_provider'], $exception
        ->getTranslatableMarkupMessage());
    }
  }

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

    // Throwing an exception would be better than returning NULL but the key
    // module's design does not allow this.
    // Related issue: https://www.drupal.org/project/key/issues/3038212
    try {
      $this
        ->checkRequirements($key);
    } catch (KeyProviderRequirementsException $exception) {
      $context = [
        '@message' => (string) $exception,
      ];
      $context += Error::decodeException($exception);
      $this
        ->getLogger()
        ->error('Could not retrieve Apigee Edge authentication key value from the environment variables: @message %function (line %line of %file). <pre>@backtrace_string</pre>', $context);
      return NULL;
    }
    return $this
      ->realGetKeyValue($key);
  }

  /**
   * The method that returns a key's value after pre-requirements got validated.
   *
   * @param \Drupal\key\KeyInterface $key
   *   A key entity.
   */
  protected abstract function realGetKeyValue(KeyInterface $key);

  /**
   * Gets the logger service.
   *
   * @return \Psr\Log\LoggerInterface
   *   The logger service.
   */
  protected function getLogger() : LoggerInterface {

    // This fallback is needed when the plugin instance is serialized and the
    // property is null.
    return $this->logger ?? \Drupal::service('logger.channel.apigee_edge');
  }

}

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::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
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
KeyProviderRequirementsBase::$logger private property The logger.
KeyProviderRequirementsBase::create public static function Creates an instance of the plugin. Overrides KeyPluginBase::create 1
KeyProviderRequirementsBase::getKeyValue final public function Returns the value of a key. Overrides KeyProviderInterface::getKeyValue
KeyProviderRequirementsBase::getLogger protected function Gets the logger service.
KeyProviderRequirementsBase::realGetKeyValue abstract protected function The method that returns a key's value after pre-requirements got validated. 2
KeyProviderRequirementsBase::validateConfigurationForm public function
KeyProviderRequirementsBase::__construct public function KeyProviderRequirementsBase constructor. Overrides KeyPluginBase::__construct 1
KeyProviderRequirementsInterface::checkRequirements public function Checks the requirements of the key provider. 2
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.