Service class for interacting with the Google Apps Provisioning API.
Like other service classes in this module, this class provides access via an HTTP client to Google servers for working with entries and feeds.
Because of the nature of this API, all access must occur over an authenticated connection.
link | http://code.google.com/apis/apps/gdata_provisioning_api_v2.0_reference.html |
---|---|
category | Zend |
package | Zend_Gdata |
subpackage | Gapps |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_Gdata |
__call(string $method, array $args)
__call(string $method, array $args)
string
The method name being called
array
The arguments passed to the call
\Zend_Gdata_App_Exception |
---|
__construct(\Zend_Http_Client $client= null
, string $domain= null
, string $applicationId= 'MyCompany-MyApp-1.0'
)
inherited_from | \Zend_Gdata::__construct() |
---|
\Zend_Http_Client
(optional) The HTTP client to use when when communicating with the Google Apps servers.
string
(optional) The Google Apps domain which is to be accessed.
string
The identity of the app in the form of Company-AppName-Version
__construct(\Zend_Http_Client $client= null
, string $applicationId= 'MyCompany-MyApp-1.0'
)
\Zend_Http_Client
string
addMemberToGroup(string $recipientAddress, string $groupId) : \Zend_Gdata_Gapps_MemberEntry
string
Email address, member id, or group id
string
The unique id of the group
\Zend_Gdata_Gapps_MemberEntry
The member entry returned by the serveraddOwnerToGroup(string $email, string $groupId) : \Zend_Gdata_Gapps_OwnerEntry
string
Owner's email
string
Group ownership to be checked for
\Zend_Gdata_Gapps_OwnerEntry
The OwnerEntry returned by the serveraddRecipientToEmailList(string $recipientAddress, string $emailList) : \Zend_Gdata_Gapps_EmailListRecipientEntry
string
The address of the recipient to be added to the email list.
string
The name of the email address to which the recipient should be added.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_EmailListRecipientEntry
The recipient entry
created by the server.createEmailList(string $emailList) : \Zend_Gdata_Gapps_EmailListEntry
string
The name of the email list to be created.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_EmailListEntry
The email list entry
as created on the server.createGroup(string $groupId, string $groupName, string $description= null
, string $emailPermission= null
) : \Zend_Gdata_Gapps_GroupEntry
string
A unique identifier for the group
string
The name of the group
string
A description of the group
string
The subscription permission of the group
\Zend_Gdata_Gapps_GroupEntry
The group entry as created on the server.createNickname(string $username, string $nickname) : \Zend_Gdata_Gapps_NicknameEntry
string
The username to which the new nickname should be associated.
string
The new nickname to be created.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_NicknameEntry
The nickname entry which was
created by the server.createUser(string $username, string $givenName, string $familyName, string $password, $passwordHashFunction= null
, string $quotaLimitInMB= null
) : \Zend_Gdata_Gapps_UserEntry
string
The username for the new user.
string
The given name for the new user.
string
The family name for the new user.
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').
string
(optional) The quota limit for the new user in MB.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_UserEntry
(optional) The new user entry as returned by
server.delete(mixed $data, integer $remainingRedirects = null
) : void
mixed
The Zend_Gdata_App_Entry or URL to delete
integer
(optional)
\Zend_Gdata_App_HttpException |
|
---|---|
\Zend_Gdata_App_InvalidArgumentException |
|
\Zend_Gdata_Gapps_ServiceException |
delete(mixed $data, $remainingRedirects = null
) : void
mixed
The Zend_Gdata_App_Entry or URL to delete
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_App_InvalidArgumentException |
deleteEmailList(string $emailList)
string
The name of the emailList to be deleted.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
deleteGroup(string $groupId)
string
The unique identifier for the group
deleteNickname(string $nickname)
string
The name of the nickname to be deleted.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
deleteUser(string $username)
string
The username associated with the user who should be deleted.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
enableRequestDebugLogging(string $logfile)
NOTE: This will not work if you have customized the adapter already to use a proxy server or other interface.
string
The logfile to use when logging the requests
generateIfMatchHeaderData($data, $allowWeek) : string | null
string
null
$dataget(string $uri, array $extraHeaders = array()
) : \Zend_Http_Response
This method overrides the default behavior of Zend_Gdata_App, providing support for Zend_Gdata_Gapps_ServiceException.
string
GET URI
array
Extra headers to add to the request, as an array of string-based key/value pairs.
\Zend_Gdata_App_HttpException |
|
---|---|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Http_Response
get(string $uri, array $extraHeaders = array()
) : \Zend_Http_Response
string
GET URI
array
Extra headers to add to the request, as an array of string-based key/value pairs.
\Zend_Gdata_App_HttpException |
---|
\Zend_Http_Response
getBaseUrl(string $domain = null
)
string
(optional) A fully-qualified domain to use instead of the default domain for this service instance.
\Zend_Gdata_App_InvalidArgumentException |
---|
getDomain() : string
string
The domain to be used for this session, or null if not
set.getEmailListEntry(mixed $location) : \Zend_Gdata_Gapps_EmailListEntry
mixed
The location for the feed, as a URL or Query.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_EmailListEntry
getEmailListFeed(mixed $location = null
) : \Zend_Gdata_Gapps_EmailListFeed
mixed
(optional) The location for the feed, as a URL or Query.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_EmailListFeed
getEmailListRecipientEntry(mixed $location) : \Zend_Gdata_Gapps_EmailListRecipientEntry
mixed
The location for the feed, as a URL or Query.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_EmailListRecipientEntry
getEmailListRecipientFeed(mixed $location) : \Zend_Gdata_Gapps_EmailListRecipientFeed
mixed
The location for the feed, as a URL or Query.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_EmailListRecipientFeed
getEntry(string $uri, string $className = 'Zend_Gdata_App_Entry'
) : string | \Zend_Gdata_App_Entry
string
string
The class which is used as the return type
string
\Zend_Gdata_App_Entry
Returns string only if the object
mapping has been disabled explicitly
by passing false to the
useObjectMapping() function.getFeed(string $uri, string $className = 'Zend_Gdata_App_Feed'
) : string | \Zend_Gdata_App_Feed
string
The uri from which to retrieve the feed
string
The class which is used as the return type
string
\Zend_Gdata_App_Feed
Returns string only if the object
mapping has been disabled explicitly
by passing false to the
useObjectMapping() function.getGroupEntry(mixed $location = null
) : \Zend_Gdata_Gapps_GroupEntry
mixed
The location for the feed, as a URL or Query.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_GroupEntry
getGroupFeed(mixed $location = null
) : \Zend_Gdata_Gapps_GroupFeed
mixed
(optional) The location for the feed, as a URL or Query.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_GroupFeed
getGzipEnabled() : boolean
boolean
getHttpClient() : \Zend_Http_Client
\Zend_Http_Client
getHttpMethodOverride() : boolean
boolean
getMajorProtocolVersion() : integer
getMaxRedirects() : integer
integer
Maximum number of redirects to followgetMemberEntry(mixed $location = null
) : \Zend_Gdata_Gapps_MemberEntry
mixed
The location for the feed, as a URL or Query.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_MemberEntry
getMemberFeed(mixed $location = null
) : \Zend_Gdata_Gapps_MemberFeed
mixed
(optional) The location for the feed, as a URL or Query.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_MemberFeed
getMinorProtocolVersion() : \(int | \NULL)
getNextFeed(\Zend_Gdata_App_Feed $feed, string $className = null
) : \Zend_Gdata_App_Feed | null
\Zend_Gdata_App_Feed
The feed from which to retreive the next set of results.
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.
\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
mixed
The location for the feed, as a URL or Query.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_NicknameEntry
getNicknameFeed(mixed $location = null
) : \Zend_Gdata_Gapps_NicknameFeed
mixed
(optional) The location for the feed, as a URL or Query.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_NicknameFeed
getOwnerEntry(mixed $location = null
) : \Zend_Gdata_Gapps_OwnerEntry
mixed
The location for the feed, as a URL or Query.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_OwnerEntry
getOwnerFeed(mixed $location = null
) : \Zend_Gdata_Gapps_OwnerFeed
mixed
(optional) The location for the feed, as a URL or Query.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_OwnerFeed
getPreviousFeed(\Zend_Gdata_App_Feed $feed, string $className = null
) : \Zend_Gdata_App_Feed | null
\Zend_Gdata_App_Feed
The feed from which to retreive the previous set of results.
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.
\Zend_Gdata_App_Feed
null
Returns a
Zend_Gdata_App_Feed or null if no previous set of results
exists.getStaticHttpClient() : \Zend_Http_Client
\Zend_Http_Client
getUserEntry(mixed $location) : \Zend_Gdata_Gapps_UserEntry
mixed
The location for the feed, as a URL or Query.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_UserEntry
getUserFeed(mixed $location = null
) : \Zend_Gdata_Gapps_UserFeed
mixed
(optional) The location for the feed, as a URL or Query.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_UserFeed
getVerboseExceptionMessages() : boolean
In the case of HTTP errors, use the body of the HTTP response in the exception message.
boolean
import(string $uri, \Zend_Http_Client $client= null
, string $className= 'Zend_Gdata_App_Feed'
, boolean $useObjectMapping= true
) : \Zend_Gdata_App_Feed
This method overrides the default behavior of Zend_Gdata_App, providing support for Zend_Gdata_Gapps_ServiceException.
inherited_from | \Zend_Gdata::import() |
---|
string
\Zend_Http_Client
(optional) The client used for communication
string
(optional) The class which is used as the return type
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_App_Feed
import(string $uri, \Zend_Http_Client $client= null
, string $className= 'Zend_Gdata_App_Feed'
, boolean $useObjectMapping= true
) : string | \Zend_Gdata_App_Feed
string
\Zend_Http_Client
The client used for communication
string
The class which is used as the return type
boolean
Enable/disable the use of XML to object mapping.
\Zend_Gdata_App_Exception |
---|
string
\Zend_Gdata_App_Feed
Returns string only if the fourth
parameter ($useObjectMapping) is set
to false.importFile(string $filename, string $className= 'Zend_Gdata_App_Feed'
, string $useIncludePath= false
) : \Zend_Gdata_App_Feed
string
string
The class which is used as the return type
string
Whether the include_path should be searched
\Zend_Gdata_App_Exception |
---|
\Zend_Gdata_App_Feed
importString(string $string, string $className= 'Zend_Gdata_App_Feed'
, $majorProtocolVersion= null
, $minorProtocolVersion= null
) : \Zend_Gdata_App_Feed
string
string
The class which is used as the return type
\Zend_Gdata_App_Exception |
---|
\Zend_Gdata_App_Feed
importUrl(string $url, string $className= 'Zend_Gdata_App_Feed'
, array $extraHeaders= array()
) : string | \Zend_Gdata_App_Feed
string
The URL to import
string
The class which is used as the return type
array
Extra headers to add to the request, as an array of string-based key/value pairs.
\Zend_Gdata_App_Exception |
---|
string
\Zend_Gdata_App_Feed
Returns string only if the object
mapping has been disabled explicitly
by passing false to the
useObjectMapping() function.insertEmailList(\Zend_Gdata_Gapps_EmailListEntry $emailList, string $uri = null
) : \Zend_Gdata_Gapps_EmailListEntry
\Zend_Gdata_Gapps_EmailListEntry
The email list entry to insert.
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.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_EmailListEntry
The inserted email list entry
as returned by the server.insertEmailListRecipient(\Zend_Gdata_Gapps_EmailListRecipientEntry $recipient, string $uri = null
) : \Zend_Gdata_Gapps_EmailListRecipientEntry
\Zend_Gdata_Gapps_EmailListRecipientEntry
The recipient entry to insert.
string
(optional) The URI where the recipient should be uploaded to. If null, the default recipient creation URI for this domain will be used.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_EmailListRecipientEntry
The inserted
recipient entry as returned by the server.insertEntry(mixed $data, string $uri, string $className= 'Zend_Gdata_App_Entry'
, array $extraHeaders= array()
) : \Zend_Gdata_App_Entry
mixed
The Zend_Gdata_App_Entry or XML to post
string
POST URI
string
The class of entry to be returned.
array
Extra headers to add to the request, as an array of string-based key/value pairs.
\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
\Zend_Gdata_Gapps_GroupEntry
The group entry to insert.
string
(optional) The URI where the group should be uploaded to. If null, the default user creation URI for this domain will be used.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_GroupEntry
The inserted group entry as
returned by the server.insertMember(\Zend_Gdata_Gapps_MemberEntry $member, string $uri = null
) : \Zend_Gdata_Gapps_MemberEntry
\Zend_Gdata_Gapps_MemberEntry
The member entry to insert.
string
(optional) The URI where the group should be uploaded to. If null, the default user creation URI for this domain will be used.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_MemberEntry
The inserted member entry as
returned by the server.insertNickname(\Zend_Gdata_Gapps_NicknameEntry $nickname, string $uri = null
) : \Zend_Gdata_Gapps_NicknameEntry
\Zend_Gdata_Gapps_NicknameEntry
The nickname entry to insert.
string
(optional) The URI where the nickname should be uploaded to. If null, the default nickname creation URI for this domain will be used.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_NicknameEntry
The inserted nickname entry as
returned by the server.insertOwner(\Zend_Gdata_Gapps_OwnerEntry $owner, string $uri = null
) : \Zend_Gdata_Gapps_OwnerEntry
\Zend_Gdata_Gapps_OwnerEntry
The owner entry to insert.
string
(optional) The URI where the owner should be uploaded to. If null, the default user creation URI for this domain will be used.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_OwnerEntry
The inserted owner entry as
returned by the server.insertUser(\Zend_Gdata_Gapps_UserEntry $user, string $uri = null
) : \Zend_Gdata_Gapps_UserEntry
\Zend_Gdata_Gapps_UserEntry
The user entry to insert.
string
(optional) The URI where the user should be uploaded to. If null, the default user creation URI for this domain will be used.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_UserEntry
The inserted user entry as
returned by the server.isAuthenticated() : boolean
boolean
True if service object is authenticated, false otherwise.isMember(string $memberId, string $groupId) : boolean
string
Member id or group group id
string
Group to be checked for
boolean
True, if given entity is a memberisOwner(string $email, string $groupId) : boolean
string
Owner's email
string
Group ownership to be checked for
boolean
True, if given entity is an ownerperformHttpRequest(string $method, string $url, array $headers= null
, string $body= null
, string $contentType= null
, integer $remainingRedirects= null
) : \Zend_Http_Response
string
The HTTP method for the request - 'GET', 'POST', 'PUT', 'DELETE'
string
The URL to which this request is being performed
array
An associative array of HTTP headers for this request
string
The body of the HTTP request
string
The value for the content type of the request body
integer
Number of redirects to follow if request s results in one
\Zend_Http_Response
The response objectpost(mixed $data, string $uri= null
, integer $remainingRedirects= null
, string $contentType= null
, $extraHeaders= null
) : \Zend_Http_Response
This method overrides the default behavior of Zend_Gdata_App, providing support for Zend_Gdata_Gapps_ServiceException.
mixed
The Zend_Gdata_App_Entry or XML to post
string
(optional) POST URI
integer
(optional)
string
Content-type of the data
\Zend_Gdata_App_HttpException |
|
---|---|
\Zend_Gdata_App_InvalidArgumentException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Http_Response
post(mixed $data, string $uri= null
, $remainingRedirects= null
, string $contentType= null
, array $extraHeaders= null
) : \Zend_Http_Response
mixed
The Zend_Gdata_App_Entry or XML to post
string
POST URI
string
Content-type of the data
array
Extra headers to add to the request, as an array of string-based key/value pairs.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_App_InvalidArgumentException |
\Zend_Http_Response
prepareRequest(string $method, string $url= null
, array $headers= array()
, mixed $data= null
, string $contentTypeOverride= null
) : array
string
The HTTP method for the request - 'GET', 'POST', 'PUT', 'DELETE'
string
The URL to which this request is being performed, or null if found in $data
array
An associative array of HTTP headers for this request
mixed
The Zend_Gdata_App_Entry or XML for the body of the request
string
The override value for the content type of the request body
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
mixed
The Zend_Gdata_App_Entry or XML to post
string
(optional) PUT URI
integer
(optional)
string
Content-type of the data
\Zend_Gdata_App_HttpException |
|
---|---|
\Zend_Gdata_App_InvalidArgumentException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Http_Response
put(mixed $data, string $uri= null
, $remainingRedirects= null
, string $contentType= null
, array $extraHeaders= null
) : \Zend_Http_Response
mixed
The Zend_Gdata_App_Entry or XML to post
string
PUT URI
string
Content-type of the data
array
Extra headers to add to the request, as an array of string-based key/value pairs.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_App_InvalidArgumentException |
\Zend_Http_Response
registerPackage(string $name) : void
This array is searched when using the magic __call method below to instantiante new objects.
string
The name of the package (eg Zend_Gdata_App)
removeMemberFromGroup(string $memberId, string $groupId)
string
Member id or group id
string
The unique id of the group
removeOwnerFromGroup(string $email, string $groupId)
string
Owner's email
string
The unique identifier for the group
removeRecipientFromEmailList(string $recipientAddress, string $emailList)
string
The recipient to be removed.
string
The list from which the recipient should be removed.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
restoreUser(string $username) : \Zend_Gdata_Gapps_UserEntry
string
The username associated with the user who should be restored.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_UserEntry
The UserEntry for the modified
user.retrieveAllEmailLists() : \Zend_Gdata_Gapps_EmailListFeed
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_EmailListFeed
The list of email lists found
as Zend_Gdata_Gapps_EmailListEntry objects.retrieveAllEntriesForFeed(object $feed) : mixed
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.
object
The feed to iterate through.
mixed
A new feed of the same type as the one originally
passed in, containing all relevent entries.retrieveAllGroups() : \Zend_Gdata_Gapps_GroupFeed
\Zend_Gdata_Gapps_GroupFeed
Collection of Zend_Gdata_GroupEntry objects
representing all groups apart of the domain.retrieveAllMembers(string $groupId) : \Zend_Gdata_Gapps_MemberFeed
string
The unique id of the group
\Zend_Gdata_Gapps_MemberFeed
Collection of MemberEntry objects
representing all members apart of the group.retrieveAllNicknames() : \Zend_Gdata_Gapps_NicknameFeed
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_NicknameFeed
Collection of Zend_Gdata_NicknameEntry
objects representing all nicknames in the domain.retrieveAllRecipients($emailList) : \Zend_Gdata_Gapps_EmailListRecipientFeed
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_EmailListRecipientFeed
The list of email lists
found as Zend_Gdata_Gapps_EmailListRecipientEntry objects.retrieveAllUsers() : \Zend_Gdata_Gapps_UserFeed
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_UserFeed
Collection of Zend_Gdata_UserEntry
objects representing all users in the domain.retrieveEmailLists($recipient) : \Zend_Gdata_Gapps_EmailListFeed
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_EmailListFeed
The list of email lists found as
Zend_Gdata_EmailListEntry objects.retrieveGroup(string $groupId) : \Zend_Gdata_Gapps_GroupEntry
string
The unique identifier for the group
\Zend_Gdata_Gapps_GroupEntry
The group entry as returned by the server.retrieveGroupOwners(string $groupId) : \Zend_Gdata_Gapps_OwnerFeed
string
The unique identifier for the group
\Zend_Gdata_Gapps_OwnerFeed
Collection of Zend_Gdata_OwnerEntry
objects representing all owners apart of the group.retrieveGroups(string $memberId, boolean $directOnly = null
) : \Zend_Gdata_Gapps_GroupFeed
string
Member username
boolean
(Optional) If true, members with direct association only will be considered
\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
string
The nickname to be retrieved.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_NicknameEntry
The requested nickname entry.retrieveNicknames(string $username) : \Zend_Gdata_Gapps_NicknameFeed
string
The username whose nicknames should be returned.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_NicknameFeed
A feed containing all nicknames
for the given user, or null ifretrievePageOfEmailLists($startNickname = null
) : \Zend_Gdata_Gapps_EmailListFeed
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_EmailListFeed
Collection of Zend_Gdata_EmailListEntry
objects representing all nicknames in the domain.retrievePageOfGroups(string $startGroup = null
) : \Zend_Gdata_Gapps_GroupFeed
string
(optional) The first group to retrieve. If null or not defined, the page will begin with the first group in the domain.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_GroupFeed
Collection of Zend_Gdata_GroupEntry
objects representing the groups in the domain.retrievePageOfMembers(string $groupId, string $startMember = null
) : \Zend_Gdata_Gapps_MemberFeed
string
The group id which should be searched.
string
(optinal) The address of the first member, or null to start with the first member in the list.
\Zend_Gdata_Gapps_MemberFeed
Collection of Zend_Gdata_MemberEntry
objectsretrievePageOfNicknames(string $startNickname = null
) : \Zend_Gdata_Gapps_NicknameFeed
string
(optional) The first nickname to retrieve. If null or not declared, the page will begin with the first nickname in the domain.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_NicknameFeed
Collection of Zend_Gdata_NicknameEntry
objects representing all nicknames in the domain.retrievePageOfRecipients($emailList, string $startRecipient = null
) : \Zend_Gdata_Gapps_EmailListRecipientFeed
string
(optinal) The address of the first recipient, or null to start with the first recipient in the list.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_EmailListRecipientFeed
Collection of
Zend_Gdata_EmailListRecipientEntry objects representing all
recpients in the specified list.retrievePageOfUsers(string $startUsername = null
) : \Zend_Gdata_Gapps_UserFeed
string
(optional) The first username to retrieve. If null or not declared, the page will begin with the first user in the domain.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_UserFeed
Collection of Zend_Gdata_UserEntry
objects representing all users in the domain.retrieveUser(string $username) : \Zend_Gdata_Gapps_UserEntry
string
The username to search for.
\Zend_Gdata_App_InvalidArgumentException |
|
---|---|
\Zend_Gdata_App_HttpException |
\Zend_Gdata_Gapps_UserEntry
The username to search for, or null
if no match found.setDomain(string $value)
This value is used when calculating URLs for retrieving and posting entries. If no value is specified, a URL will have to be manually constructed prior to using any methods which interact with the Google Apps provisioning service.
string
The domain to be used for this session.
setGzipEnabled(boolean $enabled = false
) : void
boolean
Whether or not to enable gzipped responses
setHttpClient(\Zend_Http_Client $client, $applicationId = 'MyCompany-MyApp-1.0'
) : \Zend_Gdata_App
\Zend_Http_Client
The client to use for communication
\Zend_Gdata_App_HttpException |
---|
\Zend_Gdata_App
Provides a fluent interfacesetHttpMethodOverride(boolean $override = true
) : void
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.
boolean
Whether to override PUT and DELETE with POST.
setMajorProtocolVersion(integer $value)
setMaxRedirects(integer $maxRedirects) : void
integer
Maximum number of redirects to follow
setMinorProtocolVersion(\(int|\NULL) $value)
setStaticHttpClient(\Zend_Http_Client $httpClient) : void
Sets the static HTTP client object to use for retrieving the feed.
\Zend_Http_Client
setVerboseExceptionMessages(boolean $verbose)
In the case of HTTP errors, use the body of the HTTP response in the exception message.
boolean
Whether to use verbose exception messages
suspendUser(string $username) : \Zend_Gdata_Gapps_UserEntry
string
The username associated with the user who should be suspended.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_UserEntry
The UserEntry for the modified
user.throwServiceExceptionIfDetected(\Zend_Gdata_Exception $e)
\Zend_Gdata_Exception
The exception to convert.
\Zend_Gdata_Gapps_ServiceException |
|
---|---|
mixed |
updateEntry(mixed $data, $uri= null
, $className= null
, array $extraHeaders= array()
) : \Zend_Gdata_App_Entry
mixed
Zend_Gdata_App_Entry or XML (w/ID and link rel='edit')
array
Extra headers to add to the request, as an array of string-based key/value pairs.
\Zend_Gdata_App_Exception |
---|
\Zend_Gdata_App_Entry
The entry returned from the serverupdateGroup(string $groupId, string $groupName= null
, string $description= null
, string $emailPermission= null
) : \Zend_Gdata_Gapps_GroupEntry
string
A unique identifier for the group
string
The name of the group
string
A description of the group
string
The subscription permission of the group
\Zend_Gdata_Gapps_GroupEntry
The group entry as updated on the server.updateUser(string $username, \Zend_Gdata_Gapps_UserEntry $userEntry) : \Zend_Gdata_Gapps_UserEntry
This method is provided for compliance with the Google Apps Provisioning API specification. Normally users will instead want to call UserEntry::save() instead.
see |
---|
string
The username whose data will be overwritten.
\Zend_Gdata_Gapps_UserEntry
The user entry which will be overwritten.
\Zend_Gdata_App_Exception |
|
---|---|
\Zend_Gdata_App_HttpException |
|
\Zend_Gdata_Gapps_ServiceException |
\Zend_Gdata_Gapps_UserEntry
The UserEntry returned by the
server.useObjectMapping(boolean $value) : void
boolean
Pass in true to use the XML to object mapping. Pass in false or null to disable it.
usingObjectMapping() : boolean
boolean
True if service object is using XML to object mapping,
false otherwise.$namespaces : array
array(array('apps', 'http://schemas.google.com/apps/2006', 1, 0))
inherited_from | \Zend_Gdata::namespaces |
---|
$namespaces : array
array(array('gd', 'http://schemas.google.com/g/2005', 1, 0), array('openSearch', 'http://a9.com/-/spec/opensearchrss/1.0/', 1, 0), array('openSearch', 'http://a9.com/-/spec/opensearch/1.1/', 2, 0), array('rss', 'http://blogs.law.harvard.edu/tech/rss', 1, 0))
$_defaultPostUri : string
null
$_domain : string
null
$_gzipEnabled : boolean
false
$_httpClient : \Zend_Http_Client
$_httpMethodOverride : boolean
false
$_majorProtocolVersion
$_maxRedirects : integer
5
$_minorProtocolVersion
$_registeredPackages : array
array('Zend_Gdata_App_Extension', 'Zend_Gdata_App')
$_staticHttpClient : \Zend_Http_Client
null
$_useObjectMapping : boolean
true
$_verboseExceptionMessages : boolean
true
APPS_BASE_FEED_URI = 'https://apps-apis.google.com/a/feeds'
APPS_EMAIL_LIST_PATH = '/emailList/2.0'
APPS_EMAIL_LIST_RECIPIENT_POSTFIX = '/recipient'
APPS_GROUP_PATH = '/group/2.0'
APPS_NICKNAME_PATH = '/nickname/2.0'
APPS_USER_PATH = '/user/2.0'
AUTH_SERVICE_NAME = 'apps'
inherited_from | \Zend_Gdata::AUTH_SERVICE_NAME |
---|
AUTH_SERVICE_NAME = 'xapi' : string