FetchAuthTokenInterface.php 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. <?php
  2. /*
  3. * Copyright 2015 Google Inc.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. namespace Google\Auth;
  18. /**
  19. * An interface implemented by objects that can fetch auth tokens.
  20. */
  21. interface FetchAuthTokenInterface
  22. {
  23. /**
  24. * Fetches the auth tokens based on the current state.
  25. *
  26. * @param callable $httpHandler callback which delivers psr7 request
  27. * @return array<mixed> a hash of auth tokens
  28. */
  29. public function fetchAuthToken(callable $httpHandler = null);
  30. /**
  31. * Obtains a key that can used to cache the results of #fetchAuthToken.
  32. *
  33. * If the value is empty, the auth token is not cached.
  34. *
  35. * @return string a key that may be used to cache the auth token.
  36. */
  37. public function getCacheKey();
  38. /**
  39. * Returns an associative array with the token and
  40. * expiration time.
  41. *
  42. * @return null|array<mixed> {
  43. * The last received access token.
  44. *
  45. * @type string $access_token The access token string.
  46. * @type int $expires_at The time the token expires as a UNIX timestamp.
  47. * }
  48. */
  49. public function getLastReceivedToken();
  50. }