# Google Base verwenden

Die Google Base Daten API wurde entwickelt um Entwicklern zwei Dinge zu gestatten:

- Google Base Daten abzufragen um Anwendungen und Mashups zu erstellen.

- Google Base Elemente einzugeben und programtechnisch handzuhaben.

Es gibt zwei Feeds an Elementen: Feed Fetzen und benutzerdefinierte Feeds für Elemente. Der Feed Fetzen enthält alle Google Base Daten und ist für jeden lesbar um Abfragen darauf durchzuführen ohne der Notwendigkeit sich zu Authentifizieren. Der benutzerdefinierte Feed für Elemente ist ein benutzer spezifisches Subset an Daten und nur ein Benutzer/Eigentümer kann auf diesen Feed zugreifen um eigene Daten einzufügen, zu aktualisieren oder zu löschen. Abfragen werden für beide Typen von Feeds auf dem selben Weg erstellt.

Siehe http://code.google.com/apis/base für weitere Informationen über die Google Base API.

## Verbinden zum Base Service

Die Google Base API basiert, wie alle GData APIs, auf dem Atom Publishing Protokoll (APP), einem XML basierenden Format für gemanagte Web-basierende Ressourcen. Der Verkehr zwischen einem Client und den Google Base Servern findet über HTTP statt, und erlaubt sowohl authentifizierte als auch nicht authentifizierte Verbindungen.

Bevor irgendeine Transaktion stattfinden kann, muß diese Verbindung hergestellt werden. Das Erstellen einer Verbindung zu den Base Server enthält zwei Schritte: Erstellen eines HTTP Clients und das Binden einer `Zend_Gdata_Gbase` Serviceinstanz an diesen Client.

### Authentifizierung

Die Google Base API erlaubt Zugriff auf beide, sowohl öffentliche als auch private Base Feeds. Öffentliche Feeds benötigen keine Authentifizierung, sind aber nur lesbar und bieten nur reduzierte Funktionalität. Private Feeds bieten die größte Funktionalität benötigen aber eine authentifizierte Verbindung zu den Base Servern. Es gibt drei authentifizierung Schematas die von Google Base unterstützt werden:

- ClientAuth bietet dirakte Benutzername/Passwort Authentifizierung zu den Base Servern. Da es dieses Schema notwendig macht das Benutzer die Anwendung mit Ihrem Passwort versorgen, ist diese Authentifizierung nur dann notwendig wenn andere Authentifizierung Schemata unzureichend sind.

- AuthSub erlaubt die Authentifizierung zu den Base Servern über einen Google Proxy Server. Das bietet das gleiche Level an Bequemlichkeit wie ClientAuth, aber ohne die Sicherheitsrisiken was es zu einer idealen Wahl für Web-basierte Anwendungen macht.

Die `Zend_Gdata` Bibliothek bietet Unterstützung für alle drei Authentifizierungs Schemata. Im Rest dieses Kapitels wird angenommen das man mit den Authentifizierungs Schemata umgehen kann und wie eine notwendige Authentifizierte Verbindung erstellt wird. Für weitere Informationen kann in das Kapitel oder die Übersicht der Authentifizierung im Entwickler Guide der Google Data API gesehen werden.

### Eine Service Instanz erstellen

Im mit Google Base zu interagieren, bietet diese Bibliothek die `Zend_Gdata_Gbase` Service Klasse. Diese klasse bietet ein standardmäßiges Interface zu Google Data und den Atom Publishing Protokoll Modellen und unterstützt in der Durchführung von Anfragen von und zu den Base Servern.

Sobald ein Authentifizierungs Schema ausgewählt wurde, besteht der nächste Schritt darin eine Instanz von `Zend_Gdata_Gbase` zu erstellen. Diese Klasse nimmt eine Instanz von `Zend_Http_Client` als einziges Argument. Das bietet ein Interface für AuthSub und ClientAuth Authentifizierungen, da beide einen speziellen authentifizierten HTTP Client für die Erstellung benötigen. Wenn keine Argumente angegeben wurden, wird automatisch eine nicht authentifizierte Instanz von `Zend_Http_Client` erstellt.

Das nachfolgende Beispiel zeigt wir eine Base Service Klasse erstellt wird indem die ClientAuth Authentifizierung verwendet wird:

    // Parameter für die ClientAuth Authentifizierung
    $service = Zend_Gdata_Gbase::AUTH_SERVICE_NAME;
    $user = "sample.user@gmail.com";
    $pass = "pa$$w0rd";

    // Erstellt einen authentifizierten HTTP Client
    $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);

    // Erstellt eine Instanz des Base Services
    $service = new Zend_Gdata_Gbase($client);

Ein Base Service der AuthSub verwendet kann ähnlich erstellt werden, durch einen etwas längeren Code:

    /*
     * Empfängt die aktuelle URL so das der AuthSub Server weiß wohin er
     * umleiten soll nachdem die Authentifizierung des Benutzers vollständig ist.
     */
    function getCurrentUrl()
    {
        global $_SERVER;

        // Filtert php_self um Sicherheits Risiken zu vermeiden
        $php_request_uri =
            htmlentities(substr($_SERVER['REQUEST_URI'],
                                0,
                                strcspn($_SERVER['REQUEST_URI'], "\n\r")),
                         ENT_QUOTES);

        if (isset($_SERVER['HTTPS']) &&
            strtolower($_SERVER['HTTPS']) == 'on') {
            $protocol = 'https://';
        } else {
            $protocol = 'http://';
        }
        $host = $_SERVER['HTTP_HOST'];
        if ($_SERVER['HTTP_PORT'] != '' &&
            (($protocol == 'http://' && $_SERVER['HTTP_PORT'] != '80') ||
            ($protocol == 'https://' && $_SERVER['HTTP_PORT'] != '443'))) {
            $port = ':' . $_SERVER['HTTP_PORT'];
        } else {
            $port = '';
        }
        return $protocol . $host . $port . $php_request_uri;
    }

    /**
     * Einen AuthSub authentifizierten HTTP Client erhalten, und den Benutzer zum
     * AuthSub Server umleiten um sich anzumelden wenn das notwendig ist.
     */
    function getAuthSubHttpClient()
    {
        global $_SESSION, $_GET;

        // Wenn es keine AuthSub Session gibt oder kein Einmal-Token auf uns wartet,
        // den Benutzer zum AuthSub Server umleiten um eine zu erhalten.
        if (!isset($_SESSION['sessionToken']) && !isset($_GET['token'])) {
            // Parameter für den AuthSub Server
            $next = getCurrentUrl();
            $scope = "http://www.google.com/base/feeds/items/";
            $secure = false;
            $session = true;

            // Den Benutzer zum AuthSub Server umleiten um sich anzumelden

            $authSubUrl = Zend_Gdata_AuthSub::getAuthSubTokenUri($next,
                                                                 $scope,
                                                                 $secure,
                                                                 $session);
             header("HTTP/1.0 307 Temporary redirect");

             header("Location: " . $authSubUrl);

             exit();
        }

        // Konvertiert einen AuthSub Einmal-Token in einen Session-Token wenn das notwendig ist
        if (!isset($_SESSION['sessionToken']) && isset($_GET['token'])) {
            $_SESSION['sessionToken'] =
                Zend_Gdata_AuthSub::getAuthSubSessionToken($_GET['token']);
        }

        // An diesem Punkt sind wir durch AuthSub authentifiziert und können eine
        // authentifizierte Instanz des HTTP Clients erhalten

        // Erstellt einen authentifizierten HTTP Client
        $client = Zend_Gdata_AuthSub::getHttpClient($_SESSION['sessionToken']);
        return $client;
    }

    // -> Script Ausführung beginnt hier <-

    // http://code.google.com/apis/gdata/reference.html#Queries
    // Sicherstellen das der Benutzer eine gültige Session hat sodas wir die
    // AuthSub Session aufnehmen können sobald diese vorhanden ist.
    session_start();

    // Erstellt eine Instanz des Base Services, leitet den Benutzer zum AuthSub Server um
    // wenn das notwendig ist.
    $service = new Zend_Gdata_Gbase(getAuthSubHttpClient());

Letztendlich kann ein nicht authentifizierter Server erstellt werden für die Verwendung mit Feed Fetzen:

    // Erstellt eine Instanz des Base Services und verwendet einen nicht
    // authentifizierten HTTP Client
    $service = new Zend_Gdata_Gbase();

## Elemente empfangen

Benutzerdefinierte Feeds oder Feed Fetzen können abgefragt werden um Elemente zu erhalten. Es benötigt zwei Schritte um eine Abfrage zu senden und über den zurückgegebenen Feed zu iterieren.

### Eine strukturierte Anfrage senden

Eine strukturierte Anfrage kann gesendet werden um Elemente vom eigenen benutzerdefinierten Feed oder von einem öffentlichen Feed Fetzen zu erhalten.

Wenn Elemente empfangen werden indem die Base API verwendet wird, werden speziell konstruierte Abfrage URLs verwendet um zu beschreiben welche Evente zurückgegeben werden sollen. Die `Zend_Gdata_Gbase_ItemQuery` und `Zend_Gdata_Gbase_SnippetQuery` Klassen vereinfachen diese Aufgabe durch die automatische Erstellung einer Anfrage URL basierend auf den angegebenen Parametern.

#### Benutzerdefinierte Feed Elemente Anfragen

Um eine Abfrage auf Benutzerdefinierte Feed Elemente durchzuführen, gibt es die `newItemQuery()` und `getGbaseItemFeed()` Methoden:

    $service = new Zend_Gdata_Gbase($client);
    $query = $service->newItemQuery();
    $query->setBq('[title:Programming]');
    $query->setOrderBy('modification_time');
    $query->setSortOrder('descending');
    $query->setMaxResults('5');
    $feed = $service->getGbaseItemFeed($query);

Eine komplette Liste dieser Parameter ist im Abfrage Parameter Kapitel der Benutzerdefinierten Feed Elemente Dokumentation vorhanden.

#### Feed Fetzen abfragen

Um eine Abfrage über öffentliche Feed Fetzen durchzuführen, gibt es die `newSnippetQuery()` und `getGbaseSnippetFeed()` Methoden:

    $service = new Zend_Gdata_Gbase();
    $query = $service->newSnippetQuery();
    $query->setBq('[title:Programming]');
    $query->setOrderBy('modification_time');
    $query->setSortOrder('descending');
    $query->setMaxResults('5');
    $feed = $service->getGbaseSnippetFeed($query);

Eine komplette Liste dieser Parameter ist im Abfrage Parameter Kapitel der Feed Fetzen Dokumentation vorhanden.

### Über die Elemente iterieren

Google Base Elemente können Element-Spezifische Attribute enthalten, wie `<g:main_ingredient>` und `<g:weight>`.

Um über alle Attribute eines gegebenen Elements zu iterieren, gibt es die `getGbaseAttributes()` Methode die über alle Ergebnisse iteriert:

    foreach ($feed->entries as $entry) {
      // Alle Attribute erhalten und den Namen und den Textwert
      // jedes Attributes ausgeben
      $baseAttributes = $entry->getGbaseAttributes();
      foreach ($baseAttributes as $attr) {
        echo "Attribut " . $attr->name . " : " . $attr->text . "<br>";
      }
    }

Oder es kann auf spezielle Attributnamen gesehen werden und über die passenden Ergebnisse iteriert werden:

    foreach ($feed->entries as $entry) {
      // Gibt alle Hauptzutaten aus <g:main_ingredient>
      $baseAttributes = $entry->getGbaseAttribute("main_ingredient");
      foreach ($baseAttributes as $attr) {
        echo "Hauptzutaten: " . $attr->text . "<br>";
      }
    }

## Benutzerdefinierte Elemente einfügen, aktualisieren und löschen

Ein Benutzer/Eigentümer kann auf seine eigenen Benutzerdefinierten Feed Elemente zugreifen um Sie hinzuzufügen, zu aktualisieren oder Ihre Elemente zu löschen. Diese Operationen sind für den öffentlichen Feed Fetzen nicht vorhanden.

Eine Feed Operation kann getestet werden bevor diese wirklich ausgeführt wird durch das setzen des Dry-Run Flags (`$dryRun`) auf `TRUE`. Sobald sichergestellt ist das die Daten übertragen werden sollen, muß es auf `FALSE` gesetzt werden um die Operation durchzuführen.

### Ein Element einfügen

Elemente können hinzugefügt werden durch Verwenden der `insertGbaseItem()` Methode des Base Services:

    $service = new Zend_Gdata_Gbase($client);
    $newEntry = $service->newItemEntry();

    // Überschrift hinzufügen
    $title = "PHP Entwickler Handbuch";
    $newEntry->title = $service->newTitle(trim($title));

    // Etwas Inhalt hinzufügen
    $content = "Wichtiges Handbuch für PHP Entwickler.";
    $newEntry->content = $service->newContent($content);
    $newEntry->content->type = 'text';

    // Produkt Typ definieren
    $itemType = "Produkte";
    $newEntry->itemType = $itemType;

    // Ein spezielles Element Attribut hinzufügen
    $newEntry->addGbaseAttribute("product_type", "book", "text");
    $newEntry->addGbaseAttribute("price", "12.99 USD", "floatUnit");
    $newEntry->addGbaseAttribute("quantity", "10", "int");
    $newEntry->addGbaseAttribute("weight", "2.2 lbs", "numberUnit");
    $newEntry->addGbaseAttribute("condition", "New", "text");
    $newEntry->addGbaseAttribute("author", "John Doe", "text");
    $newEntry->addGbaseAttribute("edition", "First Edition", "text");
    $newEntry->addGbaseAttribute("pages", "253", "number");
    $newEntry->addGbaseAttribute("publisher", "My Press", "text");
    $newEntry->addGbaseAttribute("year", "2007", "number");
    $newEntry->addGbaseAttribute("payment_accepted", "Google Checkout", "text");

    $dryRun = true;
    $createdEntry = $service->insertGbaseItem($newEntry, $dryRun);

### Ein Element modifizieren

Jedes Atribut eines Element kann aktualisiert werden wenn durch Sie iteriert wird:

    // Die Überschrift aktualisieren
    $newTitle = "PHP Entwickler Handbuch zweite Editiondbook Second Edition";
    $entry->title = $service->newTitle($newTitle);

    // <g:price> Attribute finden und den Preis aktualisieren
    $baseAttributes = $entry->getGbaseAttribute("price");
    if (is_object($baseAttributes[0])) {
      $newPrice = "16.99 USD";
      $baseAttributes[0]->text = $newPrice;
    }

    // <g:pages> Attribute finden und die anzahl an Seiten aktualisieren
    $baseAttributes = $entry->getGbaseAttribute("pages");
    if (is_object($baseAttributes[0])) {
      $newPages = "278";
      $baseAttributes[0]->text = $newPages;

      // Den Attribut Typ von "number" zu "int" aktualisieren
      if ($baseAttributes[0]->type == "number") {
        $newType = "int";
        $baseAttributes[0]->type = $newType;
      }
    }

    // <g:label> Attribute entfernen
    $baseAttributes = $entry->getGbaseAttribute("label");
    foreach ($baseAttributes as $note) {
      $entry->removeGbaseAttribute($note);
    }

    // Neue Attribute hinzufügen
    $entry->addGbaseAttribute("note", "PHP 5", "text");
    $entry->addGbaseAttribute("note", "Web Programming", "text");

    // Die Änderungen abspeichern durch Aufruf von save() am Element-Objekt selbst
    $dryRun = true;
    $entry->save($dryRun);

    // Oder die Änderungen durch Aufruf von updateGbaseItem() am Service Objekt abspeichern
    // $dryRun = true;
    // $service->updateGbaseItem($entry, $dryRun);

Nach der Durchführung der Änderungen, muß entweder die `save($dryRun)` Methode am `Zend_Gdata_Gbase_ItemEntry` Objekt oder die `updateGbaseItem($entry, $dryRun)` Methode am `Zend_Gdata_Gbase` Objekt aufgerufen werden um die Änderungen abzuspeichern.

### Ein Element löschen

ein Element kann gelöscht werden indem die `deleteGbaseItem()` Methode aufgerufen wird:

    $dryRun = false;
    $service->deleteGbaseItem($entry, $dryRun);

Alternativ kann `delete()` auf dem `Zend_Gdata_Gbase_ItemEntry` Objekt aufgerufen werden:

    $dryRun = false;
    $entry->delete($dryRun);