Um die Domain für die von der Serviceklasse durchgeführten Anfragen zu setzen kann entweder setDomain() aufgerufen oder die Domain bei der Instanzierung der Serviceklasse spezifiziert werden. Zum Beispiel:

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

Das Setzen der Domain für Anfrage die durch die Abfrageklasse durchgeführt werden ist ähnlich dem setzen für die Serviceklasse-entweder wird setDomain() aufgerufen, oder die Domain wird bei der Erstellung der Abfrage angegeben. Zum Beispiel:

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

Wenn eine Serviceklassen Factorymethode verwendet wird um eine Abfrage zu erstellen, setzt die Serviceklasse die Domain der Abfrage automatisch so das Sie ihrer eigenen Domain entspricht. Als Ergebnis ist es nicht notwendig die Domain als Teil der Konstruktorargumente zu spezifizieren.

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

Benutzerzugänge können durch den Aufruf der einfachen createUser() Methode erstellt werden:

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

Benutzer können durch das Instanzieren eines UserEntry erstellt werden, indem ein Benutzername, ein Name, ein Familienname und ein Passwort angegeben werden und anschließend insertUser() am Serviceobjekt aufgerufen wird um den Eintrag zum Server zu laden.

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

Das Passwort den Benutzers sollte normalerweise als Klartext angegeben werden. Operional kann das Passwort als SHA-1 Schlüssel angegeben werden wenn login->passwordHashFunction auf 'SHA-1' gesetzt ist.

Individuelle Benutzerzugänge kann man erhalten indem die einfache retrieveUser() Methode aufgerufen wird. Wenn der Benutzer nicht gefunden wird, wird NULL zurückgegeben.

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

echo 'Benutzername: ' . $user->login->userName . "\n";
echo 'Name: ' . $user->name->givenName . "\n";
echo 'Familienname: ' . $user->name->familyName . "\n";
echo 'Unterbrochen: ' . ($user->login->suspended ? 'Ja' : 'Nein') . "\n";
echo 'Administrator: ' . ($user->login->admin ? 'Ja' : 'Nein') . "\n"
echo 'Muss das Passwort ändern: ' .
     ($user->login->changePasswordAtNextLogin ? 'Ja' : 'Nein') . "\n";
echo 'Hat den Regeln zugestimmt: ' .
     ($user->login->agreedToTerms ? 'Ja' : 'Nein') . "\n";

Benutzer kann man auch erhalten indem eine Instanz von Zend_Gdata_Gapps_UserQuery erstellt wird, und dessen username Eigenschaft dem Benutzernamen des Benutzers entspricht den man erhalten will und getUserEntry() auf einem Serviceobjekt mit dieser Abfrage aufruft.

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

echo 'Benutzername: ' . $user->login->userName . "\n";
echo 'Name: ' . $user->login->givenName . "\n";
echo 'Familien Name: ' . $user->login->familyName . "\n";
echo 'Unterbrochen: ' . ($user->login->suspended ? 'Ja' : 'Nein') . "\n";
echo 'Administrator: ' . ($user->login->admin ? 'Ja' : 'Nein') . "\n"
echo 'Muss das Passwort ändern: ' .
     ($user->login->changePasswordAtNextLogin ? 'Ja' : 'Nein') . "\n";
echo 'Hat den Regeln zugestimmt: ' .
     ($user->login->agreedToTerms ? 'Ja' : 'Nein') . "\n";

Wenn der spezifizierte Benutzer nicht gefunden werden kann wird eine ServiceException mit einem Fehlercode von Zend_Gdata_Gapps_Error::ENTITY_DOES_NOT_EXIST geworfen. ServiceExceptions werden in dem Kapitel über Exceptions behandelt.

Um alle Benutzer in einer Domäne zu erhalten kann die einfache retrieveAllUsers() Methode aufgerufen werden.

$feed = $gdata->retrieveAllUsers();

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

Das wird ein Zend_Gdata_Gapps_UserFeed Objekt erstellen welches jeden Benutzer dieser Domain enthält.

Alternativ kann getUserFeed() ohne Optionen aufgerufen werden. Es ist zu beachten das dieser Feed bei größeren Domains durch den Server in Seiten ausgegeben werden kann. Über weitere Informationen der Ausgabe in Seiten siehe das Kapitel über Seiten.

$feed = $gdata->getUserFeed();

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

Der einfachste Weg um einen Benutzerzugang zu aktualisieren ist es den Benutzer wie in der vorherigen Sektion beschrieben zu empfangen, jegliche gewünschte Änderungen durchzuführen und anschließend save() auf diesem Benutzer aufzurufen. Jede gemachte Änderung wird an den Server weitergegeben.

$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();

Einen Benutzerzugang zu löschen zu dem man bereits ein UserEntry hat, ist so einfach wie der Aufruf von delete() auf diesem Eintrag.

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

Wenn man keinen Zugriff auf ein UserEntry Objekt für einen Zugang hat, kann die einfache deleteUser() Methode verwendet werden.

$gdata->deleteUser('foo');

Spitznamen können durch den Aufruf der einfachen createNickname() Methode erstellt werden:

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

Spitznamen können auch durch das instanzieren eines NichnameEntry erstellt werden, wobei der Spitzname mit einem Namen und einem Eigentümer ausgestattet wird, und dann insertNickname() auf einem Service Objekt aufgerufen wird, um den Eintrag zu einem Server hochzuladen.

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

Spitznamen können durch den Aufruf der bequemen retrieveNickname() Methode empfangen werden. Sie gibt NULL zurück wenn der Benutzer nicht gefunden wurde.

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

echo 'Spitzname: ' . $nickname->nickname->name . "\n";
echo 'Eigentümer: ' . $nickname->login->username . "\n";

Individuelle Spitznamen können durch Erstellung einer Zend_Gdata_Gapps_NicknameQuery Instanz erhalten werden, indem dessen nickname Eigenschaft dem Spitznamen gleichgesetzt wird der empfangen werden soll, und getNicknameEntry() auf einem Server Objekt mit dieser Abfrage aufgerufen wird.

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

echo 'Spitzname: ' . $nickname->nickname->name . "\n";
echo 'Eigentümer: ' . $nickname->login->username . "\n";

Genau wie bei den Benutzern wird eine ServiceException geworfen wenn kein entsprechender Spitzname gefunden wurde und ein Fehlercode von Zend_Gdata_Gapps_Error::ENTITY_DOES_NOT_EXIST zurückgegeben. Auch das wird in dem Kapitel über Exceptions beschrieben.

Um alle Spitznamen zu erhalten die einem angegebenen Benutzer assoziiert sind, kann die bequeme retrieveNicknames() Methode aufgerufen werden.

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

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

Das erzeugt ein Zend_Gdata_Gapps_NicknameFeed Objekt welches jeden mit dem spezifizierten Benutzer assoziierten Spitznamen enthält.

Alternativ setzt das Erstellen einer neuen Zend_Gdata_Gapps_NicknameQuery dessen username Eigenschaft auf den gewünschten Benutzer, und überträgt die Abfrage durch den Aufruf von getNicknameFeed() auf dem Service Objekt.

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

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

Um alle Spitznamen in einerm Feed zu empfangen, muß einfach die bequeme Methode retrieveAllNicknames() aufgerufen werden.

$feed = $gdata->retrieveAllNicknames();

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

Das wird ein Zend_Gdata_Gapps_NicknameFeed Objekt erstellen welches jeden Spitznamen in der Domain enthält.

Alternativ kann getNicknameFeed() auf einem Service Objekt ohne Argumente aufgerufen werden.

$feed = $gdata->getNicknameFeed();

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

Um einen Spitznamen zu löschen zu dem man bereits einen NicknameEntry hält muß einfach nur delete() auf diesem Eintrag aufgerufen werden.

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

Für Spitznamen zu denen man keinen NicknameEntry hält, kann die bequeme deleteNickname() Methode verwendet werden.

$gdata->deleteNickname('bar');

Gruppen können erstellt werden indem die bequeme Methode createGroup() aufgerufen wird:

$gdata->createGroup('friends', 'Freundeskreis');

Gruppen können erstellt werden indem GroupEntry instanziert wird, eine Gruppen ID und ein Name für die Gruppe angegeben wird, und dann insertGroup() auf dem Service Objekt aufgerufen wird um den Eintrag zum Server hochzuladen.

$group = $gdata->newGroupEntry();

$properties[0] = $this->newProperty();
$properties[0]->name = 'groupId';
$properties[0]->value = 'friends';
$properties[1] = $this->newProperty();
$properties[1]->name = 'groupName';
$properties[1]->value = 'Freundeskreis';

$group->property = $properties;

$group = $gdata->insertGroup($group);

Um eine individuelle Gruppe zu erhalten, muss die bequeme Methode retrieveGroup() aufgerufen werden:

$entry = $gdata->retrieveGroup('friends');

foreach ($entry->property as $p) {
    echo "Name der Eigenschaft: " . $p->name;
    echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
}

Das erstellt ein Zend_Gdata_Gapps_GroupEntry Objekt welches die Eigenschaften der Gruppe enthält.

Alternativ kann ein neuer Zend_Gdata_Gapps_GroupQuery erstellt, seine groupId Eigenschaft auf die gewünschte Gruppen Id gesetzt werden, und die Abfrage übermittelt werden indem getGroupEntry() auf dem Service Objekt aufgerufen wird.

$query = $gdata->newGroupQuery();
$query->setGroupId('friends');
$entry = $gdata->getGroupEntry($query);

foreach ($entry->property as $p) {
    echo "Name der Eigenschaft: " . $p->name;
    echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
}

Um alle Gruppen in einer Domäne zu erhalten muss die bequeme Methode retrieveAllGroups() aufgerufen werden.

$feed = $gdata->retrieveAllGroups();

foreach ($feed->entry as $entry) {
    foreach ($entry->property as $p) {
        echo "Name der Eigenschaft: " . $p->name;
        echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
    }
    echo "\n\n";
}

Dies erstellt ein Zend_Gdata_Gapps_GroupFeed Objekt welches jede Gruppe der Domain enthält.

Alternativ kann getGroupFeed() auf einem Service Objekt ohne Argumente aufgerufen werden.

$feed = $gdata->getGroupFeed();

foreach ($feed->entry as $entry) {
    foreach ($entry->property as $p) {
        echo "Name der Eigenschaft: " . $p->name;
        echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
    }
    echo "\n\n";
}

Um eine Gruppe zu löschen kann die bequeme Methode deleteGroup() aufgerufen werden:

$gdata->deleteGroup('friends');

Gruppen können aktualisiert werden indem die bequeme Methode updateGroup() aufgerufen wird:

$gdata->updateGroup('group-id-here', 'Name der Gruppe hier');

Der erste Parameter wird benötigt. Der zweite, dritte und vierte Parameter welche den Namen der Gruppe, die Beschreibung der Gruppe und die Email Erlaubnis repräsentieren, sind alle Optional. Wenn eine dieser optionalen Parameter auf null gesetzt wird, dann wird dieses Element nicht aktualisiert.

Um alle Gruppen zu erhalten bei denen eine Spezielle Person Mitglied ist, kann die bequeme Methode retrieveGroups() aufgerufen werden:

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

foreach ($feed->entry as $entry) {
    foreach ($entry->property as $p) {
        echo "Name der Eigenschaft: " . $p->name;
        echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
    }
    echo "\n\n";
}

Dies erstellt ein Zend_Gdata_Gapps_GroupFeed Objekt welches jede Gruppe enthält die mit dem spezifizierten Mitglied assoziiert ist.

Alternativ kann eine neue Zend_Gdata_Gapps_GroupQuery erstellt werden, die Eigenschaft member auf die gewünschte Email Adresse gesetzt, und die Abfrage durch Aufruf von getGroupFeed() auf dem Service Objekt übermittelt werden.

$query = $gdata->newGroupQuery();
$query->setMember('baz@somewhere.com');
$feed = $gdata->getGroupFeed($query);

foreach ($feed->entry as $entry) {
    foreach ($entry->property as $p) {
        echo "Name der Eigenschaft: " . $p->name;
        echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
    }
    echo "\n\n";
}

Um ein Mitglied zu einer Gruppe hinzuzufügen muss einfach die bequeme Methode addMemberToGroup() aufgerufen werden:

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

Um zu prüfen ob ein Mitglied einer Gruppe angehört, muss einfach die bequeme Methode isMember() aufgerufen werden:

$isMember = $gdata->isMember('bar@somewhere.com', 'friends');
var_dump($isMember);

Die Methode gibt einen Boolschen Wert zurück. Wenn das Mitglied der spezifizierten Gruppe angehört, gibt die Methode ein true zurück, andernfalls gibt Sie ein false zurück.

Um ein Mitglied von einer Gruppe zu entfernen muss die bequeme Methode removeMemberFromGroup() aufgerufen werden:

$gdata->removeMemberFromGroup('baz', 'friends');

Die bequeme Methode retrieveAllMembers() kann verwendet werden um die Liste der Mitglieder einer Gruppe zu erhalten:

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

foreach ($feed as $member) {
    foreach ($member->property as $p) {
        echo "Name der Eigenschaft: " . $p->name;
        echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
    }
}

Alternativ kann ein neuer MemberQuery erstellt, dessen Eigenschaft groupId auf die passende und gewünschte Gruppen Id gesetzt und getMemberFeed() auf einem Service Objekt aufgerufen werden.

$query = $gdata->newMemberQuery();
$query->setGroupId('friends');
$feed = $gdata->getMemberFeed($query);

foreach ($feed as $member) {
    foreach ($member->property as $p) {
        echo "Name der Eigenschaft: " . $p->name;
        echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
    }
}

Das erstellt ein Zend_Gdata_Gapps_MemberFeed Objekt welches jedes Mitglied der ausgewählten Gruppe enthält.

Um einer Gruppe einen Eigentümer hinzuzufügen muss einfach die bequeme Methode addOwnerToGroup() aufgerufen werden:

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

Die bequeme Methode retrieveGroupOwners() kann verwendet werden um die Liste der Eigentümer einer Gruppe zu erhalten:

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

foreach ($feed as $owner) {
    foreach ($owner->property as $p) {
        echo "Name der Eigenschaft: " . $p->name;
        echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
    }
}

Alternativ kann ein neuer OwnerQuery erstellt, seine Eigenschaft groupId auf die passende und gewünschte Gruppen Id gesetzt und getOwnerFeed() auf einem Service Objekt aufgerufen werden.

$query = $gdata->newOwnerQuery();
$query->setGroupId('friends');
$feed = $gdata->getOwnerFeed($query);

foreach ($feed as $owner) {
    foreach ($owner->property as $p) {
        echo "Name der Eigenschaft: " . $p->name;
        echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
    }
}

Das erstelle ein Zend_Gdata_Gapps_OwnerFeed Objekt welches jedes Mitglied der ausgewählten Gruppe enthält.

Um zu prüfen ob ein Email der Eigentümer einer Gruppe ist, kann einfach die bequeme Methode isOwner() aufgerufen werden:

$isOwner = $gdata->isOwner('bar@somewhere.com', 'friends');
var_dump($isOwner);

Die Methode gibt einen boolschen Wert zurück. Wenn die Email der Eigentümer der spezifizierten Gruppe ist, gibt die Methode true zurück, andernfalls gibt sie false zurück.

Um einen Eigentümer von einer Gruppe zu entfernen kann die bequeme Methode removeOwnerFromGroup() aufgerufen werden:

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

Email Listen können durch den Aufruf der bequemen createEmailList() Methode erstellt werden:

$gdata->createEmailList('friends');

Email Listen können auch durch die Instanzierung von EmailListEntry erstellt werden, indem ein Name für die Liste angegeben wird, und anschließend insertEmailList() auf dem Service Objekt aufgerufen wird um den Eintrag zum Server hochzuladen.

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

Um alle Email Lsiten zu denen ein spezieller Empfänger eingeschrieben ist zu empfangen, muß die bequeme retrieveEmailLists() Methode aufgerufen werden:

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

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

Das erstellt ein Zend_Gdata_Gapps_EmailListFeed Objekt welches jede Email Liste enthält die mit dem speziellen Empfänger assoziiert ist.

Alternativ kann ein neues Zend_Gdata_Gapps_EmailListQuery erstellt werden, dessen recipient Eigenschaft auf die gewünschte Email Adresse gesetzt werden, und die Abfrage durch den Aufruf von getEmailListFeed() auf dem Service Objekt übermittelt werden.

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

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

Um alle Email Listen in einer Domain zu erhalten, muß die bequeme retrieveAllEmailLists() Methode aufgerufen werden.

$feed = $gdata->retrieveAllEmailLists();

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

Das erzeugt ein Zend_Gdata_Gapps_EmailListFeed Objekt welches jede Email Liste der Domain enthält.

Alternativ kann getEmailListFeed() auf dem Service Objekt ohne Argumente aufgerufen werden.

$feed = $gdata->getEmailListFeed();

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

Um eine Email Liste zu löschen, muß die bequeme deleteEmailList() Methode aufgerufen werden:

$gdata->deleteEmailList('friends');

Um einen Empfänger zu einer Email Liste hinzuzufügen, muß einfach die bequeme addRecipientToEmailList() Methode aufgerufen werden:

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

Die bequeme retrieveAllRecipients() Methode kann verwendet werden um die Liste der Empfänger einer Email Liste zu erhalten:

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

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

Alternativ kann ein neuer EmailListRecipientQuery erstellt werdne, dessen emailListName Eigenschaft auf die gewünschte Email Liste gesetzt werden, und getEmailListRecipientFeed() auf dem Service Objekt aufgerufen werden.

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

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

Das Erstellt ein Zend_Gdata_Gapps_EmailListRecipientFeed Objekt welche jeden Empfänger für die ausgewählte Email Liste enthält.

Um einen Empfänger von einer Email Liste zu entfernen, muß die bequeme removeRecipientFromEmailList() Methode aufgerufen werden:

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