diff --git a/index.html b/index.html
index 8f6c89d2a..276a50b45 100644
--- a/index.html
+++ b/index.html
@@ -1 +1 @@
- Google | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
Namespaces
+
+
+
Classes
+
+
+
+
+
Extension to the regular Google\Model that automatically
+exposes the items array for iteration, so you can just
+iterate over the object rather than a reference inside.
+
+
+
+
This class defines attributes, valid values, and usage which is generated
+from a given json schema.
+
+
+
+
+
+
Exceptions
+
+
+
Google\AccessToken | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Classes
+
+
+
+
Wrapper around Google Access Tokens which provides convenience functions
+
+
+
+
Wrapper around Google Access Tokens which provides convenience functions
+
+
+
+
+
+
+
Google\AccessToken\Revoke | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ Revoke (View source )
+
+
+
+
+
+
+
+
Wrapper around Google Access Tokens which provides convenience functions
+
+
+
+
+
Methods
+
+
+
+
+
+
+
+
__construct (
ClientInterface $http = null)
+
+
Instantiates the class, but does not initiate the login flow, leaving it
+to the discretion of the caller.
+
+
+
+
+ bool
+
+
+
revokeToken (string|array $token)
+
+
Revoke an OAuth2 access token or refresh token. This method will revoke the current access
+token, if a token isn't provided.
+
+
+
+
+
+
Details
+
+
+
+
+
+
+ __construct (ClientInterface $http = null)
+
+
+
+
+
+
+
+
Instantiates the class, but does not initiate the login flow, leaving it
+to the discretion of the caller.
+
+
+
+
+
+
+
+
+ bool
+ revokeToken (string|array $token)
+
+
+
+
+
+
+
+
Revoke an OAuth2 access token or refresh token. This method will revoke the current access
+token, if a token isn't provided.
+
+
+
+
+
+
+
+
+
+
Google\AccessToken\Verify | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ Verify (View source )
+
+
+
+
+
+
+
+
Wrapper around Google Access Tokens which provides convenience functions
+
+
+
Constants
+
+
+ FEDERATED_SIGNON_CERT_URL
+
+
+
+
+
+
+
+
+ OAUTH2_ISSUER
+
+
+
+
+
+
+
+
+ OAUTH2_ISSUER_HTTPS
+
+
+
+
+
+
+
+
+
+
Properties
+
+
+
+
+ JWT
+
+
+ $jwt
+
+
+
+
+
Methods
+
+
+
+
+
+
+
+
__construct (
ClientInterface $http = null,
CacheItemPoolInterface $cache = null, $jwt = null)
+
+
Instantiates the class, but does not initiate the login flow, leaving it
+to the discretion of the caller.
+
+
+
+
+ array|false
+
+
+
verifyIdToken (string $idToken, string $audience = null)
+
+
Verifies an id token and returns the authenticated apiLoginTicket.
+
+
+
+
+
+
Details
+
+
+
+
+
+
+ __construct (ClientInterface $http = null, CacheItemPoolInterface $cache = null, $jwt = null)
+
+
+
+
+
+
+
+
Instantiates the class, but does not initiate the login flow, leaving it
+to the discretion of the caller.
+
+
+
+
+
+
+
+
+ array|false
+ verifyIdToken (string $idToken, string $audience = null)
+
+
+
+
+
+
+
+
Verifies an id token and returns the authenticated apiLoginTicket.
Throws an exception if the id token is not valid.
+The audience parameter can be used to control which id tokens are
+accepted. By default, the id token must have been issued to this OAuth2 client.
+
+
+
+
+
+
+
+
+
+
Google\AuthHandler | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Classes
+
+
+
+
+
+
Google\AuthHandler\AuthHandlerFactory | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ AuthHandlerFactory (View source )
+
+
+
+
+
+
+
+
+
+
+
Methods
+
+
+
+
+
+
build ($cache = null, array $cacheConfig = [])
+
+
Builds out a default http handler for the installed version of guzzle.
+
+
+
+
+
+
Details
+
+
+
+
+
+
+
+
+
+
Builds out a default http handler for the installed version of guzzle.
+
+
+
+
+
+
+
+
+
+
Google\AuthHandler\Guzzle6AuthHandler | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ Guzzle6AuthHandler (View source )
+
+
+
+
+
+
+
+
+
+
+
Properties
+
+
+
+
+ protected
+
+
+ $cache
+
+
+
+ protected
+
+
+ $cacheConfig
+
+
+
+
+
Methods
+
+
+
+
+
+
+
+
__construct (
CacheItemPoolInterface $cache = null, array $cacheConfig = [])
+
+
No description
+
+
+
+
+
+
+
+
+
attachCredentials (
ClientInterface $http,
CredentialsLoader $credentials, callable $tokenCallback = null)
+
+
No description
+
+
+
+
+
+
+
+
+
attachCredentialsCache (
ClientInterface $http,
FetchAuthTokenCache $credentials, callable $tokenCallback = null)
+
+
No description
+
+
+
+
+
+
+
+
+
attachToken (
ClientInterface $http, array $token, array $scopes)
+
+
No description
+
+
+
+
+
+
+
+
+
attachKey (
ClientInterface $http, $key)
+
+
No description
+
+
+
+
+
+
+
Details
+
+
+
+
+
+
+ __construct (CacheItemPoolInterface $cache = null, array $cacheConfig = [])
+
+
+
+
+
+
+
+
+
+ attachCredentials (ClientInterface $http, CredentialsLoader $credentials, callable $tokenCallback = null)
+
+
+
+
+
+
+
+
+
+ attachCredentialsCache (ClientInterface $http, FetchAuthTokenCache $credentials, callable $tokenCallback = null)
+
+
+
+
+
+
+
+
+
+ attachToken (ClientInterface $http, array $token, array $scopes)
+
+
+
+
+
+
+
+
+
+ attachKey (ClientInterface $http, $key)
+
+
+
+
+
+
+
+
+
+
Google\AuthHandler\Guzzle7AuthHandler | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ Guzzle7AuthHandler extends Guzzle6AuthHandler View source )
+
+
+
+
+
+
+
+
+
+
+
Properties
+
+
+
+
+
Methods
+
+
+
+
+
+
+
+
__construct (
CacheItemPoolInterface $cache = null, array $cacheConfig = [])
+
+
No description
+
+
+
+
+
+
+
+
+
attachCredentials (
ClientInterface $http,
CredentialsLoader $credentials, callable $tokenCallback = null)
+
+
No description
+
+
+
+
+
+
+
+
+
attachCredentialsCache (
ClientInterface $http,
FetchAuthTokenCache $credentials, callable $tokenCallback = null)
+
+
No description
+
+
+
+
+
+
+
+
+
attachToken (
ClientInterface $http, array $token, array $scopes)
+
+
No description
+
+
+
+
+
+
+
+
+
attachKey (
ClientInterface $http, $key)
+
+
No description
+
+
+
+
+
+
+
Details
+
+
+
+
+
+
+ __construct (CacheItemPoolInterface $cache = null, array $cacheConfig = [])
+
+
+
+
+
+
+
+
+
+ attachCredentials (ClientInterface $http, CredentialsLoader $credentials, callable $tokenCallback = null)
+
+
+
+
+
+
+
+
+
+ attachCredentialsCache (ClientInterface $http, FetchAuthTokenCache $credentials, callable $tokenCallback = null)
+
+
+
+
+
+
+
+
+
+ attachToken (ClientInterface $http, array $token, array $scopes)
+
+
+
+
+
+
+
+
+
+
+
Google\Client | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ Client (View source )
+
+
+
+
+
+
+
+
+
+
Constants
+
+
+ LIBVER
+
+
+
+
+
+
+
+
+ USER_AGENT_SUFFIX
+
+
+
+
+
+
+
+
+ OAUTH2_REVOKE_URI
+
+
+
+
+
+
+
+
+ OAUTH2_TOKEN_URI
+
+
+
+
+
+
+
+
+ OAUTH2_AUTH_URL
+
+
+
+
+
+
+
+
+ API_BASE_PATH
+
+
+
+
+
+
+
+
+
+
Properties
+
+
+
+
+ protected array
+
+
+ $requestedScopes
+
+
+
+
+
Methods
+
+
+
+
+
+
+
+
__construct (array $config = [])
+
+
Construct the Google Client.
+
+
+
+
+
+ array
+
+
+
authenticate (string $code)
+
deprecated
+
For backwards compatibility
+alias for fetchAccessTokenWithAuthCode
+
+
+
+
+
+
+
+ array
+
+
+
refreshToken (string $refreshToken)
+
+
For backwards compatibility
+alias for fetchAccessTokenWithRefreshToken
+
+
+
+
+
+ string
+
+
+
createAuthUrl (string|array $scope = null, array $queryParams = [])
+
+
Create a URL to obtain user authorization.
+
+
+
+
+
+
authorize (
ClientInterface $http = null)
+
+
Adds auth listeners to the HTTP client based on the credentials
+set in the Google API Client object
+
+
+
+
+
+
+
+
+
+
setAccessToken (string|array $token)
+
+
Set the access token used for requests.
+
+
+
+
+
+
+
+
+
+
+
getAuth ()
+
deprecated
+
No description
+
+
+
+
+
+
+
+
+
setAuth ($auth)
+
deprecated
+
No description
+
+
+
+
+
+
+
+
+
setClientId (string $clientId)
+
+
Set the OAuth 2.0 Client ID.
+
+
+
+
+
+
+
+
+
setClientSecret (string $clientSecret)
+
+
Set the OAuth 2.0 Client Secret.
+
+
+
+
+
+
+
+
+
setRedirectUri (string $redirectUri)
+
+
Set the OAuth 2.0 Redirect URI.
+
+
+
+
+
+
+
+
+
setState (string $state)
+
+
Set OAuth 2.0 "state" parameter to achieve per-request customization.
+
+
+
+
+
+
+
+
+
+
setLoginHint (string $loginHint)
+
+
Set the login hint, email address or sub id.
+
+
+
+
+
+
+
+
setApplicationName (string $applicationName)
+
+
Set the application name, this is included in the User-Agent HTTP header.
+
+
+
+
+
+
+
+
setRequestVisibleActions (array $requestVisibleActions)
+
+
If 'plus.login' is included in the list of requested scopes, you can use
+this method to define types of app activities that your app will write.
+
+
+
+
+
+
+
+
setDeveloperKey (string $developerKey)
+
+
Set the developer key to use, these are obtained through the API Console.
+
+
+
+
+
+
+
+
setHostedDomain (string $hd)
+
+
Set the hd (hosted domain) parameter streamlines the login process for
+Google Apps hosted accounts. By including the domain of the user, you
+restrict sign-in to accounts at that domain.
+
+
+
+
+
+
+
+
setPrompt (string $prompt)
+
+
Set the prompt hint. Valid values are none, consent and select_account.
+
+
+
+
+
+
+
+
setOpenidRealm (string $realm)
+
+
openid.realm is a parameter from the OpenID 2.0 protocol, not from OAuth
+2.0. It is used in OpenID 2.0 requests to signify the URL-space for which
+an authentication request is valid.
+
+
+
+
+
+
+
+
setIncludeGrantedScopes (bool $include)
+
+
If this is provided with the value true, and the authorization request is
+granted, the authorization will include any previous authorizations
+granted to this user/application combination for other scopes.
+
+
+
+
+
+
+
+
setTokenCallback (callable $tokenCallback)
+
+
sets function to be called when an access token is fetched
+
+
+
+
+ bool
+
+
+
revokeToken (string|array|null $token = null)
+
+
Revoke an OAuth2 access token or refresh token. This method will revoke the current access
+token, if a token isn't provided.
+
+
+
+
+ array|false
+
+
+
verifyIdToken (string|null $idToken = null)
+
+
Verify an id_token. This method will verify the current id_token, if one
+isn't provided.
+
+
+
+
+
+
+
+
setScopes ($scope_or_scopes)
+
+
Set the scopes to be requested. Must be called before createAuthUrl().
+
+
+
+
+
+
+
+
addScope (string|string[] $scope_or_scopes)
+
+
This functions adds a scope to be requested as part of the OAuth2.0 flow.
+
+
+
+
+ array
+
+
+
getScopes ()
+
+
Returns the list of scopes requested by the client
+
+
+
+
+
+ mixed|
T |
ResponseInterface
+
+
+
execute (
RequestInterface $request,
T> |false|null $expectedClass = null)
+
+
Helper method to execute deferred HTTP requests.
+
+
+
+
+
+
+
+
setUseBatch (bool $useBatch)
+
+
Declare whether batch calls should be used. This may increase throughput
+by making multiple requests in one connection.
+
+
+
+
+
+
+
+
isAppEngine ()
+
+
Are we running in Google AppEngine?
+return bool
+
+
+
+
+
+
+
+
setConfig ($name, $value)
+
+
No description
+
+
+
+
+
+
+
+
+
getConfig ($name, $default = null)
+
+
No description
+
+
+
+
+
+
+
+
+
setAuthConfigFile (string $file)
+
deprecated
+
For backwards compatibility
+alias for setAuthConfig
+
+
+
+
+
+
+
+
setAuthConfig (string|array $config)
+
+
Set the auth config from new or deprecated JSON config.
+
+
+
+
+
+
+
+
setSubject (string $subject)
+
+
Use when the service account has been delegated domain wide access.
+
+
+
+
+
+
+
+
setDefer (bool $defer)
+
+
Declare whether making API calls should make the call immediately, or
+return a request which can be called with ->execute();
+
+
+
+
+ bool
+
+
+
shouldDefer ()
+
+
Whether or not to return raw requests
+
+
+
+
+
+
+
+
+
+
setCache (
CacheItemPoolInterface $cache)
+
+
Set the Cache object
+
+
+
+
+
CacheItemPoolInterface
+
+
+
+
+
+
+
+
+
+
+
setLogger (
LoggerInterface $logger)
+
+
Set the Logger object
+
+
+
+
+
+
+
+
+
+
+
setHttpClient (
ClientInterface $http)
+
+
Set the Http Client object
+
+
+
+
+
+
+
+
+
+
+
Details
+
+
+
+
+
+
+ __construct (array $config = [])
+
+
+
+
+
+
+
+
Construct the Google Client.
+
+
+
+
+
+
+
+
+ string
+ getLibraryVersion ()
+
+
+
+
+
+
+
+
Get a string containing the version of the library.
+
+
+
+
+
+
+
+
+ array
+ authenticate (string $code)
+ deprecated
+
+
+
+ deprecated
+
+
+
+
+
+
+
For backwards compatibility
+alias for fetchAccessTokenWithAuthCode
+
+
+
+
+
+
+
+
+ array
+ fetchAccessTokenWithAuthCode (string $code, string $codeVerifier = null)
+
+
+
+
+
+
+
+
Attempt to exchange a code for an valid authentication token.
Helper wrapped around the OAuth 2.0 implementation.
+
+
+
+
+
+
+
+
+ array
+ refreshTokenWithAssertion ()
+ deprecated
+
+
+
+ deprecated
+
+
+
+
+
+
+
For backwards compatibility
+alias for fetchAccessTokenWithAssertion
+
+
+
+
+
+
+
+
+ array
+ fetchAccessTokenWithAssertion (ClientInterface $authHttp = null)
+
+
+
+
+
+
+
+
Fetches a fresh access token with a given assertion token.
+
+
+
+
+
+
+
+
+ array
+ refreshToken (string $refreshToken)
+
+
+
+
+
+
+
+
For backwards compatibility
+alias for fetchAccessTokenWithRefreshToken
+
+
+
+
+
+
+
+
+ array
+ fetchAccessTokenWithRefreshToken (string $refreshToken = null)
+
+
+
+
+
+
+
+
Fetches a fresh OAuth 2.0 access token with the given refresh token.
+
+
+
+
+
+
+
+
+ string
+ createAuthUrl (string|array $scope = null, array $queryParams = [])
+
+
+
+
+
+
+
+
Create a URL to obtain user authorization.
The authorization endpoint allows the user to first
+authenticate, and then grant/deny the access request.
+
+
+
+
+
+
+
+
+ ClientInterface
+ authorize (ClientInterface $http = null)
+
+
+
+
+
+
+
+
Adds auth listeners to the HTTP client based on the credentials
+set in the Google API Client object
+
+
+
+
+
+
+
+
+
+ useApplicationDefaultCredentials (bool $useAppCreds = true)
+
+
+
+
+
+
+
+
Set the configuration to use application default credentials for
+authentication
+
+
+
+
+
+
+
+
+
+ isUsingApplicationDefaultCredentials ()
+
+
+
+
+
+
+
+
To prevent useApplicationDefaultCredentials from inappropriately being
+called in a conditional
+
+
+
+
+
+
+
+
+
+ setAccessToken (string|array $token)
+
+
+
+
+
+
+
+
Set the access token used for requests.
Note that at the time requests are sent, tokens are cached. A token will be
+cached for each combination of service and authentication scopes. If a
+cache pool is not provided, creating a new instance of the client will
+allow modification of access tokens. If a persistent cache pool is
+provided, in order to change the access token, you must clear the cached
+token by calling $client->getCache()->clear(). (Use caution in this case,
+as calling clear() will remove all cache items, including any items not
+related to Google API PHP Client.)
+
NOTE: The universe domain is assumed to be "googleapis.com" unless
+explicitly set. When setting an access token directly via this method, there
+is no way to verify the universe domain. Be sure to set the "universe_domain"
+option if "googleapis.com" is not intended.
+
+
+
+
+
+
+
+
+
+ getAccessToken ()
+
+
+
+
+
+
+
+
+ string|null
+ getRefreshToken ()
+
+
+
+
+
+
+
+
+ bool
+ isAccessTokenExpired ()
+
+
+
+
+
+
+
+
Returns if the access_token is expired.
+
+
+
+
+
+
+
+
+
+ getAuth ()
+ deprecated
+
+
+
+ deprecated
+ See
+ UPGRADING.md for more information
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setAuth ($auth)
+ deprecated
+
+
+
+ deprecated
+ See
+ UPGRADING.md for more information
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setClientId (string $clientId)
+
+
+
+
+
+
+
+
Set the OAuth 2.0 Client ID.
+
+
+
+
+
+
+
+
+
+ getClientId ()
+
+
+
+
+
+
+
+
+
+ setClientSecret (string $clientSecret)
+
+
+
+
+
+
+
+
Set the OAuth 2.0 Client Secret.
+
+
+
+
+
+
+
+
+
+ getClientSecret ()
+
+
+
+
+
+
+
+
+
+ setRedirectUri (string $redirectUri)
+
+
+
+
+
+
+
+
Set the OAuth 2.0 Redirect URI.
+
+
+
+
+
+
+
+
+
+ getRedirectUri ()
+
+
+
+
+
+
+
+
+
+ setState (string $state)
+
+
+
+
+
+
+
+
Set OAuth 2.0 "state" parameter to achieve per-request customization.
+
+
+
+
+
+
+
+
+
+ setAccessType (string $accessType)
+
+
+
+
+
+
+
+
+
+ setApprovalPrompt (string $approvalPrompt)
+
+
+
+
+
+
+
+
+
+ setLoginHint (string $loginHint)
+
+
+
+
+
+
+
+
Set the login hint, email address or sub id.
+
+
+
+
+
+
+
+
+
+ setApplicationName (string $applicationName)
+
+
+
+
+
+
+
+
Set the application name, this is included in the User-Agent HTTP header.
+
+
+
+
+
+
+
+
+
+ setRequestVisibleActions (array $requestVisibleActions)
+
+
+
+
+
+
+
+
If 'plus.login' is included in the list of requested scopes, you can use
+this method to define types of app activities that your app will write.
You can find a list of available types here:
+
+
+
+
+
+
+
+
+
+ setDeveloperKey (string $developerKey)
+
+
+
+
+
+
+
+
Set the developer key to use, these are obtained through the API Console.
+
+
+
+
+
+
+
+
+
+ setHostedDomain (string $hd)
+
+
+
+
+
+
+
+
Set the hd (hosted domain) parameter streamlines the login process for
+Google Apps hosted accounts. By including the domain of the user, you
+restrict sign-in to accounts at that domain.
+
+
+
+
+
+
+
+
+
+ setPrompt (string $prompt)
+
+
+
+
+
+
+
+
Set the prompt hint. Valid values are none, consent and select_account.
If no value is specified and the user has not previously authorized
+access, then the user is shown a consent screen.
+
+
+
+
+
+
+
+
+
+ setOpenidRealm (string $realm)
+
+
+
+
+
+
+
+
openid.realm is a parameter from the OpenID 2.0 protocol, not from OAuth
+2.0. It is used in OpenID 2.0 requests to signify the URL-space for which
+an authentication request is valid.
+
+
+
+
+
+
+
+
+
+ setIncludeGrantedScopes (bool $include)
+
+
+
+
+
+
+
+
If this is provided with the value true, and the authorization request is
+granted, the authorization will include any previous authorizations
+granted to this user/application combination for other scopes.
+
+
+
+
+
+
+
+
+
+ setTokenCallback (callable $tokenCallback)
+
+
+
+
+
+
+
+
sets function to be called when an access token is fetched
+
+
+
+
+
+
+
+
+ bool
+ revokeToken (string|array|null $token = null)
+
+
+
+
+
+
+
+
Revoke an OAuth2 access token or refresh token. This method will revoke the current access
+token, if a token isn't provided.
+
+
+
+
+
+
+
+
+ array|false
+ verifyIdToken (string|null $idToken = null)
+
+
+
+
+
+
+
+
Verify an id_token. This method will verify the current id_token, if one
+isn't provided.
+
+
+
+
+
+
+
+
+
+ setScopes ($scope_or_scopes)
+
+
+
+
+
+
+
+
Set the scopes to be requested. Must be called before createAuthUrl().
Will remove any previously configured scopes.
+
+
+
+
+
+
+
+
+
+ addScope (string|string[] $scope_or_scopes)
+
+
+
+
+
+
+
+
This functions adds a scope to be requested as part of the OAuth2.0 flow.
Will append any scopes not previously requested to the scope parameter.
+A single string will be treated as a scope to request. An array of strings
+will each be appended.
+
+
+
+
+
+
+
+
+ array
+ getScopes ()
+
+
+
+
+
+
+
+
Returns the list of scopes requested by the client
+
+
+
+
+
+
+
+
+ string|null
+ prepareScopes ()
+
+
+
+
+
+
+
+
+ mixed|T |ResponseInterface
+ execute (RequestInterface $request, T> |false|null $expectedClass = null)
+
+
+
+
+
+
+
+
Helper method to execute deferred HTTP requests.
+
+
+
+
+
+
+
+
+
+ setUseBatch (bool $useBatch)
+
+
+
+
+
+
+
+
Declare whether batch calls should be used. This may increase throughput
+by making multiple requests in one connection.
+
+
+
+
+
+
+
+
+
+ isAppEngine ()
+
+
+
+
+
+
+
+
Are we running in Google AppEngine?
+return bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setConfig ($name, $value)
+
+
+
+
+
+
+
+
+
+ getConfig ($name, $default = null)
+
+
+
+
+
+
+
+
+
+ setAuthConfigFile (string $file)
+ deprecated
+
+
+
+ deprecated
+
+
+
+
+
+
+
For backwards compatibility
+alias for setAuthConfig
+
+
+
+
+
+
+
+
+
+ setAuthConfig (string|array $config)
+
+
+
+
+
+
+
+
Set the auth config from new or deprecated JSON config.
This structure should match the file downloaded from
+the "Download JSON" button on in the Google Developer
+Console.
+
+
+
+
+
+
+
+
+
+ setSubject (string $subject)
+
+
+
+
+
+
+
+
Use when the service account has been delegated domain wide access.
+
+
+
+
+
+
+
+
+
+ setDefer (bool $defer)
+
+
+
+
+
+
+
+
Declare whether making API calls should make the call immediately, or
+return a request which can be called with ->execute();
+
+
+
+
+
+
+
+
+ bool
+ shouldDefer ()
+
+
+
+
+
+
+
+
Whether or not to return raw requests
+
+
+
+
+
+
+
+
+ OAuth2
+ getOAuth2Service ()
+
+
+
+
+
+
+
+
+ protected
+ createOAuth2Service ()
+
+
+
+
+
+
+
+
create a default google auth object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setCache (CacheItemPoolInterface $cache)
+
+
+
+
+
+
+
+
+ CacheItemPoolInterface
+ getCache ()
+
+
+
+
+
+
+
+
+
+ setCacheConfig (array $cacheConfig)
+
+
+
+
+
+
+
+
+
+ setLogger (LoggerInterface $logger)
+
+
+
+
+
+
+
+
Set the Logger object
+
+
+
+
+
+
+
+
+ LoggerInterface
+ getLogger ()
+
+
+
+
+
+
+
+
+ protected
+ createDefaultLogger ()
+
+
+
+
+
+
+
+
+ protected
+ createDefaultCache ()
+
+
+
+
+
+
+
+
+
+ setHttpClient (ClientInterface $http)
+
+
+
+
+
+
+
+
Set the Http Client object
+
+
+
+
+
+
+
+
+ ClientInterface
+ getHttpClient ()
+
+
+
+
+
+
+
+
+
+
+
+
+
Set the API format version.
true will use V2, which may return more useful error messages.
+
+
+
+
+
+
+
+
+ protected
+ createDefaultHttpClient ()
+
+
+
+
+
+
+
+
+ protected
+ getAuthHandler ()
+
+
+
+
+
+
+
+
+
+ getUniverseDomain ()
+
+
+
+
+
+
+
+
+
+
Google\Collection | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+ class Google \ Collection
+
+
+
+
+
+
+
class
+ Collection extends Model Iterator , Countable (View source )
+
+
+
+
+
+
+
+
Extension to the regular Google\Model that automatically
+exposes the items array for iteration, so you can just
+iterate over the object rather than a reference inside.
+
+
+
Constants
+
+
+ NULL_VALUE
+
+
+ If you need to specify a NULL JSON value, use Google\Model::NULL_VALUE
+instead - it will be replaced when converting to JSON with a real null.
+
+
+
+
+
+
+
Properties
+
+
+
+
+ protected
+
+
+ $internal_gapi_mappings
+ from
+Model
+
+
+ protected
+
+
+ $modelData
+ from
+Model
+
+
+ protected
+
+
+ $processed
+ from
+Model
+
+
+ protected
+
+
+ $collection_key
+
+
+
+
+
Methods
+
+
+
+
+
+
+
+
__construct ()
+
+
Polymorphic - accepts a variable number of arguments dependent
+on the type of the model subclass.
+
+
+
+
+ mixed
+
+
+
__get (string $key)
+
+
Getter that handles passthrough access to the data array, and lazy object creation.
+
+
+
+
+ void
+
+
+
mapTypes (array $array)
+
+
Initialize this object's properties from an array.
+
+
+
+
+
+
+
+
gapiInit ()
+
+
Blank initialiser to be used in subclasses to do post-construction initialisation - this
+avoids the need for subclasses to have to implement the variadics handling in their
+constructors.
+
+
+
+
+
+
+
+
toSimpleObject ()
+
+
Create a simplified object suitable for straightforward
+conversion to JSON. This is relatively expensive
+due to the usage of reflection, but shouldn't be called
+a whole lot, and is the most straightforward way to filter.
+
+
+
+
+
+
+
+
+
assertIsArray (array $obj, string $method)
+
+
Verify if $obj is an array.
+
+
+
+
+
+
+ void
+
+
+
offsetSet ($offset, $value)
+
+
No description
+
+
+
+
+
+
+
+
+
+
keyType ($key)
+
+
No description
+
+
+
+
+
+
+
+
+
+
__isset ($key)
+
+
No description
+
+
+
+
+
+
+
+
+
__unset ($key)
+
+
No description
+
+
+
+
+
+ void
+
+
+
rewind ()
+
+
No description
+
+
+
+
+
+
+ mixed
+
+
+
key ()
+
+
No description
+
+
+
+
+
+ mixed
+
+
+
next ()
+
+
No description
+
+
+
+
+
+ bool
+
+
+
valid ()
+
+
No description
+
+
+
+
+
+ int
+
+
+
count ()
+
+
No description
+
+
+
+
+
+
+
Details
+
+
+
+
+
+ final
+ __construct ()
+
+
+
+
+
+
+
+
Polymorphic - accepts a variable number of arguments dependent
+on the type of the model subclass.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mixed
+ __get (string $key)
+
+
+
+
+
+
+
+
Getter that handles passthrough access to the data array, and lazy object creation.
+
+
+
+
+
+
+
+
+ protected void
+ mapTypes (array $array)
+
+
+
+
+
+
+
+
Initialize this object's properties from an array.
+
+
+
+
+
+
+
+
+ protected
+ gapiInit ()
+
+
+
+
+
+
+
+
Blank initialiser to be used in subclasses to do post-construction initialisation - this
+avoids the need for subclasses to have to implement the variadics handling in their
+constructors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Create a simplified object suitable for straightforward
+conversion to JSON. This is relatively expensive
+due to the usage of reflection, but shouldn't be called
+a whole lot, and is the most straightforward way to filter.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ protected bool
+ isAssociativeArray (array $array)
+
+
+
+
+
+
+
+
Returns true only if the array is associative.
+
+
+
+
+
+
+
+
+
+ assertIsArray (array $obj, string $method)
+
+
+
+
+
+
+
+
Verify if $obj is an array.
+
+
+
+
+
+
+
+
+ bool
+ offsetExists ($offset)
+
+
+
+
+
+
+
+
+ mixed
+ offsetGet ($offset)
+
+
+
+
+
+
+
+
+ void
+ offsetSet ($offset, $value)
+
+
+
+
+
+
+
+
+ void
+ offsetUnset ($offset)
+
+
+
+
+
+
+
+
+ protected
+ keyType ($key)
+
+
+
+
+
+
+
+
+ protected
+ dataType ($key)
+
+
+
+
+
+
+
+
+
+
+ void
+ rewind ()
+
+
+
+
+
+
+
+
+ mixed
+ current ()
+
+
+
+
+
+
+
+
+ mixed
+ key ()
+
+
+
+
+
+
+
+
+ mixed
+ next ()
+
+
+
+
+
+
+
+
+ bool
+ valid ()
+
+
+
+
+
+
+
+
+ int
+ count ()
+
+
+
+
+
+
+
+
+
+
Google\Exception | Google Cloud PHP Client
+
+ Google\Http | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Classes
+
+
+
+
Class to handle batched requests to the Google API service.
+
+
+
+
Manage large file uploads, which may be media but can be any type
+of sizable data.
+
+
+
+
This class implements the RESTful transport of apiServiceRequest()'s
+
+
+
+
+
+
+
Google\Http\Batch | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ Batch (View source )
+
+
+
+
+
+
+
+
Class to handle batched requests to the Google API service.
Note that calls to Google\Http\Batch::execute() do not clear the queued
+requests. To start a new batch, be sure to create a new instance of this
+class.
+
+
+
Constants
+
+
+ BATCH_PATH
+
+
+
+
+
+
+
+
+
+
+
Methods
+
+
+
+
+
+
+
+
__construct (
Client $client, $boundary = false, $rootUrl = null, $batchPath = null)
+
+
No description
+
+
+
+
+
+
+
+
+
add (
RequestInterface $request, $key = false)
+
+
No description
+
+
+
+
+
+
+
+
+
+
parseResponse (
ResponseInterface $response, $classes = [])
+
+
No description
+
+
+
+
+
+
+
Details
+
+
+
+
+
+
+ __construct (Client
+
+
+
+
+
+
+
+
+ add (RequestInterface $request, $key = false)
+
+
+
+
+
+
+
+
+
+
+ parseResponse (ResponseInterface $response, $classes = [])
+
+
+
+
+
+
+
+
+
+
Google\Http\MediaFileUpload | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ MediaFileUpload (View source )
+
+
+
+
+
+
+
+
Manage large file uploads, which may be media but can be any type
+of sizable data.
+
+
+
Constants
+
+
+ UPLOAD_MEDIA_TYPE
+
+
+
+
+
+
+
+
+ UPLOAD_MULTIPART_TYPE
+
+
+
+
+
+
+
+
+ UPLOAD_RESUMABLE_TYPE
+
+
+
+
+
+
+
+
+
+
+
Methods
+
+
+
+
+
+
+
+
__construct (
Client $client,
RequestInterface $request, string $mimeType, string $data, bool $resumable = false, int $chunkSize = 0)
+
+
No description
+
+
+
+
+
+
+
+
+
setFileSize (int $size)
+
+
Set the size of the file that is being uploaded.
+
+
+
+
+
+
+
+
+
nextChunk (string|bool $chunk = false)
+
+
Send the next part of the file to upload.
+
+
+
+
+
+
+
+
+
resume (string $resumeUri)
+
+
Resume a previously unfinished upload
+
+
+
+
+ string
+
+
+
getUploadType (string|false $meta)
+
+
Valid upload types:
+
+resumable (UPLOAD_RESUMABLE_TYPE)
+media (UPLOAD_MEDIA_TYPE)
+multipart (UPLOAD_MULTIPART_TYPE)
+
+
+
+
+
+
+
+
+
+
Details
+
+
+
+
+
+
+ __construct (Client RequestInterface $request, string $mimeType, string $data, bool $resumable = false, int $chunkSize = 0)
+
+
+
+
+
+
+
+
+
+ setFileSize (int $size)
+
+
+
+
+
+
+
+
Set the size of the file that is being uploaded.
+
+
+
+
+
+
+
+
+ int
+ getProgress ()
+
+
+
+
+
+
+
+
Return the progress on the upload
+
+
+
+
+
+
+
+
+
+ nextChunk (string|bool $chunk = false)
+
+
+
+
+
+
+
+
Send the next part of the file to upload.
+
+
+
+
+
+
+
+
+ int
+ getHttpResultCode ()
+
+
+
+
+
+
+
+
Return the HTTP result code from the last call made.
+
+
+
+
+
+
+
+
+
+ resume (string $resumeUri)
+
+
+
+
+
+
+
+
Resume a previously unfinished upload
+
+
+
+
+
+
+
+
+ string
+ getUploadType (string|false $meta)
+
+
+
+
+
+
+
+
Valid upload types:
+
+resumable (UPLOAD_RESUMABLE_TYPE)
+media (UPLOAD_MEDIA_TYPE)
+multipart (UPLOAD_MULTIPART_TYPE)
+
+
+
+
+
+
+
+
+
+
+ getResumeUri ()
+
+
+
+
+
+
+
+
+
+ setChunkSize ($chunkSize)
+
+
+
+
+
+
+
+
+
+ getRequest ()
+
+
+
+
+
+
+
+
+
+
Google\Http\REST | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ REST (View source )
+
+
+
+
+
+
+
+
This class implements the RESTful transport of apiServiceRequest()'s
+
+
+
+
+
Methods
+
+
+
+
+
+
execute (
ClientInterface $client,
RequestInterface $request,
T> |false|null $expectedClass = null, array $config = [], array $retryMap = null)
+
+
Executes a Psr\Http\Message\RequestInterface and (if applicable) automatically retries
+when errors occur.
+
+
+
+
+
+
doExecute (
ClientInterface $client,
RequestInterface $request,
T> |false|null $expectedClass = null)
+
+
Executes a Psr\Http\Message\RequestInterface
+
+
+
+
+
+
decodeHttpResponse (
ResponseInterface $response,
RequestInterface $request = null,
T> |false|null $expectedClass = null)
+
+
Decode an HTTP Response.
+
+
+
+
+
+
Details
+
+
+
+
+
+ static mixed|T |null
+ execute (ClientInterface $client, RequestInterface $request, T> |false|null $expectedClass = null, array $config = [], array $retryMap = null)
+
+
+
+
+
+
+
+
Executes a Psr\Http\Message\RequestInterface and (if applicable) automatically retries
+when errors occur.
+
+
+
+
+
+
+
+
+ static mixed|T |null
+ doExecute (ClientInterface $client, RequestInterface $request, T> |false|null $expectedClass = null)
+
+
+
+
+
+
+
+
Executes a Psr\Http\Message\RequestInterface
+
+
+
+
+
+
+
+
+ static mixed|T |null
+ decodeHttpResponse (ResponseInterface $response, RequestInterface $request = null, T> |false|null $expectedClass = null)
+
+
+
+
+
+
+
+
Decode an HTTP Response.
+
+
+
+
+
+
+
+
+
+
Google\Model | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ Model implements ArrayAccess (View source )
+
+
+
+
+
+
+
+
+
+
Constants
+
+
+ NULL_VALUE
+
+
+ If you need to specify a NULL JSON value, use Google\Model::NULL_VALUE
+instead - it will be replaced when converting to JSON with a real null.
+
+
+
+
+
+
+
Properties
+
+
+
+
+ protected
+
+
+ $internal_gapi_mappings
+
+
+
+ protected
+
+
+ $modelData
+
+
+
+ protected
+
+
+ $processed
+
+
+
+
+
Methods
+
+
+
+
+
+
+
+
__construct ()
+
+
Polymorphic - accepts a variable number of arguments dependent
+on the type of the model subclass.
+
+
+
+
+ mixed
+
+
+
__get (string $key)
+
+
Getter that handles passthrough access to the data array, and lazy object creation.
+
+
+
+
+ void
+
+
+
mapTypes (array $array)
+
+
Initialize this object's properties from an array.
+
+
+
+
+
+
+
+
gapiInit ()
+
+
Blank initialiser to be used in subclasses to do post-construction initialisation - this
+avoids the need for subclasses to have to implement the variadics handling in their
+constructors.
+
+
+
+
+
+
+
+
toSimpleObject ()
+
+
Create a simplified object suitable for straightforward
+conversion to JSON. This is relatively expensive
+due to the usage of reflection, but shouldn't be called
+a whole lot, and is the most straightforward way to filter.
+
+
+
+
+
+
+
+
+
assertIsArray (array $obj, string $method)
+
+
Verify if $obj is an array.
+
+
+
+
+
+
+ void
+
+
+
offsetSet ($offset, $value)
+
+
No description
+
+
+
+
+
+
+
+
+
+
keyType ($key)
+
+
No description
+
+
+
+
+
+
+
+
+
+
__isset ($key)
+
+
No description
+
+
+
+
+
+
+
+
+
__unset ($key)
+
+
No description
+
+
+
+
+
+
+
Details
+
+
+
+
+
+ final
+ __construct ()
+
+
+
+
+
+
+
+
Polymorphic - accepts a variable number of arguments dependent
+on the type of the model subclass.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mixed
+ __get (string $key)
+
+
+
+
+
+
+
+
Getter that handles passthrough access to the data array, and lazy object creation.
+
+
+
+
+
+
+
+
+ protected void
+ mapTypes (array $array)
+
+
+
+
+
+
+
+
Initialize this object's properties from an array.
+
+
+
+
+
+
+
+
+ protected
+ gapiInit ()
+
+
+
+
+
+
+
+
Blank initialiser to be used in subclasses to do post-construction initialisation - this
+avoids the need for subclasses to have to implement the variadics handling in their
+constructors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toSimpleObject ()
+
+
+
+
+
+
+
+
Create a simplified object suitable for straightforward
+conversion to JSON. This is relatively expensive
+due to the usage of reflection, but shouldn't be called
+a whole lot, and is the most straightforward way to filter.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ protected bool
+ isAssociativeArray (array $array)
+
+
+
+
+
+
+
+
Returns true only if the array is associative.
+
+
+
+
+
+
+
+
+
+ assertIsArray (array $obj, string $method)
+
+
+
+
+
+
+
+
Verify if $obj is an array.
+
+
+
+
+
+
+
+
+ bool
+ offsetExists ($offset)
+
+
+
+
+
+
+
+
+ mixed
+ offsetGet ($offset)
+
+
+
+
+
+
+
+
+ void
+ offsetSet ($offset, $value)
+
+
+
+
+
+
+
+
+ void
+ offsetUnset ($offset)
+
+
+
+
+
+
+
+
+ protected
+ keyType ($key)
+
+
+
+
+
+
+
+
+ protected
+ dataType ($key)
+
+
+
+
+
+
+
+
+
+ __isset ($key)
+
+
+
+
+
+
+
+
+
+ __unset ($key)
+
+
+
+
+
+
+
+
+
+
Google\Service | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+ class Google \ Service
+
+
+
+
+
+
+
class
+ Service (View source )
+
+
+
+
+
+
+
+
+
+
Properties
+
+
+
+
+
+
+
+ $batchPath
+
+
+
+
+
+
+ $rootUrl
+ Only used in getBatch
+
+
+
+
+
+ $rootUrlTemplate
+
+
+
+
+
+
+ $version
+
+
+
+
+
+
+ $servicePath
+
+
+
+
+
+
+ $serviceName
+
+
+
+
+
+
+ $availableScopes
+
+
+
+
+
+
+ $resource
+
+
+
+
+
Methods
+
+
+
+
+
+
+
+
__construct ($clientOrConfig = [])
+
+
No description
+
+
+
+
+
+
+
getClient ()
+
+
Return the associated Google\Client class.
+
+
+
+
+
+
createBatch ()
+
+
Create a new HTTP Batch handler for this service
+
+
+
+
+
+
Details
+
+
+
+
+
+
+ __construct ($clientOrConfig = [])
+
+
+
+
+
+
+
+
+
+
+
+
+
Return the associated Google\Client class.
+
+
+
+
+
+
+
+
+
+
+
+
+
Create a new HTTP Batch handler for this service
+
+
+
+
+
+
+
+
+
+
Google\Service\Exception | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ Exception extends Exception View source )
+
+
+
+
+
+
+
+
+
+
Properties
+
+
+
+
+ protected
+
+
+ $errors
+ Optional list of errors returned in a JSON body of an HTTP error response.
+
+
+
+
Methods
+
+
+
+
+
+
+
+
__construct (string $message, int $code = 0,
Exception $previous = null,
array<string,string> []|null $errors = [])
+
+
Override default constructor to add the ability to set $errors and a retry
+map.
+
+
+
+
+
array<string,string> []|null
+
+
+
getErrors ()
+
+
An example of the possible errors returned.
+
+
+
+
+
+
Details
+
+
+
+
+
+
+ __construct (string $message, int $code = 0, Exception array<string,string> []|null $errors = [])
+
+
+
+
+
+
+
+
Override default constructor to add the ability to set $errors and a retry
+map.
+
+
+
+
+
+
+
+
+ array<string,string> []|null
+ getErrors ()
+
+
+
+
+
+
+
+
An example of the possible errors returned.
[
+{
+"domain": "global",
+"reason": "authError",
+"message": "Invalid Credentials",
+"locationType": "header",
+"location": "Authorization",
+}
+]
+
+
+
+
+
+
+
+
+
+
Google\Service\Resource | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ Resource (View source )
+
+
+
+
+
+
+
+
Implements the actual methods/resources of the discovered Google API using magic function
+calling overloading (__call()), which on call will see if the method name (plus.activities.list)
+is available in this service, and if so construct an apiHttpRequest representing it.
+
+
+
+
Properties
+
+
+
+
+ protected string
+
+
+ $apiVersion
+
+
+
+
+
Methods
+
+
+
+
+
+
+
+
__construct ($service, $serviceName, $resourceName, $resource)
+
+
No description
+
+
+
+
+
+ mixed|
T |
ResponseInterface |
RequestInterface
+
+
+
call (string $name, array $arguments,
T> $expectedClass = null)
+
+
TODO: This function needs simplifying.
+
+
+
+
+
+ static string
+
+
+
createRequestUri (string $restPath, array $params)
+
+
Parse/expand request parameters and create a fully qualified
+request uri.
+
+
+
+
+
+
Details
+
+
+
+
+
+
+ __construct ($service, $serviceName, $resourceName, $resource)
+
+
+
+
+
+
+
+
+ mixed|T |ResponseInterface |RequestInterface
+ call (string $name, array $arguments, T> $expectedClass = null)
+
+
+
+
+
+
+
+
TODO: This function needs simplifying.
+
+
+
+
+
+
+
+
+ protected
+ convertToArrayAndStripNulls ($o)
+
+
+
+
+
+
+
+
+ static string
+ createRequestUri (string $restPath, array $params)
+
+
+
+
+
+
+
+
Parse/expand request parameters and create a fully qualified
+request uri.
+
+
+
+
+
+
+
+
+
+
Google\Task | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Classes
+
+
+
+
+
+
A task runner with exponential backoff support.
+
+
+
Interfaces
+
+
+
+
Interface for checking how many times a given task can be retried following
+a failure.
+
+
+
+
+
+
Google\Task\Composer | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ Composer (View source )
+
+
+
+
+
+
+
+
+
+
+
Methods
+
+
+
+
+ static
+
+
+
cleanup (
Event $event,
Filesystem $filesystem = null)
+
+
No description
+
+
+
+
+
+
+
Details
+
+
+
+
+
+ static
+ cleanup (Event $event, Filesystem $filesystem = null)
+
+
+
+
+
+
+
+
+
+
Google\Task\Exception | Google Cloud PHP Client
+
+ Google\Task\Retryable | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
interface
+ Retryable (View source )
+
+
+
+
+
+
+
+
Interface for checking how many times a given task can be retried following
+a failure.
+
+
+
+
+
+
+
Google\Task\Runner | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ Runner (View source )
+
+
+
+
+
+
+
+
A task runner with exponential backoff support.
+
+
+
Constants
+
+
+ TASK_RETRY_NEVER
+
+
+
+
+
+
+
+
+ TASK_RETRY_ONCE
+
+
+
+
+
+
+
+
+ TASK_RETRY_ALWAYS
+
+
+
+
+
+
+
+
+
+
Properties
+
+
+
+
+ protected array
+
+
+ $retryMap
+
+
+
+
+
Methods
+
+
+
+
+
+
+
+
__construct (array $config, string $name, callable $action, array $arguments = [])
+
+
Creates a new task runner with exponential backoff support.
+
+
+
+
+ bool
+
+
+
canAttempt ()
+
+
Checks if a retry can be attempted.
+
+
+
+
+ mixed
+
+
+
run ()
+
+
Runs the task and (if applicable) automatically retries when errors occur.
+
+
+
+
+ bool
+
+
+
attempt ()
+
+
Runs a task once, if possible. This is useful for bypassing the run()
+loop.
+
+
+
+
+ int
+
+
+
allowedRetries ($code, $errors = [])
+
+
Gets the number of times the associated task can be retried.
+
+
+
+
+
+
+
Details
+
+
+
+
+
+
+ __construct (array $config, string $name, callable $action, array $arguments = [])
+
+
+
+
+
+
+
+
Creates a new task runner with exponential backoff support.
+
+
+
+
+
+
+
+
+ bool
+ canAttempt ()
+
+
+
+
+
+
+
+
Checks if a retry can be attempted.
+
+
+
+
+
+
+
+
+
+
+
+
+
Runs the task and (if applicable) automatically retries when errors occur.
+
+
+
+
+
+
+
+
+ bool
+ attempt ()
+
+
+
+
+
+
+
+
Runs a task once, if possible. This is useful for bypassing the run()
+loop.
NOTE: If this is not the first attempt, this function will sleep in
+accordance to the backoff configurations before running the task.
+
+
+
+
+
+
+
+
+ int
+ allowedRetries ($code, $errors = [])
+
+
+
+
+
+
+
+
Gets the number of times the associated task can be retried.
NOTE: -1 is returned if the task can be retried indefinitely
+
+
+
+
+
+
+
+
+
+ setRetryMap ($retryMap)
+
+
+
+
+
+
+
+
+
+
Google\Utils | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Classes
+
+
+
+
Implementation of levels 1-3 of the URI Template spec.
+
+
+
+
+
+
+
Google\Utils\UriTemplate | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+ UriTemplate (View source )
+
+
+
+
+
+
+
+
Implementation of levels 1-3 of the URI Template spec.
+
+
+
Constants
+
+
+ TYPE_MAP
+
+
+
+
+
+
+
+
+ TYPE_LIST
+
+
+
+
+
+
+
+
+ TYPE_SCALAR
+
+
+
+
+
+
+
+
+
+
+
Methods
+
+
+
+
+
+
+
+
parse ($string, array $parameters)
+
+
No description
+
+
+
+
+
+
+
+
+
combine ($key, $parameters, $sep, $combine, $reserved, $tag_empty, $combine_on_empty)
+
+
No description
+
+
+
+
+
+
+
Details
+
+
+
+
+
+
+ parse ($string, array $parameters)
+
+
+
+
+
+
+
+
+
+ combine ($key, $parameters, $sep, $combine, $reserved, $tag_empty, $combine_on_empty)
+
+
+
+
+
+
+
+
+
+
All Classes | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Wrapper around Google Access Tokens which provides convenience functions
+
+
+
+
Wrapper around Google Access Tokens which provides convenience functions
+
+
+
+
+
+
+
+
Extension to the regular Google\Model that automatically
+exposes the items array for iteration, so you can just
+iterate over the object rather than a reference inside.
+
+
+
+
+
Class to handle batched requests to the Google API service.
+
+
+
+
Manage large file uploads, which may be media but can be any type
+of sizable data.
+
+
+
+
This class implements the RESTful transport of apiServiceRequest()'s
+
+
+
+
This class defines attributes, valid values, and usage which is generated
+from a given json schema.
+
+
+
+
+
+
Implements the actual methods/resources of the discovered Google API using magic function
+calling overloading (__call()), which on call will see if the method name (plus.activities.list)
+is available in this service, and if so construct an apiHttpRequest representing it.
+
+
+
+
+
+
Interface for checking how many times a given task can be retried following
+a failure.
+
+
+
+
A task runner with exponential backoff support.
+
+
+
+
Implementation of levels 1-3 of the URI Template spec.
+
+
+
+
Index | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A
+
AuthHandlerFactory Class in namespace Google\AuthHandler
+Guzzle6AuthHandler ::attachCredentials () — Method in class Guzzle6AuthHandler
+Guzzle6AuthHandler ::attachCredentialsCache () — Method in class Guzzle6AuthHandler
+Guzzle6AuthHandler ::attachToken () — Method in class Guzzle6AuthHandler
+Guzzle6AuthHandler ::attachKey () — Method in class Guzzle6AuthHandler
+Client ::authenticate () — Method in class Client For backwards compatibility
+alias for fetchAccessTokenWithAuthCode
+Client ::authorize () — Method in class Client Adds auth listeners to the HTTP client based on the credentials
+set in the Google API Client object
+Client ::addScope () — Method in class Client This functions adds a scope to be requested as part of the OAuth2.0 flow.
+Batch ::add () — Method in class Batch
+Model ::assertIsArray () — Method in class Model Verify if $obj is an array.
$
+Service #availableScopes — Property in class Service
+ $
+Resource #apiVersion — Property in class Resource
+
+Runner ::attempt () — Method in class Runner Runs a task once, if possible. This is useful for bypassing the run()
+loop.
+Runner ::allowedRetries () — Method in class Runner Gets the number of times the associated task can be retried.
B
+
+AuthHandlerFactory ::build () — Method in class AuthHandlerFactory Builds out a default http handler for the installed version of guzzle.
Batch Class in namespace Google\Http Class to handle batched requests to the Google API service.
$
+Service #batchPath — Property in class Service
+ C
+
$
+Guzzle6AuthHandler #cache — Property in class Guzzle6AuthHandler
+ $
+Guzzle6AuthHandler #cacheConfig — Property in class Guzzle6AuthHandler
+ Client Class in namespace Google The Google API Client
+https://github.com/google/google-api-php-client
+Client ::createAuthUrl () — Method in class Client Create a URL to obtain user authorization.
+Client ::createOAuth2Service () — Method in class Client create a default google auth object
+Client ::createDefaultLogger () — Method in class Client
+Client ::createDefaultCache () — Method in class Client
+Client ::createDefaultHttpClient () — Method in class Client Collection Class in namespace Google Extension to the regular Google\Model that automatically
+exposes the items array for iteration, so you can just
+iterate over the object rather than a reference inside.
$
+Collection #collection_key — Property in class Collection
+
+Collection ::current () — Method in class Collection
+Collection ::count () — Method in class Collection
+Service ::createBatch () — Method in class Service Create a new HTTP Batch handler for this service
+Resource ::call () — Method in class Resource TODO: This function needs simplifying.
+Resource ::convertToArrayAndStripNulls () — Method in class Resource
+Resource ::createRequestUri () — Method in class Resource Parse/expand request parameters and create a fully qualified
+request uri.
Composer Class in namespace Google\Task
+Composer ::cleanup () — Method in class Composer
+Runner ::canAttempt () — Method in class Runner Checks if a retry can be attempted.
+UriTemplate ::combine () — Method in class UriTemplate D
+
+REST ::doExecute () — Method in class REST Executes a Psr\Http\Message\RequestInterface
+REST ::decodeHttpResponse () — Method in class REST Decode an HTTP Response.
+Model ::dataType () — Method in class Model E
+
+Client ::execute () — Method in class Client Helper method to execute deferred HTTP requests.
Exception Class in namespace Google
+Batch ::execute () — Method in class Batch
+REST ::execute () — Method in class REST Executes a Psr\Http\Message\RequestInterface and (if applicable) automatically retries
+when errors occur.
Exception Class in namespace Google\Service $
+Exception #errors — Property in class Exception
+ Optional list of errors returned in a JSON body of an HTTP error response.
Exception Class in namespace Google\Task F
+
+Client ::fetchAccessTokenWithAuthCode () — Method in class Client Attempt to exchange a code for an valid authentication token.
+Client ::fetchAccessTokenWithAssertion () — Method in class Client Fetches a fresh access token with a given assertion token.
+Client ::fetchAccessTokenWithRefreshToken () — Method in class Client Fetches a fresh OAuth 2.0 access token with the given refresh token.
G
+
Guzzle6AuthHandler Class in namespace Google\AuthHandler This supports Guzzle 6
Guzzle7AuthHandler Class in namespace Google\AuthHandler This supports Guzzle 7
+Client ::getLibraryVersion () — Method in class Client Get a string containing the version of the library.
+Client ::getAccessToken () — Method in class Client
+Client ::getRefreshToken () — Method in class Client
+Client ::getAuth () — Method in class Client
+Client ::getClientId () — Method in class Client
+Client ::getClientSecret () — Method in class Client
+Client ::getRedirectUri () — Method in class Client
+Client ::getScopes () — Method in class Client Returns the list of scopes requested by the client
+Client ::getConfig () — Method in class Client
+Client ::getOAuth2Service () — Method in class Client
+Client ::getCache () — Method in class Client
+Client ::getLogger () — Method in class Client
+Client ::getHttpClient () — Method in class Client
+Client ::getAuthHandler () — Method in class Client
+Client ::getUniverseDomain () — Method in class Client
+MediaFileUpload ::getProgress () — Method in class MediaFileUpload Return the progress on the upload
+MediaFileUpload ::getHttpResultCode () — Method in class MediaFileUpload Return the HTTP result code from the last call made.
+MediaFileUpload ::getUploadType () — Method in class MediaFileUpload Valid upload types:
+
+resumable (UPLOAD_RESUMABLE_TYPE)
+media (UPLOAD_MEDIA_TYPE)
+multipart (UPLOAD_MULTIPART_TYPE)
+
+MediaFileUpload ::getResumeUri () — Method in class MediaFileUpload
+MediaFileUpload ::getRequest () — Method in class MediaFileUpload
+Model ::gapiInit () — Method in class Model Blank initialiser to be used in subclasses to do post-construction initialisation - this
+avoids the need for subclasses to have to implement the variadics handling in their
+constructors.
+Service ::getClient () — Method in class Service Return the associated Google\Client class.
+Exception ::getErrors () — Method in class Exception An example of the possible errors returned.
I
+
+Client ::isUsingApplicationDefaultCredentials () — Method in class Client To prevent useApplicationDefaultCredentials from inappropriately being
+called in a conditional
+Client ::isAccessTokenExpired () — Method in class Client Returns if the access_token is expired.
+Client ::isAppEngine () — Method in class Client Are we running in Google AppEngine?
+return bool
$
+Model #internal_gapi_mappings — Property in class Model
+
+Model ::isAssociativeArray () — Method in class Model Returns true only if the array is associative.
J
+
$
+Verify #jwt — Property in class Verify
+ K
+
+Collection ::key () — Method in class Collection
+Model ::keyType () — Method in class Model M
+
MediaFileUpload Class in namespace Google\Http Manage large file uploads, which may be media but can be any type
+of sizable data.
Model Class in namespace Google This class defines attributes, valid values, and usage which is generated
+from a given json schema.
$
+Model #modelData — Property in class Model
+
+Model ::mapTypes () — Method in class Model Initialize this object's properties from an array.
N
+
+Collection ::next () — Method in class Collection
+MediaFileUpload ::nextChunk () — Method in class MediaFileUpload Send the next part of the file to upload.
O
+
+Collection ::offsetExists () — Method in class Collection
+Collection ::offsetGet () — Method in class Collection
+Collection ::offsetSet () — Method in class Collection
+Collection ::offsetUnset () — Method in class Collection
+Model ::offsetExists () — Method in class Model
+Model ::offsetGet () — Method in class Model
+Model ::offsetSet () — Method in class Model
+Model ::offsetUnset () — Method in class Model P
+
+Client ::prepareScopes () — Method in class Client
+Batch ::parseResponse () — Method in class Batch $
+Model #processed — Property in class Model
+
+UriTemplate ::parse () — Method in class UriTemplate R
+
Revoke Class in namespace Google\AccessToken Wrapper around Google Access Tokens which provides convenience functions
+Revoke ::revokeToken () — Method in class Revoke Revoke an OAuth2 access token or refresh token. This method will revoke the current access
+token, if a token isn't provided.
$
+Client #requestedScopes — Property in class Client
+
+Client ::refreshTokenWithAssertion () — Method in class Client For backwards compatibility
+alias for fetchAccessTokenWithAssertion
+Client ::refreshToken () — Method in class Client For backwards compatibility
+alias for fetchAccessTokenWithRefreshToken
+Client ::revokeToken () — Method in class Client Revoke an OAuth2 access token or refresh token. This method will revoke the current access
+token, if a token isn't provided.
+Collection ::rewind () — Method in class Collection
+MediaFileUpload ::resume () — Method in class MediaFileUpload Resume a previously unfinished upload
REST Class in namespace Google\Http This class implements the RESTful transport of apiServiceRequest()'s
$
+Service #rootUrl — Property in class Service
+ Only used in getBatch
$
+Service #rootUrlTemplate — Property in class Service
+ $
+Service #resource — Property in class Service
+ Resource Class in namespace Google\Service Implements the actual methods/resources of the discovered Google API using magic function
+calling overloading (__call()), which on call will see if the method name (plus.activities.list)
+is available in this service, and if so construct an apiHttpRequest representing it.
Retryable Class in namespace Google\Task Interface for checking how many times a given task can be retried following
+a failure.
Runner Class in namespace Google\Task A task runner with exponential backoff support.
$
+Runner #retryMap — Property in class Runner
+
+Runner ::run () — Method in class Runner Runs the task and (if applicable) automatically retries when errors occur.
S
+
+Client ::setAccessToken () — Method in class Client Set the access token used for requests.
+Client ::setAuth () — Method in class Client
+Client ::setClientId () — Method in class Client Set the OAuth 2.0 Client ID.
+Client ::setClientSecret () — Method in class Client Set the OAuth 2.0 Client Secret.
+Client ::setRedirectUri () — Method in class Client Set the OAuth 2.0 Redirect URI.
+Client ::setState () — Method in class Client Set OAuth 2.0 "state" parameter to achieve per-request customization.
+Client ::setAccessType () — Method in class Client
+Client ::setApprovalPrompt () — Method in class Client
+Client ::setLoginHint () — Method in class Client Set the login hint, email address or sub id.
+Client ::setApplicationName () — Method in class Client Set the application name, this is included in the User-Agent HTTP header.
+Client ::setRequestVisibleActions () — Method in class Client If 'plus.login' is included in the list of requested scopes, you can use
+this method to define types of app activities that your app will write.
+Client ::setDeveloperKey () — Method in class Client Set the developer key to use, these are obtained through the API Console.
+Client ::setHostedDomain () — Method in class Client Set the hd (hosted domain) parameter streamlines the login process for
+Google Apps hosted accounts. By including the domain of the user, you
+restrict sign-in to accounts at that domain.
+Client ::setPrompt () — Method in class Client Set the prompt hint. Valid values are none, consent and select_account.
+Client ::setOpenidRealm () — Method in class Client openid.realm is a parameter from the OpenID 2.0 protocol, not from OAuth
+2.0. It is used in OpenID 2.0 requests to signify the URL-space for which
+an authentication request is valid.
+Client ::setIncludeGrantedScopes () — Method in class Client If this is provided with the value true, and the authorization request is
+granted, the authorization will include any previous authorizations
+granted to this user/application combination for other scopes.
+Client ::setTokenCallback () — Method in class Client sets function to be called when an access token is fetched
+Client ::setScopes () — Method in class Client Set the scopes to be requested. Must be called before createAuthUrl().
+Client ::setUseBatch () — Method in class Client Declare whether batch calls should be used. This may increase throughput
+by making multiple requests in one connection.
+Client ::setConfig () — Method in class Client
+Client ::setAuthConfigFile () — Method in class Client For backwards compatibility
+alias for setAuthConfig
+Client ::setAuthConfig () — Method in class Client Set the auth config from new or deprecated JSON config.
+Client ::setSubject () — Method in class Client Use when the service account has been delegated domain wide access.
+Client ::setDefer () — Method in class Client Declare whether making API calls should make the call immediately, or
+return a request which can be called with ->execute();
+Client ::shouldDefer () — Method in class Client Whether or not to return raw requests
+Client ::setCache () — Method in class Client Set the Cache object
+Client ::setCacheConfig () — Method in class Client
+Client ::setLogger () — Method in class Client Set the Logger object
+Client ::setHttpClient () — Method in class Client Set the Http Client object
+Client ::setApiFormatV2 () — Method in class Client Set the API format version.
+MediaFileUpload ::setFileSize () — Method in class MediaFileUpload Set the size of the file that is being uploaded.
+MediaFileUpload ::setChunkSize () — Method in class MediaFileUpload Service Class in namespace Google $
+Service #servicePath — Property in class Service
+ $
+Service #serviceName — Property in class Service
+
+Runner ::setRetryMap () — Method in class Runner T
+
+Model ::toSimpleObject () — Method in class Model Create a simplified object suitable for straightforward
+conversion to JSON. This is relatively expensive
+due to the usage of reflection, but shouldn't be called
+a whole lot, and is the most straightforward way to filter.
U
+
+Client ::useApplicationDefaultCredentials () — Method in class Client Set the configuration to use application default credentials for
+authentication
UriTemplate Class in namespace Google\Utils Implementation of levels 1-3 of the URI Template spec.
V
+
Verify Class in namespace Google\AccessToken Wrapper around Google Access Tokens which provides convenience functions
+Verify ::verifyIdToken () — Method in class Verify Verifies an id token and returns the authenticated apiLoginTicket.
+Client ::verifyIdToken () — Method in class Client Verify an id_token. This method will verify the current id_token, if one
+isn't provided.
+Collection ::valid () — Method in class Collection $
+Service #version — Property in class Service
+ _
+
+Revoke ::__construct () — Method in class Revoke Instantiates the class, but does not initiate the login flow, leaving it
+to the discretion of the caller.
+Verify ::__construct () — Method in class Verify Instantiates the class, but does not initiate the login flow, leaving it
+to the discretion of the caller.
+Guzzle6AuthHandler ::__construct () — Method in class Guzzle6AuthHandler
+Client ::__construct () — Method in class Client Construct the Google Client.
+Batch ::__construct () — Method in class Batch
+MediaFileUpload ::__construct () — Method in class MediaFileUpload
+Model ::__construct () — Method in class Model Polymorphic - accepts a variable number of arguments dependent
+on the type of the model subclass.
+Model ::__get () — Method in class Model Getter that handles passthrough access to the data array, and lazy object creation.
+Model ::__isset () — Method in class Model
+Model ::__unset () — Method in class Model
+Service ::__construct () — Method in class Service
+Exception ::__construct () — Method in class Exception Override default constructor to add the ability to set $errors and a retry
+map.
+Resource ::__construct () — Method in class Resource
+Runner ::__construct () — Method in class Runner Creates a new task runner with exponential backoff support.
+
Wrapper around Google Access Tokens which provides convenience functions
","f":{"n":"Google\\AccessToken","p":"Google/AccessToken.html"}},{"t":"C","n":"Google\\AccessToken\\Verify","p":"Google/AccessToken/Verify.html","d":"Wrapper around Google Access Tokens which provides convenience functions
","f":{"n":"Google\\AccessToken","p":"Google/AccessToken.html"}},{"t":"C","n":"Google\\AuthHandler\\AuthHandlerFactory","p":"Google/AuthHandler/AuthHandlerFactory.html","d":null,"f":{"n":"Google\\AuthHandler","p":"Google/AuthHandler.html"}},{"t":"C","n":"Google\\AuthHandler\\Guzzle6AuthHandler","p":"Google/AuthHandler/Guzzle6AuthHandler.html","d":"This supports Guzzle 6
","f":{"n":"Google\\AuthHandler","p":"Google/AuthHandler.html"}},{"t":"C","n":"Google\\AuthHandler\\Guzzle7AuthHandler","p":"Google/AuthHandler/Guzzle7AuthHandler.html","d":"This supports Guzzle 7
","f":{"n":"Google\\AuthHandler","p":"Google/AuthHandler.html"}},{"t":"C","n":"Google\\Client","p":"Google/Client.html","d":"The Google API Client\nhttps://github.com/google/google-api-php-client
","f":{"n":"Google","p":"Google.html"}},{"t":"C","n":"Google\\Collection","p":"Google/Collection.html","d":"Extension to the regular Google\\Model that automatically\nexposes the items array for iteration, so you can just\niterate over the object rather than a reference inside.
","f":{"n":"Google","p":"Google.html"}},{"t":"C","n":"Google\\Exception","p":"Google/Exception.html","d":null,"f":{"n":"Google","p":"Google.html"}},{"t":"C","n":"Google\\Http\\Batch","p":"Google/Http/Batch.html","d":"Class to handle batched requests to the Google API service.
","f":{"n":"Google\\Http","p":"Google/Http.html"}},{"t":"C","n":"Google\\Http\\MediaFileUpload","p":"Google/Http/MediaFileUpload.html","d":"Manage large file uploads, which may be media but can be any type\nof sizable data.
","f":{"n":"Google\\Http","p":"Google/Http.html"}},{"t":"C","n":"Google\\Http\\REST","p":"Google/Http/REST.html","d":"This class implements the RESTful transport of apiServiceRequest()'s
","f":{"n":"Google\\Http","p":"Google/Http.html"}},{"t":"C","n":"Google\\Model","p":"Google/Model.html","d":"This class defines attributes, valid values, and usage which is generated\nfrom a given json schema.
","f":{"n":"Google","p":"Google.html"}},{"t":"C","n":"Google\\Service","p":"Google/Service.html","d":null,"f":{"n":"Google","p":"Google.html"}},{"t":"C","n":"Google\\Service\\Exception","p":"Google/Service/Exception.html","d":null,"f":{"n":"Google\\Service","p":"Google/Service.html"}},{"t":"C","n":"Google\\Service\\Resource","p":"Google/Service/Resource.html","d":"Implements the actual methods/resources of the discovered Google API using magic function\ncalling overloading (__call()), which on call will see if the method name (plus.activities.list)\nis available in this service, and if so construct an apiHttpRequest representing it.
","f":{"n":"Google\\Service","p":"Google/Service.html"}},{"t":"C","n":"Google\\Task\\Composer","p":"Google/Task/Composer.html","d":null,"f":{"n":"Google\\Task","p":"Google/Task.html"}},{"t":"C","n":"Google\\Task\\Exception","p":"Google/Task/Exception.html","d":null,"f":{"n":"Google\\Task","p":"Google/Task.html"}},{"t":"C","n":"Google\\Task\\Retryable","p":"Google/Task/Retryable.html","d":"Interface for checking how many times a given task can be retried following\na failure.
","f":{"n":"Google\\Task","p":"Google/Task.html"}},{"t":"C","n":"Google\\Task\\Runner","p":"Google/Task/Runner.html","d":"A task runner with exponential backoff support.
","f":{"n":"Google\\Task","p":"Google/Task.html"}},{"t":"C","n":"Google\\Utils\\UriTemplate","p":"Google/Utils/UriTemplate.html","d":"Implementation of levels 1-3 of the URI Template spec.
","f":{"n":"Google\\Utils","p":"Google/Utils.html"}},{"t":"I","n":"Google\\Task\\Retryable","p":"Google/Task/Retryable.html","f":{"n":"Google\\Task","p":"Google/Task.html"}},{"t":"M","n":"Google\\AccessToken\\Revoke::__construct","p":"Google/AccessToken/Revoke.html#method___construct","d":"Instantiates the class, but does not initiate the login flow, leaving it\nto the discretion of the caller.
"},{"t":"M","n":"Google\\AccessToken\\Revoke::revokeToken","p":"Google/AccessToken/Revoke.html#method_revokeToken","d":"Revoke an OAuth2 access token or refresh token. This method will revoke the current access\ntoken, if a token isn't provided.
"},{"t":"M","n":"Google\\AccessToken\\Verify::__construct","p":"Google/AccessToken/Verify.html#method___construct","d":"Instantiates the class, but does not initiate the login flow, leaving it\nto the discretion of the caller.
"},{"t":"M","n":"Google\\AccessToken\\Verify::verifyIdToken","p":"Google/AccessToken/Verify.html#method_verifyIdToken","d":"Verifies an id token and returns the authenticated apiLoginTicket.
"},{"t":"M","n":"Google\\AuthHandler\\AuthHandlerFactory::build","p":"Google/AuthHandler/AuthHandlerFactory.html#method_build","d":"Builds out a default http handler for the installed version of guzzle.
"},{"t":"M","n":"Google\\AuthHandler\\Guzzle6AuthHandler::__construct","p":"Google/AuthHandler/Guzzle6AuthHandler.html#method___construct","d":null},{"t":"M","n":"Google\\AuthHandler\\Guzzle6AuthHandler::attachCredentials","p":"Google/AuthHandler/Guzzle6AuthHandler.html#method_attachCredentials","d":null},{"t":"M","n":"Google\\AuthHandler\\Guzzle6AuthHandler::attachCredentialsCache","p":"Google/AuthHandler/Guzzle6AuthHandler.html#method_attachCredentialsCache","d":null},{"t":"M","n":"Google\\AuthHandler\\Guzzle6AuthHandler::attachToken","p":"Google/AuthHandler/Guzzle6AuthHandler.html#method_attachToken","d":null},{"t":"M","n":"Google\\AuthHandler\\Guzzle6AuthHandler::attachKey","p":"Google/AuthHandler/Guzzle6AuthHandler.html#method_attachKey","d":null},{"t":"M","n":"Google\\Client::__construct","p":"Google/Client.html#method___construct","d":"Construct the Google Client.
"},{"t":"M","n":"Google\\Client::getLibraryVersion","p":"Google/Client.html#method_getLibraryVersion","d":"Get a string containing the version of the library.
"},{"t":"M","n":"Google\\Client::authenticate","p":"Google/Client.html#method_authenticate","d":"For backwards compatibility\nalias for fetchAccessTokenWithAuthCode
"},{"t":"M","n":"Google\\Client::fetchAccessTokenWithAuthCode","p":"Google/Client.html#method_fetchAccessTokenWithAuthCode","d":"Attempt to exchange a code for an valid authentication token.
"},{"t":"M","n":"Google\\Client::refreshTokenWithAssertion","p":"Google/Client.html#method_refreshTokenWithAssertion","d":"For backwards compatibility\nalias for fetchAccessTokenWithAssertion
"},{"t":"M","n":"Google\\Client::fetchAccessTokenWithAssertion","p":"Google/Client.html#method_fetchAccessTokenWithAssertion","d":"Fetches a fresh access token with a given assertion token.
"},{"t":"M","n":"Google\\Client::refreshToken","p":"Google/Client.html#method_refreshToken","d":"For backwards compatibility\nalias for fetchAccessTokenWithRefreshToken
"},{"t":"M","n":"Google\\Client::fetchAccessTokenWithRefreshToken","p":"Google/Client.html#method_fetchAccessTokenWithRefreshToken","d":"Fetches a fresh OAuth 2.0 access token with the given refresh token.
"},{"t":"M","n":"Google\\Client::createAuthUrl","p":"Google/Client.html#method_createAuthUrl","d":"Create a URL to obtain user authorization.
"},{"t":"M","n":"Google\\Client::authorize","p":"Google/Client.html#method_authorize","d":"Adds auth listeners to the HTTP client based on the credentials\nset in the Google API Client object
"},{"t":"M","n":"Google\\Client::useApplicationDefaultCredentials","p":"Google/Client.html#method_useApplicationDefaultCredentials","d":"Set the configuration to use application default credentials for\nauthentication
"},{"t":"M","n":"Google\\Client::isUsingApplicationDefaultCredentials","p":"Google/Client.html#method_isUsingApplicationDefaultCredentials","d":"To prevent useApplicationDefaultCredentials from inappropriately being\ncalled in a conditional
"},{"t":"M","n":"Google\\Client::setAccessToken","p":"Google/Client.html#method_setAccessToken","d":"Set the access token used for requests.
"},{"t":"M","n":"Google\\Client::getAccessToken","p":"Google/Client.html#method_getAccessToken","d":null},{"t":"M","n":"Google\\Client::getRefreshToken","p":"Google/Client.html#method_getRefreshToken","d":""},{"t":"M","n":"Google\\Client::isAccessTokenExpired","p":"Google/Client.html#method_isAccessTokenExpired","d":"Returns if the access_token is expired.
"},{"t":"M","n":"Google\\Client::getAuth","p":"Google/Client.html#method_getAuth","d":""},{"t":"M","n":"Google\\Client::setAuth","p":"Google/Client.html#method_setAuth","d":""},{"t":"M","n":"Google\\Client::setClientId","p":"Google/Client.html#method_setClientId","d":"Set the OAuth 2.0 Client ID.
"},{"t":"M","n":"Google\\Client::getClientId","p":"Google/Client.html#method_getClientId","d":null},{"t":"M","n":"Google\\Client::setClientSecret","p":"Google/Client.html#method_setClientSecret","d":"Set the OAuth 2.0 Client Secret.
"},{"t":"M","n":"Google\\Client::getClientSecret","p":"Google/Client.html#method_getClientSecret","d":null},{"t":"M","n":"Google\\Client::setRedirectUri","p":"Google/Client.html#method_setRedirectUri","d":"Set the OAuth 2.0 Redirect URI.
"},{"t":"M","n":"Google\\Client::getRedirectUri","p":"Google/Client.html#method_getRedirectUri","d":null},{"t":"M","n":"Google\\Client::setState","p":"Google/Client.html#method_setState","d":"Set OAuth 2.0 "state" parameter to achieve per-request customization.
"},{"t":"M","n":"Google\\Client::setAccessType","p":"Google/Client.html#method_setAccessType","d":""},{"t":"M","n":"Google\\Client::setApprovalPrompt","p":"Google/Client.html#method_setApprovalPrompt","d":""},{"t":"M","n":"Google\\Client::setLoginHint","p":"Google/Client.html#method_setLoginHint","d":"Set the login hint, email address or sub id.
"},{"t":"M","n":"Google\\Client::setApplicationName","p":"Google/Client.html#method_setApplicationName","d":"Set the application name, this is included in the User-Agent HTTP header.
"},{"t":"M","n":"Google\\Client::setRequestVisibleActions","p":"Google/Client.html#method_setRequestVisibleActions","d":"If 'plus.login' is included in the list of requested scopes, you can use\nthis method to define types of app activities that your app will write.
"},{"t":"M","n":"Google\\Client::setDeveloperKey","p":"Google/Client.html#method_setDeveloperKey","d":"Set the developer key to use, these are obtained through the API Console.
"},{"t":"M","n":"Google\\Client::setHostedDomain","p":"Google/Client.html#method_setHostedDomain","d":"Set the hd (hosted domain) parameter streamlines the login process for\nGoogle Apps hosted accounts. By including the domain of the user, you\nrestrict sign-in to accounts at that domain.
"},{"t":"M","n":"Google\\Client::setPrompt","p":"Google/Client.html#method_setPrompt","d":"Set the prompt hint. Valid values are none, consent and select_account.
"},{"t":"M","n":"Google\\Client::setOpenidRealm","p":"Google/Client.html#method_setOpenidRealm","d":"openid.realm is a parameter from the OpenID 2.0 protocol, not from OAuth\n2.0. It is used in OpenID 2.0 requests to signify the URL-space for which\nan authentication request is valid.
"},{"t":"M","n":"Google\\Client::setIncludeGrantedScopes","p":"Google/Client.html#method_setIncludeGrantedScopes","d":"If this is provided with the value true, and the authorization request is\ngranted, the authorization will include any previous authorizations\ngranted to this user/application combination for other scopes.
"},{"t":"M","n":"Google\\Client::setTokenCallback","p":"Google/Client.html#method_setTokenCallback","d":"sets function to be called when an access token is fetched
"},{"t":"M","n":"Google\\Client::revokeToken","p":"Google/Client.html#method_revokeToken","d":"Revoke an OAuth2 access token or refresh token. This method will revoke the current access\ntoken, if a token isn't provided.
"},{"t":"M","n":"Google\\Client::verifyIdToken","p":"Google/Client.html#method_verifyIdToken","d":"Verify an id_token. This method will verify the current id_token, if one\nisn't provided.
"},{"t":"M","n":"Google\\Client::setScopes","p":"Google/Client.html#method_setScopes","d":"Set the scopes to be requested. Must be called before createAuthUrl().
"},{"t":"M","n":"Google\\Client::addScope","p":"Google/Client.html#method_addScope","d":"This functions adds a scope to be requested as part of the OAuth2.0 flow.
"},{"t":"M","n":"Google\\Client::getScopes","p":"Google/Client.html#method_getScopes","d":"Returns the list of scopes requested by the client
"},{"t":"M","n":"Google\\Client::prepareScopes","p":"Google/Client.html#method_prepareScopes","d":""},{"t":"M","n":"Google\\Client::execute","p":"Google/Client.html#method_execute","d":"Helper method to execute deferred HTTP requests.
"},{"t":"M","n":"Google\\Client::setUseBatch","p":"Google/Client.html#method_setUseBatch","d":"Declare whether batch calls should be used. This may increase throughput\nby making multiple requests in one connection.
"},{"t":"M","n":"Google\\Client::isAppEngine","p":"Google/Client.html#method_isAppEngine","d":"Are we running in Google AppEngine?\nreturn bool
"},{"t":"M","n":"Google\\Client::setConfig","p":"Google/Client.html#method_setConfig","d":null},{"t":"M","n":"Google\\Client::getConfig","p":"Google/Client.html#method_getConfig","d":null},{"t":"M","n":"Google\\Client::setAuthConfigFile","p":"Google/Client.html#method_setAuthConfigFile","d":"For backwards compatibility\nalias for setAuthConfig
"},{"t":"M","n":"Google\\Client::setAuthConfig","p":"Google/Client.html#method_setAuthConfig","d":"Set the auth config from new or deprecated JSON config.
"},{"t":"M","n":"Google\\Client::setSubject","p":"Google/Client.html#method_setSubject","d":"Use when the service account has been delegated domain wide access.
"},{"t":"M","n":"Google\\Client::setDefer","p":"Google/Client.html#method_setDefer","d":"Declare whether making API calls should make the call immediately, or\nreturn a request which can be called with ->execute();
"},{"t":"M","n":"Google\\Client::shouldDefer","p":"Google/Client.html#method_shouldDefer","d":"Whether or not to return raw requests
"},{"t":"M","n":"Google\\Client::getOAuth2Service","p":"Google/Client.html#method_getOAuth2Service","d":""},{"t":"M","n":"Google\\Client::createOAuth2Service","p":"Google/Client.html#method_createOAuth2Service","d":"create a default google auth object
"},{"t":"M","n":"Google\\Client::setCache","p":"Google/Client.html#method_setCache","d":"Set the Cache object
"},{"t":"M","n":"Google\\Client::getCache","p":"Google/Client.html#method_getCache","d":""},{"t":"M","n":"Google\\Client::setCacheConfig","p":"Google/Client.html#method_setCacheConfig","d":""},{"t":"M","n":"Google\\Client::setLogger","p":"Google/Client.html#method_setLogger","d":"Set the Logger object
"},{"t":"M","n":"Google\\Client::getLogger","p":"Google/Client.html#method_getLogger","d":""},{"t":"M","n":"Google\\Client::createDefaultLogger","p":"Google/Client.html#method_createDefaultLogger","d":null},{"t":"M","n":"Google\\Client::createDefaultCache","p":"Google/Client.html#method_createDefaultCache","d":null},{"t":"M","n":"Google\\Client::setHttpClient","p":"Google/Client.html#method_setHttpClient","d":"Set the Http Client object
"},{"t":"M","n":"Google\\Client::getHttpClient","p":"Google/Client.html#method_getHttpClient","d":""},{"t":"M","n":"Google\\Client::setApiFormatV2","p":"Google/Client.html#method_setApiFormatV2","d":"Set the API format version.
"},{"t":"M","n":"Google\\Client::createDefaultHttpClient","p":"Google/Client.html#method_createDefaultHttpClient","d":null},{"t":"M","n":"Google\\Client::getAuthHandler","p":"Google/Client.html#method_getAuthHandler","d":null},{"t":"M","n":"Google\\Client::getUniverseDomain","p":"Google/Client.html#method_getUniverseDomain","d":null},{"t":"M","n":"Google\\Collection::rewind","p":"Google/Collection.html#method_rewind","d":""},{"t":"M","n":"Google\\Collection::current","p":"Google/Collection.html#method_current","d":""},{"t":"M","n":"Google\\Collection::key","p":"Google/Collection.html#method_key","d":""},{"t":"M","n":"Google\\Collection::next","p":"Google/Collection.html#method_next","d":""},{"t":"M","n":"Google\\Collection::valid","p":"Google/Collection.html#method_valid","d":""},{"t":"M","n":"Google\\Collection::count","p":"Google/Collection.html#method_count","d":""},{"t":"M","n":"Google\\Collection::offsetExists","p":"Google/Collection.html#method_offsetExists","d":""},{"t":"M","n":"Google\\Collection::offsetGet","p":"Google/Collection.html#method_offsetGet","d":""},{"t":"M","n":"Google\\Collection::offsetSet","p":"Google/Collection.html#method_offsetSet","d":""},{"t":"M","n":"Google\\Collection::offsetUnset","p":"Google/Collection.html#method_offsetUnset","d":""},{"t":"M","n":"Google\\Http\\Batch::__construct","p":"Google/Http/Batch.html#method___construct","d":null},{"t":"M","n":"Google\\Http\\Batch::add","p":"Google/Http/Batch.html#method_add","d":null},{"t":"M","n":"Google\\Http\\Batch::execute","p":"Google/Http/Batch.html#method_execute","d":null},{"t":"M","n":"Google\\Http\\Batch::parseResponse","p":"Google/Http/Batch.html#method_parseResponse","d":null},{"t":"M","n":"Google\\Http\\MediaFileUpload::__construct","p":"Google/Http/MediaFileUpload.html#method___construct","d":""},{"t":"M","n":"Google\\Http\\MediaFileUpload::setFileSize","p":"Google/Http/MediaFileUpload.html#method_setFileSize","d":"Set the size of the file that is being uploaded.
"},{"t":"M","n":"Google\\Http\\MediaFileUpload::getProgress","p":"Google/Http/MediaFileUpload.html#method_getProgress","d":"Return the progress on the upload
"},{"t":"M","n":"Google\\Http\\MediaFileUpload::nextChunk","p":"Google/Http/MediaFileUpload.html#method_nextChunk","d":"Send the next part of the file to upload.
"},{"t":"M","n":"Google\\Http\\MediaFileUpload::getHttpResultCode","p":"Google/Http/MediaFileUpload.html#method_getHttpResultCode","d":"Return the HTTP result code from the last call made.
"},{"t":"M","n":"Google\\Http\\MediaFileUpload::resume","p":"Google/Http/MediaFileUpload.html#method_resume","d":"Resume a previously unfinished upload
"},{"t":"M","n":"Google\\Http\\MediaFileUpload::getUploadType","p":"Google/Http/MediaFileUpload.html#method_getUploadType","d":"Valid upload types:
\n\nresumable (UPLOAD_RESUMABLE_TYPE) \nmedia (UPLOAD_MEDIA_TYPE) \nmultipart (UPLOAD_MULTIPART_TYPE) \n "},{"t":"M","n":"Google\\Http\\MediaFileUpload::getResumeUri","p":"Google/Http/MediaFileUpload.html#method_getResumeUri","d":null},{"t":"M","n":"Google\\Http\\MediaFileUpload::setChunkSize","p":"Google/Http/MediaFileUpload.html#method_setChunkSize","d":null},{"t":"M","n":"Google\\Http\\MediaFileUpload::getRequest","p":"Google/Http/MediaFileUpload.html#method_getRequest","d":null},{"t":"M","n":"Google\\Http\\REST::execute","p":"Google/Http/REST.html#method_execute","d":"Executes a Psr\\Http\\Message\\RequestInterface and (if applicable) automatically retries\nwhen errors occur.
"},{"t":"M","n":"Google\\Http\\REST::doExecute","p":"Google/Http/REST.html#method_doExecute","d":"Executes a Psr\\Http\\Message\\RequestInterface
"},{"t":"M","n":"Google\\Http\\REST::decodeHttpResponse","p":"Google/Http/REST.html#method_decodeHttpResponse","d":"Decode an HTTP Response.
"},{"t":"M","n":"Google\\Model::__construct","p":"Google/Model.html#method___construct","d":"Polymorphic - accepts a variable number of arguments dependent\non the type of the model subclass.
"},{"t":"M","n":"Google\\Model::__get","p":"Google/Model.html#method___get","d":"Getter that handles passthrough access to the data array, and lazy object creation.
"},{"t":"M","n":"Google\\Model::mapTypes","p":"Google/Model.html#method_mapTypes","d":"Initialize this object's properties from an array.
"},{"t":"M","n":"Google\\Model::gapiInit","p":"Google/Model.html#method_gapiInit","d":"Blank initialiser to be used in subclasses to do post-construction initialisation - this\navoids the need for subclasses to have to implement the variadics handling in their\nconstructors.
"},{"t":"M","n":"Google\\Model::toSimpleObject","p":"Google/Model.html#method_toSimpleObject","d":"Create a simplified object suitable for straightforward\nconversion to JSON. This is relatively expensive\ndue to the usage of reflection, but shouldn't be called\na whole lot, and is the most straightforward way to filter.
"},{"t":"M","n":"Google\\Model::isAssociativeArray","p":"Google/Model.html#method_isAssociativeArray","d":"Returns true only if the array is associative.
"},{"t":"M","n":"Google\\Model::assertIsArray","p":"Google/Model.html#method_assertIsArray","d":"Verify if $obj is an array.
"},{"t":"M","n":"Google\\Model::offsetExists","p":"Google/Model.html#method_offsetExists","d":""},{"t":"M","n":"Google\\Model::offsetGet","p":"Google/Model.html#method_offsetGet","d":""},{"t":"M","n":"Google\\Model::offsetSet","p":"Google/Model.html#method_offsetSet","d":""},{"t":"M","n":"Google\\Model::offsetUnset","p":"Google/Model.html#method_offsetUnset","d":""},{"t":"M","n":"Google\\Model::keyType","p":"Google/Model.html#method_keyType","d":null},{"t":"M","n":"Google\\Model::dataType","p":"Google/Model.html#method_dataType","d":null},{"t":"M","n":"Google\\Model::__isset","p":"Google/Model.html#method___isset","d":null},{"t":"M","n":"Google\\Model::__unset","p":"Google/Model.html#method___unset","d":null},{"t":"M","n":"Google\\Service::__construct","p":"Google/Service.html#method___construct","d":null},{"t":"M","n":"Google\\Service::getClient","p":"Google/Service.html#method_getClient","d":"Return the associated Google\\Client class.
"},{"t":"M","n":"Google\\Service::createBatch","p":"Google/Service.html#method_createBatch","d":"Create a new HTTP Batch handler for this service
"},{"t":"M","n":"Google\\Service\\Exception::__construct","p":"Google/Service/Exception.html#method___construct","d":"Override default constructor to add the ability to set $errors and a retry\nmap.
"},{"t":"M","n":"Google\\Service\\Exception::getErrors","p":"Google/Service/Exception.html#method_getErrors","d":"An example of the possible errors returned.
"},{"t":"M","n":"Google\\Service\\Resource::__construct","p":"Google/Service/Resource.html#method___construct","d":null},{"t":"M","n":"Google\\Service\\Resource::call","p":"Google/Service/Resource.html#method_call","d":"TODO: This function needs simplifying.
"},{"t":"M","n":"Google\\Service\\Resource::convertToArrayAndStripNulls","p":"Google/Service/Resource.html#method_convertToArrayAndStripNulls","d":null},{"t":"M","n":"Google\\Service\\Resource::createRequestUri","p":"Google/Service/Resource.html#method_createRequestUri","d":"Parse/expand request parameters and create a fully qualified\nrequest uri.
"},{"t":"M","n":"Google\\Task\\Composer::cleanup","p":"Google/Task/Composer.html#method_cleanup","d":""},{"t":"M","n":"Google\\Task\\Runner::__construct","p":"Google/Task/Runner.html#method___construct","d":"Creates a new task runner with exponential backoff support.
"},{"t":"M","n":"Google\\Task\\Runner::canAttempt","p":"Google/Task/Runner.html#method_canAttempt","d":"Checks if a retry can be attempted.
"},{"t":"M","n":"Google\\Task\\Runner::run","p":"Google/Task/Runner.html#method_run","d":"Runs the task and (if applicable) automatically retries when errors occur.
"},{"t":"M","n":"Google\\Task\\Runner::attempt","p":"Google/Task/Runner.html#method_attempt","d":"Runs a task once, if possible. This is useful for bypassing the run()\nloop.
"},{"t":"M","n":"Google\\Task\\Runner::allowedRetries","p":"Google/Task/Runner.html#method_allowedRetries","d":"Gets the number of times the associated task can be retried.
"},{"t":"M","n":"Google\\Task\\Runner::setRetryMap","p":"Google/Task/Runner.html#method_setRetryMap","d":null},{"t":"M","n":"Google\\Utils\\UriTemplate::parse","p":"Google/Utils/UriTemplate.html#method_parse","d":null},{"t":"M","n":"Google\\Utils\\UriTemplate::combine","p":"Google/Utils/UriTemplate.html#method_combine","d":null},{"t":"N","n":"Google","p":"Google.html"},{"t":"N","n":"Google\\AccessToken","p":"Google/AccessToken.html"},{"t":"N","n":"Google\\AuthHandler","p":"Google/AuthHandler.html"},{"t":"N","n":"Google\\Http","p":"Google/Http.html"},{"t":"N","n":"Google\\Service","p":"Google/Service.html"},{"t":"N","n":"Google\\Task","p":"Google/Task.html"},{"t":"N","n":"Google\\Utils","p":"Google/Utils.html"}]}
diff --git a/v2.15.5/doctum.js b/v2.15.5/doctum.js
new file mode 100644
index 000000000..e371762a2
--- /dev/null
+++ b/v2.15.5/doctum.js
@@ -0,0 +1,319 @@
+var Doctum = {
+ treeJson: {"tree":{"l":0,"n":"","p":"","c":[{"l":1,"n":"Google","p":"Google","c":[{"l":2,"n":"AccessToken","p":"Google/AccessToken","c":[{"l":3,"n":"Revoke","p":"Google/AccessToken/Revoke"},{"l":3,"n":"Verify","p":"Google/AccessToken/Verify"}]},{"l":2,"n":"AuthHandler","p":"Google/AuthHandler","c":[{"l":3,"n":"AuthHandlerFactory","p":"Google/AuthHandler/AuthHandlerFactory"},{"l":3,"n":"Guzzle6AuthHandler","p":"Google/AuthHandler/Guzzle6AuthHandler"},{"l":3,"n":"Guzzle7AuthHandler","p":"Google/AuthHandler/Guzzle7AuthHandler"}]},{"l":2,"n":"Http","p":"Google/Http","c":[{"l":3,"n":"Batch","p":"Google/Http/Batch"},{"l":3,"n":"MediaFileUpload","p":"Google/Http/MediaFileUpload"},{"l":3,"n":"REST","p":"Google/Http/REST"}]},{"l":2,"n":"Service","p":"Google/Service","c":[{"l":3,"n":"Exception","p":"Google/Service/Exception"},{"l":3,"n":"Resource","p":"Google/Service/Resource"}]},{"l":2,"n":"Task","p":"Google/Task","c":[{"l":3,"n":"Composer","p":"Google/Task/Composer"},{"l":3,"n":"Exception","p":"Google/Task/Exception"},{"l":3,"n":"Retryable","p":"Google/Task/Retryable"},{"l":3,"n":"Runner","p":"Google/Task/Runner"}]},{"l":2,"n":"Utils","p":"Google/Utils","c":[{"l":3,"n":"UriTemplate","p":"Google/Utils/UriTemplate"}]},{"l":2,"n":"Client","p":"Google/Client"},{"l":2,"n":"Collection","p":"Google/Collection"},{"l":2,"n":"Exception","p":"Google/Exception"},{"l":2,"n":"Model","p":"Google/Model"},{"l":2,"n":"Service","p":"Google/Service"}]}]},"treeOpenLevel":1},
+ /** @var boolean */
+ treeLoaded: false,
+ /** @var boolean */
+ listenersRegistered: false,
+ autoCompleteData: null,
+ /** @var boolean */
+ autoCompleteLoading: false,
+ /** @var boolean */
+ autoCompleteLoaded: false,
+ /** @var string|null */
+ rootPath: null,
+ /** @var string|null */
+ autoCompleteDataUrl: null,
+ /** @var HTMLElement|null */
+ doctumSearchAutoComplete: null,
+ /** @var HTMLElement|null */
+ doctumSearchAutoCompleteProgressBarContainer: null,
+ /** @var HTMLElement|null */
+ doctumSearchAutoCompleteProgressBar: null,
+ /** @var number */
+ doctumSearchAutoCompleteProgressBarPercent: 0,
+ /** @var autoComplete|null */
+ autoCompleteJS: null,
+ querySearchSecurityRegex: /([^0-9a-zA-Z:\\\\_\s])/gi,
+ buildTreeNode: function (treeNode, htmlNode, treeOpenLevel) {
+ var ulNode = document.createElement('ul');
+ for (var childKey in treeNode.c) {
+ var child = treeNode.c[childKey];
+ var liClass = document.createElement('li');
+ var hasChildren = child.hasOwnProperty('c');
+ var nodeSpecialName = (hasChildren ? 'namespace:' : 'class:') + child.p.replace(/\//g, '_');
+ liClass.setAttribute('data-name', nodeSpecialName);
+
+ // Create the node that will have the text
+ var divHd = document.createElement('div');
+ var levelCss = child.l - 1;
+ divHd.className = hasChildren ? 'hd' : 'hd leaf';
+ divHd.style.paddingLeft = (hasChildren ? (levelCss * 18) : (8 + (levelCss * 18))) + 'px';
+ if (hasChildren) {
+ if (child.l <= treeOpenLevel) {
+ liClass.className = 'opened';
+ }
+ var spanIcon = document.createElement('span');
+ spanIcon.className = 'icon icon-play';
+ divHd.appendChild(spanIcon);
+ }
+ var aLink = document.createElement('a');
+
+ // Edit the HTML link to work correctly based on the current depth
+ aLink.href = Doctum.rootPath + child.p + '.html';
+ aLink.innerText = child.n;
+ divHd.appendChild(aLink);
+ liClass.appendChild(divHd);
+
+ // It has children
+ if (hasChildren) {
+ var divBd = document.createElement('div');
+ divBd.className = 'bd';
+ Doctum.buildTreeNode(child, divBd, treeOpenLevel);
+ liClass.appendChild(divBd);
+ }
+ ulNode.appendChild(liClass);
+ }
+ htmlNode.appendChild(ulNode);
+ },
+ initListeners: function () {
+ if (Doctum.listenersRegistered) {
+ // Quick exit, already registered
+ return;
+ }
+ Doctum.listenersRegistered = true;
+ },
+ loadTree: function () {
+ if (Doctum.treeLoaded) {
+ // Quick exit, already registered
+ return;
+ }
+ Doctum.rootPath = document.body.getAttribute('data-root-path');
+ Doctum.buildTreeNode(Doctum.treeJson.tree, document.getElementById('api-tree'), Doctum.treeJson.treeOpenLevel);
+
+ // Toggle left-nav divs on click
+ $('#api-tree .hd span').on('click', function () {
+ $(this).parent().parent().toggleClass('opened');
+ });
+
+ // Expand the parent namespaces of the current page.
+ var expected = $('body').attr('data-name');
+
+ if (expected) {
+ // Open the currently selected node and its parents.
+ var container = $('#api-tree');
+ var node = $('#api-tree li[data-name="' + expected + '"]');
+ // Node might not be found when simulating namespaces
+ if (node.length > 0) {
+ node.addClass('active').addClass('opened');
+ node.parents('li').addClass('opened');
+ var scrollPos = node.offset().top - container.offset().top + container.scrollTop();
+ // Position the item nearer to the top of the screen.
+ scrollPos -= 200;
+ container.scrollTop(scrollPos);
+ }
+ }
+ Doctum.treeLoaded = true;
+ },
+ pagePartiallyLoaded: function (event) {
+ Doctum.initListeners();
+ Doctum.loadTree();
+ Doctum.loadAutoComplete();
+ },
+ pageFullyLoaded: function (event) {
+ // it may not have received DOMContentLoaded event
+ Doctum.initListeners();
+ Doctum.loadTree();
+ Doctum.loadAutoComplete();
+ // Fire the event in the search page too
+ if (typeof DoctumSearch === 'object') {
+ DoctumSearch.pageFullyLoaded();
+ }
+ },
+ loadAutoComplete: function () {
+ if (Doctum.autoCompleteLoaded) {
+ // Quick exit, already loaded
+ return;
+ }
+ Doctum.autoCompleteDataUrl = document.body.getAttribute('data-search-index-url');
+ Doctum.doctumSearchAutoComplete = document.getElementById('doctum-search-auto-complete');
+ Doctum.doctumSearchAutoCompleteProgressBarContainer = document.getElementById('search-progress-bar-container');
+ Doctum.doctumSearchAutoCompleteProgressBar = document.getElementById('search-progress-bar');
+ if (Doctum.doctumSearchAutoComplete !== null) {
+ // Wait for it to be loaded
+ Doctum.doctumSearchAutoComplete.addEventListener('init', function (_) {
+ Doctum.autoCompleteLoaded = true;
+ Doctum.doctumSearchAutoComplete.addEventListener('selection', function (event) {
+ // Go to selection page
+ window.location = Doctum.rootPath + event.detail.selection.value.p;
+ });
+ Doctum.doctumSearchAutoComplete.addEventListener('navigate', function (event) {
+ // Set selection in text box
+ if (typeof event.detail.selection.value === 'object') {
+ Doctum.doctumSearchAutoComplete.value = event.detail.selection.value.n;
+ }
+ });
+ Doctum.doctumSearchAutoComplete.addEventListener('results', function (event) {
+ Doctum.markProgressFinished();
+ });
+ });
+ }
+ // Check if the lib is loaded
+ if (typeof autoComplete === 'function') {
+ Doctum.bootAutoComplete();
+ }
+ },
+ markInProgress: function () {
+ Doctum.doctumSearchAutoCompleteProgressBarContainer.className = 'search-bar';
+ Doctum.doctumSearchAutoCompleteProgressBar.className = 'progress-bar indeterminate';
+ if (typeof DoctumSearch === 'object' && DoctumSearch.pageFullyLoaded) {
+ DoctumSearch.doctumSearchPageAutoCompleteProgressBarContainer.className = 'search-bar';
+ DoctumSearch.doctumSearchPageAutoCompleteProgressBar.className = 'progress-bar indeterminate';
+ }
+ },
+ markProgressFinished: function () {
+ Doctum.doctumSearchAutoCompleteProgressBarContainer.className = 'search-bar hidden';
+ Doctum.doctumSearchAutoCompleteProgressBar.className = 'progress-bar';
+ if (typeof DoctumSearch === 'object' && DoctumSearch.pageFullyLoaded) {
+ DoctumSearch.doctumSearchPageAutoCompleteProgressBarContainer.className = 'search-bar hidden';
+ DoctumSearch.doctumSearchPageAutoCompleteProgressBar.className = 'progress-bar';
+ }
+ },
+ makeProgess: function () {
+ Doctum.makeProgressOnProgressBar(
+ Doctum.doctumSearchAutoCompleteProgressBarPercent,
+ Doctum.doctumSearchAutoCompleteProgressBar
+ );
+ if (typeof DoctumSearch === 'object' && DoctumSearch.pageFullyLoaded) {
+ Doctum.makeProgressOnProgressBar(
+ Doctum.doctumSearchAutoCompleteProgressBarPercent,
+ DoctumSearch.doctumSearchPageAutoCompleteProgressBar
+ );
+ }
+ },
+ loadAutoCompleteData: function (query) {
+ return new Promise(function (resolve, reject) {
+ if (Doctum.autoCompleteData !== null) {
+ resolve(Doctum.autoCompleteData);
+ return;
+ }
+ Doctum.markInProgress();
+ function reqListener() {
+ Doctum.autoCompleteLoading = false;
+ Doctum.autoCompleteData = JSON.parse(this.responseText).items;
+ Doctum.markProgressFinished();
+
+ setTimeout(function () {
+ resolve(Doctum.autoCompleteData);
+ }, 50);// Let the UI render once before sending the results for processing. This gives time to the progress bar to hide
+ }
+ function reqError(err) {
+ Doctum.autoCompleteLoading = false;
+ Doctum.autoCompleteData = null;
+ console.error(err);
+ reject(err);
+ }
+
+ var oReq = new XMLHttpRequest();
+ oReq.onload = reqListener;
+ oReq.onerror = reqError;
+ oReq.onprogress = function (pe) {
+ if (pe.lengthComputable) {
+ Doctum.doctumSearchAutoCompleteProgressBarPercent = parseInt(pe.loaded / pe.total * 100, 10);
+ Doctum.makeProgess();
+ }
+ };
+ oReq.onloadend = function (_) {
+ Doctum.markProgressFinished();
+ };
+ oReq.open('get', Doctum.autoCompleteDataUrl, true);
+ oReq.send();
+ });
+ },
+ /**
+ * Make some progress on a progress bar
+ *
+ * @param number percentage
+ * @param HTMLElement progressBar
+ * @return void
+ */
+ makeProgressOnProgressBar: function(percentage, progressBar) {
+ progressBar.className = 'progress-bar';
+ progressBar.style.width = percentage + '%';
+ progressBar.setAttribute(
+ 'aria-valuenow', percentage
+ );
+ },
+ searchEngine: function (query, record) {
+ if (typeof query !== 'string') {
+ return '';
+ }
+ // replace all (mode = g) spaces and non breaking spaces (\s) by pipes
+ // g = global mode to mark also the second word searched
+ // i = case insensitive
+ // how this function works:
+ // First: search if the query has the keywords in sequence
+ // Second: replace the keywords by a mark and leave all the text in between non marked
+
+ if (record.match(new RegExp('(' + query.replace(/\s/g, ').*(') + ')', 'gi')) === null) {
+ return '';// Does not match
+ }
+
+ var replacedRecord = record.replace(new RegExp('(' + query.replace(/\s/g, '|') + ')', 'gi'), function (group) {
+ return '' + group + ' ';
+ });
+
+ if (replacedRecord !== record) {
+ return replacedRecord;// This should not happen but just in case there was no match done
+ }
+
+ return '';
+ },
+ /**
+ * Clean the search query
+ *
+ * @param string|null query
+ * @return string
+ */
+ cleanSearchQuery: function (query) {
+ if (typeof query !== 'string') {
+ return '';
+ }
+ // replace any chars that could lead to injecting code in our regex
+ // remove start or end spaces
+ // replace backslashes by an escaped version, use case in search: \myRootFunction
+ return query.replace(Doctum.querySearchSecurityRegex, '').trim().replace(/\\/g, '\\\\');
+ },
+ bootAutoComplete: function () {
+ Doctum.autoCompleteJS = new autoComplete(
+ {
+ selector: '#doctum-search-auto-complete',
+ searchEngine: function (query, record) {
+ return Doctum.searchEngine(query, record);
+ },
+ submit: true,
+ data: {
+ src: function (q) {
+ Doctum.markInProgress();
+ return Doctum.loadAutoCompleteData(q);
+ },
+ keys: ['n'],// Data 'Object' key to be searched
+ cache: false, // Is not compatible with async fetch of data
+ },
+ query: (input) => {
+ return Doctum.cleanSearchQuery(input);
+ },
+ trigger: (query) => {
+ return Doctum.cleanSearchQuery(query).length > 0;
+ },
+ resultsList: {
+ tag: 'ul',
+ class: 'auto-complete-dropdown-menu',
+ destination: '#auto-complete-results',
+ position: 'afterbegin',
+ maxResults: 500,
+ noResults: false,
+ },
+ resultItem: {
+ tag: 'li',
+ class: 'auto-complete-result',
+ highlight: 'auto-complete-highlight',
+ selected: 'auto-complete-selected'
+ },
+ }
+ );
+ }
+};
+
+
+document.addEventListener('DOMContentLoaded', Doctum.pagePartiallyLoaded, false);
+window.addEventListener('load', Doctum.pageFullyLoaded, false);
diff --git a/v2.15.5/fonts/doctum-font.css b/v2.15.5/fonts/doctum-font.css
new file mode 100644
index 000000000..d022b4c34
--- /dev/null
+++ b/v2.15.5/fonts/doctum-font.css
@@ -0,0 +1,61 @@
+@font-face {
+ font-family: "doctum";
+ src: url("./doctum.eot?39101248");
+ src: url("./doctum.eot?39101248#iefix") format("embedded-opentype"),
+ url("./doctum.woff2?39101248") format("woff2"), url("./doctum.woff?39101248") format("woff"),
+ url("./doctum.ttf?39101248") format("truetype"), url("./doctum.svg?39101248#doctum") format("svg");
+ font-weight: normal;
+ font-style: normal;
+}
+/* Chrome hack: SVG is rendered more smooth in Windozze. 100% magic, uncomment if you need it. */
+/* Note, that will break hinting! In other OS-es font will be not as sharp as it could be */
+/*
+@media screen and (-webkit-min-device-pixel-ratio:0) {
+ @font-face {
+ font-family: 'doctum';
+ src: url('./doctum.svg?39101248#doctum') format('svg');
+ }
+}
+*/
+
+.icon {
+ font-family: "doctum";
+ font-style: normal;
+ font-weight: normal;
+ speak: never;
+
+ display: inline-block;
+ text-decoration: inherit;
+ width: 1em;
+ margin-right: 0.2em;
+ text-align: center;
+ /* opacity: .8; */
+
+ /* For safety - reset parent styles, that can break glyph codes*/
+ font-variant: normal;
+ text-transform: none;
+
+ /* fix buttons height, for twitter bootstrap */
+ line-height: 1em;
+
+ /* Animation center compensation - margins should be symmetric */
+ /* remove if not needed */
+ margin-left: 0.2em;
+
+ /* you can be more comfortable with increased icons size */
+ /* font-size: 120%; */
+
+ /* Font smoothing. That was taken from TWBS */
+ -webkit-font-smoothing: antialiased;
+ -moz-osx-font-smoothing: grayscale;
+
+ /* Uncomment for 3D effect */
+ /* text-shadow: 1px 1px 1px rgba(127, 127, 127, 0.3); */
+}
+
+.icon-search:before {
+ content: "\e800";
+} /* '' */
+.icon-play:before {
+ content: "\e801";
+} /* '' */
diff --git a/v2.15.5/fonts/doctum.eot b/v2.15.5/fonts/doctum.eot
new file mode 100644
index 000000000..0daf464c7
Binary files /dev/null and b/v2.15.5/fonts/doctum.eot differ
diff --git a/v2.15.5/fonts/doctum.svg b/v2.15.5/fonts/doctum.svg
new file mode 100644
index 000000000..341469b6c
--- /dev/null
+++ b/v2.15.5/fonts/doctum.svg
@@ -0,0 +1,14 @@
+
+
+
+Material Design Icons
+
+
+
+
+
\ No newline at end of file
diff --git a/v2.15.5/fonts/doctum.ttf b/v2.15.5/fonts/doctum.ttf
new file mode 100644
index 000000000..cf3f81625
Binary files /dev/null and b/v2.15.5/fonts/doctum.ttf differ
diff --git a/v2.15.5/fonts/doctum.woff b/v2.15.5/fonts/doctum.woff
new file mode 100644
index 000000000..6e1ca3b57
Binary files /dev/null and b/v2.15.5/fonts/doctum.woff differ
diff --git a/v2.15.5/fonts/doctum.woff2 b/v2.15.5/fonts/doctum.woff2
new file mode 100644
index 000000000..e7b1a3e81
Binary files /dev/null and b/v2.15.5/fonts/doctum.woff2 differ
diff --git a/v2.15.5/index.html b/v2.15.5/index.html
new file mode 100644
index 000000000..c6e77f8d4
--- /dev/null
+++ b/v2.15.5/index.html
@@ -0,0 +1,99 @@
+
+
+
+ Namespaces | Google Cloud PHP Client
+
+ Interfaces | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Interface for checking how many times a given task can be retried following
+a failure.
+
+
+
+
t.length)&&(e=t.length);for(var n=0,r=new Array(e);n=t.length?{done:!0}:{done:!1,value:t[r++]}},e:function(t){throw t},f:i}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}var s,u=!0,a=!1;return{s:function(){n=n.call(t)},n:function(){var t=n.next();return u=t.done,t},e:function(t){a=!0,s=t},f:function(){try{u||null==n.return||n.return()}finally{if(a)throw s}}}}(n.keys);try{for(l.s();!(c=l.n()).done;)a(c.value)}catch(t){l.e(t)}finally{l.f()}}else a()})),n.filter&&(i=n.filter(i));var s=i.slice(0,e.resultsList.maxResults);e.feedback={query:t,matches:i,results:s},f("results",e)},m="aria-expanded",b="aria-activedescendant",y="aria-selected",v=function(t,n){t.feedback.selection=e({index:n},t.feedback.results[n])},g=function(t){t.isOpen||((t.wrapper||t.input).setAttribute(m,!0),t.list.removeAttribute("hidden"),t.isOpen=!0,f("open",t))},w=function(t){t.isOpen&&((t.wrapper||t.input).setAttribute(m,!1),t.input.setAttribute(b,""),t.list.setAttribute("hidden",""),t.isOpen=!1,f("close",t))},O=function(t,e){var n=e.resultItem,r=e.list.getElementsByTagName(n.tag),o=!!n.selected&&n.selected.split(" ");if(e.isOpen&&r.length){var s,u,a=e.cursor;t>=r.length&&(t=0),t<0&&(t=r.length-1),e.cursor=t,a>-1&&(r[a].removeAttribute(y),o&&(u=r[a].classList).remove.apply(u,i(o))),r[t].setAttribute(y,!0),o&&(s=r[t].classList).add.apply(s,i(o)),e.input.setAttribute(b,r[e.cursor].id),e.list.scrollTop=r[t].offsetTop-e.list.clientHeight+r[t].clientHeight+5,e.feedback.cursor=e.cursor,v(e,t),f("navigate",e)}},A=function(t){O(t.cursor+1,t)},k=function(t){O(t.cursor-1,t)},L=function(t,e,n){(n=n>=0?n:t.cursor)<0||(t.feedback.event=e,v(t,n),f("selection",t),w(t))};function j(t,n){var r=this;return new Promise((function(i,o){var s,u;return s=n||((u=t.input)instanceof HTMLInputElement||u instanceof HTMLTextAreaElement?u.value:u.innerHTML),function(t,e,n){return e?e(t):t.length>=n}(s=t.query?t.query(s):s,t.trigger,t.threshold)?d(t,s).then((function(n){try{return t.feedback instanceof Error?i():(h(s,t),t.resultsList&&function(t){var n=t.resultsList,r=t.list,i=t.resultItem,o=t.feedback,s=o.matches,u=o.results;if(t.cursor=-1,r.innerHTML="",s.length||n.noResults){var c=new DocumentFragment;u.forEach((function(t,n){var r=a(i.tag,e({id:"".concat(i.id,"_").concat(n),role:"option",innerHTML:t.match,inside:c},i.class&&{class:i.class}));i.element&&i.element(r,t)})),r.append(c),n.element&&n.element(r,o),g(t)}else w(t)}(t),c.call(r))}catch(t){return o(t)}}),o):(w(t),c.call(r));function c(){return i()}}))}var S=function(t,e){for(var n in t)for(var r in t[n])e(n,r)},T=function(t){var n,r,i,o=t.events,s=(n=function(){return j(t)},r=t.debounce,function(){clearTimeout(i),i=setTimeout((function(){return n()}),r)}),u=t.events=e({input:e({},o&&o.input)},t.resultsList&&{list:o?e({},o.list):{}}),a={input:{input:function(){s()},keydown:function(e){!function(t,e){switch(t.keyCode){case 40:case 38:t.preventDefault(),40===t.keyCode?A(e):k(e);break;case 13:e.submit||t.preventDefault(),e.cursor>=0&&L(e,t);break;case 9:e.resultsList.tabSelect&&e.cursor>=0&&L(e,t);break;case 27:e.input.value="",w(e)}}(e,t)},blur:function(){w(t)}},list:{mousedown:function(t){t.preventDefault()},click:function(e){!function(t,e){var n=e.resultItem.tag.toUpperCase(),r=Array.from(e.list.querySelectorAll(n)),i=t.target.closest(n);i&&i.nodeName===n&&L(e,t,r.indexOf(i))}(e,t)}}};S(a,(function(e,n){(t.resultsList||"input"===n)&&(u[e][n]||(u[e][n]=a[e][n]))})),S(u,(function(e,n){t[e].addEventListener(n,u[e][n])}))};function E(t){var n=this;return new Promise((function(r,i){var o,s,u;if(o=t.placeHolder,u={role:"combobox","aria-owns":(s=t.resultsList).id,"aria-haspopup":!0,"aria-expanded":!1},a(t.input,e(e({"aria-controls":s.id,"aria-autocomplete":"both"},o&&{placeholder:o}),!t.wrapper&&e({},u))),t.wrapper&&(t.wrapper=a("div",e({around:t.input,class:t.name+"_wrapper"},u))),s&&(t.list=a(s.tag,e({dest:[s.destination,s.position],id:s.id,role:"listbox",hidden:"hidden"},s.class&&{class:s.class}))),T(t),t.data.cache)return d(t).then((function(t){try{return c.call(n)}catch(t){return i(t)}}),i);function c(){return f("init",t),r()}return c.call(n)}))}function x(t){var e=t.prototype;e.init=function(){E(this)},e.start=function(t){j(this,t)},e.unInit=function(){if(this.wrapper){var t=this.wrapper.parentNode;t.insertBefore(this.input,this.wrapper),t.removeChild(this.wrapper)}var e;S((e=this).events,(function(t,n){e[t].removeEventListener(n,e.events[t][n])}))},e.open=function(){g(this)},e.close=function(){w(this)},e.goTo=function(t){O(t,this)},e.next=function(){A(this)},e.previous=function(){k(this)},e.select=function(t){L(this,null,t)},e.search=function(t,e,n){return p(t,e,n)}}return function t(e){this.options=e,this.id=t.instances=(t.instances||0)+1,this.name="autoComplete",this.wrapper=1,this.threshold=1,this.debounce=0,this.resultsList={position:"afterend",tag:"ul",maxResults:5},this.resultItem={tag:"li"},function(t){var e=t.name,r=t.options,i=t.resultsList,o=t.resultItem;for(var s in r)if("object"===n(r[s]))for(var a in t[s]||(t[s]={}),r[s])t[s][a]=r[s][a];else t[s]=r[s];t.selector=t.selector||"#"+e,i.destination=i.destination||t.selector,i.id=i.id||e+"_list_"+t.id,o.id=o.id||e+"_result",t.input=u(t.selector)}(this),x.call(this,t),E(this)}},"object"==typeof exports&&"undefined"!=typeof module?module.exports=e():"function"==typeof define&&define.amd?define(e):(t="undefined"!=typeof globalThis?globalThis:t||self).autoComplete=e();
diff --git a/v2.15.5/js/bootstrap.min.js b/v2.15.5/js/bootstrap.min.js
new file mode 100644
index 000000000..5c8647b12
--- /dev/null
+++ b/v2.15.5/js/bootstrap.min.js
@@ -0,0 +1,11 @@
+/*!
+ * Generated using the Bootstrap Customizer (https://getbootstrap.com/docs/3.4/customize/)
+ */
+
+/*!
+ * Bootstrap v3.4.1 (https://getbootstrap.com/)
+ * Copyright 2011-2021 Twitter, Inc.
+ * Licensed under the MIT license
+ */
+
+if("undefined"==typeof jQuery)throw new Error("Bootstrap's JavaScript requires jQuery");+function(t){"use strict";var e=t.fn.jquery.split(" ")[0].split(".");if(e[0]<2&&e[1]<9||1==e[0]&&9==e[1]&&e[2]<1||e[0]>3)throw new Error("Bootstrap's JavaScript requires jQuery version 1.9.1 or higher, but lower than version 4")}(jQuery),+function(t){"use strict";function e(e){var a=e.attr("data-target");a||(a=e.attr("href"),a=a&&/#[A-Za-z]/.test(a)&&a.replace(/.*(?=#[^\s]*$)/,""));var n="#"!==a?t(document).find(a):null;return n&&n.length?n:e.parent()}function a(a){a&&3===a.which||(t(i).remove(),t(s).each(function(){var n=t(this),i=e(n),s={relatedTarget:this};i.hasClass("open")&&(a&&"click"==a.type&&/input|textarea/i.test(a.target.tagName)&&t.contains(i[0],a.target)||(i.trigger(a=t.Event("hide.bs.dropdown",s)),a.isDefaultPrevented()||(n.attr("aria-expanded","false"),i.removeClass("open").trigger(t.Event("hidden.bs.dropdown",s)))))}))}function n(e){return this.each(function(){var a=t(this),n=a.data("bs.dropdown");n||a.data("bs.dropdown",n=new o(this)),"string"==typeof e&&n[e].call(a)})}var i=".dropdown-backdrop",s='[data-toggle="dropdown"]',o=function(e){t(e).on("click.bs.dropdown",this.toggle)};o.VERSION="3.4.1",o.prototype.toggle=function(n){var i=t(this);if(!i.is(".disabled, :disabled")){var s=e(i),o=s.hasClass("open");if(a(),!o){"ontouchstart"in document.documentElement&&!s.closest(".navbar-nav").length&&t(document.createElement("div")).addClass("dropdown-backdrop").insertAfter(t(this)).on("click",a);var r={relatedTarget:this};if(s.trigger(n=t.Event("show.bs.dropdown",r)),n.isDefaultPrevented())return;i.trigger("focus").attr("aria-expanded","true"),s.toggleClass("open").trigger(t.Event("shown.bs.dropdown",r))}return!1}},o.prototype.keydown=function(a){if(/(38|40|27|32)/.test(a.which)&&!/input|textarea/i.test(a.target.tagName)){var n=t(this);if(a.preventDefault(),a.stopPropagation(),!n.is(".disabled, :disabled")){var i=e(n),o=i.hasClass("open");if(!o&&27!=a.which||o&&27==a.which)return 27==a.which&&i.find(s).trigger("focus"),n.trigger("click");var r=" li:not(.disabled):visible a",l=i.find(".dropdown-menu"+r);if(l.length){var d=l.index(a.target);38==a.which&&d>0&&d--,40==a.which&&d+~]|"+R+")"+R+"*"),U=new RegExp(R+"|>"),V=new RegExp(W),X=new RegExp("^"+B+"$"),Q={ID:new RegExp("^#("+B+")"),CLASS:new RegExp("^\\.("+B+")"),TAG:new RegExp("^("+B+"|[*])"),ATTR:new RegExp("^"+M),PSEUDO:new RegExp("^"+W),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+R+"*(even|odd|(([+-]|)(\\d*)n|)"+R+"*(?:([+-]|)"+R+"*(\\d+)|))"+R+"*\\)|)","i"),bool:new RegExp("^(?:"+I+")$","i"),needsContext:new RegExp("^"+R+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+R+"*((?:-\\d)?\\d*)"+R+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,G=/^(?:input|select|textarea|button)$/i,K=/^h\d$/i,J=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+R+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){C()},ae=xe(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{O.apply(t=P.call(d.childNodes),d.childNodes),t[d.childNodes.length].nodeType}catch(e){O={apply:t.length?function(e,t){q.apply(e,P.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,d=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==d&&9!==d&&11!==d)return n;if(!r&&(C(e),e=e||T,E)){if(11!==d&&(u=Z.exec(t)))if(i=u[1]){if(9===d){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return O.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&p.getElementsByClassName&&e.getElementsByClassName)return O.apply(n,e.getElementsByClassName(i)),n}if(p.qsa&&!k[t+" "]&&(!v||!v.test(t))&&(1!==d||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===d&&(U.test(t)||_.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&p.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=A)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+be(l[o]);c=l.join(",")}try{return O.apply(n,f.querySelectorAll(c)),n}catch(e){k(t,!0)}finally{s===A&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>x.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[A]=!0,e}function ce(e){var t=T.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)x.attrHandle[n[r]]=t}function de(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function pe(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in p=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},C=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:d;return r!=T&&9===r.nodeType&&r.documentElement&&(a=(T=r).documentElement,E=!i(T),d!=T&&(n=T.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),p.scope=ce(function(e){return a.appendChild(e).appendChild(T.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),p.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),p.getElementsByTagName=ce(function(e){return e.appendChild(T.createComment("")),!e.getElementsByTagName("*").length}),p.getElementsByClassName=J.test(T.getElementsByClassName),p.getById=ce(function(e){return a.appendChild(e).id=A,!T.getElementsByName||!T.getElementsByName(A).length}),p.getById?(x.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},x.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(x.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},x.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),x.find.TAG=p.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):p.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},x.find.CLASS=p.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(p.qsa=J.test(T.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return Q.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&V.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+R+")"+e+"("+R+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function D(e,n,r){return b(n)?E.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?E.grep(e,function(e){return e===n!==r}):"string"!=typeof n?E.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(E.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||L,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:j.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof E?t[0]:t,E.merge(this,E.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:w,!0)),k.test(r[1])&&E.isPlainObject(t))for(r in t)b(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=w.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):b(e)?void 0!==n.ready?n.ready(e):e(E):E.makeArray(e,this)}).prototype=E.fn,L=E(w);var q=/^(?:parents|prev(?:Until|All))/,O={children:!0,contents:!0,next:!0,prev:!0};function P(e,t){while((e=e[t])&&1!==e.nodeType);return e}E.fn.extend({has:function(e){var t=E(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,pe=/^$|^module$|\/(?:java|ecma)script/i;le=w.createDocumentFragment().appendChild(w.createElement("div")),(ce=w.createElement("input")).setAttribute("type","radio"),ce.setAttribute("checked","checked"),ce.setAttribute("name","t"),le.appendChild(ce),m.checkClone=le.cloneNode(!0).cloneNode(!0).lastChild.checked,le.innerHTML="",m.noCloneChecked=!!le.cloneNode(!0).lastChild.defaultValue,le.innerHTML="",""]);var ye=/<|&#?\w+;/;function me(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),d=[],p=0,h=e.length;p\s*$/g;function Le(e,t){return S(e,"table")&&S(11!==t.nodeType?t:t.firstChild,"tr")&&E(e).children("tbody")[0]||e}function je(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Oe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n",2===ft.childNodes.length),E.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(m.createHTMLDocument?((r=(t=w.implementation.createHTMLDocument("")).createElement("base")).href=w.location.href,t.head.appendChild(r)):t=w),o=!n&&[],(i=k.exec(e))?[t.createElement(i[1])]:(i=me([e],t,o),o&&o.length&&E(o).remove(),E.merge([],i.childNodes)));var r,i,o},E.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=E.css(e,"position"),c=E(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=E.css(e,"top"),u=E.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),b(t)&&(t=t.call(e,n,E.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):("number"==typeof f.top&&(f.top+="px"),"number"==typeof f.left&&(f.left+="px"),c.css(f))}},E.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){E.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===E.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===E.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=E(e).offset()).top+=E.css(e,"borderTopWidth",!0),i.left+=E.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-E.css(r,"marginTop",!0),left:t.left-i.left-E.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===E.css(e,"position"))e=e.offsetParent;return e||re})}}),E.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;E.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),E.each(["top","left"],function(e,n){E.cssHooks[n]=Fe(m.pixelPosition,function(e,t){if(t)return t=We(e,n),Ie.test(t)?E(e).position()[n]+"px":t})}),E.each({Height:"height",Width:"width"},function(a,s){E.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){E.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?E.css(e,t,i):E.style(e,t,n,i)},s,n?e:void 0,n)}})}),E.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),E.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){E.fn[n]=function(e,t){return 0
+
+
+ Namespaces | Google Cloud PHP Client
+
+ Search | Google Cloud PHP Client
+
+
+
+
+
+
+
+
+
+
+
+
This page allows you to search through the API documentation for
+ specific terms. Enter your search words into the box below and click
+ "submit". The search will be performed on namespaces, classes, interfaces,
+ traits, functions, and methods.
+
+
+
+
+
+
+
+
+
+
+
+
+
Traits | Google Cloud PHP Client
+
+