Service class for interacting with the Google Apps Provisioning API.

Like other service classes in this module, this class provides access via an HTTP client to Google servers for working with entries and feeds.

Because of the nature of this API, all access must occur over an authenticated connection.

link http://code.google.com/apis/apps/gdata_provisioning_api_v2.0_reference.html
category Zend
package Zend_Gdata
subpackage Gapps
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Gdata

 Methods

Provides a magic factory method to instantiate new objects with shorter syntax than would otherwise be required by the Zend Framework naming conventions. For more information, see Zend_Gdata_App::__call().

__call(string $method, array $args) 

This overrides the default behavior of __call() so that query classes do not need to have their domain manually set when created with a magic factory method.

see

Parameters

$method

string

The method name being called

$args

array

The arguments passed to the call

Exceptions

\Zend_Gdata_App_Exception

Provides a magic factory method to instantiate new objects with shorter syntax than would otherwise be required by the Zend Framework naming conventions. For instance, to construct a new Zend_Gdata_Calendar_Extension_Color, a developer simply needs to do $gCal->newColor(). For this magic constructor, packages are searched in the same order as which they appear in the $_registeredPackages array

__call(string $method, array $args) 
Inherited

Parameters

$method

string

The method name being called

$args

array

The arguments passed to the call

Exceptions

\Zend_Gdata_App_Exception

Create Gdata_Gapps object

__construct(\Zend_Http_Client $client = null, string $domain = null, string $applicationId = 'MyCompany-MyApp-1.0'
inherited_from \Zend_Gdata::__construct()

Parameters

$client

\Zend_Http_Client

(optional) The HTTP client to use when when communicating with the Google Apps servers.

$domain

string

(optional) The Google Apps domain which is to be accessed.

$applicationId

string

The identity of the app in the form of Company-AppName-Version

Create Gdata object

__construct(\Zend_Http_Client $client = null, string $applicationId = 'MyCompany-MyApp-1.0'
Inherited

Parameters

$client

\Zend_Http_Client

$applicationId

string

Add an email address to a group as a member

addMemberToGroup(string $recipientAddress, string $groupId) : \Zend_Gdata_Gapps_MemberEntry

Parameters

$recipientAddress

string

Email address, member id, or group id

$groupId

string

The unique id of the group

Returns

\Zend_Gdata_Gapps_MemberEntryThe member entry returned by the server

Add an email as an owner of a group

addOwnerToGroup(string $email, string $groupId) : \Zend_Gdata_Gapps_OwnerEntry

Parameters

$email

string

Owner's email

$groupId

string

Group ownership to be checked for

Returns

\Zend_Gdata_Gapps_OwnerEntryThe OwnerEntry returned by the server

Add a specified recipient to an existing emailList.

addRecipientToEmailList(string $recipientAddress, string $emailList) : \Zend_Gdata_Gapps_EmailListRecipientEntry

Parameters

$recipientAddress

string

The address of the recipient to be added to the email list.

$emailList

string

The name of the email address to which the recipient should be added.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_EmailListRecipientEntryThe recipient entry created by the server.

Create a new email list.

createEmailList(string $emailList) : \Zend_Gdata_Gapps_EmailListEntry

Parameters

$emailList

string

The name of the email list to be created.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_EmailListEntryThe email list entry as created on the server.

Create a new group.

createGroup(string $groupId, string $groupName, string $description = null, string $emailPermission = null) : \Zend_Gdata_Gapps_GroupEntry

Parameters

$groupId

string

A unique identifier for the group

$groupName

string

The name of the group

$description

string

A description of the group

$emailPermission

string

The subscription permission of the group

Returns

\Zend_Gdata_Gapps_GroupEntryThe group entry as created on the server.

Create a nickname for a given user.

createNickname(string $username, string $nickname) : \Zend_Gdata_Gapps_NicknameEntry

Parameters

$username

string

The username to which the new nickname should be associated.

$nickname

string

The new nickname to be created.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_NicknameEntryThe nickname entry which was created by the server.

Create a new user entry and send it to the Google Apps servers.

createUser(string $username, string $givenName, string $familyName, string $password, $passwordHashFunction = null, string $quotaLimitInMB = null) : \Zend_Gdata_Gapps_UserEntry

Parameters

$username

string

The username for the new user.

$givenName

string

The given name for the new user.

$familyName

string

The family name for the new user.

$password

string

The password for the new user as a plaintext string (if $passwordHashFunction is null) or a SHA-1 hashed value (if $passwordHashFunction = 'SHA-1').

$passwordHashFunction

$quotaLimitInMB

string

(optional) The quota limit for the new user in MB.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_UserEntry(optional) The new user entry as returned by server.

DELETE entry with client object This method overrides the default behavior of Zend_Gdata_App, providing support for Zend_Gdata_Gapps_ServiceException.

delete(mixed $data, integer $remainingRedirects = null) : void

Parameters

$data

mixed

The Zend_Gdata_App_Entry or URL to delete

$remainingRedirects

integer

(optional)

Exceptions

\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException
\Zend_Gdata_Gapps_ServiceException

DELETE entry with client object

delete(mixed $data, $remainingRedirects = null) : void
Inherited

Parameters

$data

mixed

The Zend_Gdata_App_Entry or URL to delete

$remainingRedirects

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException

Delete a specified email list.

deleteEmailList(string $emailList) 

Parameters

$emailList

string

The name of the emailList to be deleted.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Delete a group

deleteGroup(string $groupId) 

Parameters

$groupId

string

The unique identifier for the group

Delete a specified nickname.

deleteNickname(string $nickname) 

Parameters

$nickname

string

The name of the nickname to be deleted.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Delete a user by username.

deleteUser(string $username) 

Parameters

$username

string

The username associated with the user who should be deleted.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

This method enables logging of requests by changing the Zend_Http_Client_Adapter used for performing the requests.

enableRequestDebugLogging(string $logfile) 
Inherited

NOTE: This will not work if you have customized the adapter already to use a proxy server or other interface.

Parameters

$logfile

string

The logfile to use when logging the requests

Returns the data for an If-Match header based on the current Etag property. If Etags are not supported by the server or cannot be extracted from the data, then null will be returned.

generateIfMatchHeaderData($data, $allowWeek) : string | null
Inherited

Parameters

$data

$allowWeek

Returns

stringnull$data

GET a URI using client object.

get(string $uri, array $extraHeaders = array()) : \Zend_Http_Response

This method overrides the default behavior of Zend_Gdata_App, providing support for Zend_Gdata_Gapps_ServiceException.

Parameters

$uri

string

GET URI

$extraHeaders

array

Extra headers to add to the request, as an array of string-based key/value pairs.

Exceptions

\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Http_Response

GET a URI using client object.

get(string $uri, array $extraHeaders = array()) : \Zend_Http_Response
Inherited

Parameters

$uri

string

GET URI

$extraHeaders

array

Extra headers to add to the request, as an array of string-based key/value pairs.

Exceptions

\Zend_Gdata_App_HttpException

Returns

\Zend_Http_Response

Returns the base URL used to access the Google Apps service, based on the current domain. The current domain can be temporarily overridden by providing a fully qualified domain as $domain.

getBaseUrl(string $domain = null

Parameters

$domain

string

(optional) A fully-qualified domain to use instead of the default domain for this service instance.

Exceptions

\Zend_Gdata_App_InvalidArgumentException

Get domain for this service instance. This should be a fully qualified domain, such as 'foo.example.com'. If no domain is set, null will be returned.

getDomain() : string

Returns

stringThe domain to be used for this session, or null if not set.

Retreive a single EmailListEntry object.

getEmailListEntry(mixed $location) : \Zend_Gdata_Gapps_EmailListEntry

Parameters

$location

mixed

The location for the feed, as a URL or Query.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_EmailListEntry

Retreive EmailListFeed object containing multiple EmailListEntry objects.

getEmailListFeed(mixed $location = null) : \Zend_Gdata_Gapps_EmailListFeed

Parameters

$location

mixed

(optional) The location for the feed, as a URL or Query.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_EmailListFeed

Retreive a single EmailListRecipientEntry object.

getEmailListRecipientEntry(mixed $location) : \Zend_Gdata_Gapps_EmailListRecipientEntry

Parameters

$location

mixed

The location for the feed, as a URL or Query.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_EmailListRecipientEntry

Retreive EmailListRecipientFeed object containing multiple EmailListRecipientEntry objects.

getEmailListRecipientFeed(mixed $location) : \Zend_Gdata_Gapps_EmailListRecipientFeed

Parameters

$location

mixed

The location for the feed, as a URL or Query.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_EmailListRecipientFeed

Retrieve entry as string or object

getEntry(string $uri, string $className = 'Zend_Gdata_App_Entry') : string | \Zend_Gdata_App_Entry
Inherited

Parameters

$uri

string

$className

string

The class which is used as the return type

Returns

string\Zend_Gdata_App_EntryReturns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.

Retrieve feed as string or object

getFeed(string $uri, string $className = 'Zend_Gdata_App_Feed') : string | \Zend_Gdata_App_Feed
Inherited

Parameters

$uri

string

The uri from which to retrieve the feed

$className

string

The class which is used as the return type

Returns

string\Zend_Gdata_App_FeedReturns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.

Retreive a single GroupEntry object.

getGroupEntry(mixed $location = null) : \Zend_Gdata_Gapps_GroupEntry

Parameters

$location

mixed

The location for the feed, as a URL or Query.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_GroupEntry

Retreive GroupFeed object containing multiple GroupEntry objects.

getGroupFeed(mixed $location = null) : \Zend_Gdata_Gapps_GroupFeed

Parameters

$location

mixed

(optional) The location for the feed, as a URL or Query.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_GroupFeed

Get the HTTP override state

getGzipEnabled() : boolean
InheritedStatic

Returns

boolean

Get the Zend_Http_Client object used for communication

getHttpClient() : \Zend_Http_Client
Inherited

Returns

\Zend_Http_Client

Get the HTTP override state

getHttpMethodOverride() : boolean
InheritedStatic

Returns

boolean

Get the major protocol version that is in use.

getMajorProtocolVersion() : integer
Inherited
see

Returns

integerThe major protocol version in use.

Get the maximum number of redirects to follow during HTTP operations

getMaxRedirects() : integer
InheritedStatic

Returns

integerMaximum number of redirects to follow

Retreive a single MemberEntry object.

getMemberEntry(mixed $location = null) : \Zend_Gdata_Gapps_MemberEntry

Parameters

$location

mixed

The location for the feed, as a URL or Query.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_MemberEntry

Retreive MemberFeed object containing multiple MemberEntry objects.

getMemberFeed(mixed $location = null) : \Zend_Gdata_Gapps_MemberFeed

Parameters

$location

mixed

(optional) The location for the feed, as a URL or Query.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_MemberFeed

Get the minor protocol version that is in use.

getMinorProtocolVersion() : \(int | \NULL)
Inherited
see

Returns

\(int\NULL)The major protocol version in use, or NULL if no minor version is specified.

Retrieve next set of results based on a given feed.

getNextFeed(\Zend_Gdata_App_Feed $feed, string $className = null) : \Zend_Gdata_App_Feed | null
Inherited

Parameters

$feed

\Zend_Gdata_App_Feed

The feed from which to retreive the next set of results.

$className

string

(optional) The class of feed to be returned. If null, the next feed (if found) will be the same class as the feed that was given as the first argument.

Returns

\Zend_Gdata_App_FeednullReturns a Zend_Gdata_App_Feed or null if no next set of results exists.

Retreive a single NicknameEntry object.

getNicknameEntry(mixed $location) : \Zend_Gdata_Gapps_NicknameEntry

Parameters

$location

mixed

The location for the feed, as a URL or Query.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_NicknameEntry

Retreive NicknameFeed object containing multiple NicknameEntry objects.

getNicknameFeed(mixed $location = null) : \Zend_Gdata_Gapps_NicknameFeed

Parameters

$location

mixed

(optional) The location for the feed, as a URL or Query.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_NicknameFeed

Retreive a single OwnerEntry object.

getOwnerEntry(mixed $location = null) : \Zend_Gdata_Gapps_OwnerEntry

Parameters

$location

mixed

The location for the feed, as a URL or Query.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_OwnerEntry

Retreive OwnerFeed object containing multiple OwnerEntry objects.

getOwnerFeed(mixed $location = null) : \Zend_Gdata_Gapps_OwnerFeed

Parameters

$location

mixed

(optional) The location for the feed, as a URL or Query.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_OwnerFeed

Retrieve previous set of results based on a given feed.

getPreviousFeed(\Zend_Gdata_App_Feed $feed, string $className = null) : \Zend_Gdata_App_Feed | null
Inherited

Parameters

$feed

\Zend_Gdata_App_Feed

The feed from which to retreive the previous set of results.

$className

string

(optional) The class of feed to be returned. If null, the previous feed (if found) will be the same class as the feed that was given as the first argument.

Returns

\Zend_Gdata_App_FeednullReturns a Zend_Gdata_App_Feed or null if no previous set of results exists.

Gets the HTTP client object. If none is set, a new Zend_Http_Client will be used.

getStaticHttpClient() : \Zend_Http_Client
InheritedStatic

Returns

\Zend_Http_Client

Retreive a single UserEntry object.

getUserEntry(mixed $location) : \Zend_Gdata_Gapps_UserEntry

Parameters

$location

mixed

The location for the feed, as a URL or Query.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_UserEntry

Retrieve a UserFeed containing multiple UserEntry objects.

getUserFeed(mixed $location = null) : \Zend_Gdata_Gapps_UserFeed

Parameters

$location

mixed

(optional) The location for the feed, as a URL or Query.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_UserFeed

Get whether to use verbose exception messages

getVerboseExceptionMessages() : boolean
InheritedStatic

In the case of HTTP errors, use the body of the HTTP response in the exception message.

Returns

boolean

Imports a feed located at $uri.

import(string $uri, \Zend_Http_Client $client = null, string $className = 'Zend_Gdata_App_Feed', boolean $useObjectMapping = true) : \Zend_Gdata_App_Feed
Static

This method overrides the default behavior of Zend_Gdata_App, providing support for Zend_Gdata_Gapps_ServiceException.

inherited_from \Zend_Gdata::import()

Parameters

$uri

string

$client

\Zend_Http_Client

(optional) The client used for communication

$className

string

(optional) The class which is used as the return type

$useObjectMapping

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_App_Feed

Imports a feed located at $uri.

import(string $uri, \Zend_Http_Client $client = null, string $className = 'Zend_Gdata_App_Feed', boolean $useObjectMapping = true) : string | \Zend_Gdata_App_Feed
InheritedStatic

Parameters

$uri

string

$client

\Zend_Http_Client

The client used for communication

$className

string

The class which is used as the return type

$useObjectMapping

boolean

Enable/disable the use of XML to object mapping.

Exceptions

\Zend_Gdata_App_Exception

Returns

string\Zend_Gdata_App_FeedReturns string only if the fourth parameter ($useObjectMapping) is set to false.

Imports a feed from a file located at $filename.

importFile(string $filename, string $className = 'Zend_Gdata_App_Feed', string $useIncludePath = false) : \Zend_Gdata_App_Feed
InheritedStatic

Parameters

$filename

string

$className

string

The class which is used as the return type

$useIncludePath

string

Whether the include_path should be searched

Exceptions

\Zend_Gdata_App_Exception

Returns

\Zend_Gdata_App_Feed

Imports a feed represented by $string.

importString(string $string, string $className = 'Zend_Gdata_App_Feed', $majorProtocolVersion = null, $minorProtocolVersion = null) : \Zend_Gdata_App_Feed
InheritedStatic

Parameters

$string

string

$className

string

The class which is used as the return type

$majorProtocolVersion

$minorProtocolVersion

Exceptions

\Zend_Gdata_App_Exception

Returns

\Zend_Gdata_App_Feed

Imports the specified URL (non-statically).

importUrl(string $url, string $className = 'Zend_Gdata_App_Feed', array $extraHeaders = array()) : string | \Zend_Gdata_App_Feed
Inherited

Parameters

$url

string

The URL to import

$className

string

The class which is used as the return type

$extraHeaders

array

Extra headers to add to the request, as an array of string-based key/value pairs.

Exceptions

\Zend_Gdata_App_Exception

Returns

string\Zend_Gdata_App_FeedReturns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.

Create a new email list from an EmailListEntry.

insertEmailList(\Zend_Gdata_Gapps_EmailListEntry $emailList, string $uri = null) : \Zend_Gdata_Gapps_EmailListEntry

Parameters

$emailList

\Zend_Gdata_Gapps_EmailListEntry

The email list entry to insert.

$uri

string

(optional) The URI where the email list should be uploaded to. If null, the default email list creation URI for this domain will be used.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_EmailListEntryThe inserted email list entry as returned by the server.

Create a new email list recipient from an EmailListRecipientEntry.

insertEmailListRecipient(\Zend_Gdata_Gapps_EmailListRecipientEntry $recipient, string $uri = null) : \Zend_Gdata_Gapps_EmailListRecipientEntry

Parameters

$recipient

\Zend_Gdata_Gapps_EmailListRecipientEntry

The recipient entry to insert.

$uri

string

(optional) The URI where the recipient should be uploaded to. If null, the default recipient creation URI for this domain will be used.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_EmailListRecipientEntryThe inserted recipient entry as returned by the server.

Inserts an entry to a given URI and returns the response as a fully formed Entry.

insertEntry(mixed $data, string $uri, string $className = 'Zend_Gdata_App_Entry', array $extraHeaders = array()) : \Zend_Gdata_App_Entry
Inherited

Parameters

$data

mixed

The Zend_Gdata_App_Entry or XML to post

$uri

string

POST URI

$className

string

The class of entry to be returned.

$extraHeaders

array

Extra headers to add to the request, as an array of string-based key/value pairs.

Returns

\Zend_Gdata_App_EntryThe entry returned by the service after insertion.

Create a new group from a GroupEntry.

insertGroup(\Zend_Gdata_Gapps_GroupEntry $group, string $uri = null) : \Zend_Gdata_Gapps_GroupEntry

Parameters

$group

\Zend_Gdata_Gapps_GroupEntry

The group entry to insert.

$uri

string

(optional) The URI where the group should be uploaded to. If null, the default user creation URI for this domain will be used.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_GroupEntryThe inserted group entry as returned by the server.

Create a new member from a MemberEntry.

insertMember(\Zend_Gdata_Gapps_MemberEntry $member, string $uri = null) : \Zend_Gdata_Gapps_MemberEntry

Parameters

$member

\Zend_Gdata_Gapps_MemberEntry

The member entry to insert.

$uri

string

(optional) The URI where the group should be uploaded to. If null, the default user creation URI for this domain will be used.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_MemberEntryThe inserted member entry as returned by the server.

Create a new nickname from a NicknameEntry.

insertNickname(\Zend_Gdata_Gapps_NicknameEntry $nickname, string $uri = null) : \Zend_Gdata_Gapps_NicknameEntry

Parameters

$nickname

\Zend_Gdata_Gapps_NicknameEntry

The nickname entry to insert.

$uri

string

(optional) The URI where the nickname should be uploaded to. If null, the default nickname creation URI for this domain will be used.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_NicknameEntryThe inserted nickname entry as returned by the server.

Create a new group from a OwnerEntry.

insertOwner(\Zend_Gdata_Gapps_OwnerEntry $owner, string $uri = null) : \Zend_Gdata_Gapps_OwnerEntry

Parameters

$owner

\Zend_Gdata_Gapps_OwnerEntry

The owner entry to insert.

$uri

string

(optional) The URI where the owner should be uploaded to. If null, the default user creation URI for this domain will be used.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_OwnerEntryThe inserted owner entry as returned by the server.

Create a new user from a UserEntry.

insertUser(\Zend_Gdata_Gapps_UserEntry $user, string $uri = null) : \Zend_Gdata_Gapps_UserEntry

Parameters

$user

\Zend_Gdata_Gapps_UserEntry

The user entry to insert.

$uri

string

(optional) The URI where the user should be uploaded to. If null, the default user creation URI for this domain will be used.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_UserEntryThe inserted user entry as returned by the server.

Determines whether service object is authenticated.

isAuthenticated() : boolean
Inherited

Returns

booleanTrue if service object is authenticated, false otherwise.

Check to see if a member id or group id is a member of group

isMember(string $memberId, string $groupId) : boolean

Parameters

$memberId

string

Member id or group group id

$groupId

string

Group to be checked for

Returns

booleanTrue, if given entity is a member

Checks to see if an email is an owner of a group

isOwner(string $email, string $groupId) : boolean

Parameters

$email

string

Owner's email

$groupId

string

Group ownership to be checked for

Returns

booleanTrue, if given entity is an owner

Performs a HTTP request using the specified method

performHttpRequest(string $method, string $url, array $headers = null, string $body = null, string $contentType = null, integer $remainingRedirects = null) : \Zend_Http_Response
Inherited

Parameters

$method

string

The HTTP method for the request - 'GET', 'POST', 'PUT', 'DELETE'

$url

string

The URL to which this request is being performed

$headers

array

An associative array of HTTP headers for this request

$body

string

The body of the HTTP request

$contentType

string

The value for the content type of the request body

$remainingRedirects

integer

Number of redirects to follow if request s results in one

Returns

\Zend_Http_ResponseThe response object

POST data with client object.

post(mixed $data, string $uri = null, integer $remainingRedirects = null, string $contentType = null, $extraHeaders = null) : \Zend_Http_Response

This method overrides the default behavior of Zend_Gdata_App, providing support for Zend_Gdata_Gapps_ServiceException.

Parameters

$data

mixed

The Zend_Gdata_App_Entry or XML to post

$uri

string

(optional) POST URI

$remainingRedirects

integer

(optional)

$contentType

string

Content-type of the data

$extraHeaders

Exceptions

\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Http_Response

POST data with client object

post(mixed $data, string $uri = null, $remainingRedirects = null, string $contentType = null, array $extraHeaders = null) : \Zend_Http_Response
Inherited

Parameters

$data

mixed

The Zend_Gdata_App_Entry or XML to post

$uri

string

POST URI

$remainingRedirects

$contentType

string

Content-type of the data

$extraHeaders

array

Extra headers to add to the request, as an array of string-based key/value pairs.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException

Returns

\Zend_Http_Response

Provides pre-processing for HTTP requests to APP services.

prepareRequest(string $method, string $url = null, array $headers = array(), mixed $data = null, string $contentTypeOverride = null) : array
Inherited
  1. Checks the $data element and, if it's an entry, extracts the XML, multipart data, edit link (PUT,DELETE), etc.
  2. If $data is a string, sets the default content-type header as 'application/atom+xml' if it's not already been set.
  3. Adds a x-http-method override header and changes the HTTP method to 'POST' if necessary as per getHttpMethodOverride()

Parameters

$method

string

The HTTP method for the request - 'GET', 'POST', 'PUT', 'DELETE'

$url

string

The URL to which this request is being performed, or null if found in $data

$headers

array

An associative array of HTTP headers for this request

$data

mixed

The Zend_Gdata_App_Entry or XML for the body of the request

$contentTypeOverride

string

The override value for the content type of the request body

Returns

arrayAn associative array containing the determined 'method', 'url', 'data', 'headers', 'contentType'

PUT data with client object This method overrides the default behavior of Zend_Gdata_App, providing support for Zend_Gdata_Gapps_ServiceException.

put(mixed $data, string $uri = null, integer $remainingRedirects = null, string $contentType = null, $extraHeaders = null) : \Zend_Http_Response

Parameters

$data

mixed

The Zend_Gdata_App_Entry or XML to post

$uri

string

(optional) PUT URI

$remainingRedirects

integer

(optional)

$contentType

string

Content-type of the data

$extraHeaders

Exceptions

\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Http_Response

PUT data with client object

put(mixed $data, string $uri = null, $remainingRedirects = null, string $contentType = null, array $extraHeaders = null) : \Zend_Http_Response
Inherited

Parameters

$data

mixed

The Zend_Gdata_App_Entry or XML to post

$uri

string

PUT URI

$remainingRedirects

$contentType

string

Content-type of the data

$extraHeaders

array

Extra headers to add to the request, as an array of string-based key/value pairs.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException

Returns

\Zend_Http_Response

Adds a Zend Framework package to the $_registeredPackages array.

registerPackage(string $name) : void
Inherited

This array is searched when using the magic __call method below to instantiante new objects.

Parameters

$name

string

The name of the package (eg Zend_Gdata_App)

Remove a member id from a group

removeMemberFromGroup(string $memberId, string $groupId) 

Parameters

$memberId

string

Member id or group id

$groupId

string

The unique id of the group

Remove email as an owner of a group

removeOwnerFromGroup(string $email, string $groupId) 

Parameters

$email

string

Owner's email

$groupId

string

The unique identifier for the group

Remove a specified recipient from an email list.

removeRecipientFromEmailList(string $recipientAddress, string $emailList) 

Parameters

$recipientAddress

string

The recipient to be removed.

$emailList

string

The list from which the recipient should be removed.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Mark a given user as not suspended.

restoreUser(string $username) : \Zend_Gdata_Gapps_UserEntry

Parameters

$username

string

The username associated with the user who should be restored.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_UserEntryThe UserEntry for the modified user.

Retrieve all email lists associated with the curent domain. Be aware that calling this function on a domain with many email lists will take a signifigant amount of time to complete. On larger domains this may may cause execution to timeout without proper precautions in place.

retrieveAllEmailLists() : \Zend_Gdata_Gapps_EmailListFeed

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_EmailListFeedThe list of email lists found as Zend_Gdata_Gapps_EmailListEntry objects.

Retrieve all entries for a feed, iterating through pages as necessary.

retrieveAllEntriesForFeed(object $feed) : mixed
Inherited

Be aware that calling this function on a large dataset will take a significant amount of time to complete. In some cases this may cause execution to timeout without proper precautions in place.

Parameters

$feed

object

The feed to iterate through.

Returns

mixedA new feed of the same type as the one originally passed in, containing all relevent entries.

Retrieve all groups in the current domain. Be aware that calling this function on a domain with many groups will take a signifigant amount of time to complete. On larger domains this may may cause execution to timeout without proper precautions in place.

retrieveAllGroups() : \Zend_Gdata_Gapps_GroupFeed

Returns

\Zend_Gdata_Gapps_GroupFeedCollection of Zend_Gdata_GroupEntry objects representing all groups apart of the domain.

Retrieves all the members of a group

retrieveAllMembers(string $groupId) : \Zend_Gdata_Gapps_MemberFeed

Parameters

$groupId

string

The unique id of the group

Returns

\Zend_Gdata_Gapps_MemberFeedCollection of MemberEntry objects representing all members apart of the group.

Retrieve all nicknames in the current domain. Be aware that calling this function on a domain with many nicknames will take a signifigant amount of time to complete. On larger domains this may may cause execution to timeout without proper precautions in place.

retrieveAllNicknames() : \Zend_Gdata_Gapps_NicknameFeed

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_NicknameFeedCollection of Zend_Gdata_NicknameEntry objects representing all nicknames in the domain.

Retrieve all recipients associated with an email list. Be aware that calling this function on a domain with many email lists will take a signifigant amount of time to complete. On larger domains this may may cause execution to timeout without proper precautions in place.

retrieveAllRecipients($emailList) : \Zend_Gdata_Gapps_EmailListRecipientFeed

Parameters

$emailList

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_EmailListRecipientFeedThe list of email lists found as Zend_Gdata_Gapps_EmailListRecipientEntry objects.

Retrieve all users in the current domain. Be aware that calling this function on a domain with many users will take a signifigant amount of time to complete. On larger domains this may may cause execution to timeout without proper precautions in place.

retrieveAllUsers() : \Zend_Gdata_Gapps_UserFeed

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_UserFeedCollection of Zend_Gdata_UserEntry objects representing all users in the domain.

Retrieve all email lists associated with a recipient.

retrieveEmailLists($recipient) : \Zend_Gdata_Gapps_EmailListFeed

Parameters

$recipient

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_EmailListFeedThe list of email lists found as Zend_Gdata_EmailListEntry objects.

Retrieves a group based on group id

retrieveGroup(string $groupId) : \Zend_Gdata_Gapps_GroupEntry

Parameters

$groupId

string

The unique identifier for the group

Returns

\Zend_Gdata_Gapps_GroupEntryThe group entry as returned by the server.

Retrieves all the owners of a group

retrieveGroupOwners(string $groupId) : \Zend_Gdata_Gapps_OwnerFeed

Parameters

$groupId

string

The unique identifier for the group

Returns

\Zend_Gdata_Gapps_OwnerFeedCollection of Zend_Gdata_OwnerEntry objects representing all owners apart of the group.

Retrieve all of the groups that a user is a member of

retrieveGroups(string $memberId, boolean $directOnly = null) : \Zend_Gdata_Gapps_GroupFeed

Parameters

$memberId

string

Member username

$directOnly

boolean

(Optional) If true, members with direct association only will be considered

Returns

\Zend_Gdata_Gapps_GroupFeedCollection of Zend_Gdata_GroupEntry objects representing all groups member is apart of in the domain.

Retrieve the entry for a specified nickname.

retrieveNickname(string $nickname) : \Zend_Gdata_Gapps_NicknameEntry

Parameters

$nickname

string

The nickname to be retrieved.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_NicknameEntryThe requested nickname entry.

Retrieve all nicknames associated with a specific username.

retrieveNicknames(string $username) : \Zend_Gdata_Gapps_NicknameFeed

Parameters

$username

string

The username whose nicknames should be returned.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_NicknameFeedA feed containing all nicknames for the given user, or null if

Retrieve a page of email lists in alphabetical order, starting with the provided email list.

retrievePageOfEmailLists($startNickname = null) : \Zend_Gdata_Gapps_EmailListFeed

Parameters

$startNickname

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_EmailListFeedCollection of Zend_Gdata_EmailListEntry objects representing all nicknames in the domain.

Retrieve a page of groups in alphabetical order, starting with the provided group.

retrievePageOfGroups(string $startGroup = null) : \Zend_Gdata_Gapps_GroupFeed

Parameters

$startGroup

string

(optional) The first group to retrieve. If null or not defined, the page will begin with the first group in the domain.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_GroupFeedCollection of Zend_Gdata_GroupEntry objects representing the groups in the domain.

Gets page of Members

retrievePageOfMembers(string $groupId, string $startMember = null) : \Zend_Gdata_Gapps_MemberFeed

Parameters

$groupId

string

The group id which should be searched.

$startMember

string

(optinal) The address of the first member, or null to start with the first member in the list.

Returns

\Zend_Gdata_Gapps_MemberFeedCollection of Zend_Gdata_MemberEntry objects

Retrieve a page of nicknames in alphabetical order, starting with the provided nickname.

retrievePageOfNicknames(string $startNickname = null) : \Zend_Gdata_Gapps_NicknameFeed

Parameters

$startNickname

string

(optional) The first nickname to retrieve. If null or not declared, the page will begin with the first nickname in the domain.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_NicknameFeedCollection of Zend_Gdata_NicknameEntry objects representing all nicknames in the domain.

Retrieve a page of email list recipients in alphabetical order, starting with the provided email list recipient.

retrievePageOfRecipients($emailList, string $startRecipient = null) : \Zend_Gdata_Gapps_EmailListRecipientFeed

Parameters

$emailList

$startRecipient

string

(optinal) The address of the first recipient, or null to start with the first recipient in the list.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_EmailListRecipientFeedCollection of Zend_Gdata_EmailListRecipientEntry objects representing all recpients in the specified list.

Retrieve a page of users in alphabetical order, starting with the provided username.

retrievePageOfUsers(string $startUsername = null) : \Zend_Gdata_Gapps_UserFeed

Parameters

$startUsername

string

(optional) The first username to retrieve. If null or not declared, the page will begin with the first user in the domain.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_UserFeedCollection of Zend_Gdata_UserEntry objects representing all users in the domain.

Retrieve a user based on their username.

retrieveUser(string $username) : \Zend_Gdata_Gapps_UserEntry

Parameters

$username

string

The username to search for.

Exceptions

\Zend_Gdata_App_InvalidArgumentException
\Zend_Gdata_App_HttpException

Returns

\Zend_Gdata_Gapps_UserEntryThe username to search for, or null if no match found.

Set domain for this service instance. This should be a fully qualified domain, such as 'foo.example.com'.

setDomain(string $value) 

This value is used when calculating URLs for retrieving and posting entries. If no value is specified, a URL will have to be manually constructed prior to using any methods which interact with the Google Apps provisioning service.

Parameters

$value

string

The domain to be used for this session.

Toggle requesting gzip encoded responses

setGzipEnabled(boolean $enabled = false) : void
InheritedStatic

Parameters

$enabled

boolean

Whether or not to enable gzipped responses

Set the Zend_Http_Client object used for communication

setHttpClient(\Zend_Http_Client $client, $applicationId = 'MyCompany-MyApp-1.0') : \Zend_Gdata_App
Inherited

Parameters

$client

\Zend_Http_Client

The client to use for communication

$applicationId

Exceptions

\Zend_Gdata_App_HttpException

Returns

\Zend_Gdata_AppProvides a fluent interface

Toggle using POST instead of PUT and DELETE HTTP methods

setHttpMethodOverride(boolean $override = true) : void
InheritedStatic

Some feed implementations do not accept PUT and DELETE HTTP methods, or they can't be used because of proxies or other measures. This allows turning on using POST where PUT and DELETE would normally be used; in addition, an X-Method-Override header will be sent with a value of PUT or DELETE as appropriate.

Parameters

$override

boolean

Whether to override PUT and DELETE with POST.

Set the major protocol version that should be used. Values < 1 will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

setMajorProtocolVersion(integer $value) 
Inherited
see

Parameters

$value

integer

The major protocol version to use.

Exceptions

\Zend_Gdata_App_InvalidArgumentException

Set the maximum number of redirects to follow during HTTP operations

setMaxRedirects(integer $maxRedirects) : void
InheritedStatic

Parameters

$maxRedirects

integer

Maximum number of redirects to follow

Set the minor protocol version that should be used. If set to NULL, no minor protocol version will be sent to the server. Values < 0 will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

setMinorProtocolVersion(\(int|\NULL) $value) 
Inherited
see

Parameters

$value

\(int\NULL)

The minor protocol version to use.

Exceptions

\Zend_Gdata_App_InvalidArgumentException

Set the static HTTP client instance

setStaticHttpClient(\Zend_Http_Client $httpClient) : void
InheritedStatic

Sets the static HTTP client object to use for retrieving the feed.

Parameters

$httpClient

\Zend_Http_Client

Set whether to use verbose exception messages

setVerboseExceptionMessages(boolean $verbose) 
InheritedStatic

In the case of HTTP errors, use the body of the HTTP response in the exception message.

Parameters

$verbose

boolean

Whether to use verbose exception messages

Mark a given user as suspended.

suspendUser(string $username) : \Zend_Gdata_Gapps_UserEntry

Parameters

$username

string

The username associated with the user who should be suspended.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_UserEntryThe UserEntry for the modified user.

Convert an exception to an ServiceException if an AppsForYourDomain XML document is contained within the original exception's HTTP response. If conversion fails, throw the original error.

throwServiceExceptionIfDetected(\Zend_Gdata_Exception $e) 
Static

Parameters

$e

\Zend_Gdata_Exception

The exception to convert.

Exceptions

\Zend_Gdata_Gapps_ServiceException
mixed

Update an entry

updateEntry(mixed $data, $uri = null, $className = null, array $extraHeaders = array()) : \Zend_Gdata_App_Entry
Inherited

Parameters

$data

mixed

Zend_Gdata_App_Entry or XML (w/ID and link rel='edit')

$uri

$className

$extraHeaders

array

Extra headers to add to the request, as an array of string-based key/value pairs.

Exceptions

\Zend_Gdata_App_Exception

Returns

\Zend_Gdata_App_EntryThe entry returned from the server

Update group properties with new values. any property not defined will not be updated

updateGroup(string $groupId, string $groupName = null, string $description = null, string $emailPermission = null) : \Zend_Gdata_Gapps_GroupEntry

Parameters

$groupId

string

A unique identifier for the group

$groupName

string

The name of the group

$description

string

A description of the group

$emailPermission

string

The subscription permission of the group

Returns

\Zend_Gdata_Gapps_GroupEntryThe group entry as updated on the server.

Overwrite a specified username with the provided UserEntry. The UserEntry does not need to contain an edit link.

updateUser(string $username, \Zend_Gdata_Gapps_UserEntry $userEntry) : \Zend_Gdata_Gapps_UserEntry

This method is provided for compliance with the Google Apps Provisioning API specification. Normally users will instead want to call UserEntry::save() instead.

see

Parameters

$username

string

The username whose data will be overwritten.

$userEntry

\Zend_Gdata_Gapps_UserEntry

The user entry which will be overwritten.

Exceptions

\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Returns

\Zend_Gdata_Gapps_UserEntryThe UserEntry returned by the server.

Enable/disable the use of XML to object mapping.

useObjectMapping(boolean $value) : void
Inherited

Parameters

$value

boolean

Pass in true to use the XML to object mapping. Pass in false or null to disable it.

Determine whether service object is using XML to object mapping.

usingObjectMapping() : boolean
Inherited

Returns

booleanTrue if service object is using XML to object mapping, false otherwise.

 Properties

 

Namespaces used for Zend_Gdata_Gapps

$namespaces : array

Default

array(array('apps', 'http://schemas.google.com/apps/2006', 1, 0))
Static
inherited_from \Zend_Gdata::namespaces
 

Namespaces used for Gdata data

$namespaces : array

Default

array(array('gd', 'http://schemas.google.com/g/2005', 1, 0), array('openSearch', 'http://a9.com/-/spec/opensearchrss/1.0/', 1, 0), array('openSearch', 'http://a9.com/-/spec/opensearch/1.1/', 2, 0), array('rss', 'http://blogs.law.harvard.edu/tech/rss', 1, 0))
Static
 

Default URI to which to POST.

$_defaultPostUri : string

Default

null
 

The domain which is being administered via the Provisioning API.

$_domain : string

Default

null
 

Enable gzipped responses?

$_gzipEnabled : boolean

Default

false
Static
 

Client object used to communicate

$_httpClient : \Zend_Http_Client

Default

 

Override HTTP PUT and DELETE request methods?

$_httpMethodOverride : boolean

Default

false
Static
 

Indicates the major protocol version that should be used.

$_majorProtocolVersion 

Default

At present, recognized values are either 1 or 2. However, any integer value >= 1 is considered valid.

Under most circumtances, this will be automatically set by Zend_Gdata_App subclasses.

see
see
 

Maximum number of redirects to follow during HTTP operations

$_maxRedirects : integer

Default

5
Static
 

Indicates the minor protocol version that should be used. Can be set to either an integer >= 0, or NULL if no minor version should be sent to the server.

$_minorProtocolVersion 

Default

At present, this field is not used by any Google services, but may be used in the future.

Under most circumtances, this will be automatically set by Zend_Gdata_App subclasses.

see
see
 

Packages to search for classes when using magic __call method, in order.

$_registeredPackages : array

Default

array('Zend_Gdata_App_Extension', 'Zend_Gdata_App')
 

Client object used to communicate in static context

$_staticHttpClient : \Zend_Http_Client

Default

null
Static
 

Whether we want to use XML to object mapping when fetching data.

$_useObjectMapping : boolean

Default

true
 

Use verbose exception messages. In the case of HTTP errors, use the body of the HTTP response in the exception message.

$_verboseExceptionMessages : boolean

Default

true
Static

 Constants

 

APPS_BASE_FEED_URI

APPS_BASE_FEED_URI = 'https://apps-apis.google.com/a/feeds' 
 

Path to email list feeds on the Google Apps server.

APPS_EMAIL_LIST_PATH = '/emailList/2.0' 
 

Path to email list recipient feeds on the Google Apps server.

APPS_EMAIL_LIST_RECIPIENT_POSTFIX = '/recipient' 
 

Path to group feeds on the Google Apps server.

APPS_GROUP_PATH = '/group/2.0' 
 

Path to nickname feeds on the Google Apps server.

APPS_NICKNAME_PATH = '/nickname/2.0' 
 

Path to user feeds on the Google Apps server.

APPS_USER_PATH = '/user/2.0' 
 

Service name for use with Google's authentication mechanisms

AUTH_SERVICE_NAME = 'apps' 
inherited_from \Zend_Gdata::AUTH_SERVICE_NAME
 

Service name for use with Google's authentication mechanisms

AUTH_SERVICE_NAME = 'xapi' : string
 

Default major protocol version.

DEFAULT_MAJOR_PROTOCOL_VERSION = 1 
see
 

Default minor protocol version.

DEFAULT_MINOR_PROTOCOL_VERSION = null 
see