[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  namespace OAuth\Common\Storage;
   4  
   5  use OAuth\Common\Token\TokenInterface;
   6  
   7  /**
   8   * All token storage providers must implement this interface.
   9   */
  10  interface TokenStorageInterface
  11  {
  12      /**
  13       * @param string $service
  14       *
  15       * @return TokenInterface
  16       */
  17      public function retrieveAccessToken($service);
  18  
  19      /**
  20       * @param string         $service
  21       *
  22       * @return TokenStorageInterface
  23       */
  24      public function storeAccessToken($service, TokenInterface $token);
  25  
  26      /**
  27       * @param string $service
  28       *
  29       * @return bool
  30       */
  31      public function hasAccessToken($service);
  32  
  33      /**
  34       * Delete the users token. Aka, log out.
  35       *
  36       * @param string $service
  37       *
  38       * @return TokenStorageInterface
  39       */
  40      public function clearToken($service);
  41  
  42      /**
  43       * Delete *ALL* user tokens. Use with care. Most of the time you will likely
  44       * want to use clearToken() instead.
  45       *
  46       * @return TokenStorageInterface
  47       */
  48      public function clearAllTokens();
  49  
  50      /**
  51       * Store the authorization state related to a given service.
  52       *
  53       * @param string $service
  54       * @param string $state
  55       *
  56       * @return TokenStorageInterface
  57       */
  58      public function storeAuthorizationState($service, $state);
  59  
  60      /**
  61       * Check if an authorization state for a given service exists.
  62       *
  63       * @param string $service
  64       *
  65       * @return bool
  66       */
  67      public function hasAuthorizationState($service);
  68  
  69      /**
  70       * Retrieve the authorization state for a given service.
  71       *
  72       * @param string $service
  73       *
  74       * @return string
  75       */
  76      public function retrieveAuthorizationState($service);
  77  
  78      /**
  79       * Clear the authorization state of a given service.
  80       *
  81       * @param string $service
  82       *
  83       * @return TokenStorageInterface
  84       */
  85      public function clearAuthorizationState($service);
  86  
  87      /**
  88       * Delete *ALL* user authorization states. Use with care. Most of the time you will likely
  89       * want to use clearAuthorization() instead.
  90       *
  91       * @return TokenStorageInterface
  92       */
  93      public function clearAllAuthorizationStates();
  94  }