[Summary view] [Print] [Text view]

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