interface Oauth2ClientPluginRedirectInterface in OAuth2 Client 8.3

An interface for plugins that provides a redirection method.

@package Drupal\oauth2_client\Plugin\Oauth2Client

Hierarchy

• interface \Drupal\oauth2_client\Plugin\Oauth2Client\Oauth2ClientPluginRedirectInterface

2 files declare their use of Oauth2ClientPluginRedirectInterface

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

AuthorizationCodeGrantService.php in src/Service/Grant/AuthorizationCodeGrantService.php

File

src/Plugin/Oauth2Client/Oauth2ClientPluginRedirectInterface.php, line 10

Namespace

Drupal\oauth2_client\Plugin\Oauth2Client

interface Oauth2ClientPluginRedirectInterface {

  /**
   * Override the default redirection with this method.
   *
   * The sole grant service that uses this redirection is authorization
   * code. If you are implementing the authorization_code grant and the default
   * in AuthorizationCodeGrantService::getPostCaptureRedirect does not meet
   * your needs,then you can implement both Oauth2ClientPluginInterface along
   * with this interface.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   The redirect response.
   */
  public function getPostCaptureRedirect();

}

Members

Name	Modifiers	Type	Description	Overrides
Oauth2ClientPluginRedirectInterface::getPostCaptureRedirect	public	function	Override the default redirection with this method.	1