Gdata/Gapps.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: Gapps
version: $Id: Gapps.php 22534 2010-07-07 19:11:51Z tjohns $
Functions: createUser; retrieveUser; retrievePageOfUsers; retrieveAllUsers; updateUser; suspendUser; restoreUser; deleteUser; createNickname; retrieveNickname; retrieveNicknames; retrievePageOfNicknames; retrieveAllNicknames; deleteNickname; createGroup; retrieveGroup; retrieveAllGroups; deleteGroup; isMember; addMemberToGroup; removeMemberFromGroup; retrieveAllMembers; addOwnerToGroup; retrieveGroupOwners; isOwner; removeOwnerFromGroup; updateGroup; retrieveGroups; retrievePageOfGroups; retrievePageOfMembers; createEmailList; retrieveEmailLists; retrievePageOfEmailLists; retrieveAllEmailLists; deleteEmailList; addRecipientToEmailList; retrievePageOfRecipients; retrieveAllRecipients; removeRecipientFromEmailList
Classes: Zend_Gdata_Gapps

Description

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.

Functions

addMemberToGroup
jump to top

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

Add an email address to a group as a member

Arguments

$recipientAddress: string
Email address, member id, or group id
$groupId: string
The unique id of the group

Output

Zend_Gdata_Gapps_MemberEntry: The member entry returned by the server

addOwnerToGroup
jump to top

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

Add an email as an owner of a group

Arguments

$email: string
Owner's email
$groupId: string
Group ownership to be checked for

Output

Zend_Gdata_Gapps_OwnerEntry: The OwnerEntry returned by the server

addRecipientToEmailList
jump to top

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

Add a specified recipient to an existing emailList.

Arguments

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

Output

Zend_Gdata_Gapps_EmailListRecipientEntry: The recipient entry created by the server.

Details

throws
throws
throws

createEmailList
jump to top

createEmailList(
          string $emailList
          )
        
        :
        Zend_Gdata_Gapps_EmailListEntry

Create a new email list.

Arguments

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

Output

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

Details

throws
throws
throws

createGroup
jump to top

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

Create a new group.

Arguments

$groupId: string
A unique identifier for the group
$groupName: string
The name of the group
$description: string
A description of the group
$emailPermission: string
The subscription permission of the group

Output

Zend_Gdata_Gapps_GroupEntry: The group entry as created on the server.

createNickname
jump to top

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

Create a nickname for a given user.

Arguments

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

Output

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

Details

throws
throws
throws

createUser
jump to top

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

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

Arguments

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

Output

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

Details

throws
throws
throws

deleteEmailList
jump to top

deleteEmailList(
          string $emailList
          )
        
        :

Delete a specified email list.

Arguments

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

Details

throws
throws
throws

deleteGroup
jump to top

deleteGroup(
          string $groupId
          )
        
        :

Delete a group

Arguments

$groupId: string
The unique identifier for the group

deleteNickname
jump to top

deleteNickname(
          string $nickname
          )
        
        :

Delete a specified nickname.

Arguments

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

Details

throws
throws
throws

deleteUser
jump to top

deleteUser(
          string $username
          )
        
        :

Delete a user by username.

Arguments

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

Details

throws
throws
throws

isMember
jump to top

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

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

Arguments

$memberId: string
Member id or group group id
$groupId: string
Group to be checked for

Output

bool: True, if given entity is a member

isOwner
jump to top

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

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

Arguments

$email: string
Owner's email
$groupId: string
Group ownership to be checked for

Output

bool: True, if given entity is an owner

removeMemberFromGroup
jump to top

removeMemberFromGroup(
          string $memberId, string $groupId
          )
        
        :

Remove a member id from a group

Arguments

$memberId: string
Member id or group id
$groupId: string
The unique id of the group

removeOwnerFromGroup
jump to top

removeOwnerFromGroup(
          string $email, string $groupId
          )
        
        :

Remove email as an owner of a group

Arguments

$email: string
Owner's email
$groupId: string
The unique identifier for the group

removeRecipientFromEmailList
jump to top

removeRecipientFromEmailList(
          string $recipientAddress, string $emailList
          )
        
        :

Remove a specified recipient from an email list.

Arguments

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

Details

throws
throws
throws

restoreUser
jump to top

restoreUser(
          string $username
          )
        
        :
        Zend_Gdata_Gapps_UserEntry

Mark a given user as not suspended.

Arguments

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

Output

Zend_Gdata_Gapps_UserEntry: The UserEntry for the modified user.

Details

throws
throws
throws

retrieveAllEmailLists
jump to top

retrieveAllEmailLists(
          
          )
        
        :
        Zend_Gdata_Gapps_EmailListFeed

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

Output

Zend_Gdata_Gapps_EmailListFeed: The list of email lists found as Zend_Gdata_Gapps_EmailListEntry objects.

Details

throws
throws
throws

retrieveAllGroups
jump to top

retrieveAllGroups(
          
          )
        
        :
        Zend_Gdata_Gapps_GroupFeed

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

Output

Zend_Gdata_Gapps_GroupFeed: Collection of Zend_Gdata_GroupEntry objects representing all groups apart of the domain.

retrieveAllMembers
jump to top

retrieveAllMembers(
          string $groupId
          )
        
        :
        Zend_Gdata_Gapps_MemberFeed

Retrieves all the members of a group

Arguments

$groupId: string
The unique id of the group

Output

Zend_Gdata_Gapps_MemberFeed: Collection of MemberEntry objects representing all members apart of the group.

retrieveAllNicknames
jump to top

retrieveAllNicknames(
          
          )
        
        :
        Zend_Gdata_Gapps_NicknameFeed

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

Output

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

Details

throws
throws
throws

retrieveAllRecipients
jump to top

retrieveAllRecipients(
           $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.

Arguments

$emailList

Output

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

Details

throws
throws
throws

retrieveAllUsers
jump to top

retrieveAllUsers(
          
          )
        
        :
        Zend_Gdata_Gapps_UserFeed

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

Output

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

Details

throws
throws
throws

retrieveEmailLists
jump to top

retrieveEmailLists(
           $recipient
          )
        
        :
        Zend_Gdata_Gapps_EmailListFeed

Retrieve all email lists associated with a recipient.

Arguments

$recipient

Output

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

Details

throws
throws
throws

retrieveGroup
jump to top

retrieveGroup(
          string $groupId
          )
        
        :
        Zend_Gdata_Gapps_GroupEntry

Retrieves a group based on group id

Arguments

$groupId: string
The unique identifier for the group

Output

Zend_Gdata_Gapps_GroupEntry: The group entry as returned by the server.

retrieveGroupOwners
jump to top

retrieveGroupOwners(
          string $groupId
          )
        
        :
        Zend_Gdata_Gapps_OwnerFeed

Retrieves all the owners of a group

Arguments

$groupId: string
The unique identifier for the group

Output

Zend_Gdata_Gapps_OwnerFeed: Collection of Zend_Gdata_OwnerEntry objects representing all owners apart of the group.

retrieveGroups
jump to top

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

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

Arguments

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

Output

Zend_Gdata_Gapps_GroupFeed: Collection of Zend_Gdata_GroupEntry objects representing all groups member is apart of in the domain.

retrieveNickname
jump to top

retrieveNickname(
          string $nickname
          )
        
        :
        Zend_Gdata_Gapps_NicknameEntry

Retrieve the entry for a specified nickname.

Arguments

$nickname: string
The nickname to be retrieved.

Output

Zend_Gdata_Gapps_NicknameEntry: The requested nickname entry.

Details

throws
throws
throws

retrieveNicknames
jump to top

retrieveNicknames(
          string $username
          )
        
        :
        Zend_Gdata_Gapps_NicknameFeed

Retrieve all nicknames associated with a specific username.

Arguments

$username: string
The username whose nicknames should be returned.

Output

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

Details

throws
throws
throws

retrievePageOfEmailLists
jump to top

retrievePageOfEmailLists(
           $startNickname
              =
              null
          )
        
        :
        Zend_Gdata_Gapps_EmailListFeed

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

Arguments

$startNickname

Output

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

Details

throws
throws
throws

retrievePageOfGroups
jump to top

retrievePageOfGroups(
          string $startGroup
              =
              null
          )
        
        :
        Zend_Gdata_Gapps_GroupFeed

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

Arguments

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

Output

Zend_Gdata_Gapps_GroupFeed: Collection of Zend_Gdata_GroupEntry objects representing the groups in the domain.

Details

throws
throws
throws

retrievePageOfMembers
jump to top

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

Gets page of Members

Arguments

$groupId: string
The group id which should be searched.
$startMember: string
(optinal) The address of the first member, or null to start with the first member in the list.

Output

Zend_Gdata_Gapps_MemberFeed: Collection of Zend_Gdata_MemberEntry objects

retrievePageOfNicknames
jump to top

retrievePageOfNicknames(
          string $startNickname
              =
              null
          )
        
        :
        Zend_Gdata_Gapps_NicknameFeed

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

Arguments

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

Output

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

Details

throws
throws
throws

retrievePageOfRecipients
jump to top

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

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

Arguments

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

Output

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

Details

throws
throws
throws

retrievePageOfUsers
jump to top

retrievePageOfUsers(
          string $startUsername
              =
              null
          )
        
        :
        Zend_Gdata_Gapps_UserFeed

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

Arguments

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

Output

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

Details

throws
throws
throws

retrieveUser
jump to top

retrieveUser(
          string $username
          )
        
        :
        Zend_Gdata_Gapps_UserEntry

Retrieve a user based on their username.

Arguments

$username: string
The username to search for.

Output

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

Details

throws
throws

suspendUser
jump to top

suspendUser(
          string $username
          )
        
        :
        Zend_Gdata_Gapps_UserEntry

Mark a given user as suspended.

Arguments

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

Output

Zend_Gdata_Gapps_UserEntry: The UserEntry for the modified user.

Details

throws
throws
throws

updateGroup
jump to top

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

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

Arguments

$groupId: string
A unique identifier for the group
$groupName: string
The name of the group
$description: string
A description of the group
$emailPermission: string
The subscription permission of the group

Output

Zend_Gdata_Gapps_GroupEntry: The group entry as updated on the server.

updateUser
jump to top

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

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

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

Arguments

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

Output

Zend_Gdata_Gapps_UserEntry: The UserEntry returned by the server.

Details

see: Zend_Gdata_App_Entry::save
throws
throws
throws

Zend_Gdata_Gapps
jump to top

Extends from: Zend_Gdata
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
link: http://code.google.com/apis/apps/gdata_provisioning_api_v2.0_reference.html
package: Zend_Gdata
subpackage: Gapps
Constants: APPS_BASE_FEED_URI; AUTH_SERVICE_NAME; APPS_USER_PATH; APPS_NICKNAME_PATH; APPS_GROUP_PATH; APPS_EMAIL_LIST_PATH; APPS_EMAIL_LIST_RECIPIENT_POSTFIX
Properties: $_domain; $namespaces; $method; $args
Methods: __construct; throwServiceExceptionIfDetected; import; get; post; put; delete; setDomain; getDomain; getBaseUrl; getUserFeed; getNicknameFeed; getGroupFeed; getMemberFeed; getOwnerFeed; getEmailListFeed; getEmailListRecipientFeed; getUserEntry; getNicknameEntry; getGroupEntry; getMemberEntry; getOwnerEntry; getEmailListEntry; getEmailListRecipientEntry; insertUser; insertNickname; insertGroup; insertMember; insertOwner; insertEmailList; insertEmailListRecipient; __call

Description

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.

Constants

APPS_BASE_FEED_URI
jump to class

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

Details

value: https://apps-apis.google.com/a/feeds

AUTH_SERVICE_NAME
jump to class

 AUTH_SERVICE_NAME = 'apps'

Details

value: apps

APPS_USER_PATH
jump to class

 APPS_USER_PATH = '/user/2.0'

Path to user feeds on the Google Apps server.

Details

value: /user/2.0

APPS_NICKNAME_PATH
jump to class

 APPS_NICKNAME_PATH = '/nickname/2.0'

Path to nickname feeds on the Google Apps server.

Details

value: /nickname/2.0

APPS_GROUP_PATH
jump to class

 APPS_GROUP_PATH = '/group/2.0'

Path to group feeds on the Google Apps server.

Details

value: /group/2.0

APPS_EMAIL_LIST_PATH
jump to class

 APPS_EMAIL_LIST_PATH = '/emailList/2.0'

Path to email list feeds on the Google Apps server.

Details

value: /emailList/2.0

APPS_EMAIL_LIST_RECIPIENT_POSTFIX
jump to class

 APPS_EMAIL_LIST_RECIPIENT_POSTFIX = '/recipient'

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

Details

value: /recipient

Properties

$_domain
jump to class

string $_domain = 'null'

The domain which is being administered via the Provisioning API.

Details

$_domain: string
visibility: protected
default: null
final: false
static: false

$args
jump to class

$args = ''

Details

visibility: public
default
final: false
static: false

$method
jump to class

$method = ''

Details

visibility: public
default
final: false
static: false

$namespaces
jump to class

array $namespaces = 'array'

Namespaces used for Zend_Gdata_Gapps

Details

$namespaces: array
visibility: public
default: array
final: false
static: true

Methods

__call
jump to class

__call(
          string $method, array $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.

Arguments

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

Details

visibility: public
final: false
static: false
see: Zend_Gdata_App::__call()
throws

__construct
jump to class

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

Create Gdata_Gapps object

Arguments

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

Details

visibility: public
final: false
static: false

delete
jump to class

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

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

Arguments

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

Details

visibility: public
final: false
static: false
throws
throws
throws

get
jump to class

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

GET a URI using client object.

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

Arguments

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

Output

Zend_Http_Response

Details

visibility: public
final: false
static: false
throws
throws

getBaseUrl
jump to class

getBaseUrl(
          string $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.

Arguments

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

Details

visibility: public
final: false
static: false
throws

getDomain
jump to class

getDomain(
          
          )
        
        :
        string

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

Output

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

Details

visibility: public
final: false
static: false

getEmailListEntry
jump to class

getEmailListEntry(
          mixed $location
          )
        
        :
        Zend_Gdata_Gapps_EmailListEntry

Retreive a single EmailListEntry object.

Arguments

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

Output

Zend_Gdata_Gapps_EmailListEntry

Details

visibility: public
final: false
static: false
throws
throws
throws

getEmailListFeed
jump to class

getEmailListFeed(
          mixed $location
              =
              null
          )
        
        :
        Zend_Gdata_Gapps_EmailListFeed

Retreive EmailListFeed object containing multiple EmailListEntry objects.

Arguments

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

Output

Zend_Gdata_Gapps_EmailListFeed

Details

visibility: public
final: false
static: false
throws
throws
throws

getEmailListRecipientEntry
jump to class

getEmailListRecipientEntry(
          mixed $location
          )
        
        :
        Zend_Gdata_Gapps_EmailListRecipientEntry

Retreive a single EmailListRecipientEntry object.

Arguments

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

Output

Zend_Gdata_Gapps_EmailListRecipientEntry

Details

visibility: public
final: false
static: false
throws
throws
throws

getEmailListRecipientFeed
jump to class

getEmailListRecipientFeed(
          mixed $location
          )
        
        :
        Zend_Gdata_Gapps_EmailListRecipientFeed

Retreive EmailListRecipientFeed object containing multiple EmailListRecipientEntry objects.

Arguments

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

Output

Zend_Gdata_Gapps_EmailListRecipientFeed

Details

visibility: public
final: false
static: false
throws
throws
throws

getGroupEntry
jump to class

getGroupEntry(
          mixed $location
              =
              null
          )
        
        :
        Zend_Gdata_Gapps_GroupEntry

Retreive a single GroupEntry object.

Arguments

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

Output

Zend_Gdata_Gapps_GroupEntry

Details

visibility: public
final: false
static: false
throws
throws
throws

getGroupFeed
jump to class

getGroupFeed(
          mixed $location
              =
              null
          )
        
        :
        Zend_Gdata_Gapps_GroupFeed

Retreive GroupFeed object containing multiple GroupEntry objects.

Arguments

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

Output

Zend_Gdata_Gapps_GroupFeed

Details

visibility: public
final: false
static: false
throws
throws
throws

getMemberEntry
jump to class

getMemberEntry(
          mixed $location
              =
              null
          )
        
        :
        Zend_Gdata_Gapps_MemberEntry

Retreive a single MemberEntry object.

Arguments

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

Output

Zend_Gdata_Gapps_MemberEntry

Details

visibility: public
final: false
static: false
throws
throws
throws

getMemberFeed
jump to class

getMemberFeed(
          mixed $location
              =
              null
          )
        
        :
        Zend_Gdata_Gapps_MemberFeed

Retreive MemberFeed object containing multiple MemberEntry objects.

Arguments

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

Output

Zend_Gdata_Gapps_MemberFeed

Details

visibility: public
final: false
static: false
throws
throws
throws

getNicknameEntry
jump to class

getNicknameEntry(
          mixed $location
          )
        
        :
        Zend_Gdata_Gapps_NicknameEntry

Retreive a single NicknameEntry object.

Arguments

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

Output

Zend_Gdata_Gapps_NicknameEntry

Details

visibility: public
final: false
static: false
throws
throws
throws

getNicknameFeed
jump to class

getNicknameFeed(
          mixed $location
              =
              null
          )
        
        :
        Zend_Gdata_Gapps_NicknameFeed

Retreive NicknameFeed object containing multiple NicknameEntry objects.

Arguments

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

Output

Zend_Gdata_Gapps_NicknameFeed

Details

visibility: public
final: false
static: false
throws
throws
throws

getOwnerEntry
jump to class

getOwnerEntry(
          mixed $location
              =
              null
          )
        
        :
        Zend_Gdata_Gapps_OwnerEntry

Retreive a single OwnerEntry object.

Arguments

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

Output

Zend_Gdata_Gapps_OwnerEntry

Details

visibility: public
final: false
static: false
throws
throws
throws

getOwnerFeed
jump to class

getOwnerFeed(
          mixed $location
              =
              null
          )
        
        :
        Zend_Gdata_Gapps_OwnerFeed

Retreive OwnerFeed object containing multiple OwnerEntry objects.

Arguments

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

Output

Zend_Gdata_Gapps_OwnerFeed

Details

visibility: public
final: false
static: false
throws
throws
throws

getUserEntry
jump to class

getUserEntry(
          mixed $location
          )
        
        :
        Zend_Gdata_Gapps_UserEntry

Retreive a single UserEntry object.

Arguments

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

Output

Zend_Gdata_Gapps_UserEntry

Details

visibility: public
final: false
static: false
throws
throws
throws

getUserFeed
jump to class

getUserFeed(
          mixed $location
              =
              null
          )
        
        :
        Zend_Gdata_Gapps_UserFeed

Retrieve a UserFeed containing multiple UserEntry objects.

Arguments

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

Output

Zend_Gdata_Gapps_UserFeed

Details

visibility: public
final: false
static: false
throws
throws
throws

import
jump to class

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

Imports a feed located at $uri.

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

Arguments

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

Output

Zend_Gdata_App_Feed

Details

visibility: public
final: false
static: true
throws
throws
throws

insertEmailList
jump to class

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

Create a new email list from an EmailListEntry.

Arguments

$emailList: Zend_Gdata_Gapps_EmailListEntry
The email list entry to insert.
$uri: string
(optional) The URI where the email list should be uploaded to. If null, the default email list creation URI for this domain will be used.

Output

Zend_Gdata_Gapps_EmailListEntry: The inserted email list entry as returned by the server.

Details

visibility: public
final: false
static: false
throws
throws
throws

insertEmailListRecipient
jump to class

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

Create a new email list recipient from an EmailListRecipientEntry.

Arguments

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

Output

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

Details

visibility: public
final: false
static: false
throws
throws
throws

insertGroup
jump to class

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

Create a new group from a GroupEntry.

Arguments

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

Output

Zend_Gdata_Gapps_GroupEntry: The inserted group entry as returned by the server.

Details

visibility: public
final: false
static: false
throws
throws
throws

insertMember
jump to class

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

Create a new member from a MemberEntry.

Arguments

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

Output

Zend_Gdata_Gapps_MemberEntry: The inserted member entry as returned by the server.

Details

visibility: public
final: false
static: false
throws
throws
throws

insertNickname
jump to class

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

Create a new nickname from a NicknameEntry.

Arguments

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

Output

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

Details

visibility: public
final: false
static: false
throws
throws
throws

insertOwner
jump to class

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

Create a new group from a OwnerEntry.

Arguments

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

Output

Zend_Gdata_Gapps_OwnerEntry: The inserted owner entry as returned by the server.

Details

visibility: public
final: false
static: false
throws
throws
throws

insertUser
jump to class

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

Create a new user from a UserEntry.

Arguments

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

Output

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

Details

visibility: public
final: false
static: false
throws
throws
throws

post
jump to class

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

POST data with client object.

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

Arguments

$data: mixed
The Zend_Gdata_App_Entry or XML to post
$uri: string
(optional) POST URI
$remainingRedirects: integer
(optional)
$contentType: string
Content-type of the data
$extraHeaders

Output

Zend_Http_Response

Details

visibility: public
final: false
static: false
throws
throws
throws

put
jump to class

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

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

Arguments

$data: mixed
The Zend_Gdata_App_Entry or XML to post
$uri: string
(optional) PUT URI
$remainingRedirects: integer
(optional)
$contentType: string
Content-type of the data
$extraHeaders

Output

Zend_Http_Response

Details

visibility: public
final: false
static: false
throws
throws
throws

setDomain
jump to class

setDomain(
          string $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.

Arguments

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

Details

visibility: public
final: false
static: false

throwServiceExceptionIfDetected
jump to class

throwServiceExceptionIfDetected(
          Zend_Gdata_Exception $e
          )
        
        :

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.

Arguments

$e: Zend_Gdata_Exception
The exception to convert.

Details

visibility: public
final: false
static: true
throws
throws

API Documentation

Gdata/Gapps.php

Description

Functions

addMemberToGroupjump to top

Arguments

Output

addOwnerToGroupjump to top

Arguments

Output

addRecipientToEmailListjump to top

Arguments

Output

Details

createEmailListjump to top

Arguments

Output

Details

createGroupjump to top

Arguments

Output

createNicknamejump to top

Arguments

Output

Details

createUserjump to top

Arguments

Output

Details

deleteEmailListjump to top

Arguments

Details

deleteGroupjump to top

Arguments

deleteNicknamejump to top

Arguments

Details

deleteUserjump to top

Arguments

Details

isMemberjump to top

Arguments

Output

isOwnerjump to top

Arguments

Output

removeMemberFromGroupjump to top

Arguments

removeOwnerFromGroupjump to top

Arguments

removeRecipientFromEmailListjump to top

Arguments

Details

restoreUserjump to top

Arguments

Output

Details

retrieveAllEmailListsjump to top

Output

Details

retrieveAllGroupsjump to top

Output

retrieveAllMembersjump to top

Arguments

Output

retrieveAllNicknamesjump to top

Output

Details

retrieveAllRecipientsjump to top

Arguments

Output

Details

retrieveAllUsersjump to top

Output

Details

retrieveEmailListsjump to top

Arguments

Output

Details

retrieveGroupjump to top

addMemberToGroup
jump to top

addOwnerToGroup
jump to top

addRecipientToEmailList
jump to top

createEmailList
jump to top

createGroup
jump to top

createNickname
jump to top

createUser
jump to top

deleteEmailList
jump to top

deleteGroup
jump to top

deleteNickname
jump to top

deleteUser
jump to top

isMember
jump to top

isOwner
jump to top

removeMemberFromGroup
jump to top

removeOwnerFromGroup
jump to top

removeRecipientFromEmailList
jump to top

restoreUser
jump to top

retrieveAllEmailLists
jump to top

retrieveAllGroups
jump to top

retrieveAllMembers
jump to top

retrieveAllNicknames
jump to top

retrieveAllRecipients
jump to top

retrieveAllUsers
jump to top

retrieveEmailLists
jump to top

retrieveGroup
jump to top

retrieveGroupOwners
jump to top

retrieveGroups
jump to top

retrieveNickname
jump to top

retrieveNicknames
jump to top

retrievePageOfEmailLists
jump to top

retrievePageOfGroups
jump to top

retrievePageOfMembers
jump to top

retrievePageOfNicknames
jump to top

retrievePageOfRecipients
jump to top

retrievePageOfUsers
jump to top

retrieveUser
jump to top

suspendUser
jump to top

updateGroup
jump to top

updateUser
jump to top

Zend_Gdata_Gapps
jump to top

APPS_BASE_FEED_URI
jump to class

AUTH_SERVICE_NAME
jump to class

APPS_USER_PATH
jump to class

APPS_NICKNAME_PATH
jump to class

APPS_GROUP_PATH
jump to class

APPS_EMAIL_LIST_PATH
jump to class

APPS_EMAIL_LIST_RECIPIENT_POSTFIX
jump to class