class KeyProviderRequirementsException in Apigee Edge 8

Defines an exception for Apigee Edge key provider problems.

Hierarchy

• class \Drupal\apigee_edge\Exception\RuntimeException implements ApigeeEdgeExceptionInterface
  • class \Drupal\apigee_edge\Exception\RuntimeException implements ApigeeEdgeExceptionInterface
    • class \Drupal\apigee_edge\Exception\KeyProviderRequirementsException

5 files declare their use of KeyProviderRequirementsException

AuthenticationForm.php in src/Form/AuthenticationForm.php

EnvironmentVariablesKeyProvider.php in src/Plugin/KeyProvider/EnvironmentVariablesKeyProvider.php

KeyEntityFormEnhancer.php in src/KeyEntityFormEnhancer.php

KeyProviderRequirementsBase.php in src/Plugin/KeyProvider/KeyProviderRequirementsBase.php

PrivateFileKeyProvider.php in src/Plugin/KeyProvider/PrivateFileKeyProvider.php

File

src/Exception/KeyProviderRequirementsException.php, line 28

Namespace

Drupal\apigee_edge\Exception

class KeyProviderRequirementsException extends RuntimeException {

  /**
   * The TranslatableMarkup object containing a message to render on the UI.
   *
   * @var \Drupal\Core\StringTranslation\TranslatableMarkup
   */
  protected $translatableMarkupMessage;

  /**
   * KeyProviderRequirementsException constructor.
   *
   * @param string $message
   *   The Exception message.
   * @param \Drupal\Core\StringTranslation\TranslatableMarkup $translatable_markup_message
   *   The translatable markup object of the exception to display on the pages
   *   where the exception is caught.
   * @param int|null $code
   *   The error code.
   * @param \Throwable|null $previous
   *   The previous throwable used for the exception chaining.
   */
  public function __construct(string $message, TranslatableMarkup $translatable_markup_message = NULL, int $code = 0, \Throwable $previous = NULL) {
    $this->translatableMarkupMessage = $translatable_markup_message;
    parent::__construct($message, $code, $previous);
  }

  /**
   * Gets the translatable markup object.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The translatable markup object.
   */
  public function getTranslatableMarkupMessage() : TranslatableMarkup {
    return $this->translatableMarkupMessage ?? $this
      ->t('Key provider error: @error', [
      '@error' => $this->message,
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
KeyProviderRequirementsException::$translatableMarkupMessage	protected	property	The TranslatableMarkup object containing a message to render on the UI.
KeyProviderRequirementsException::getTranslatableMarkupMessage	public	function	Gets the translatable markup object.
KeyProviderRequirementsException::__construct	public	function	KeyProviderRequirementsException constructor.