Gdata/Gapps.php

Show: PublicProtectedPrivateinherited
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

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

>VConstant  APPS_BASE_FEED_URI = 'https://apps-apis.google.com/a/feeds'
>VConstantstring  AUTH_SERVICE_NAME = 'apps'
Service name for use with Google's authentication mechanisms
string

>VConstant  APPS_USER_PATH = '/user/2.0'
Path to user feeds on the Google Apps server.
>VConstant  APPS_NICKNAME_PATH = '/nickname/2.0'
Path to nickname feeds on the Google Apps server.
>VConstant  APPS_GROUP_PATH = '/group/2.0'
Path to group feeds on the Google Apps server.
>VConstant  APPS_EMAIL_LIST_PATH = '/emailList/2.0'
Path to email list feeds on the Google Apps server.
>VConstant  APPS_EMAIL_LIST_RECIPIENT_POSTFIX = '/recipient'
Path to email list recipient feeds on the Google Apps server.
>VConstant  DEFAULT_MAJOR_PROTOCOL_VERSION = 1
Inherited_from
\Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION  
Inherited_from
\Zend_Gdata::DEFAULT_MAJOR_PROTOCOL_VERSION  
See
\_majorProtocolVersion  
>VConstant  DEFAULT_MINOR_PROTOCOL_VERSION = null
Inherited_from
\Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION  
Inherited_from
\Zend_Gdata::DEFAULT_MINOR_PROTOCOL_VERSION  
See
\_minorProtocolVersion  

Properties

>VPropertyprotectedstring $_defaultPostUri = null
inherited
Default URI to which to POST.
Inherited from: \Zend_Gdata::$$_defaultPostUri
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata::$$_defaultPostUri  
>VPropertyprotectedstring $_domain = null
The domain which is being administered via the Provisioning API.
Default valuenullDetails
Type
string
>VPropertyprotectedboolean $_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  
>VPropertyprotected\Zend_Gdata_HttpClient $_httpClient
inherited
Client object used to communicate
Inherited from: \Zend_Gdata::$$_httpClient
>VPropertyprotectedboolean $_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  
>VPropertyprotected$_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()  
>VPropertyprotectedint $_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  
>VPropertyprotected$_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()  
>VPropertyprotectedarray $_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  
>VPropertyprotected\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  
>VPropertyprotectedboolean $_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  
>VPropertyprotectedboolean $_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  
>VPropertypublicarray $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

methodpublic__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
NameTypeDescription
$methodstring

The method name being called

$argsarray

The arguments passed to the call

Throws
ExceptionDescription
\Zend_Gdata_App_Exception
Details
See
\Zend_Gdata_App::__call()  
methodpublic__construct(\Zend_Http_Client $client = null, string $domain = null, string $applicationId = 'MyCompany-MyApp-1.0') : void

Create Gdata_Gapps object

Parameters
NameTypeDescription
$client\Zend_Http_Client

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

$domainstring

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

$applicationIdstring

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

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

Add an email address to a group as a member

Parameters
NameTypeDescription
$recipientAddressstring

Email address, member id, or group id

$groupIdstring

The unique id of the group

Returns
TypeDescription
\Zend_Gdata_Gapps_MemberEntryThe member entry returned by the server
methodpublicaddOwnerToGroup(string $email, string $groupId) : \Zend_Gdata_Gapps_OwnerEntry

Add an email as an owner of a group

Parameters
NameTypeDescription
$emailstring

Owner's email

$groupIdstring

Group ownership to be checked for

Returns
TypeDescription
\Zend_Gdata_Gapps_OwnerEntryThe OwnerEntry returned by the server
methodpublicaddRecipientToEmailList(string $recipientAddress, string $emailList) : \Zend_Gdata_Gapps_EmailListRecipientEntry

Add a specified recipient to an existing emailList.

Parameters
NameTypeDescription
$recipientAddressstring

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

$emailListstring

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

Returns
TypeDescription
\Zend_Gdata_Gapps_EmailListRecipientEntryThe recipient entry created by the server.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpubliccreateEmailList(string $emailList) : \Zend_Gdata_Gapps_EmailListEntry

Create a new email list.

Parameters
NameTypeDescription
$emailListstring

The name of the email list to be created.

Returns
TypeDescription
\Zend_Gdata_Gapps_EmailListEntryThe email list entry as created on the server.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpubliccreateGroup(string $groupId, string $groupName, string $description = null, string $emailPermission = null) : \Zend_Gdata_Gapps_GroupEntry

Create a new group.

Parameters
NameTypeDescription
$groupIdstring

A unique identifier for the group

$groupNamestring

The name of the group

$descriptionstring

A description of the group

$emailPermissionstring

The subscription permission of the group

Returns
TypeDescription
\Zend_Gdata_Gapps_GroupEntryThe group entry as created on the server.
methodpubliccreateNickname(string $username, string $nickname) : \Zend_Gdata_Gapps_NicknameEntry

Create a nickname for a given user.

Parameters
NameTypeDescription
$usernamestring

The username to which the new nickname should be associated.

$nicknamestring

The new nickname to be created.

Returns
TypeDescription
\Zend_Gdata_Gapps_NicknameEntryThe nickname entry which was created by the server.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpubliccreateUser(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
NameTypeDescription
$usernamestring

The username for the new user.

$givenNamestring

The given name for the new user.

$familyNamestring

The family name for the new user.

$passwordstring

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
$quotaLimitInMBstring

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

Returns
TypeDescription
\Zend_Gdata_Gapps_UserEntry(optional) The new user entry as returned by server.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicdelete(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
NameTypeDescription
$datamixed

The Zend_Gdata_App_Entry or URL to delete

$remainingRedirectsinteger

(optional)

Throws
ExceptionDescription
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException
\Zend_Gdata_Gapps_ServiceException
methodpublicdeleteEmailList(string $emailList) : void

Delete a specified email list.

Parameters
NameTypeDescription
$emailListstring

The name of the emailList to be deleted.

Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicdeleteGroup(string $groupId) : void

Delete a group

Parameters
NameTypeDescription
$groupIdstring

The unique identifier for the group

methodpublicdeleteNickname(string $nickname) : void

Delete a specified nickname.

Parameters
NameTypeDescription
$nicknamestring

The name of the nickname to be deleted.

Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicdeleteUser(string $username) : void

Delete a user by username.

Parameters
NameTypeDescription
$usernamestring

The username associated with the user who should be deleted.

Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicenableRequestDebugLogging(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
NameTypeDescription
$logfilestring

The logfile to use when logging the requests

methodpublicgenerateIfMatchHeaderData( $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
NameTypeDescription
$data
$allowWeek
Returns
TypeDescription
string | null$data
methodpublicget(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
NameTypeDescription
$uristring

GET URI

$extraHeadersarray

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

Returns
TypeDescription
\Zend_Http_Response
Throws
ExceptionDescription
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetBaseUrl(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
NameTypeDescription
$domainstring

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

Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
methodpublicgetDomain() : 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
TypeDescription
stringThe domain to be used for this session, or null if not set.
methodpublicgetEmailListEntry(mixed $location) : \Zend_Gdata_Gapps_EmailListEntry

Retreive a single EmailListEntry object.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\Zend_Gdata_Gapps_EmailListEntry
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetEmailListFeed(mixed $location = null) : \Zend_Gdata_Gapps_EmailListFeed

Retreive EmailListFeed object containing multiple EmailListEntry objects.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\Zend_Gdata_Gapps_EmailListFeed
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetEmailListRecipientEntry(mixed $location) : \Zend_Gdata_Gapps_EmailListRecipientEntry

Retreive a single EmailListRecipientEntry object.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\Zend_Gdata_Gapps_EmailListRecipientEntry
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetEmailListRecipientFeed(mixed $location) : \Zend_Gdata_Gapps_EmailListRecipientFeed

Retreive EmailListRecipientFeed object containing multiple EmailListRecipientEntry objects.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\Zend_Gdata_Gapps_EmailListRecipientFeed
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetEntry(mixed $location,  $className = 'Zend_Gdata_Entry') : string | \Zend_Gdata_App_Entry
inherited

Retrieve entry as string or object

Inherited from: \Zend_Gdata::getEntry()
Parameters
NameTypeDescription
$locationmixed

The location as string or Zend_Gdata_Query

$className
Returns
TypeDescription
string | \Zend_Gdata_App_EntryReturns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.
Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
methodpublicgetFeed(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
NameTypeDescription
$locationmixed

The location as string or Zend_Gdata_Query

$classNamestring

The class type to use for returning the feed

Returns
TypeDescription
string | \Zend_Gdata_App_FeedReturns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.
Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
methodpublicgetGroupEntry(mixed $location = null) : \Zend_Gdata_Gapps_GroupEntry

Retreive a single GroupEntry object.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\Zend_Gdata_Gapps_GroupEntry
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetGroupFeed(mixed $location = null) : \Zend_Gdata_Gapps_GroupFeed

Retreive GroupFeed object containing multiple GroupEntry objects.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\Zend_Gdata_Gapps_GroupFeed
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetGzipEnabled() : boolean
staticinherited

Get the HTTP override state

Inherited from: \Zend_Gdata_App::getGzipEnabled()\Zend_Gdata::getGzipEnabled()
Returns
TypeDescription
boolean
methodpublicgetHttpClient() : \Zend_Http_Client
inherited

Get the Zend_Http_Client object used for communication

Inherited from: \Zend_Gdata_App::getHttpClient()\Zend_Gdata::getHttpClient()
Returns
TypeDescription
\Zend_Http_Client
methodpublicgetHttpMethodOverride() : boolean
staticinherited

Get the HTTP override state

Inherited from: \Zend_Gdata_App::getHttpMethodOverride()\Zend_Gdata::getHttpMethodOverride()
Returns
TypeDescription
boolean
methodpublicgetMajorProtocolVersion() : int
inherited

Get the major protocol version that is in use.

Inherited from: \Zend_Gdata_App::getMajorProtocolVersion()\Zend_Gdata::getMajorProtocolVersion()
Returns
TypeDescription
intThe major protocol version in use.
Details
See
\_majorProtocolVersion  
methodpublicgetMaxRedirects() : int
staticinherited

Get the maximum number of redirects to follow during HTTP operations

Inherited from: \Zend_Gdata_App::getMaxRedirects()\Zend_Gdata::getMaxRedirects()
Returns
TypeDescription
intMaximum number of redirects to follow
methodpublicgetMemberEntry(mixed $location = null) : \Zend_Gdata_Gapps_MemberEntry

Retreive a single MemberEntry object.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\Zend_Gdata_Gapps_MemberEntry
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetMemberFeed(mixed $location = null) : \Zend_Gdata_Gapps_MemberFeed

Retreive MemberFeed object containing multiple MemberEntry objects.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\Zend_Gdata_Gapps_MemberFeed
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetMinorProtocolVersion() : \(int | \NULL)
inherited

Get the minor protocol version that is in use.

Inherited from: \Zend_Gdata_App::getMinorProtocolVersion()\Zend_Gdata::getMinorProtocolVersion()
Returns
TypeDescription
\(int | \NULL)The major protocol version in use, or NULL if no minor version is specified.
Details
See
\_minorProtocolVersion  
methodpublicgetNextFeed(\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
NameTypeDescription
$feed\Zend_Gdata_App_Feed

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

$classNamestring

(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
TypeDescription
\Zend_Gdata_App_Feed | nullReturns a Zend_Gdata_App_Feed or null if no next set of results exists.
methodpublicgetNicknameEntry(mixed $location) : \Zend_Gdata_Gapps_NicknameEntry

Retreive a single NicknameEntry object.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\Zend_Gdata_Gapps_NicknameEntry
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetNicknameFeed(mixed $location = null) : \Zend_Gdata_Gapps_NicknameFeed

Retreive NicknameFeed object containing multiple NicknameEntry objects.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\Zend_Gdata_Gapps_NicknameFeed
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetOwnerEntry(mixed $location = null) : \Zend_Gdata_Gapps_OwnerEntry

Retreive a single OwnerEntry object.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\Zend_Gdata_Gapps_OwnerEntry
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetOwnerFeed(mixed $location = null) : \Zend_Gdata_Gapps_OwnerFeed

Retreive OwnerFeed object containing multiple OwnerEntry objects.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\Zend_Gdata_Gapps_OwnerFeed
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetPreviousFeed(\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
NameTypeDescription
$feed\Zend_Gdata_App_Feed

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

$classNamestring

(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
TypeDescription
\Zend_Gdata_App_Feed | nullReturns a Zend_Gdata_App_Feed or null if no previous set of results exists.
methodpublicgetStaticHttpClient() : \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
TypeDescription
\Zend_Http_Client
methodpublicgetUserEntry(mixed $location) : \Zend_Gdata_Gapps_UserEntry

Retreive a single UserEntry object.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\Zend_Gdata_Gapps_UserEntry
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetUserFeed(mixed $location = null) : \Zend_Gdata_Gapps_UserFeed

Retrieve a UserFeed containing multiple UserEntry objects.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\Zend_Gdata_Gapps_UserFeed
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicgetVerboseExceptionMessages() : 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
TypeDescription
boolean
methodpublicimport(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
NameTypeDescription
$uristring
$client\Zend_Http_Client

(optional) The client used for communication

$classNamestring

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

Returns
TypeDescription
\Zend_Gdata_App_Feed
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicimportFile(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
NameTypeDescription
$filenamestring
$classNamestring

The class which is used as the return type

$useIncludePathstring

Whether the include_path should be searched

Returns
TypeDescription
\Zend_Gdata_App_Feed
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicimportString(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
NameTypeDescription
$stringstring
$classNamestring

The class which is used as the return type

$majorProtocolVersion
$minorProtocolVersion
Returns
TypeDescription
\Zend_Gdata_App_Feed
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicimportUrl(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
NameTypeDescription
$urlstring

The URL to import

$classNamestring

The class which is used as the return type

$extraHeadersarray

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

Returns
TypeDescription
string | \Zend_Gdata_App_FeedReturns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicinsertEmailList(\Zend_Gdata_Gapps_EmailListEntry $emailList, string $uri = null) : \Zend_Gdata_Gapps_EmailListEntry

Create a new email list from an EmailListEntry.

Parameters
NameTypeDescription
$emailList\Zend_Gdata_Gapps_EmailListEntry

The email list entry to insert.

$uristring

(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
TypeDescription
\Zend_Gdata_Gapps_EmailListEntryThe inserted email list entry as returned by the server.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicinsertEmailListRecipient(\Zend_Gdata_Gapps_EmailListRecipientEntry $recipient, string $uri = null) : \Zend_Gdata_Gapps_EmailListRecipientEntry

Create a new email list recipient from an EmailListRecipientEntry.

Parameters
NameTypeDescription
$recipient\Zend_Gdata_Gapps_EmailListRecipientEntry

The recipient entry to insert.

$uristring

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

Returns
TypeDescription
\Zend_Gdata_Gapps_EmailListRecipientEntryThe inserted recipient entry as returned by the server.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicinsertEntry(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
NameTypeDescription
$datamixed

The Zend_Gdata_App_Entry or XML to post

$uristring

POST URI

$classNamestring

The class of entry to be returned.

$extraHeadersarray

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

Returns
TypeDescription
\Zend_Gdata_App_EntryThe entry returned by the service after insertion.
methodpublicinsertGroup(\Zend_Gdata_Gapps_GroupEntry $group, string $uri = null) : \Zend_Gdata_Gapps_GroupEntry

Create a new group from a GroupEntry.

Parameters
NameTypeDescription
$group\Zend_Gdata_Gapps_GroupEntry

The group entry to insert.

$uristring

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

Returns
TypeDescription
\Zend_Gdata_Gapps_GroupEntryThe inserted group entry as returned by the server.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicinsertMember(\Zend_Gdata_Gapps_MemberEntry $member, string $uri = null) : \Zend_Gdata_Gapps_MemberEntry

Create a new member from a MemberEntry.

Parameters
NameTypeDescription
$member\Zend_Gdata_Gapps_MemberEntry

The member entry to insert.

$uristring

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

Returns
TypeDescription
\Zend_Gdata_Gapps_MemberEntryThe inserted member entry as returned by the server.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicinsertNickname(\Zend_Gdata_Gapps_NicknameEntry $nickname, string $uri = null) : \Zend_Gdata_Gapps_NicknameEntry

Create a new nickname from a NicknameEntry.

Parameters
NameTypeDescription
$nickname\Zend_Gdata_Gapps_NicknameEntry

The nickname entry to insert.

$uristring

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

Returns
TypeDescription
\Zend_Gdata_Gapps_NicknameEntryThe inserted nickname entry as returned by the server.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicinsertOwner(\Zend_Gdata_Gapps_OwnerEntry $owner, string $uri = null) : \Zend_Gdata_Gapps_OwnerEntry

Create a new group from a OwnerEntry.

Parameters
NameTypeDescription
$owner\Zend_Gdata_Gapps_OwnerEntry

The owner entry to insert.

$uristring

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

Returns
TypeDescription
\Zend_Gdata_Gapps_OwnerEntryThe inserted owner entry as returned by the server.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicinsertUser(\Zend_Gdata_Gapps_UserEntry $user, string $uri = null) : \Zend_Gdata_Gapps_UserEntry

Create a new user from a UserEntry.

Parameters
NameTypeDescription
$user\Zend_Gdata_Gapps_UserEntry

The user entry to insert.

$uristring

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

Returns
TypeDescription
\Zend_Gdata_Gapps_UserEntryThe inserted user entry as returned by the server.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicisAuthenticated() : boolean
inherited

Determines whether service object is authenticated.

Inherited from: \Zend_Gdata::isAuthenticated()
Returns
TypeDescription
booleanTrue if service object is authenticated, false otherwise.
methodpublicisMember(string $memberId, string $groupId) : bool

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

Parameters
NameTypeDescription
$memberIdstring

Member id or group group id

$groupIdstring

Group to be checked for

Returns
TypeDescription
boolTrue, if given entity is a member
methodpublicisOwner(string $email, string $groupId) : bool

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

Parameters
NameTypeDescription
$emailstring

Owner's email

$groupIdstring

Group ownership to be checked for

Returns
TypeDescription
boolTrue, if given entity is an owner
methodpublicperformHttpRequest(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
NameTypeDescription
$methodstring

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

$urlstring

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

$headersarray

An associative array of HTTP headers for this request

$bodystring

The body of the HTTP request

$contentTypestring

The value for the content type of the request body

$remainingRedirectsint

Number of redirects to follow if requests results in one

Returns
TypeDescription
\Zend_Http_ResponseThe response object
methodpublicpost(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
NameTypeDescription
$datamixed

The Zend_Gdata_App_Entry or XML to post

$uristring

(optional) POST URI

$remainingRedirectsinteger

(optional)

$contentTypestring

Content-type of the data

$extraHeaders
Returns
TypeDescription
\Zend_Http_Response
Throws
ExceptionDescription
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException
\Zend_Gdata_Gapps_ServiceException
methodpublicprepareRequest(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()
  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
NameTypeDescription
$methodstring

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

$urlstring

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

$headersarray

An associative array of HTTP headers for this request

$datamixed

The Zend_Gdata_App_Entry or XML for the body of the request

$contentTypeOverridestring

The override value for the content type of the request body

Returns
TypeDescription
arrayAn associative array containing the determined 'method', 'url', 'data', 'headers', 'contentType'
methodpublicput(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
NameTypeDescription
$datamixed

The Zend_Gdata_App_Entry or XML to post

$uristring

(optional) PUT URI

$remainingRedirectsinteger

(optional)

$contentTypestring

Content-type of the data

$extraHeaders
Returns
TypeDescription
\Zend_Http_Response
Throws
ExceptionDescription
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException
\Zend_Gdata_Gapps_ServiceException
methodpublicregisterPackage(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
NameTypeDescription
$namestring

The name of the package (eg Zend_Gdata_App)

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

Remove a member id from a group

Parameters
NameTypeDescription
$memberIdstring

Member id or group id

$groupIdstring

The unique id of the group

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

Remove email as an owner of a group

Parameters
NameTypeDescription
$emailstring

Owner's email

$groupIdstring

The unique identifier for the group

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

Remove a specified recipient from an email list.

Parameters
NameTypeDescription
$recipientAddressstring

The recipient to be removed.

$emailListstring

The list from which the recipient should be removed.

Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicrestoreUser(string $username) : \Zend_Gdata_Gapps_UserEntry

Mark a given user as not suspended.

Parameters
NameTypeDescription
$usernamestring

The username associated with the user who should be restored.

Returns
TypeDescription
\Zend_Gdata_Gapps_UserEntryThe UserEntry for the modified user.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicretrieveAllEmailLists() : \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
TypeDescription
\Zend_Gdata_Gapps_EmailListFeedThe list of email lists found as Zend_Gdata_Gapps_EmailListEntry objects.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicretrieveAllEntriesForFeed(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
NameTypeDescription
$feedobject

The feed to iterate through.

Returns
TypeDescription
mixedA new feed of the same type as the one originally passed in, containing all relevent entries.
methodpublicretrieveAllGroups() : \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
TypeDescription
\Zend_Gdata_Gapps_GroupFeedCollection of Zend_Gdata_GroupEntry objects representing all groups apart of the domain.
methodpublicretrieveAllMembers(string $groupId) : \Zend_Gdata_Gapps_MemberFeed

Retrieves all the members of a group

Parameters
NameTypeDescription
$groupIdstring

The unique id of the group

Returns
TypeDescription
\Zend_Gdata_Gapps_MemberFeedCollection of MemberEntry objects representing all members apart of the group.
methodpublicretrieveAllNicknames() : \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
TypeDescription
\Zend_Gdata_Gapps_NicknameFeedCollection of Zend_Gdata_NicknameEntry objects representing all nicknames in the domain.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicretrieveAllRecipients( $emailList) : \Zend_Gdata_Gapps_EmailListRecipientFeed

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.

Parameters
NameTypeDescription
$emailList
Returns
TypeDescription
\Zend_Gdata_Gapps_EmailListRecipientFeedThe list of email lists found as Zend_Gdata_Gapps_EmailListRecipientEntry objects.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicretrieveAllUsers() : \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
TypeDescription
\Zend_Gdata_Gapps_UserFeedCollection of Zend_Gdata_UserEntry objects representing all users in the domain.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicretrieveEmailLists( $recipient) : \Zend_Gdata_Gapps_EmailListFeed

Retrieve all email lists associated with a recipient.

Parameters
NameTypeDescription
$recipient
Returns
TypeDescription
\Zend_Gdata_Gapps_EmailListFeedThe list of email lists found as Zend_Gdata_EmailListEntry objects.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicretrieveGroup(string $groupId) : \Zend_Gdata_Gapps_GroupEntry

Retrieves a group based on group id

Parameters
NameTypeDescription
$groupIdstring

The unique identifier for the group

Returns
TypeDescription
\Zend_Gdata_Gapps_GroupEntryThe group entry as returned by the server.
methodpublicretrieveGroupOwners(string $groupId) : \Zend_Gdata_Gapps_OwnerFeed

Retrieves all the owners of a group

Parameters
NameTypeDescription
$groupIdstring

The unique identifier for the group

Returns
TypeDescription
\Zend_Gdata_Gapps_OwnerFeedCollection of Zend_Gdata_OwnerEntry objects representing all owners apart of the group.
methodpublicretrieveGroups(string $memberId, bool $directOnly = null) : \Zend_Gdata_Gapps_GroupFeed

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

Parameters
NameTypeDescription
$memberIdstring

Member username

$directOnlybool

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

Returns
TypeDescription
\Zend_Gdata_Gapps_GroupFeedCollection of Zend_Gdata_GroupEntry objects representing all groups member is apart of in the domain.
methodpublicretrieveNickname(string $nickname) : \Zend_Gdata_Gapps_NicknameEntry

Retrieve the entry for a specified nickname.

Parameters
NameTypeDescription
$nicknamestring

The nickname to be retrieved.

Returns
TypeDescription
\Zend_Gdata_Gapps_NicknameEntryThe requested nickname entry.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicretrieveNicknames(string $username) : \Zend_Gdata_Gapps_NicknameFeed

Retrieve all nicknames associated with a specific username.

Parameters
NameTypeDescription
$usernamestring

The username whose nicknames should be returned.

Returns
TypeDescription
\Zend_Gdata_Gapps_NicknameFeedA feed containing all nicknames for the given user, or null if
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicretrievePageOfEmailLists( $startNickname = null) : \Zend_Gdata_Gapps_EmailListFeed

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

Parameters
NameTypeDescription
$startNickname
Returns
TypeDescription
\Zend_Gdata_Gapps_EmailListFeedCollection of Zend_Gdata_EmailListEntry objects representing all nicknames in the domain.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicretrievePageOfGroups(string $startGroup = null) : \Zend_Gdata_Gapps_GroupFeed

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

Parameters
NameTypeDescription
$startGroupstring

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

Returns
TypeDescription
\Zend_Gdata_Gapps_GroupFeedCollection of Zend_Gdata_GroupEntry objects representing the groups in the domain.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicretrievePageOfMembers(string $groupId, string $startMember = null) : \Zend_Gdata_Gapps_MemberFeed

Gets page of Members

Parameters
NameTypeDescription
$groupIdstring

The group id which should be searched.

$startMemberstring

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

Returns
TypeDescription
\Zend_Gdata_Gapps_MemberFeedCollection of Zend_Gdata_MemberEntry objects
methodpublicretrievePageOfNicknames(string $startNickname = null) : \Zend_Gdata_Gapps_NicknameFeed

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

Parameters
NameTypeDescription
$startNicknamestring

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

Returns
TypeDescription
\Zend_Gdata_Gapps_NicknameFeedCollection of Zend_Gdata_NicknameEntry objects representing all nicknames in the domain.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicretrievePageOfRecipients( $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
NameTypeDescription
$emailList
$startRecipientstring

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

Returns
TypeDescription
\Zend_Gdata_Gapps_EmailListRecipientFeedCollection of Zend_Gdata_EmailListRecipientEntry objects representing all recpients in the specified list.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicretrievePageOfUsers(string $startUsername = null) : \Zend_Gdata_Gapps_UserFeed

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

Parameters
NameTypeDescription
$startUsernamestring

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

Returns
TypeDescription
\Zend_Gdata_Gapps_UserFeedCollection of Zend_Gdata_UserEntry objects representing all users in the domain.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicretrieveUser(string $username) : \Zend_Gdata_Gapps_UserEntry

Retrieve a user based on their username.

Parameters
NameTypeDescription
$usernamestring

The username to search for.

Returns
TypeDescription
\Zend_Gdata_Gapps_UserEntryThe username to search for, or null if no match found.
Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
\Zend_Gdata_App_HttpException
methodpublicsetDomain(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
NameTypeDescription
$valuestring

The domain to be used for this session.

methodpublicsetGzipEnabled(boolean $enabled = false) : void
staticinherited

Toggle requesting gzip encoded responses

Inherited from: \Zend_Gdata_App::setGzipEnabled()\Zend_Gdata::setGzipEnabled()
Parameters
NameTypeDescription
$enabledboolean

Whether or not to enable gzipped responses

methodpublicsetHttpClient(\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
NameTypeDescription
$client\Zend_Http_Client

The client to use for communication

$applicationId
Returns
TypeDescription
\Zend_Gdata_AppProvides a fluent interface
Throws
ExceptionDescription
\Zend_Gdata_App_HttpException
methodpublicsetHttpMethodOverride(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
NameTypeDescription
$overrideboolean

Whether to override PUT and DELETE with POST.

methodpublicsetMajorProtocolVersion(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
NameTypeDescription
$valueint

The major protocol version to use.

Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
Details
See
\_majorProtocolVersion  
methodpublicsetMaxRedirects(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
NameTypeDescription
$maxRedirectsint

Maximum number of redirects to follow

methodpublicsetMinorProtocolVersion(\(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
NameTypeDescription
$value\(int | \NULL)

The minor protocol version to use.

Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
Details
See
\_minorProtocolVersion  
methodpublicsetStaticHttpClient(\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
NameTypeDescription
$httpClient\Zend_Http_Client
methodpublicsetVerboseExceptionMessages(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
NameTypeDescription
$verboseboolean

Whether to use verbose exception messages

methodpublicsuspendUser(string $username) : \Zend_Gdata_Gapps_UserEntry

Mark a given user as suspended.

Parameters
NameTypeDescription
$usernamestring

The username associated with the user who should be suspended.

Returns
TypeDescription
\Zend_Gdata_Gapps_UserEntryThe UserEntry for the modified user.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
methodpublicthrowServiceExceptionIfDetected(\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
NameTypeDescription
$e\Zend_Gdata_Exception

The exception to convert.

Throws
ExceptionDescription
\Zend_Gdata_Gapps_ServiceException
mixed
methodpublicupdateEntry(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
NameTypeDescription
$datamixed

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

$uristring | null

The URI to send requests to, or null if $data contains the URI.

$classNamestring | null

The name of the class that should be deserialized from the server response. If null, then 'Zend_Gdata_App_Entry' will be used.

$extraHeadersarray

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

Returns
TypeDescription
\Zend_Gdata_App_EntryThe entry returned from the server
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicupdateGroup(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
NameTypeDescription
$groupIdstring

A unique identifier for the group

$groupNamestring

The name of the group

$descriptionstring

A description of the group

$emailPermissionstring

The subscription permission of the group

Returns
TypeDescription
\Zend_Gdata_Gapps_GroupEntryThe group entry as updated on the server.
methodpublicupdateUser(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
NameTypeDescription
$usernamestring

The username whose data will be overwritten.

$userEntry\Zend_Gdata_Gapps_UserEntry

The user entry which will be overwritten.

Returns
TypeDescription
\Zend_Gdata_Gapps_UserEntryThe UserEntry returned by the server.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_Gapps_ServiceException
Details
See
\Zend_Gdata_App_Entry::save  
methodpublicuseObjectMapping(boolean $value) : void
inherited

Enable/disable the use of XML to object mapping.

Inherited from: \Zend_Gdata_App::useObjectMapping()\Zend_Gdata::useObjectMapping()
Parameters
NameTypeDescription
$valueboolean

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

methodpublicusingObjectMapping() : boolean
inherited

Determine whether service object is using XML to object mapping.

Inherited from: \Zend_Gdata_App::usingObjectMapping()\Zend_Gdata::usingObjectMapping()
Returns
TypeDescription
booleanTrue if service object is using XML to object mapping, false otherwise.
Documentation was generated by phpDocumentor 2.0.0a12.