Gdata/Gapps.php

+ Show: +

inherited

+ Classes +
- \Zend_Gdata_Gapps

+ Table of Contents +

Zend Framework

LICENSE

+ +

This source file is subject to the new BSD license that is bundled +with this package in the file LICENSE.txt. +It is also available through the world-wide-web at this URL: +http://framework.zend.com/license/new-bsd +If you did not receive a copy of the license and are unable to +obtain it through the world-wide-web, please send an email +to license@zend.com so we can send you a copy immediately.

Category: Zend + +
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) + +
License: New BSD License + +
Package: Zend_Gdata + +
Subpackage: Gapps + +
Version: $Id: Gapps.php 24593 2012-01-05 20:35:02Z matthew $ + +

\Zend_Gdata_Gapps
jump to top

Package: Zend\Gdata\Gapps

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.

Parent(s): \Zend_Gdata + < + \Zend_Gdata_App
Category: Zend + +
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) + +
License: New BSD License + +
Link: http://code.google.com/apis/apps/gdata_provisioning_api_v2.0_reference.html + +

Constants

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

string 
+                AUTH_SERVICE_NAME
+                = 'apps'

Service name for use with Google's authentication mechanisms

: string

 
+                APPS_USER_PATH
+                = '/user/2.0'

Path to user feeds on the Google Apps server.

 
+                APPS_NICKNAME_PATH
+                = '/nickname/2.0'

Path to nickname feeds on the Google Apps server.

 
+                APPS_GROUP_PATH
+                = '/group/2.0'

Path to group feeds on the Google Apps server.

 
+                APPS_EMAIL_LIST_PATH
+                = '/emailList/2.0'

Path to email list feeds on the Google Apps server.

 
+                APPS_EMAIL_LIST_RECIPIENT_POSTFIX
+                = '/recipient'

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

 
+                DEFAULT_MAJOR_PROTOCOL_VERSION
+                = 1

inherited

Default major protocol version.

Inherited from: + \Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION \Zend_Gdata::DEFAULT_MAJOR_PROTOCOL_VERSION

Inherited_from: \Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION + +
Inherited_from: \Zend_Gdata::DEFAULT_MAJOR_PROTOCOL_VERSION + +
See: \_majorProtocolVersion + +

 
+                DEFAULT_MINOR_PROTOCOL_VERSION
+                = null

inherited

Default minor protocol version.

Inherited from: + \Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION \Zend_Gdata::DEFAULT_MINOR_PROTOCOL_VERSION

Inherited_from: \Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION + +
Inherited_from: \Zend_Gdata::DEFAULT_MINOR_PROTOCOL_VERSION + +
See: \_minorProtocolVersion + +

Properties

string $_defaultPostUri = null

inherited

Default URI to which to POST.

Inherited from: + \Zend_Gdata::$$_defaultPostUri

Default valuenullDetails

Type: string
Inherited_from: \Zend_Gdata::$$_defaultPostUri + +

string $_domain = null

The domain which is being administered via the Provisioning API.

Default valuenullDetails

Type: string

boolean $_gzipEnabled = false

staticinherited

Enable gzipped responses?

Inherited from: + \Zend_Gdata_App::$$_gzipEnabled \Zend_Gdata::$$_gzipEnabled

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Gdata_App::$$_gzipEnabled + +
Inherited_from: \Zend_Gdata::$$_gzipEnabled + +

\Zend_Gdata_HttpClient $_httpClient

inherited

Client object used to communicate

Inherited from: + \Zend_Gdata::$$_httpClient

Details

Type: \Zend_Gdata_HttpClient
Inherited_from: \Zend_Gdata::$$_httpClient + +

boolean $_httpMethodOverride = false

staticinherited

Override HTTP PUT and DELETE request methods?

Inherited from: + \Zend_Gdata_App::$$_httpMethodOverride \Zend_Gdata::$$_httpMethodOverride

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Gdata_App::$$_httpMethodOverride + +
Inherited_from: \Zend_Gdata::$$_httpMethodOverride + +

$_majorProtocolVersion

inherited

Indicates the major protocol version that should be used.

Inherited from: + \Zend_Gdata_App::$$_majorProtocolVersion \Zend_Gdata::$$_majorProtocolVersion

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.

Details

Type: n/a
Inherited_from: \Zend_Gdata_App::$$_majorProtocolVersion + +
Inherited_from: \Zend_Gdata::$$_majorProtocolVersion + +
See: \setMajorProtocolVersion() + +
See: \getMajorProtocolVersion() + +

int $_maxRedirects = 5

staticinherited

Maximum number of redirects to follow during HTTP operations

Inherited from: + \Zend_Gdata_App::$$_maxRedirects \Zend_Gdata::$$_maxRedirects

Default value5Details

Type: int
Inherited_from: \Zend_Gdata_App::$$_maxRedirects + +
Inherited_from: \Zend_Gdata::$$_maxRedirects + +

$_minorProtocolVersion

inherited

Indicates the minor protocol version that should be used.

Inherited from: + \Zend_Gdata_App::$$_minorProtocolVersion \Zend_Gdata::$$_minorProtocolVersion

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

+ +

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.

Details

Type: n/a
Inherited_from: \Zend_Gdata_App::$$_minorProtocolVersion + +
Inherited_from: \Zend_Gdata::$$_minorProtocolVersion + +
See: \setMinorProtocolVersion() + +
See: \getMinorProtocolVersion() + +

array $_registeredPackages = array('Zend_Gdata_Kind', 'Zend_Gdata_Extension', 'Zend_Gdata', 'Zend_Gdata_App_Extension', 'Zend_Gdata_App')

inherited

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

Inherited from: + \Zend_Gdata::$$_registeredPackages

Default valuearray('Zend_Gdata_Kind', 'Zend_Gdata_Extension', 'Zend_Gdata', 'Zend_Gdata_App_Extension', 'Zend_Gdata_App')Details

Type: array
Inherited_from: \Zend_Gdata::$$_registeredPackages + +

\Zend_Gdata_HttpClient $_staticHttpClient = null

staticinherited

Client object used to communicate in static context

Inherited from: + \Zend_Gdata::$$_staticHttpClient

Default valuenullDetails

Type: \Zend_Gdata_HttpClient
Inherited_from: \Zend_Gdata::$$_staticHttpClient + +

boolean $_useObjectMapping = true

inherited

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

Inherited from: + \Zend_Gdata_App::$$_useObjectMapping \Zend_Gdata::$$_useObjectMapping

Default valuetrueDetails

Type: boolean
Inherited_from: \Zend_Gdata_App::$$_useObjectMapping + +
Inherited_from: \Zend_Gdata::$$_useObjectMapping + +

boolean $_verboseExceptionMessages = true

staticinherited

Use verbose exception messages.

Inherited from: + \Zend_Gdata_App::$$_verboseExceptionMessages \Zend_Gdata::$$_verboseExceptionMessages

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

Default valuetrueDetails

Type: boolean
Inherited_from: \Zend_Gdata_App::$$_verboseExceptionMessages + +
Inherited_from: \Zend_Gdata::$$_verboseExceptionMessages + +

array $namespaces = array(array('apps', 'http://schemas.google.com/apps/2006', 1, 0))

static

Namespaces used for Zend_Gdata_Gapps

Default valuearray(array('apps', 'http://schemas.google.com/apps/2006', 1, 0))Details

Type: array

Methods

__call(string $method, array $args) : void

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().

+ +

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.

Parameters

Name	Type	Description
$method	string	The method name being called
$args	array	The arguments passed to the call

Throws

Exception	Description
\Zend_Gdata_App_Exception

Details

See: \Zend_Gdata_App::__call() + +

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

Create Gdata_Gapps object

Parameters

Name	Type	Description
$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 +

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

Add an email address to a group as a member

Parameters

Name	Type	Description
$recipientAddress	string	Email address, member id, or group id
$groupId	string	The unique id of the group

Returns

Type	Description
\Zend_Gdata_Gapps_MemberEntry	The member entry returned by the server

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

Add an email as an owner of a group

Parameters

Name	Type	Description
$email	string	Owner's email +
$groupId	string	Group ownership to be checked for

Returns

Type	Description
\Zend_Gdata_Gapps_OwnerEntry	The OwnerEntry returned by the server

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

Add a specified recipient to an existing emailList.

Parameters

Name	Type	Description
$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.

Returns

Type	Description
\Zend_Gdata_Gapps_EmailListRecipientEntry	The recipient entry + created by the server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

createEmailList(string $emailList) : \Zend_Gdata_Gapps_EmailListEntry

Create a new email list.

Parameters

Name	Type	Description
$emailList	string	The name of the email list to be created.

Returns

Type	Description
\Zend_Gdata_Gapps_EmailListEntry	The email list entry + as created on the server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

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

Create a new group.

Parameters

Name	Type	Description
$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

Type	Description
\Zend_Gdata_Gapps_GroupEntry	The group entry as created on the server.

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

Create a nickname for a given user.

Parameters

Name	Type	Description
$username	string	The username to which the new nickname should + be associated.
$nickname	string	The new nickname to be created.

Returns

Type	Description
\Zend_Gdata_Gapps_NicknameEntry	The nickname entry which was + created by the server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

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

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

Parameters

Name	Type	Description
$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. +

Returns

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

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

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

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

Parameters

Name	Type	Description
$data	mixed	The Zend_Gdata_App_Entry or URL to delete
$remainingRedirects	integer	(optional) +

Throws

Exception	Description
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException
\Zend_Gdata_Gapps_ServiceException

deleteEmailList(string $emailList) : void

Delete a specified email list.

Parameters

Name	Type	Description
$emailList	string	The name of the emailList to be deleted.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

deleteGroup(string $groupId) : void

Delete a group

Parameters

Name	Type	Description
$groupId	string	The unique identifier for the group

deleteNickname(string $nickname) : void

Delete a specified nickname.

Parameters

Name	Type	Description
$nickname	string	The name of the nickname to be deleted.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

deleteUser(string $username) : void

Delete a user by username.

Parameters

Name	Type	Description
$username	string	The username associated with the user who + should be deleted.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

enableRequestDebugLogging(string $logfile) : void

inherited

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

Inherited from: + \Zend_Gdata_App::enableRequestDebugLogging()\Zend_Gdata::enableRequestDebugLogging()

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

Parameters

Name	Type	Description
$logfile	string	The logfile to use when logging the requests

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

inherited

Returns the data for an If-Match header based on the current Etag +property.

Inherited from: + \Zend_Gdata_App::generateIfMatchHeaderData()\Zend_Gdata::generateIfMatchHeaderData()

If Etags are not supported by the server or cannot be +extracted from the data, then null will be returned.

Parameters

Name	Type	Description
$data
$allowWeek

Returns

Type	Description
string \| null	$data

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

GET a URI using client object.

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

Parameters

Name	Type	Description
$uri	string	GET URI
$extraHeaders	array	Extra headers to add to the request, as an + array of string-based key/value pairs. +

Returns

Type	Description
\Zend_Http_Response

Throws

Exception	Description
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

getBaseUrl(string $domain = null) : void

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.

Parameters

Name	Type	Description
$domain	string	(optional) A fully-qualified domain to use + instead of the default domain for this service instance. +

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

getDomain() : string

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.

Returns

Type	Description
string	The domain to be used for this session, or null if not + set.

getEmailListEntry(mixed $location) : \Zend_Gdata_Gapps_EmailListEntry

Retreive a single EmailListEntry object.

Parameters

Name	Type	Description
$location	mixed	The location for the feed, as a URL or Query.

Returns

Type	Description
\Zend_Gdata_Gapps_EmailListEntry

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

getEmailListFeed(mixed $location = null) : \Zend_Gdata_Gapps_EmailListFeed

Retreive EmailListFeed object containing multiple EmailListEntry +objects.

Parameters

Name	Type	Description
$location	mixed	(optional) The location for the feed, as a URL + or Query. +

Returns

Type	Description
\Zend_Gdata_Gapps_EmailListFeed

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

getEmailListRecipientEntry(mixed $location) : \Zend_Gdata_Gapps_EmailListRecipientEntry

Retreive a single EmailListRecipientEntry object.

Parameters

Name	Type	Description
$location	mixed	The location for the feed, as a URL or Query.

Returns

Type	Description
\Zend_Gdata_Gapps_EmailListRecipientEntry

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

getEmailListRecipientFeed(mixed $location) : \Zend_Gdata_Gapps_EmailListRecipientFeed

Retreive EmailListRecipientFeed object containing multiple +EmailListRecipientEntry objects.

Parameters

Name	Type	Description
$location	mixed	The location for the feed, as a URL or Query.

Returns

Type	Description
\Zend_Gdata_Gapps_EmailListRecipientFeed

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

getEntry(mixed $location, $className = 'Zend_Gdata_Entry') : string | \Zend_Gdata_App_Entry

inherited

Retrieve entry as string or object

Inherited from: + \Zend_Gdata::getEntry()

Parameters

Name	Type	Description
$location	mixed	The location as string or Zend_Gdata_Query
$className

Returns

Type	Description
string \| \Zend_Gdata_App_Entry	Returns string only if the object + mapping has been disabled explicitly + by passing false to the + useObjectMapping() function.

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

getFeed(mixed $location, string $className = 'Zend_Gdata_Feed') : string | \Zend_Gdata_App_Feed

inherited

Retrieve feed as string or object

Inherited from: + \Zend_Gdata::getFeed()

Parameters

Name	Type	Description
$location	mixed	The location as string or Zend_Gdata_Query
$className	string	The class type to use for returning the feed

Returns

Type	Description
string \| \Zend_Gdata_App_Feed	Returns string only if the object + mapping has been disabled explicitly + by passing false to the + useObjectMapping() function.

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

getGroupEntry(mixed $location = null) : \Zend_Gdata_Gapps_GroupEntry

Retreive a single GroupEntry object.

Parameters

Name	Type	Description
$location	mixed	The location for the feed, as a URL or Query.

Returns

Type	Description
\Zend_Gdata_Gapps_GroupEntry

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

getGroupFeed(mixed $location = null) : \Zend_Gdata_Gapps_GroupFeed

Retreive GroupFeed object containing multiple GroupEntry +objects.

Parameters

Name	Type	Description
$location	mixed	(optional) The location for the feed, as a URL + or Query. +

Returns

Type	Description
\Zend_Gdata_Gapps_GroupFeed

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

getGzipEnabled() : boolean

staticinherited

Get the HTTP override state

Inherited from: + \Zend_Gdata_App::getGzipEnabled()\Zend_Gdata::getGzipEnabled()

Returns

Type	Description
boolean

getHttpClient() : \Zend_Http_Client

inherited

Get the Zend_Http_Client object used for communication

Inherited from: + \Zend_Gdata_App::getHttpClient()\Zend_Gdata::getHttpClient()

Returns

Type	Description
\Zend_Http_Client

getHttpMethodOverride() : boolean

staticinherited

Get the HTTP override state

Inherited from: + \Zend_Gdata_App::getHttpMethodOverride()\Zend_Gdata::getHttpMethodOverride()

Returns

Type	Description
boolean

getMajorProtocolVersion() : int

inherited

Get the major protocol version that is in use.

Inherited from: + \Zend_Gdata_App::getMajorProtocolVersion()\Zend_Gdata::getMajorProtocolVersion()

Returns

Type	Description
int	The major protocol version in use.

Details

See: \_majorProtocolVersion + +

getMaxRedirects() : int

staticinherited

Get the maximum number of redirects to follow during HTTP operations

Inherited from: + \Zend_Gdata_App::getMaxRedirects()\Zend_Gdata::getMaxRedirects()

Returns

Type	Description
int	Maximum number of redirects to follow

getMemberEntry(mixed $location = null) : \Zend_Gdata_Gapps_MemberEntry

Retreive a single MemberEntry object.

Parameters

Name	Type	Description
$location	mixed	The location for the feed, as a URL or Query.

Returns

Type	Description
\Zend_Gdata_Gapps_MemberEntry

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

getMemberFeed(mixed $location = null) : \Zend_Gdata_Gapps_MemberFeed

Retreive MemberFeed object containing multiple MemberEntry +objects.

Parameters

Name	Type	Description
$location	mixed	(optional) The location for the feed, as a URL + or Query. +

Returns

Type	Description
\Zend_Gdata_Gapps_MemberFeed

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

getMinorProtocolVersion() : \(int | \NULL)

inherited

Get the minor protocol version that is in use.

Inherited from: + \Zend_Gdata_App::getMinorProtocolVersion()\Zend_Gdata::getMinorProtocolVersion()

Returns

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

Details

See: \_minorProtocolVersion + +

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

inherited

Retrieve next set of results based on a given feed.

Inherited from: + \Zend_Gdata_App::getNextFeed()\Zend_Gdata::getNextFeed()

Parameters

Name	Type	Description
$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

Type	Description
\Zend_Gdata_App_Feed \| null	Returns a + Zend_Gdata_App_Feed or null if no next set of results + exists.

getNicknameEntry(mixed $location) : \Zend_Gdata_Gapps_NicknameEntry

Retreive a single NicknameEntry object.

Parameters

Name	Type	Description
$location	mixed	The location for the feed, as a URL or Query.

Returns

Type	Description
\Zend_Gdata_Gapps_NicknameEntry

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

getNicknameFeed(mixed $location = null) : \Zend_Gdata_Gapps_NicknameFeed

Retreive NicknameFeed object containing multiple NicknameEntry objects.

Parameters

Name	Type	Description
$location	mixed	(optional) The location for the feed, as a URL + or Query. +

Returns

Type	Description
\Zend_Gdata_Gapps_NicknameFeed

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

getOwnerEntry(mixed $location = null) : \Zend_Gdata_Gapps_OwnerEntry

Retreive a single OwnerEntry object.

Parameters

Name	Type	Description
$location	mixed	The location for the feed, as a URL or Query.

Returns

Type	Description
\Zend_Gdata_Gapps_OwnerEntry

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

getOwnerFeed(mixed $location = null) : \Zend_Gdata_Gapps_OwnerFeed

Retreive OwnerFeed object containing multiple OwnerEntry +objects.

Parameters

Name	Type	Description
$location	mixed	(optional) The location for the feed, as a URL + or Query. +

Returns

Type	Description
\Zend_Gdata_Gapps_OwnerFeed

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

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

inherited

Retrieve previous set of results based on a given feed.

Inherited from: + \Zend_Gdata_App::getPreviousFeed()\Zend_Gdata::getPreviousFeed()

Parameters

Name	Type	Description
$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

Type	Description
\Zend_Gdata_App_Feed \| null	Returns a + Zend_Gdata_App_Feed or null if no previous set of results + exists.

getStaticHttpClient() : \Zend_Http_Client

staticinherited

Gets the HTTP client object.

Inherited from: + \Zend_Gdata_App::getStaticHttpClient()\Zend_Gdata::getStaticHttpClient()

If none is set, a new Zend_Http_Client will be used.

Returns

Type	Description
\Zend_Http_Client

getUserEntry(mixed $location) : \Zend_Gdata_Gapps_UserEntry

Retreive a single UserEntry object.

Parameters

Name	Type	Description
$location	mixed	The location for the feed, as a URL or Query.

Returns

Type	Description
\Zend_Gdata_Gapps_UserEntry

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

getUserFeed(mixed $location = null) : \Zend_Gdata_Gapps_UserFeed

Retrieve a UserFeed containing multiple UserEntry objects.

Parameters

Name	Type	Description
$location	mixed	(optional) The location for the feed, as a URL + or Query. +

Returns

Type	Description
\Zend_Gdata_Gapps_UserFeed

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

getVerboseExceptionMessages() : boolean

staticinherited

Get whether to use verbose exception messages

Inherited from: + \Zend_Gdata_App::getVerboseExceptionMessages()\Zend_Gdata::getVerboseExceptionMessages()

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

Returns

Type	Description
boolean

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

static

Imports a feed located at $uri.

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

Parameters

Name	Type	Description
$uri	string
$client	\Zend_Http_Client	(optional) The client used for + communication +
$className	string	(optional) The class which is used as the + return type +

Returns

Type	Description
\Zend_Gdata_App_Feed

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

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

staticinherited

Imports a feed from a file located at $filename.

Inherited from: + \Zend_Gdata_App::importFile()\Zend_Gdata::importFile()

Parameters

Name	Type	Description
$filename	string
$className	string	The class which is used as the return type
$useIncludePath	string	Whether the include_path should be searched

Returns

Type	Description
\Zend_Gdata_App_Feed

Throws

Exception	Description
\Zend_Gdata_App_Exception

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

staticinherited

Imports a feed represented by $string.

Inherited from: + \Zend_Gdata_App::importString()\Zend_Gdata::importString()

Parameters

Name	Type	Description
$string	string
$className	string	The class which is used as the return type
$majorProtocolVersion
$minorProtocolVersion

Returns

Type	Description
\Zend_Gdata_App_Feed

Throws

Exception	Description
\Zend_Gdata_App_Exception

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

inherited

Imports the specified URL (non-statically).

Inherited from: + \Zend_Gdata_App::importUrl()\Zend_Gdata::importUrl()

Parameters

Name	Type	Description
$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. +

Returns

Type	Description
string \| \Zend_Gdata_App_Feed	Returns string only if the object + mapping has been disabled explicitly + by passing false to the + useObjectMapping() function.

Throws

Exception	Description
\Zend_Gdata_App_Exception

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

Create a new email list from an EmailListEntry.

Parameters

Name	Type	Description
$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. +

Returns

Type	Description
\Zend_Gdata_Gapps_EmailListEntry	The inserted email list entry + as returned by the server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

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

Create a new email list recipient from an EmailListRecipientEntry.

Parameters

Name	Type	Description
$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. +

Returns

Type	Description
\Zend_Gdata_Gapps_EmailListRecipientEntry	The inserted + recipient entry as returned by the server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

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

inherited

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

Inherited from: + \Zend_Gdata_App::insertEntry()\Zend_Gdata::insertEntry()

Parameters

Name	Type	Description
$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

Type	Description
\Zend_Gdata_App_Entry	The entry returned by the service after + insertion.

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

Create a new group from a GroupEntry.

Parameters

Name	Type	Description
$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. +

Returns

Type	Description
\Zend_Gdata_Gapps_GroupEntry	The inserted group entry as + returned by the server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

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

Create a new member from a MemberEntry.

Parameters

Name	Type	Description
$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. +

Returns

Type	Description
\Zend_Gdata_Gapps_MemberEntry	The inserted member entry as + returned by the server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

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

Create a new nickname from a NicknameEntry.

Parameters

Name	Type	Description
$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. +

Returns

Type	Description
\Zend_Gdata_Gapps_NicknameEntry	The inserted nickname entry as + returned by the server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

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

Create a new group from a OwnerEntry.

Parameters

Name	Type	Description
$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. +

Returns

Type	Description
\Zend_Gdata_Gapps_OwnerEntry	The inserted owner entry as + returned by the server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

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

Create a new user from a UserEntry.

Parameters

Name	Type	Description
$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. +

Returns

Type	Description
\Zend_Gdata_Gapps_UserEntry	The inserted user entry as + returned by the server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

isAuthenticated() : boolean

inherited

Determines whether service object is authenticated.

Inherited from: + \Zend_Gdata::isAuthenticated()

Returns

Type	Description
boolean	True if service object is authenticated, false otherwise.

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

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

Parameters

Name	Type	Description
$memberId	string	Member id or group group id
$groupId	string	Group to be checked for

Returns

Type	Description
bool	True, if given entity is a member

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

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

Parameters

Name	Type	Description
$email	string	Owner's email +
$groupId	string	Group ownership to be checked for

Returns

Type	Description
bool	True, if given entity is an owner

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

inherited

Performs a HTTP request using the specified method.

Inherited from: + \Zend_Gdata::performHttpRequest()

Overrides the definition in the parent (Zend_Gdata_App) +and uses the Zend_Gdata_HttpClient functionality +to filter the HTTP requests and responses.

Parameters

Name	Type	Description
$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
$body	string	The body of the HTTP request
$contentType	string	The value for the content type of the + request body
$remainingRedirects	int	Number of redirects to follow + if requests results in one

Returns

Type	Description
\Zend_Http_Response	The response object

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

POST data with client object.

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

Parameters

Name	Type	Description
$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

Returns

Type	Description
\Zend_Http_Response

Throws

Exception	Description
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException
\Zend_Gdata_Gapps_ServiceException

prepareRequest(string $method, string $url = null, array $headers = array(), mixed $data = null, string $contentTypeOverride = null) : array

inherited

Provides pre-processing for HTTP requests to APP services.

Inherited from: + \Zend_Gdata_App::prepareRequest()\Zend_Gdata::prepareRequest()

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

Parameters

Name	Type	Description
$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

Type	Description
array	An associative array containing the determined + 'method', 'url', 'data', 'headers', 'contentType'

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

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

Parameters

Name	Type	Description
$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

Returns

Type	Description
\Zend_Http_Response

Throws

Exception	Description
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException
\Zend_Gdata_Gapps_ServiceException

registerPackage(string $name) : void

inherited

Adds a Zend Framework package to the $_registeredPackages array.

Inherited from: + \Zend_Gdata_App::registerPackage()\Zend_Gdata::registerPackage()

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

Parameters

Name	Type	Description
$name	string	The name of the package (eg Zend_Gdata_App) +

removeMemberFromGroup(string $memberId, string $groupId) : void

Remove a member id from a group

Parameters

Name	Type	Description
$memberId	string	Member id or group id
$groupId	string	The unique id of the group

removeOwnerFromGroup(string $email, string $groupId) : void

Remove email as an owner of a group

Parameters

Name	Type	Description
$email	string	Owner's email +
$groupId	string	The unique identifier for the group

removeRecipientFromEmailList(string $recipientAddress, string $emailList) : void

Remove a specified recipient from an email list.

Parameters

Name	Type	Description
$recipientAddress	string	The recipient to be removed.
$emailList	string	The list from which the recipient should + be removed.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

restoreUser(string $username) : \Zend_Gdata_Gapps_UserEntry

Mark a given user as not suspended.

Parameters

Name	Type	Description
$username	string	The username associated with the user who + should be restored.

Returns

Type	Description
\Zend_Gdata_Gapps_UserEntry	The UserEntry for the modified + user.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

retrieveAllEmailLists() : \Zend_Gdata_Gapps_EmailListFeed

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.

Returns

Type	Description
\Zend_Gdata_Gapps_EmailListFeed	The list of email lists found + as Zend_Gdata_Gapps_EmailListEntry objects.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

retrieveAllEntriesForFeed(object $feed) : mixed

inherited

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

Inherited from: + \Zend_Gdata_App::retrieveAllEntriesForFeed()\Zend_Gdata::retrieveAllEntriesForFeed()

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

Name	Type	Description
$feed	object	The feed to iterate through.

Returns

Type	Description
mixed	A new feed of the same type as the one originally + passed in, containing all relevent entries.

retrieveAllGroups() : \Zend_Gdata_Gapps_GroupFeed

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.

Returns

Type	Description
\Zend_Gdata_Gapps_GroupFeed	Collection of Zend_Gdata_GroupEntry objects + representing all groups apart of the domain.

retrieveAllMembers(string $groupId) : \Zend_Gdata_Gapps_MemberFeed

Retrieves all the members of a group

Parameters

Name	Type	Description
$groupId	string	The unique id of the group

Returns

Type	Description
\Zend_Gdata_Gapps_MemberFeed	Collection of MemberEntry objects + representing all members apart of the group.

retrieveAllNicknames() : \Zend_Gdata_Gapps_NicknameFeed

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.

Returns

Type	Description
\Zend_Gdata_Gapps_NicknameFeed	Collection of Zend_Gdata_NicknameEntry + objects representing all nicknames in the domain.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

retrieveAllRecipients( $emailList) : \Zend_Gdata_Gapps_EmailListRecipientFeed

Retrieve all recipients associated with an email list.

Parameters

Name	Type	Description
$emailList

Returns

Type	Description
\Zend_Gdata_Gapps_EmailListRecipientFeed	The list of email lists + found as Zend_Gdata_Gapps_EmailListRecipientEntry objects.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

retrieveAllUsers() : \Zend_Gdata_Gapps_UserFeed

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.

Returns

Type	Description
\Zend_Gdata_Gapps_UserFeed	Collection of Zend_Gdata_UserEntry + objects representing all users in the domain.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

retrieveEmailLists( $recipient) : \Zend_Gdata_Gapps_EmailListFeed

Retrieve all email lists associated with a recipient.

Parameters

Name	Type	Description
$recipient

Returns

Type	Description
\Zend_Gdata_Gapps_EmailListFeed	The list of email lists found as + Zend_Gdata_EmailListEntry objects.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

retrieveGroup(string $groupId) : \Zend_Gdata_Gapps_GroupEntry

Retrieves a group based on group id

Parameters

Name	Type	Description
$groupId	string	The unique identifier for the group

Returns

Type	Description
\Zend_Gdata_Gapps_GroupEntry	The group entry as returned by the server.

retrieveGroupOwners(string $groupId) : \Zend_Gdata_Gapps_OwnerFeed

Retrieves all the owners of a group

Parameters

Name	Type	Description
$groupId	string	The unique identifier for the group

Returns

Type	Description
\Zend_Gdata_Gapps_OwnerFeed	Collection of Zend_Gdata_OwnerEntry + objects representing all owners apart of the group.

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

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

Parameters

Name	Type	Description
$memberId	string	Member username
$directOnly	bool	(Optional) If true, members with direct association + only will be considered +

Returns

Type	Description
\Zend_Gdata_Gapps_GroupFeed	Collection of Zend_Gdata_GroupEntry + objects representing all groups member is apart of in the domain.

retrieveNickname(string $nickname) : \Zend_Gdata_Gapps_NicknameEntry

Retrieve the entry for a specified nickname.

Parameters

Name	Type	Description
$nickname	string	The nickname to be retrieved.

Returns

Type	Description
\Zend_Gdata_Gapps_NicknameEntry	The requested nickname entry.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

retrieveNicknames(string $username) : \Zend_Gdata_Gapps_NicknameFeed

Retrieve all nicknames associated with a specific username.

Parameters

Name	Type	Description
$username	string	The username whose nicknames should be + returned.

Returns

Type	Description
\Zend_Gdata_Gapps_NicknameFeed	A feed containing all nicknames + for the given user, or null if

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

retrievePageOfEmailLists( $startNickname = null) : \Zend_Gdata_Gapps_EmailListFeed

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

Parameters

Name	Type	Description
$startNickname

Returns

Type	Description
\Zend_Gdata_Gapps_EmailListFeed	Collection of Zend_Gdata_EmailListEntry + objects representing all nicknames in the domain.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

retrievePageOfGroups(string $startGroup = null) : \Zend_Gdata_Gapps_GroupFeed

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

Parameters

Name	Type	Description
$startGroup	string	(optional) The first group to + retrieve. If null or not defined, the page will begin + with the first group in the domain. +

Returns

Type	Description
\Zend_Gdata_Gapps_GroupFeed	Collection of Zend_Gdata_GroupEntry + objects representing the groups in the domain.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

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

Gets page of Members

Parameters

Name	Type	Description
$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

Type	Description
\Zend_Gdata_Gapps_MemberFeed	Collection of Zend_Gdata_MemberEntry + objects

retrievePageOfNicknames(string $startNickname = null) : \Zend_Gdata_Gapps_NicknameFeed

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

Parameters

Name	Type	Description
$startNickname	string	(optional) The first nickname to + retrieve. If null or not declared, the page will begin with + the first nickname in the domain. +

Returns

Type	Description
\Zend_Gdata_Gapps_NicknameFeed	Collection of Zend_Gdata_NicknameEntry + objects representing all nicknames in the domain.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

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

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

Parameters

Name	Type	Description
$emailList
$startRecipient	string	(optinal) The address of the first + recipient, or null to start with the first recipient in + the list. +

Returns

Type	Description
\Zend_Gdata_Gapps_EmailListRecipientFeed	Collection of + Zend_Gdata_EmailListRecipientEntry objects representing all + recpients in the specified list.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

retrievePageOfUsers(string $startUsername = null) : \Zend_Gdata_Gapps_UserFeed

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

Parameters

Name	Type	Description
$startUsername	string	(optional) The first username to retrieve. + If null or not declared, the page will begin with the first + user in the domain. +

Returns

Type	Description
\Zend_Gdata_Gapps_UserFeed	Collection of Zend_Gdata_UserEntry + objects representing all users in the domain.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

retrieveUser(string $username) : \Zend_Gdata_Gapps_UserEntry

Retrieve a user based on their username.

Parameters

Name	Type	Description
$username	string	The username to search for.

Returns

Type	Description
\Zend_Gdata_Gapps_UserEntry	The username to search for, or null + if no match found.

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException
\Zend_Gdata_App_HttpException

setDomain(string $value) : void

Set domain for this service instance.

This should be a fully qualified +domain, such as 'foo.example.com'.

+ +

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

Name	Type	Description
$value	string	The domain to be used for this session.

setGzipEnabled(boolean $enabled = false) : void

staticinherited

Toggle requesting gzip encoded responses

Inherited from: + \Zend_Gdata_App::setGzipEnabled()\Zend_Gdata::setGzipEnabled()

Parameters

Name	Type	Description
$enabled	boolean	Whether or not to enable gzipped responses

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

inherited

Set the Zend_Http_Client object used for communication

Inherited from: + \Zend_Gdata_App::setHttpClient()\Zend_Gdata::setHttpClient()

Parameters

Name	Type	Description
$client	\Zend_Http_Client	The client to use for communication
$applicationId

Returns

Type	Description
\Zend_Gdata_App	Provides a fluent interface

Throws

Exception	Description
\Zend_Gdata_App_HttpException

setHttpMethodOverride(boolean $override = true) : void

staticinherited

Toggle using POST instead of PUT and DELETE HTTP methods

Inherited from: + \Zend_Gdata_App::setHttpMethodOverride()\Zend_Gdata::setHttpMethodOverride()

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

Name	Type	Description
$override	boolean	Whether to override PUT and DELETE with POST.

setMajorProtocolVersion(int $value) : void

inherited

Set the major protocol version that should be used.

Inherited from: + \Zend_Gdata_App::setMajorProtocolVersion()\Zend_Gdata::setMajorProtocolVersion()

Values < 1 will +cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

Parameters

Name	Type	Description
$value	int	The major protocol version to use.

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

Details

See: \_majorProtocolVersion + +

setMaxRedirects(int $maxRedirects) : void

staticinherited

Set the maximum number of redirects to follow during HTTP operations

Inherited from: + \Zend_Gdata_App::setMaxRedirects()\Zend_Gdata::setMaxRedirects()

Parameters

Name	Type	Description
$maxRedirects	int	Maximum number of redirects to follow

setMinorProtocolVersion(\(int | \NULL) $value) : void

inherited

Set the minor protocol version that should be used.

Inherited from: + \Zend_Gdata_App::setMinorProtocolVersion()\Zend_Gdata::setMinorProtocolVersion()

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.

Parameters

Name	Type	Description
$value	\(int \| \NULL)	The minor protocol version to use.

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

Details

See: \_minorProtocolVersion + +

setStaticHttpClient(\Zend_Http_Client $httpClient) : void

staticinherited

Set the static HTTP client instance

Inherited from: + \Zend_Gdata_App::setStaticHttpClient()\Zend_Gdata::setStaticHttpClient()

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

Parameters

Name	Type	Description
$httpClient	\Zend_Http_Client

setVerboseExceptionMessages(boolean $verbose) : void

staticinherited

Set whether to use verbose exception messages

Inherited from: + \Zend_Gdata_App::setVerboseExceptionMessages()\Zend_Gdata::setVerboseExceptionMessages()

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

Parameters

Name	Type	Description
$verbose	boolean	Whether to use verbose exception messages

suspendUser(string $username) : \Zend_Gdata_Gapps_UserEntry

Mark a given user as suspended.

Parameters

Name	Type	Description
$username	string	The username associated with the user who + should be suspended.

Returns

Type	Description
\Zend_Gdata_Gapps_UserEntry	The UserEntry for the modified + user.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

throwServiceExceptionIfDetected(\Zend_Gdata_Exception $e) : void

static

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.

Parameters

Name	Type	Description
$e	\Zend_Gdata_Exception	The exception to convert.

Throws

Exception	Description
\Zend_Gdata_Gapps_ServiceException
mixed

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

inherited

Update an entry

Inherited from: + \Zend_Gdata_App::updateEntry()\Zend_Gdata::updateEntry()

Parameters

Name	Type	Description
$data	mixed	Zend_Gdata_App_Entry or XML (w/ID and link rel='edit') +
$uri	string \| null	The URI to send requests to, or null if $data + contains the URI. +
$className	string \| null	The name of the class that should be deserialized + from the server response. If null, then 'Zend_Gdata_App_Entry' + will be used. +
$extraHeaders	array	Extra headers to add to the request, as an + array of string-based key/value pairs. +

Returns

Type	Description
\Zend_Gdata_App_Entry	The entry returned from the server

Throws

Exception	Description
\Zend_Gdata_App_Exception

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

Update group properties with new values.

any property not defined will not +be updated

Parameters

Name	Type	Description
$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

Type	Description
\Zend_Gdata_Gapps_GroupEntry	The group entry as updated on the server.

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

Overwrite a specified username with the provided UserEntry.

The +UserEntry does not need to contain an edit link.

+ +

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

Parameters

Name	Type	Description
$username	string	The username whose data will be overwritten.
$userEntry	\Zend_Gdata_Gapps_UserEntry	The user entry which + will be overwritten.

Returns

Type	Description
\Zend_Gdata_Gapps_UserEntry	The UserEntry returned by the + server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException

Details

See: \Zend_Gdata_App_Entry::save + +

useObjectMapping(boolean $value) : void

inherited

Enable/disable the use of XML to object mapping.

Inherited from: + \Zend_Gdata_App::useObjectMapping()\Zend_Gdata::useObjectMapping()

Parameters

Name	Type	Description
$value	boolean	Pass in true to use the XML to object mapping. + Pass in false or null to disable it.

usingObjectMapping() : boolean

inherited

Determine whether service object is using XML to object mapping.

Inherited from: + \Zend_Gdata_App::usingObjectMapping()\Zend_Gdata::usingObjectMapping()

Returns

Type	Description
boolean	True if service object is using XML to object mapping, + false otherwise.

Gdata/Gapps.php

\Zend_Gdata_Gappsjump to top

Constants

Properties

Methods

\Zend_Gdata_Gapps
jump to top