1. class
  2. Google
  3. \
  4. Auth
  5. \
  6. FetchAuthTokenCache

FetchAuthTokenCache

class FetchAuthTokenCache implements FetchAuthTokenInterface, GetQuotaProjectInterface, GetUniverseDomainInterface, SignBlobInterface, ProjectIdProviderInterface, UpdateMetadataInterface (View source)

A class to implement caching for any object implementing FetchAuthTokenInterface

Traits

CacheTrait

Methods

__construct(FetchAuthTokenInterface $fetcher, array $cacheConfig = null, CacheItemPoolInterface $cache)

No description

FetchAuthTokenInterface
getFetcher()

No description

array
fetchAuthToken(callable $httpHandler = null)

Implements FetchAuthTokenInterface#fetchAuthToken.

string
getCacheKey()

No description

null|array
getLastReceivedToken()

No description

string
getClientName(callable $httpHandler = null)

Get the client name from the fetcher.

string
signBlob(string $stringToSign, bool $forceOpenSsl = false)

Sign a blob using the fetcher.

string|null
getQuotaProject()

Get the quota project used for this API request from the credentials fetcher.

string|null
getProjectId(callable $httpHandler = null)

Get the project ID.

string
getUniverseDomain()

Get the universe domain from the credential. This should always return a string, and default to "googleapis.com" if no universe domain is configured.

array
updateMetadata(array $metadata, string $authUri = null, callable $httpHandler = null)

Updates metadata with the authorization token.

Details

at line 51
__construct(FetchAuthTokenInterface $fetcher, array $cacheConfig = null, CacheItemPoolInterface $cache)

Parameters

FetchAuthTokenInterface $fetcher A credentials fetcher
array $cacheConfig Configuration for the cache
CacheItemPoolInterface $cache

at line 68
FetchAuthTokenInterface getFetcher()

Return Value

FetchAuthTokenInterface

at line 83
array fetchAuthToken(callable $httpHandler = null)

Implements FetchAuthTokenInterface#fetchAuthToken.

Checks the cache for a valid auth token and fetches the auth tokens from the supplied fetcher.

Parameters

callable $httpHandler callback which delivers psr7 request

Return Value

array a hash of auth tokens

Exceptions

Exception

at line 99
string getCacheKey()

Return Value

string a key that may be used to cache the auth token.

at line 107
null|array getLastReceivedToken()

Return Value

null|array { The last received access token.

@type string $access_token The access token string.
@type int $expires_at The time the token expires as a UNIX timestamp.

}

at line 118
string getClientName(callable $httpHandler = null)

Get the client name from the fetcher.

Parameters

callable $httpHandler callback which delivers psr7 request, if one is required to obtain a client name.

Return Value

string

at line 141
string signBlob(string $stringToSign, bool $forceOpenSsl = false)

Sign a blob using the fetcher.

Parameters

string $stringToSign The string to sign.
bool $forceOpenSsl Require use of OpenSSL for local signing. Does not apply to signing done using external services. Defaults to false.

Return Value

string The resulting signature. Value should be base64-encoded.

Exceptions

RuntimeException If the fetcher does not implement Google\Auth\SignBlobInterface.

at line 170
string|null getQuotaProject()

Get the quota project used for this API request from the credentials fetcher.

Return Value

string|null

at line 187
string|null getProjectId(callable $httpHandler = null)

Get the project ID.

Parameters

callable $httpHandler Callback which delivers psr7 request

Return Value

string|null

at line 213
string getUniverseDomain()

Get the universe domain from the credential. This should always return a string, and default to "googleapis.com" if no universe domain is configured.

Return Value

string

at line 235
array updateMetadata(array $metadata, string $authUri = null, callable $httpHandler = null)

Updates metadata with the authorization token.

Parameters

array $metadata metadata hashmap
string $authUri optional auth uri
callable $httpHandler callback which delivers psr7 request

Return Value

array updated metadata hashmap

Exceptions

RuntimeException If the fetcher does not implement Google\Auth\UpdateMetadataInterface.