interface Oauth2ClientPluginAccessInterface in OAuth2 Client 8.3

An interface for plugins that provide route access methods.

@package Drupal\oauth2_client\Plugin\Oauth2Client

Hierarchy

• interface \Drupal\oauth2_client\Plugin\Oauth2Client\Oauth2ClientPluginAccessInterface

2 files declare their use of Oauth2ClientPluginAccessInterface

AuthCodeAccessExample.php in examples/oauth2_client_example_plugins/src/Plugin/Oauth2Client/AuthCodeAccessExample.php

RouteAccess.php in src/Access/RouteAccess.php

File

src/Plugin/Oauth2Client/Oauth2ClientPluginAccessInterface.php, line 12

Namespace

Drupal\oauth2_client\Plugin\Oauth2Client

interface Oauth2ClientPluginAccessInterface {

  /**
   * Override the default access with this method.
   *
   * The sole route that checks this method is `oauth2_client.code` which
   * captures the returned authorization code from the remote service for
   * plugins that implement the grant type of the same name.  If you are
   * implementing the authorization_code grant and the default, permission
   * controlled access meets your use case, then you can simply implement
   * Oauth2ClientPluginInterface.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Access is checked against this account.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   */
  public function codeRouteAccess(AccountInterface $account);

}

Members

Name	Modifiers	Type	Description	Overrides
Oauth2ClientPluginAccessInterface::codeRouteAccess	public	function	Override the default access with this method.	1