Documentation

Google Apps Provisionierung verwenden - Zend_Gdata

Google Apps Provisionierung verwenden

Google Apps ist ein Service der es Domain Administratoren erlaubt Ihren Benutzern einen gemanagten Zugriff auf Google Services wie Mail, Kalender und Dokumente & Tabellenkalkulationen zu bieten. Die Provisionierungs API bietet ein programmmäßiges Interface um dieses Service zu konfigurieren. Im speziellen erlaubt es diese API den Administratoren Benutzerzugänge, Nicknamen, Gruppen und Email Listen zu erstellen, zu empfangen, zu verändern und zu löschen.

Diese Bibliothek implementiert die Version 2.0 der Provisionierungs API. Zugriff zum eigenen Konto über die Provisionierungs API muß manuell für jede Domain aktiviert werden die das Google Apps Kontrollpanel verwendet. Nur bestimmte Kontotpen sind fähig dieses Feature einzuschalten.

Für weitere Information zur Google Apps Provisionierungs API, inklusive Anleitungen für das Einschalten des API Zugriffs, kann in die » Provisionierungs API V2.0 Referenz gesehen werden.

Note: Authentifizierung
Die Provisionierungs API unterstützt keine Authentifizierung über AuthSub und anonymer Zugriff ist nicht gestattet. Alle HTTP Verbindungen müssen mit Hilfe der ClientAuth Authentifizierung authentifiziert werden.

Die aktuelle Domain setzen

Um die Provisionierungs API zu verwenden muß die Domain, die administriert werden soll, in allen Anfrage URIs spezifiziert werden. Um die Entwicklung zu vereinfachen, wird diese Information sowohl im Gapps Service und den Abfrageklassen gespeichert um Sie zu verwenden wenn Abfragen erstellt werden.

Setzen der Domain für die Serviceklasse

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:

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

Die Domain für die Abfrageklasse setzen

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:

  1. $domain = "example.com";
  2. $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.

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

Interaktion mit Benutzern

Jeder Benutzerzugang zu einer Google Apps gehosteten Domain wird als Instanz von Zend_Gdata_Gapps_UserEntry repräsentiert. Diese Klasse bietet Zugriff zu allen Zugangseigenschaften inklusive Name, Benutzername, Passwort, Zugriffsrechte und aktuellen Quoten.

Erstellen eines Benutzerzugangs

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

  1. $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.

  1. $user = $gdata->newUserEntry();
  2. $user->login = $gdata->newLogin();
  3. $user->login->username = 'foo';
  4. $user->login->password = '••••••••';
  5. $user->name = $gdata->newName();
  6. $user->name->givenName = 'Irgendwer';
  7. $user->name->familyName = 'Benutzer';
  8. $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.

Einen Benutzerzugang erhalten

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

  1. $user = $gdata->retrieveUser('foo');
  2.  
  3. echo 'Benutzername: ' . $user->login->userName . "\n";
  4. echo 'Name: ' . $user->name->givenName . "\n";
  5. echo 'Familienname: ' . $user->name->familyName . "\n";
  6. echo 'Unterbrochen: ' . ($user->login->suspended ? 'Ja' : 'Nein') . "\n";
  7. echo 'Administrator: ' . ($user->login->admin ? 'Ja' : 'Nein') . "\n"
  8. echo 'Muss das Passwort ändern: ' .
  9.      ($user->login->changePasswordAtNextLogin ? 'Ja' : 'Nein') . "\n";
  10. echo 'Hat den Regeln zugestimmt: ' .
  11.      ($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.

  1. $query = $gdata->newUserQuery('foo');
  2. $user = $gdata->getUserEntry($query);
  3.  
  4. echo 'Benutzername: ' . $user->login->userName . "\n";
  5. echo 'Name: ' . $user->login->givenName . "\n";
  6. echo 'Familien Name: ' . $user->login->familyName . "\n";
  7. echo 'Unterbrochen: ' . ($user->login->suspended ? 'Ja' : 'Nein') . "\n";
  8. echo 'Administrator: ' . ($user->login->admin ? 'Ja' : 'Nein') . "\n"
  9. echo 'Muss das Passwort ändern: ' .
  10.      ($user->login->changePasswordAtNextLogin ? 'Ja' : 'Nein') . "\n";
  11. echo 'Hat den Regeln zugestimmt: ' .
  12.      ($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.

Alle Benutzer in einer Domain erhalten

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

  1. $feed = $gdata->retrieveAllUsers();
  2.  
  3. foreach ($feed as $user) {
  4.     echo "  * " . $user->login->username . ' (' . $user->name->givenName .
  5.         ' ' . $user->name->familyName . ")\n";
  6. }

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.

  1. $feed = $gdata->getUserFeed();
  2.  
  3. foreach ($feed as $user) {
  4.     echo "  * " . $user->login->username . ' (' . $user->name->givenName .
  5.         ' ' . $user->name->familyName . ")\n";
  6. }

Einen Benutzerzugang aktualisieren

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.

  1. $user = $gdata->retrieveUser('foo');
  2. $user->name->givenName = 'Foo';
  3. $user->name->familyName = 'Bar';
  4. $user = $user->save();

Ein Benutzerpasswort zurücksetzen

Ein Benutzerpasswort kann auf einen neuen Wert zurückgesetzt werden indem die login->password Eigenschaft aktualisiert wird.

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

Es ist zu beachten das es nicht möglich ist ein Passwort auf diesem Weg wiederherzustellen da gespeicherte Passwörter aus Sicherheitsgründern nicht über die Provisionierungs API verfügbar gemacht werden.

Einen Benutzer zwingen sein Passwort zu ändern

Ein Benutzer kann dazu gezwungen werden sein Passwort bei seinem nächsten Login zu ändern, indem die login->changePasswordAtNextLogin Eigenschaft auf TRUE gesetzt wird.

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

Genauso kann das rückgängig gemacht werden indem die login->changePasswordAtNextLogin Eigenschaft auf FALSE gesetzt wird.

Einen Benutzerzugang unterbrechen

Benutzer können daran gehindert werden sich anzumelden ohne das Ihr Benutzerzugang gelöscht wird indem Ihr Benutzerzugang unterbrochen wird. Zugänge können unterbrochen oder wiederhergestellt werden indem die einfachen suspendUser() und restoreUser() Methoden verwendet werden:

  1. $gdata->suspendUser('foo');
  2. $gdata->restoreUser('foo');

Alternativ kann die Eigenschaft login->suspended des Benutzerzugangs auf TRUE gesetzt werden.

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

Um den Benutzerzugang wiederherzustellen muß die login->suspended Eigenschaft auf FALSE gesetzt werden.

Administrative Rechte vergeben

Benutzern kann die Möglichkeit gegeben werden die Domain zu verwalten durch das setzen Ihrer login->admin Eigenschaft auf TRUE.

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

Und wie erwartet, entfernt das Setzen der Eigenschaft login->admin, des Benutzers auf FALSE, dessen administrative Rechte.

Löschen eines Benutzerzugangs

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

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

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

  1. $gdata->deleteUser('foo');

Mit Spitznamen interagieren

Spitznamen arbeiten als Email Aliase für bestehende Benutzer. Jeder Spitzname enthält genau zwei Schlüsseleigenschaften: Seinen Namen und seinen Eigentümer. Jede Email die zu einem Spitznamen adressiert wurde wird zu dem Benutzer weitergeleitet der diesen Spitznamen besitzt.

Spitznamen werden repräsentiert als Instanz von Zend_Gdata_Gapps_NicknameEntry.

Erstellen eines Spitznamens

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

  1. $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.

  1. $nickname = $gdata->newNicknameEntry();
  2. $nickname->login = $gdata->newLogin('foo');
  3. $nickname->nickname = $gdata->newNickname('bar');
  4. $nickname = $gdata->insertNickname($nickname);

Einen Spitznamen empfangen

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

  1. $nickname = $gdata->retrieveNickname('bar');
  2.  
  3. echo 'Spitzname: ' . $nickname->nickname->name . "\n";
  4. 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.

  1. $query = $gdata->newNicknameQuery('bar');
  2. $nickname = $gdata->getNicknameEntry($query);
  3.  
  4. echo 'Spitzname: ' . $nickname->nickname->name . "\n";
  5. 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.

Alle Spitznamen eines Benutzers erhalten

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

  1. $feed = $gdata->retrieveNicknames('foo');
  2.  
  3. foreach ($feed as $nickname) {
  4.     echo '  * ' . $nickname->nickname->name . "\n";
  5. }

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.

  1. $query = $gdata->newNicknameQuery();
  2. $query->setUsername('foo');
  3. $feed = $gdata->getNicknameFeed($query);
  4.  
  5. foreach ($feed as $nickname) {
  6.     echo '  * ' . $nickname->nickname->name . "\n";
  7. }

Empfangen aller Spitznamen in einer Domain

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

  1. $feed = $gdata->retrieveAllNicknames();
  2.  
  3. foreach ($feed as $nickname) {
  4.     echo '  * ' . $nickname->nickname->name . ' => ' .
  5.         $nickname->login->username . "\n";
  6. }

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.

  1. $feed = $gdata->getNicknameFeed();
  2.  
  3. foreach ($feed as $nickname) {
  4.     echo '  * ' . $nickname->nickname->name . ' => ' .
  5.         $nickname->login->username . "\n";
  6. }

Löschen eines Spitznamens

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

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

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

  1. $gdata->deleteNickname('bar');

Mit Gruppen interagieren

Google Gruppen erlauben es Personen Nachrichten zu senden so wie eine Email Liste. Google missbilligt die API der Email Listen. Google Gruppen bieten einige nette Features wie verschachtelte Gruppen und Gruppen Besitzer. Wenn man mit einer neuen Email Liste beginnen will, ist es empfehlenswert statt dessen Google Gruppen zu verwenden. Google's Email Liste ist nicht mit Google Gruppen kompatibel. Wenn man also eine Email Liste erstellt, scheint Sie nicht als Gruppe auf. Das Gegenteil ist natürlich genauso wahr.

Jede Gruppe an einer Domain wird als Instanz von Zend_Gdata_Gapps_GroupEntry repräsentiert.

Erstellen einer Gruppe

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

  1. $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.

  1. $group = $gdata->newGroupEntry();
  2.  
  3. $properties[0] = $this->newProperty();
  4. $properties[0]->name = 'groupId';
  5. $properties[0]->value = 'friends';
  6. $properties[1] = $this->newProperty();
  7. $properties[1]->name = 'groupName';
  8. $properties[1]->value = 'Freundeskreis';
  9.  
  10. $group->property = $properties;
  11.  
  12. $group = $gdata->insertGroup($group);

Eine individuelle Gruppe empfangen

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

  1. $entry = $gdata->retrieveGroup('friends');
  2.  
  3. foreach ($entry->property as $p) {
  4.     echo "Name der Eigenschaft: " . $p->name;
  5.     echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
  6. }

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.

  1. $query = $gdata->newGroupQuery();
  2. $query->setGroupId('friends');
  3. $entry = $gdata->getGroupEntry($query);
  4.  
  5. foreach ($entry->property as $p) {
  6.     echo "Name der Eigenschaft: " . $p->name;
  7.     echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
  8. }

Alle Gruppen einer Domäne empfangen

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

  1. $feed = $gdata->retrieveAllGroups();
  2.  
  3. foreach ($feed->entry as $entry) {
  4.     foreach ($entry->property as $p) {
  5.         echo "Name der Eigenschaft: " . $p->name;
  6.         echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
  7.     }
  8.     echo "\n\n";
  9. }

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.

  1. $feed = $gdata->getGroupFeed();
  2.  
  3. foreach ($feed->entry as $entry) {
  4.     foreach ($entry->property as $p) {
  5.         echo "Name der Eigenschaft: " . $p->name;
  6.         echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
  7.     }
  8.     echo "\n\n";
  9. }

Eine Gruppe löschen

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

  1. $gdata->deleteGroup('friends');

Eine Gruppe aktualisieren

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

  1. $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.

Empfangen aller Gruppen bei denen eine Person Mitglied ist

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

  1. $feed = $gdata->retrieveGroups('baz@somewhere.com');
  2.  
  3. foreach ($feed->entry as $entry) {
  4.     foreach ($entry->property as $p) {
  5.         echo "Name der Eigenschaft: " . $p->name;
  6.         echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
  7.     }
  8.     echo "\n\n";
  9. }

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.

  1. $query = $gdata->newGroupQuery();
  2. $query->setMember('baz@somewhere.com');
  3. $feed = $gdata->getGroupFeed($query);
  4.  
  5. foreach ($feed->entry as $entry) {
  6.     foreach ($entry->property as $p) {
  7.         echo "Name der Eigenschaft: " . $p->name;
  8.         echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
  9.     }
  10.     echo "\n\n";
  11. }

Mit Gruppenmitgliedern interagieren

Jedes Mitglied welches bei einer Gruppe eingeschrieben ist wird durch eine Instanz von Zend_Gdata_Gapps_MemberEntry repräsentiert. Durch diese Klasse können individuelle Empfänger bei Gruppen hinzugefügt und gelöscht werden.

Ein Mitglied zu einer Gruppe hinzufügen

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

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

Prüfen um zu sehen ob ein Mitglied einer Gruppe angehört

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

  1. $isMember = $gdata->isMember('bar@somewhere.com', 'friends');
  2. 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.

Ein Mitglied von einer Gruppe entfernen

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

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

Die Liste der Mitglieder einer Gruppe erhalten

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

  1. $feed = $gdata->retrieveAllMembers('friends');
  2.  
  3. foreach ($feed as $member) {
  4.     foreach ($member->property as $p) {
  5.         echo "Name der Eigenschaft: " . $p->name;
  6.         echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
  7.     }
  8. }

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.

  1. $query = $gdata->newMemberQuery();
  2. $query->setGroupId('friends');
  3. $feed = $gdata->getMemberFeed($query);
  4.  
  5. foreach ($feed as $member) {
  6.     foreach ($member->property as $p) {
  7.         echo "Name der Eigenschaft: " . $p->name;
  8.         echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
  9.     }
  10. }

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

Mit Gruppen Eigentümern interagieren

Jeder Eigentümer der mit einer Gruppe assoziiert ist wird durch eine Instanz von Zend_Gdata_Gapps_OwnerEntry repräsentiert. Durch diese Klasse können individuelle Eigentümer hinzugefügt und von Gruppen entfernt werden.

Einen Eigentümer einer Gruppe hinzufügen

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

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

Die Liste der Eigentümer einer Gruppe erhalten

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

  1. $feed = $gdata->retrieveGroupOwners('friends');
  2.  
  3. foreach ($feed as $owner) {
  4.     foreach ($owner->property as $p) {
  5.         echo "Name der Eigenschaft: " . $p->name;
  6.         echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
  7.     }
  8. }

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.

  1. $query = $gdata->newOwnerQuery();
  2. $query->setGroupId('friends');
  3. $feed = $gdata->getOwnerFeed($query);
  4.  
  5. foreach ($feed as $owner) {
  6.     foreach ($owner->property as $p) {
  7.         echo "Name der Eigenschaft: " . $p->name;
  8.         echo "\nWert der Eigenschaft: " . $p->value . "\n\n";
  9.     }
  10. }

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

Prüfen um zu sehen ob ein Email der Eigentümer einer Gruppe ist

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

  1. $isOwner = $gdata->isOwner('bar@somewhere.com', 'friends');
  2. 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.

Einen Eigentümer von einer Gruppe entfernen

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

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

Mit Email Listen interagieren

Email Listen erlauben verschiedenen Benutzern Emails zu empfangen die zu einer einzelnen Email Adresse adressiert sind. Benutzer müssen keine Teilnehmer dieser Domain sein um sich in eine Email Liste einzuschreiben, wen deren komplette Email Adresse (inklusive Domain) verwendet wird.

Jede Email Liste einer Domain wird als Instanz von Zend_Gdata_Gapps_EmailListEntry repräsentiert.

Erstellen einer Email Liste

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

  1. $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.

  1. $list = $gdata->newEmailListEntry();
  2. $list->emailList = $gdata->newEmailList('friends');
  3. $list = $gdata->insertEmailList($list);

Empfangen aller Email Listen bei denen ein Empfänger eingeschrieben ist

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

  1. $feed = $gdata->retrieveEmailLists('baz@somewhere.com');
  2.  
  3. foreach ($feed as $list) {
  4.     echo '  * ' . $list->emailList->name . "\n";
  5. }

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.

  1. $query = $gdata->newEmailListQuery();
  2. $query->setRecipient('baz@somewhere.com');
  3. $feed = $gdata->getEmailListFeed($query);
  4.  
  5. foreach ($feed as $list) {
  6.     echo '  * ' . $list->emailList->name . "\n";
  7. }

Empfangen aller Email Listen in einer Domain

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

  1. $feed = $gdata->retrieveAllEmailLists();
  2.  
  3. foreach ($feed as $list) {
  4.     echo '  * ' . $list->emailList->name . "\n";
  5. }

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.

  1. $feed = $gdata->getEmailListFeed();
  2.  
  3. foreach ($feed as $list) {
  4.     echo '  * ' . $list->emailList->name . "\n";
  5. }

Löschen einer Email Liste

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

  1. $gdata->deleteEmailList('friends');

Mit den Empfängern von Email Listen interagieren

Jeder Empfänger der bei einer Email Liste eingeschrieben ist, wird durch eine Instanz von Zend_Gdata_Gapps_EmailListRecipient repräsentiert. Durch diese Klasse können individuelle Empfänger hinzugefügt und von Email Listen entfernt werden.

Einen Empfängern zu einer Email Liste hinzufügen

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

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

Eine Liste von Empfängern einer Email Liste erhalten

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

  1. $feed = $gdata->retrieveAllRecipients('friends');
  2.  
  3. foreach ($feed as $recipient) {
  4.     echo '  * ' . $recipient->who->email . "\n";
  5. }

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.

  1. $query = $gdata->newEmailListRecipientQuery();
  2. $query->setEmailListName('friends');
  3. $feed = $gdata->getEmailListRecipientFeed($query);
  4.  
  5. foreach ($feed as $recipient) {
  6.     echo '  * ' . $recipient->who->email . "\n";
  7. }

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

Einen Empfänger von einer Email Liste entfernen

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

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

Fehler handhaben

Zusätzlich zur Standardsuite von Ausnahmen die von Zend_Gdata geworfen werden, können Anfragen welche die Provisionierungs API verwenden auch eine Zend_Gdata_Gapps_ServiceException werfen. Diese Ausnahme zeigt das ein API spezieller Fehler aufgetreten ist welche verhindert das die Anfrage fertiggestellt werden kann.

Jede ServiceException Instanz kann einen oder mehrere Fehler Objekte enthalten. Jedes dieser Objekte enthalten einen Fehlercode, Grund und (optional) die Eingave welche die Ausnahme getriggert hat. Eine komplette Liste von bekannten Fehlercodes wird in der Zend Framework API Dokumentation unter Zend_Gdata_Gapps_Error angeboten. Zusätzlich ist die maßgebliche Fehlerliste online unter » Google Apps Provisioning API V2.0 Reference: Appendix D vorhanden.

Wärend die komplette Liste von Fehler die empfangen wurden in ServiceException als Array vorhanden sind das man durch den Aufruf von getErrors() erhalten kann, ist es oft bequemer zu wissen ob ein spezieller Fehler aufgetreten ist. Für diese Fälle kann das Vorhandensein eines Fehler durch den Aufruf von hasError() erkannt werden.

Das folgende Beispiel demonstriert wie erkannt werden kann ob eine angefragte Ressource nicht existiert und der Fehler korrekt behandelt werden kann:

  1. function retrieveUser ($username) {
  2.     $query = $gdata->newUserQuery($username);
  3.     try {
  4.         $user = $gdata->getUserEntry($query);
  5.     } catch (Zend_Gdata_Gapps_ServiceException $e) {
  6.         // Den Benutzer auf null setzen wen er nicht gefunden wurde
  7.         if ($e->hasError(Zend_Gdata_Gapps_Error::ENTITY_DOES_NOT_EXIST)) {
  8.             $user = null;
  9.         } else {
  10.             throw $e;
  11.         }
  12.     }
  13.     return $user;
  14. }

Previous topic

Google Tabellenkalkulation verwenden

Next topic

Picasa Web Alben verwenden

Copyright

© 2006-2021 by Zend by Perforce. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.

Contacts