interface KeyProviderInterface in Akamai 8.3

Interface for Key Providers.

Hierarchy

• interface \Drupal\akamai\KeyProviderInterface

3 files declare their use of KeyProviderInterface

AkamaiAuthenticationTest.php in tests/src/Unit/AkamaiAuthenticationTest.php

AkamaiClientV3Test.php in tests/src/Unit/AkamaiClientV3Test.php

ConfigForm.php in src/Form/ConfigForm.php

File

src/KeyProviderInterface.php, line 8

Namespace

Drupal\akamai

interface KeyProviderInterface {

  /**
   * Confirms if key.repository service exists.
   */
  public function hasKeyRepository();

  /**
   * Retrieves a key from the key module.
   *
   * @param string $key
   *   The id of the key to retrieve.
   *
   * @return string|null
   *   The key value on success, NULL on failure.
   *
   * @throws \Exception
   *   Indicates the key.repository service was not found.
   */
  public function getKey($key);

  /**
   * Retrieves all keys from the key module.
   *
   * @return array
   *   An array of valid keys.
   *
   * @throws \Exception
   *   Indicates the key.repository service was not found.
   */
  public function getKeys();

}

Members

Name	Modifiers	Type	Description	Overrides
KeyProviderInterface::getKey	public	function	Retrieves a key from the key module.	1
KeyProviderInterface::getKeys	public	function	Retrieves all keys from the key module.	1
KeyProviderInterface::hasKeyRepository	public	function	Confirms if key.repository service exists.	1