[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  namespace OAuth\OAuth2\Service;
   4  
   5  use OAuth\Common\Consumer\CredentialsInterface;
   6  use OAuth\Common\Storage\TokenStorageInterface;
   7  use OAuth\Common\Token\TokenInterface;
   8  use OAuth\Common\Http\Client\ClientInterface;
   9  use OAuth\Common\Http\Exception\TokenResponseException;
  10  use OAuth\Common\Service\ServiceInterface as BaseServiceInterface;
  11  use OAuth\Common\Http\Uri\UriInterface;
  12  
  13  /**
  14   * Defines the common methods across OAuth 2 services.
  15   */
  16  interface ServiceInterface extends BaseServiceInterface
  17  {
  18      /**
  19       * Authorization methods for various services
  20       */
  21      const AUTHORIZATION_METHOD_HEADER_OAUTH    = 0;
  22      const AUTHORIZATION_METHOD_HEADER_BEARER   = 1;
  23      const AUTHORIZATION_METHOD_QUERY_STRING    = 2;
  24      const AUTHORIZATION_METHOD_QUERY_STRING_V2 = 3;
  25      const AUTHORIZATION_METHOD_QUERY_STRING_V3 = 4;
  26      const AUTHORIZATION_METHOD_QUERY_STRING_V4 = 5;
  27  
  28      /**
  29       * Retrieves and stores/returns the OAuth2 access token after a successful authorization.
  30       *
  31       * @param string $code The access code from the callback.
  32       * @param string $state
  33       *
  34       * @return TokenInterface $token
  35       *
  36       * @throws TokenResponseException
  37       */
  38      public function requestAccessToken($code, $state = null);
  39  }