Inheritance diagram for Zend_Gdata_Gapps:

Collaboration diagram for Zend_Gdata_Gapps:

Public Member Functions
	__construct ($client=null, $domain=null, $applicationId= 'MyCompany-MyApp-1.0')
	get ($uri, $extraHeaders=array())
	post ($data, $uri=null, $remainingRedirects=null, $contentType=null, $extraHeaders=null)
	put ($data, $uri=null, $remainingRedirects=null, $contentType=null, $extraHeaders=null)
	delete ($data, $remainingRedirects=null)
	setDomain ($value)
	getDomain ()
	getBaseUrl ($domain=null)
	getUserFeed ($location=null)
	getNicknameFeed ($location=null)
	getEmailListFeed ($location=null)
	getEmailListRecipientFeed ($location)
	getUserEntry ($location)
	getNicknameEntry ($location)
	getEmailListEntry ($location)
	getEmailListRecipientEntry ($location)
	insertUser ($user, $uri=null)
	insertNickname ($nickname, $uri=null)
	insertEmailList ($emailList, $uri=null)
	insertEmailListRecipient ($recipient, $uri=null)
	__call ($method, $args)
	createUser ($username, $givenName, $familyName, $password, $passwordHashFunction=null, $quotaLimitInMB=null)
	retrieveUser ($username)
	retrievePageOfUsers ($startUsername=null)
	retrieveAllUsers ()
	updateUser ($username, $userEntry)
	suspendUser ($username)
	restoreUser ($username)
	deleteUser ($username)
	createNickname ($username, $nickname)
	retrieveNickname ($nickname)
	retrieveNicknames ($username)
	retrievePageOfNicknames ($startNickname=null)
	retrieveAllNicknames ()
	deleteNickname ($nickname)
	createEmailList ($emailList)
	retrieveEmailLists ($recipient)
	retrievePageOfEmailLists ($startNickname=null)
	retrieveAllEmailLists ()
	deleteEmailList ($emailList)
	addRecipientToEmailList ($recipientAddress, $emailList)
	retrievePageOfRecipients ($emailList, $startRecipient=null)
	retrieveAllRecipients ($emailList)
	removeRecipientFromEmailList ($recipientAddress, $emailList)
Static Public Member Functions
static	throwServiceExceptionIfDetected ($e)
static	import ($uri, $client=null, $className='Zend_Gdata_App_Feed')
Data Fields
const	APPS_BASE_FEED_URI = 'https://apps-apis.google.com/a/feeds'
const	AUTH_SERVICE_NAME = 'apps'
const	APPS_USER_PATH = '/user/2.0'
const	APPS_NICKNAME_PATH = '/nickname/2.0'
const	APPS_EMAIL_LIST_PATH = '/emailList/2.0'
const	APPS_EMAIL_LIST_RECIPIENT_POSTFIX = '/recipient'
Static Public Attributes
static	$namespaces
Protected Attributes
	$_domain = null

Detailed Description

Definition at line 67 of file Gapps.php.

Constructor & Destructor Documentation

__construct	(	$	client = `null`,
		$	domain = `null`,
		$	applicationId = `'MyCompany-MyApp-1.0'`
	)

Create Gdata_Gapps object

Parameters:

Zend_Http_Client	$client	(optional) The HTTP client to use when when communicating with the Google Apps servers.
string	$domain	(optional) The Google Apps domain which is to be accessed.
string	$applicationId	The identity of the app in the form of Company-AppName-Version

Definition at line 118 of file Gapps.php.

Here is the call graph for this function:

Member Function Documentation

__call	(	$	method,
		$	args
	)

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.

See also:: Zend_Gdata_App::__call()

Parameters:

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

Exceptions:

Zend_Gdata_App_Exception

Reimplemented from Zend_Gdata_App.

Definition at line 622 of file Gapps.php.

Here is the call graph for this function:

addRecipientToEmailList	(	$	recipientAddress,
		$	emailList
	)

Add a specified recipient to an existing emailList.

Parameters:

string	$recipientAddress	The address of the recipient to be added to the email list.
string	$emailList	The name of the email address to which the recipient should be added.

Returns:: Zend_Gdata_Gapps_EmailListRecipientEntry The recipient entry created by the server.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 1030 of file Gapps.php.

Here is the call graph for this function:

createEmailList ( $ emailList )

Create a new email list.

Parameters:

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

Returns:: Zend_Gdata_Gapps_EmailListEntry The email list entry as created on the server.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 944 of file Gapps.php.

Here is the call graph for this function:

createNickname	(	$	username,
		$	nickname
	)

Create a nickname for a given user.

Parameters:

string	$username	The username to which the new nickname should be associated.
string	$nickname	The new nickname to be created.

Returns:: Zend_Gdata_Gapps_NicknameEntry The nickname entry which was created by the server.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 834 of file Gapps.php.

Here is the call graph for this function:

createUser	(	$	username,
		$	givenName,
		$	familyName,
		$	password,
		$	passwordHashFunction = `null`,
		$	quotaLimitInMB = `null`
	)

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

Parameters:

string	$username	The username for the new user.
string	$givenName	The given name for the new user.
string	$familyName	The family name for the new user.
string	$password	The password for the new user as a plaintext string (if $passwordHashFunction is null) or a SHA-1 hashed value (if $passwordHashFunction = 'SHA-1').
string	$quotaLimitInMB	(optional) The quota limit for the new user in MB.

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

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 675 of file Gapps.php.

Here is the call graph for this function:

delete	(	$	data,
		$	remainingRedirects = `null`
	)

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

Parameters:

mixed	$data	The Zend_Gdata_App_Entry or URL to delete
integer	$remainingRedirects	(optional)

Returns:: void

Exceptions:

Zend_Gdata_App_HttpException
Zend_Gdata_App_InvalidArgumentException
Zend_Gdata_Gapps_ServiceException

Reimplemented from Zend_Gdata_App.

Definition at line 270 of file Gapps.php.

Here is the call graph for this function:

deleteEmailList ( $ emailList )

Delete a specified email list.

Parameters:

string $emailList The name of the emailList to be deleted.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 1012 of file Gapps.php.

Here is the call graph for this function:

deleteNickname ( $ nickname )

Delete a specified nickname.

Parameters:

string $nickname The name of the nickname to be deleted.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 930 of file Gapps.php.

Here is the call graph for this function:

deleteUser ( $ username )

Delete a user by username.

Parameters:

string $username The username associated with the user who should be deleted.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 817 of file Gapps.php.

Here is the call graph for this function:

get	(	$	uri,
		$	extraHeaders = `array()`
	)

GET a URI using client object. This method overrides the default behavior of Zend_Gdata_App, providing support for Zend_Gdata_Gapps_ServiceException.

Parameters:

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

Exceptions:

Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Returns:: Zend_Http_Response

Reimplemented from Zend_Gdata_App.

Definition at line 199 of file Gapps.php.

Here is the call graph for this function:

getBaseUrl ( $ domain = null )

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:

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

Exceptions:

Zend_Gdata_App_InvalidArgumentException

Definition at line 317 of file Gapps.php.

Here is the caller graph for this function:

getDomain ( )

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:: string The domain to be used for this session, or null if not set.

Definition at line 303 of file Gapps.php.

Here is the caller graph for this function:

getEmailListEntry ( $ location )

Retreive a single EmailListEntry object.

Parameters:

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

Returns:: Zend_Gdata_Gapps_EmailListEntry

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 476 of file Gapps.php.

Here is the call graph for this function:

getEmailListFeed ( $ location = null )

Retreive EmailListFeed object containing multiple EmailListEntry objects.

Parameters:

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

Returns:: Zend_Gdata_Gapps_EmailListFeed

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 385 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getEmailListRecipientEntry ( $ location )

Retreive a single EmailListRecipientEntry object.

Parameters:

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

Returns:: Zend_Gdata_Gapps_EmailListRecipientEntry

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 499 of file Gapps.php.

Here is the call graph for this function:

getEmailListRecipientFeed ( $ location )

Retreive EmailListRecipientFeed object containing multiple EmailListRecipientEntry objects.

Parameters:

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

Returns:: Zend_Gdata_Gapps_EmailListRecipientFeed

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 407 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getNicknameEntry ( $ location )

Retreive a single NicknameEntry object.

Parameters:

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

Returns:: Zend_Gdata_Gapps_NicknameEntry

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 453 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getNicknameFeed ( $ location = null )

Retreive NicknameFeed object containing multiple NicknameEntry objects.

Parameters:

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

Returns:: Zend_Gdata_Gapps_NicknameFeed

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 362 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getUserEntry ( $ location )

Retreive a single UserEntry object.

Parameters:

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

Returns:: Zend_Gdata_Gapps_UserEntry

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 430 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getUserFeed ( $ location = null )

Retrieve a UserFeed containing multiple UserEntry objects.

Parameters:

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

Returns:: Zend_Gdata_Gapps_UserFeed

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 340 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static import	(	$	uri,
		$	client = `null`,
		$	className = `'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:

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

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Returns:: Zend_Gdata_App_Feed

Reimplemented from Zend_Gdata.

Definition at line 178 of file Gapps.php.

Here is the call graph for this function:

insertEmailList	(	$	emailList,
		$	uri = `null`
	)

Create a new email list from an EmailListEntry.

Parameters:

Zend_Gdata_Gapps_EmailListEntry	$emailList	The email list entry to insert.
string	$uri	(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:: Zend_Gdata_Gapps_EmailListEntry The inserted email list entry as returned by the server.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 572 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

insertEmailListRecipient	(	$	recipient,
		$	uri = `null`
	)

Create a new email list recipient from an EmailListRecipientEntry.

Parameters:

Zend_Gdata_Gapps_EmailListRecipientEntry	$recipient	The recipient entry to insert.
string	$uri	(optional) The URI where the recipient should be uploaded to. If null, the default recipient creation URI for this domain will be used.

Returns:: Zend_Gdata_Gapps_EmailListRecipientEntry The inserted recipient entry as returned by the server.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 595 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

insertNickname	(	$	nickname,
		$	uri = `null`
	)

Create a new nickname from a NicknameEntry.

Parameters:

Zend_Gdata_Gapps_NicknameEntry	$nickname	The nickname entry to insert.
string	$uri	(optional) The URI where the nickname should be uploaded to. If null, the default nickname creation URI for this domain will be used.

Returns:: Zend_Gdata_Gapps_NicknameEntry The inserted nickname entry as returned by the server.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 549 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

insertUser	(	$	user,
		$	uri = `null`
	)

Create a new user from a UserEntry.

Parameters:

Zend_Gdata_Gapps_UserEntry	$user	The user entry to insert.
string	$uri	(optional) The URI where the user should be uploaded to. If null, the default user creation URI for this domain will be used.

Returns:: Zend_Gdata_Gapps_UserEntry The inserted user entry as returned by the server.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 526 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

post	(	$	data,
		$	uri = `null`,
		$	remainingRedirects = `null`,
		$	contentType = `null`,
		$	extraHeaders = `null`
	)

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

Parameters:

mixed	$data	The Zend_Gdata_App_Entry or XML to post
string	$uri	(optional) POST URI
integer	$remainingRedirects	(optional)
string	$contentType	Content-type of the data
array	$extraHaders	Extra headers to add tot he request

Returns:: Zend_Http_Response

Exceptions:

Zend_Gdata_App_HttpException
Zend_Gdata_App_InvalidArgumentException
Zend_Gdata_Gapps_ServiceException

Reimplemented from Zend_Gdata_App.

Definition at line 223 of file Gapps.php.

Here is the call graph for this function:

put	(	$	data,
		$	uri = `null`,
		$	remainingRedirects = `null`,
		$	contentType = `null`,
		$	extraHeaders = `null`
	)

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

Parameters:

mixed	$data	The Zend_Gdata_App_Entry or XML to post
string	$uri	(optional) PUT URI
integer	$remainingRedirects	(optional)
string	$contentType	Content-type of the data
array	$extraHaders	Extra headers to add tot he request

Returns:: Zend_Http_Response

Exceptions:

Zend_Gdata_App_HttpException
Zend_Gdata_App_InvalidArgumentException
Zend_Gdata_Gapps_ServiceException

Reimplemented from Zend_Gdata_App.

Definition at line 248 of file Gapps.php.

Here is the call graph for this function:

removeRecipientFromEmailList	(	$	recipientAddress,
		$	emailList
	)

Remove a specified recipient from an email list.

Parameters:

string	$recipientAddress	The recipient to be removed.
string	$emailList	The list from which the recipient should be removed.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 1091 of file Gapps.php.

Here is the call graph for this function:

restoreUser ( $ username )

Mark a given user as not suspended.

Parameters:

string $username The username associated with the user who should be restored.

Returns:: Zend_Gdata_Gapps_UserEntry The UserEntry for the modified user.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 802 of file Gapps.php.

Here is the call graph for this function:

retrieveAllEmailLists ( )

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:: Zend_Gdata_Gapps_EmailListFeed The list of email lists found as Zend_Gdata_Gapps_EmailListEntry objects.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 1000 of file Gapps.php.

Here is the call graph for this function:

retrieveAllNicknames ( )

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:: Zend_Gdata_Gapps_NicknameFeed Collection of Zend_Gdata_NicknameEntry objects representing all nicknames in the domain.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 918 of file Gapps.php.

Here is the call graph for this function:

retrieveAllRecipients ( $ emailList )

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:

string $emaiList The email list which should be searched.

Returns:: Zend_Gdata_Gapps_EmailListRecipientFeed The list of email lists found as Zend_Gdata_Gapps_EmailListRecipientEntry objects.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 1076 of file Gapps.php.

Here is the call graph for this function:

retrieveAllUsers ( )

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:: Zend_Gdata_Gapps_UserFeed Collection of Zend_Gdata_UserEntry objects representing all users in the domain.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 747 of file Gapps.php.

Here is the call graph for this function:

retrieveEmailLists ( $ recipient )

Retrieve all email lists associated with a recipient.

Parameters:

string $username The recipient whose associated email lists should be returned.

Returns:: Zend_Gdata_Gapps_EmailListFeed The list of email lists found as Zend_Gdata_EmailListEntry objects.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 963 of file Gapps.php.

Here is the call graph for this function:

retrieveNickname ( $ nickname )

Retrieve the entry for a specified nickname.

Parameters:

string $nickname The nickname to be retrieved.

Returns:: Zend_Gdata_Gapps_NicknameEntry The requested nickname entry.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 852 of file Gapps.php.

Here is the call graph for this function:

retrieveNicknames ( $ username )

Retrieve all nicknames associated with a specific username.

Parameters:

string $username The username whose nicknames should be returned.

Returns:: Zend_Gdata_Gapps_NicknameFeed A feed containing all nicknames for the given user, or null if

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 879 of file Gapps.php.

Here is the call graph for this function:

retrievePageOfEmailLists ( $ startNickname = null )

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

Parameters:

string $startEmailListName (optional) The first list to retrieve. If null or not defined, the page will begin with the first email list in the domain.

Returns:: Zend_Gdata_Gapps_EmailListFeed Collection of Zend_Gdata_EmailListEntry objects representing all nicknames in the domain.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 982 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

retrievePageOfNicknames ( $ startNickname = null )

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

Parameters:

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

Returns:: Zend_Gdata_Gapps_NicknameFeed Collection of Zend_Gdata_NicknameEntry objects representing all nicknames in the domain.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 900 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

retrievePageOfRecipients	(	$	emailList,
		$	startRecipient = `null`
	)

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

Parameters:

string	$emaiList	The email list which should be searched.
string	$startRecipient	(optinal) The address of the first recipient, or null to start with the first recipient in the list.

Returns:: Zend_Gdata_Gapps_EmailListRecipientFeed Collection of Zend_Gdata_EmailListRecipientEntry objects representing all recpients in the specified list.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 1055 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

retrievePageOfUsers ( $ startUsername = null )

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

Parameters:

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

Returns:: Zend_Gdata_Gapps_UserFeed Collection of Zend_Gdata_UserEntry objects representing all users in the domain.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 729 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

retrieveUser ( $ username )

Retrieve a user based on their username.

Parameters:

string $username The username to search for.

Returns:: Zend_Gdata_Gapps_UserEntry The username to search for, or null if no match found.

Exceptions:

Zend_Gdata_App_InvalidArgumentException
Zend_Gdata_App_HttpException

Definition at line 701 of file Gapps.php.

Here is the call graph for this function:

Here is the caller graph for this function:

setDomain ( $ value )

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:

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

Definition at line 290 of file Gapps.php.

suspendUser ( $ username )

Mark a given user as suspended.

Parameters:

string $username The username associated with the user who should be suspended.

Returns:: Zend_Gdata_Gapps_UserEntry The UserEntry for the modified user.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 785 of file Gapps.php.

Here is the call graph for this function:

static throwServiceExceptionIfDetected ( $ e ) [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:

Zend_Gdata_Exception $e The exception to convert.

Exceptions:

Zend_Gdata_Gapps_ServiceException
mixed

Definition at line 136 of file Gapps.php.

Here is the caller graph for this function:

updateUser	(	$	username,
		$	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.

See also:: Zend_Gdata_App_Entry::save

Parameters:

string	$username	The username whose data will be overwritten.
Zend_Gdata_Gapps_UserEntry	$userEntry	The user entry which will be overwritten.

Returns:: Zend_Gdata_Gapps_UserEntry The UserEntry returned by the server.

Exceptions:

Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException
Zend_Gdata_Gapps_ServiceException

Definition at line 769 of file Gapps.php.

Here is the call graph for this function:

Field Documentation

$_domain = null [protected]

Definition at line 98 of file Gapps.php.

$namespaces [static]

Initial value:

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

Reimplemented from Zend_Gdata.

Definition at line 105 of file Gapps.php.

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

Definition at line 70 of file Gapps.php.

const APPS_EMAIL_LIST_PATH = '/emailList/2.0'

Path to email list feeds on the Google Apps server.

Definition at line 86 of file Gapps.php.

const APPS_EMAIL_LIST_RECIPIENT_POSTFIX = '/recipient'

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

Definition at line 91 of file Gapps.php.

const APPS_NICKNAME_PATH = '/nickname/2.0'

Path to nickname feeds on the Google Apps server.

Definition at line 81 of file Gapps.php.

const APPS_USER_PATH = '/user/2.0'

Path to user feeds on the Google Apps server.

Definition at line 76 of file Gapps.php.

const AUTH_SERVICE_NAME = 'apps'

Reimplemented from Zend_Gdata.

Definition at line 71 of file Gapps.php.

The documentation for this class was generated from the following file:

C:/xampp/htdocs/moodle/lib/zend/Zend/Gdata/Gapps.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation