interface ClientAuthorizationInterface in Entity Share 8.3

Defines an interface for Client authorization plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\ConfigurableInterface
  • interface \Drupal\entity_share_client\ClientAuthorization\ClientAuthorizationInterface

8 files declare their use of ClientAuthorizationInterface

EntityShareClientFunctionalTestBase.php in modules/entity_share_client/tests/src/Functional/EntityShareClientFunctionalTestBase.php

entity_share_client.install in modules/entity_share_client/entity_share_client.install

entity_share_client.module in modules/entity_share_client/entity_share_client.module

KeyProvider.php in modules/entity_share_client/src/Service/KeyProvider.php

Remote.php in modules/entity_share_client/src/Entity/Remote.php

... See full list

File

modules/entity_share_client/src/ClientAuthorization/ClientAuthorizationInterface.php, line 14

Namespace

Drupal\entity_share_client\ClientAuthorization

interface ClientAuthorizationInterface extends PluginInspectionInterface, PluginFormInterface, ConfigurableInterface {

  /**
   * The collection ID of for authorization config local storage.
   */
  const LOCAL_STORAGE_KEY_VALUE_COLLECTION = 'entity_share_client.client_authorization';

  /**
   * Gets the plugin label.
   *
   * @return string
   *   The plugin label.
   */
  public function getLabel();

  /**
   * Returns true if the plugin method is supported.
   *
   * The method could be in core, or it could require a contrib module.
   *
   * @return bool
   *   Is this plugin available?
   */
  public function checkIfAvailable();

  /**
   * Prepares a guzzle client for JSON operations with the supported auth.
   *
   * @param string $url
   *   The remote url.
   *
   * @return \GuzzleHttp\Client
   *   The HTTP client.
   */
  public function getJsonApiClient($url);

  /**
   * Prepares a guzzle client for http operations with the supported auth.
   *
   * @param string $url
   *   The url to set in the client.
   *
   * @return \GuzzleHttp\Client
   *   The HTTP client.
   */
  public function getClient($url);

  /**
   * Returns the plugin data if it is set, otherwise returns NULL.
   *
   * @return string|null
   *   The data.
   */
  public function getCredentialProvider();

  /**
   * Returns the plugin data if it is set, otherwise returns NULL.
   *
   * @return mixed|null
   *   The data.
   */
  public function getStorageKey();

}

Members

Name	Modifiers	Type	Description	Overrides
ClientAuthorizationInterface::checkIfAvailable	public	function	Returns true if the plugin method is supported.	4
ClientAuthorizationInterface::getClient	public	function	Prepares a guzzle client for http operations with the supported auth.	4
ClientAuthorizationInterface::getCredentialProvider	public	function	Returns the plugin data if it is set, otherwise returns NULL.	1
ClientAuthorizationInterface::getJsonApiClient	public	function	Prepares a guzzle client for JSON operations with the supported auth.	4
ClientAuthorizationInterface::getLabel	public	function	Gets the plugin label.	1
ClientAuthorizationInterface::getStorageKey	public	function	Returns the plugin data if it is set, otherwise returns NULL.	1
ClientAuthorizationInterface::LOCAL_STORAGE_KEY_VALUE_COLLECTION		constant	The collection ID of for authorization config local storage.
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2