A
AuthHandlerFactory — Class in namespace Google\AuthHandler
Guzzle5AuthHandler ::attachCredentials () — Method in class Guzzle5AuthHandler
Guzzle5AuthHandler ::attachCredentialsCache () — Method in class Guzzle5AuthHandler
Guzzle5AuthHandler ::attachToken () — Method in class Guzzle5AuthHandler
Guzzle5AuthHandler ::attachKey () — Method in class Guzzle5AuthHandler
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
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
$Guzzle5AuthHandler #cache — Property in class Guzzle5AuthHandler
$Guzzle5AuthHandler #cacheConfig — Property in class Guzzle5AuthHandler
$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
Guzzle5AuthHandler — Class in namespace Google\AuthHandler
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
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. Google_Task_Composer — Class in namespace
This class needs to be defined explicitly as scripts must be recognized by
the autoloader. 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. 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
$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
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. Guzzle5AuthHandler ::__construct () — Method in class Guzzle5AuthHandler
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.