18.7. Using Google Apps Provisioning

To set the domain for requests made by the service class, either call setDomain() or specify the domain when instantiating the service class. For example:

$domain = "example.com";
$gdata = new Zend_Gdata_Gapps($client, $domain);

            

Setting the domain for requests made by query classes is similar to setting it for the service class-either call setDomain() or specify the domain when creating the query. For example:

$domain = "example.com";
$query = new Zend_Gdata_Gapps_UserQuery($domain, $arg);

            

When using a service class factory method to create a query, the service class will automatically set the query's domain to match its own domain. As a result, it is not necessary to specify the domain as part of the constructor arguments.

$domain = "example.com";
$gdata = new Zend_Gdata_Gapps($client, $domain);
$query = $gdata->newUserQuery($arg);

            

User accounts can be created by calling the createUser() convenience method:

$gdata->createUser('foo', 'Random', 'User', '••••••••');

            

Users can also be created by instantiating UserEntry, providing a username, given name, family name, and password, then calling insertUser() on a service object to upload the entry to the server.

$user = $gdata->newUserEntry();
$user->login = $gdata->newLogin();
$user->login->username = 'foo';
$user->login->password = '••••••••';
$user->name = $gdata->newName();
$user->name->givenName = 'Random';
$user->name->familyName = 'User';
$user = $gdata->insertUser($user);

            

The user's password should normally be provided as cleartext. Optionally, the password can be provided as an SHA-1 digest if login->passwordHashFunction is set to 'SHA-1'.

Individual user accounts can be retrieved by calling the retrieveUser() convenience method. If the user is not found, null will be returned.

$user = $gdata->retrieveUser('foo');

echo 'Username: ' . $user->login->userName . "\n";
echo 'Given Name: ' . $user->login->givenName . "\n";
echo 'Family Name: ' . $user->login->familyName . "\n";
echo 'Suspended: ' . ($user->login->suspended ? 'Yes' : 'No') . "\n";
echo 'Admin: ' . ($user->login->admin ? 'Yes' : 'No') . "\n"
echo 'Must Change Password: ' .
     ($user->login->changePasswordAtNextLogin ? 'Yes' : 'No') . "\n";
echo 'Has Agreed To Terms: ' .
     ($user->login->agreedToTerms ? 'Yes' : 'No') . "\n";

            

Users can also be retrieved by creating an instance of Zend_Gdata_Gapps_UserQuery, setting its username property to equal the username of the user that is to be retrieved, and calling getUserEntry() on a service object with that query.

$query = $gdata->newUserQuery('foo');
$user = $gdata->getUserEntry($query);

echo 'Username: ' . $user->login->userName . "\n";
echo 'Given Name: ' . $user->login->givenName . "\n";
echo 'Family Name: ' . $user->login->familyName . "\n";
echo 'Suspended: ' . ($user->login->suspended ? 'Yes' : 'No') . "\n";
echo 'Admin: ' . ($user->login->admin ? 'Yes' : 'No') . "\n"
echo 'Must Change Password: ' .
     ($user->login->changePasswordAtNextLogin ? 'Yes' : 'No') . "\n";
echo 'Has Agreed To Terms: ' .
     ($user->login->agreedToTerms ? 'Yes' : 'No') . "\n";

            

If the specified user cannot be located a ServiceException will be thrown with an error code of Zend_Gdata_Gapps_Error::ENTITY_DOES_NOT_EXIST. ServiceExceptions will be covered in 第 18.7.6 节 “Handling errors”.

To retrieve all users in a domain, call the retrieveAllUsers() convenience method.

$feed = $gdata->retrieveAllUsers();

foreach ($feed as $user) {
    echo "  * " . $user->login->username . ' (' . $user->name->givenName .
        ' ' . $user->name->familyName . ")\n";
}

            

This will create a Zend_Gdata_Gapps_UserFeed object which holds each user on the domain.

Alternatively, call getUserFeed() with no options. Keep in mind that on larger domains this feed may be paged by the server. For more information on paging, see 第 18.1.9 节 “Working with multi-page feeds”.

$feed = $gdata->getUserFeed();

foreach ($feed as $user) {
    echo "  * " . $user->login->username . ' (' . $user->name->givenName .
        ' ' . $user->name->familyName . ")\n";
}

            

The easiest way to update a user account is to retrieve the user as described in the previous sections, make any desired changes, then call save() on that user. Any changes made will be propagated to the server.

$user = $gdata->retrieveUser('foo');
$user->name->givenName = 'Foo';
$user->name->familyName = 'Bar';
$user = $user->save();

            

$user = $gdata->retrieveUser('foo');
$user->login->password = '••••••••';
$user = $user->save();

                

$user = $gdata->retrieveUser('foo');
$user->login->changePasswordAtNextLogin = true;
$user = $user->save();

                

$gdata->suspendUser('foo');
$gdata->restoreUser('foo');

                

$user = $gdata->retrieveUser('foo');
$user->login->suspended = true;
$user = $user->save();

                

$user = $gdata->retrieveUser('foo');
$user->login->admin = true;
$user = $user->save();

                

Deleting a user account to which you already hold a UserEntry is a simple as calling delete() on that entry.

$user = $gdata->retrieveUser('foo');
$user->delete();

            

If you do not have access to a UserEntry object for an account, use the deleteUser() convenience method.

$gdata->deleteUser('foo');

            

Nicknames can be created by calling the createNickname() convenience method:

$gdata->createNickname('foo', 'bar');

            

Nicknames can also be created by instantiating NicknameEntry, providing the nickname with a name and an owner, then calling insertNickname() on a service object to upload the entry to the server.

$nickname = $gdata->newNicknameEntry();
$nickname->login = $gdata->newLogin('foo');
$nickname->nickname = $gdata->newNickname('bar');
$nickname = $gdata->insertNickname($nickname);

            

Nicknames can be retrieved by calling the retrieveNickname() convenience method. This will return null if a user is not found.

$nickname = $gdata->retrieveNickname('bar');

echo 'Nickname: ' . $nickname->nickname->name . "\n";
echo 'Owner: ' . $nickname->login->username . "\n";

            

Individual nicknames can also be retrieved by creating an instance of Zend_Gdata_Gapps_NicknameQuery, setting its nickname property to equal the nickname that is to be retrieved, and calling getNicknameEntry() on a service object with that query.

$query = $gdata->newNicknameQuery('bar');
$nickname = $gdata->getNicknameEntry($query);

echo 'Nickname: ' . $nickname->nickname->name . "\n";
echo 'Owner: ' . $nickname->login->username . "\n";

            

As with users, if no corresponding nickname is found a ServiceException will be thrown with an error code of Zend_Gdata_Gapps_Error::ENTITY_DOES_NOT_EXIST. Again, these will be discussed in 第 18.7.6 节 “Handling errors”.

To retrieve all nicknames associated with a given user, call the convenience method retrieveNicknames().

$feed = $gdata->retrieveNicknames('foo');

foreach ($feed as $nickname) {
    echo '  * ' . $nickname->nickname->name . "\n";
}

            

This will create a Zend_Gdata_Gapps_NicknameFeed object which holds each nickname associated with the specified user.

Alternatively, create a new Zend_Gdata_Gapps_NicknameQuery, set its username property to the desired user, and submit the query by calling getNicknameFeed() on a service object.

$query = $gdata->newNicknameQuery();
$query->setUsername('foo');
$feed = $gdata->getNicknameFeed($query);

foreach ($feed as $nickname) {
    echo '  * ' . $nickname->nickname->name . "\n";
}

            

To retrieve all nicknames in a feed, simply call the convenience method retrieveAllNicknames()

$feed = $gdata->retrieveAllNicknames();

foreach ($feed as $nickname) {
    echo '  * ' . $nickname->nickname->name . ' => ' . 
        $nickname->login->username . "\n";
}

            

This will create a Zend_Gdata_Gapps_NicknameFeed object which holds each nickname on the domain.

Alternatively, call getNicknameFeed() on a service object with no arguments.

$feed = $gdata->getNicknameFeed();

foreach ($feed as $nickname) {
    echo '  * ' . $nickname->nickname->name . ' => ' . 
        $nickname->login->username . "\n";
}

            

Deleting a nickname to which you already hold a NicknameEntry for is a simple as calling delete() on that entry.

$nickname = $gdata->retrieveNickname('bar');
$nickname->delete();

            

For nicknames which you do not hold a NicknameEntry for, use the deleteNickname() convenience method.

$gdata->deleteNickname('bar');

            

Email lists can be created by calling the createEmailList() convenience method:

$gdata->createEmailList('friends');

            

Email lists can also be created by instantiating EmailListEntry, providing a name for the list, then calling insertEmailList() on a service object to upload the entry to the server.

$list = $gdata->newEmailListEntry();
$list->emailList = $gdata->newEmailList('friends');
$list = $gdata->insertEmailList($list);

            

To retrieve all email lists to which a particular recipient is subscribed, call the retrieveEmailLists() convenience method:

$feed = $gdata->retrieveEmailLists('baz@somewhere.com');

foreach ($feed as $list) {
    echo '  * ' . $list->emailList->name . "\n";
}

            

This will create a Zend_Gdata_Gapps_EmailListFeed object which holds each email list associated with the specified recipient.

Alternatively, create a new Zend_Gdata_Gapps_EmailListQuery, set its recipient property to the desired email address, and submit the query by calling getEmailListFeed() on a service object.

$query = $gdata->newEmailListQuery();
$query->setRecipient('baz@somewhere.com');
$feed = $gdata->getEmailListFeed($query);

foreach ($feed as $list) {
    echo '  * ' . $list->emailList->name . "\n";
}

            

To retrieve all email lists in a domain, call the convenience method retrieveAllEmailLists().

$feed = $gdata->retrieveAllEmailLists();

foreach ($feed as $list) {
    echo '  * ' . $list->emailList->name . "\n";
}

            

This will create a Zend_Gdata_Gapps_EmailListFeed object which holds each email list on the domain.

Alternatively, call getEmailListFeed() on a service object with no arguments.

$feed = $gdata->getEmailListFeed();

foreach ($feed as $list) {
    echo '  * ' . $list->emailList->name . "\n";
}

            

To delete an email list, call the deleteEmailList() convenience method:

$gdata->deleteEmailList('friends');

            

To add a recipient to an email list, simply call the addRecipientToEmailList() convenience method:

$gdata->addRecipientToEmailList('bar@somewhere.com', 'friends');

            

The convenience method retrieveAllRecipients() can be used to retrieve the list of subscribers to an email list:

$feed = $gdata->retrieveAllRecipients('friends');

foreach ($feed as $recipient) {
    echo '  * ' . $recipient->who->email . "\n";
}

            

Alternatively, construct a new EmailListRecipientQuery, set its emailListName property to match the desired email list, and call getEmailListRecipientFeed() on a service object.

$query = $gdata->newEmailListRecipientQuery();
$query->setEmailListName('friends');
$feed = $gdata->getEmailListRecipientFeed($query);

foreach ($feed as $recipient) {
    echo '  * ' . $recipient->who->email . "\n";
}

            

This will create a Zend_Gdata_Gapps_EmailListRecipientFeed object which holds each recipient for the selected email list.

To remove a recipient from an email list, call the removeRecipientFromEmailList() convenience method:

$gdata->removeRecipientFromEmailList('baz@somewhere.com', 'friends');