Zend_Gata se compone de varios tipos de clases:

Los servicios de Google data se basan en el Atom Publishing Protocol (APP) y el formato de sindicación Atom. Para interactuar con los servicios APP o de Google usando el componente Zend_Gdata, necesita usar las clases de servicio como Zend_Gdata_App, Zend_Gdata, Zend_Gdata_Spreadsheets, etc. Estas clases de servicio proporcionan métodos para recuperar datos de los servicios como feeds, insertar nuevas entradas en feeds, actualizar entradas y eliminar entradas.

Nota: Un ejemplo completo de trabajo con Zend_Gdata está disponible en el directorio demos/Zend/Gdata. Este ejemplo puede ejecutarse desde la línea de comandos, pero los métodos contenidos en él son fácilmente portables a una aplicación web.

Los estándares de nomenclatura de Zend Framework requieren que todas las clases se nombren según la estructura de directorios en la que están ubicadas. Por ejemplo, las extensiones relacionadas con Spreadsheets se almacenan en: Zend/Gdata/Spreadsheets/Extension/... y, como resultado de esto, se nombran Zend_Gdata_Spreadsheets_Extension_.... ¡Esto provoca mucha escritura si intenta construir una nueva instancia de un elemento de celda de hoja de cálculo!

Hemos implementado un método de fábrica mágico en todas las clases de servicio (como Zend_Gdata_App, Zend_Gdata, Zend_Gdata_Spreadsheets) que debería facilitar mucho la construcción de nuevas instancias de clases de modelo de datos, consulta y otras. Esta fábrica mágica está implementada usando el método mágico __call() para interceptar todos los intentos de llamar a $service->newXXX(arg1, arg2, ...). Según el valor de XXX, se realiza una búsqueda en todos los 'paquetes' registrados para la clase deseada. Aquí hay algunos ejemplos:

$ss = new Zend_Gdata_Spreadsheets();

// creates a Zend_Gdata_App_Spreadsheets_CellEntry
$entry = $ss->newCellEntry();

// creates a Zend_Gdata_App_Spreadsheets_Extension_Cell
$cell = $ss->newCell();
$cell->setText('My cell value');
$cell->setRow('1');
$cell->setColumn('3');
$entry->cell = $cell;

// ... $entry can then be used to send an update to a Google Spreadsheet

Cada clase de servicio en el árbol de herencia es responsable de registrar los 'paquetes' (directorios) apropiados que deben buscarse al llamar al método de fábrica mágico.

La mayoría de los servicios de Google Data requieren que las aplicaciones cliente se autentiquen contra el servidor de Google antes de acceder a datos privados, o guardar o eliminar datos. Hay dos implementaciones de autenticación para Google Data: AuthSub y ClientLogin. Zend_Gdata ofrece interfaces de clase para ambos métodos.

La mayoría de los demás tipos de consultas contra servicios de Google Data no requieren autenticación.

Zend_Gdata hace uso de Zend_Http_Client para enviar solicitudes a google.com y obtener resultados. La respuesta a la mayoría de las solicitudes de Google Data se devuelve como una subclase de las clases Zend_Gdata_App_Feed o Zend_Gdata_App_Entry.

Zend_Gdata asume que su aplicación PHP se ejecuta en un host que tiene una conexión directa a Internet. El cliente Zend_Gdata funciona contactando con los servidores de Google Data.

Cree un nuevo objeto de la clase Zend_Gdata_App, Zend_Gdata, o una de las subclases disponibles que ofrecen métodos auxiliares para el comportamiento específico del servicio.

El único parámetro opcional del constructor de Zend_Gdata_App es una instancia de Zend_Http_Client. Si no pasa este parámetro, Zend_Gdata crea un objeto Zend_Http_Client por defecto, que no tendrá credenciales asociadas para acceder a feeds privados. Especificar el objeto Zend_Http_Client también le permite pasar opciones de configuración a ese objeto cliente.

$client = new Zend_Http_Client();
$client->setConfig( ...options... );

$gdata = new Zend_Gdata($client);

A partir de Zend Framework 1.7, se ha añadido soporte para el versionado de protocolo. Esto permite que el cliente y el servidor admitan nuevas funciones manteniendo la compatibilidad hacia atrás. Aunque la mayoría de los servicios gestionarán esto por usted, si crea una instancia de Zend_Gdata directamente (a diferencia de una de sus subclases), es posible que necesite especificar la versión de protocolo deseada para acceder a cierta funcionalidad del servidor.

$client = new Zend_Http_Client();
$client->setConfig( ...options... );

$gdata = new Zend_Gdata($client);
$gdata->setMajorProtocolVersion(2);
$gdata->setMinorProtocolVersion(null);

Vea también las secciones sobre autenticación para métodos que crean un objeto Zend_Http_Client autenticado.

Puede especificar parámetros para personalizar consultas con Zend_Gdata. Los parámetros de consulta se especifican usando subclases de Zend_Gdata_Query. La clase Zend_Gdata_Query incluye métodos para establecer todos los parámetros de consulta usados en los servicios GData. Los servicios individuales, como Spreadsheets, también proporcionan clases de consulta para definir parámetros personalizados para el servicio y feeds concretos. Spreadsheets incluye una clase CellQuery para consultar el feed Cell y una clase ListQuery para consultar el feed List, ya que diferentes parámetros de consulta son aplicables a cada uno de esos tipos de feed. Los parámetros de GData a nivel general se describen a continuación.

Hay una función get*() por cada función set*().

$query = new Zend_Gdata_Query();
$query->setMaxResults(10);
echo $query->getMaxResults();   // returns 10

La clase Zend_Gdata también implementa métodos "mágicos" de getter y setter, por lo que puede usar el nombre del parámetro como un miembro virtual de la clase.

$query = new Zend_Gdata_Query();
$query->maxResults = 10;
echo $query->maxResults;        // returns 10

Puede borrar todos los parámetros con la función resetParameters(). Esto es útil si reutiliza un objeto Zend_Gdata para varias consultas.

$query = new Zend_Gdata_Query();
$query->maxResults = 10;
// ...get feed...

$query->resetParameters();      // clears all parameters
// ...get a different feed...

Use la función getFeed() para recuperar un feed desde una URI especificada. Esta función devuelve una instancia de la clase especificada como segundo argumento de getFeed, que por defecto es Zend_Gdata_Feed.

$gdata = new Zend_Gdata();
$query = new Zend_Gdata_Query(
        'http://www.blogger.com/feeds/blogID/posts/default');
$query->setMaxResults(10);
$feed = $gdata->getFeed($query);

Vea las secciones posteriores para funciones especiales en cada clase auxiliar para los servicios de Google Data. Estas funciones le ayudan a obtener feeds desde la URI apropiada para el servicio respectivo.

Al recuperar un feed que contiene un gran número de entradas, el feed puede dividirse en varias "páginas" más pequeñas de feeds. Cuando esto ocurre, cada página contendrá un enlace a la siguiente página en la serie. Se puede acceder a este enlace llamando a getLink('next'). El siguiente ejemplo muestra cómo recuperar la siguiente página de un feed:

function getNextPage($feed) {
    $nextURL = $feed->getLink('next');
    if ($nextURL !== null) {
        return $gdata->getFeed($nextURL);
    } else {
        return null;
    }
}

Si prefiere no trabajar con páginas en su aplicación, pase la primera página del feed a Zend_Gdata_App::retrieveAllEntriesForFeed(), que consolidará todas las entradas de cada página en un único feed. Este ejemplo muestra cómo usar esta función:

$gdata = new Zend_Gdata();
$query = new Zend_Gdata_Query(
        'http://www.blogger.com/feeds/blogID/posts/default');
$feed = $gdata->retrieveAllEntriesForFeed($gdata->getFeed($query));

Tenga en cuenta al llamar a esta función que puede tardar mucho tiempo en completarse en feeds grandes. Es posible que necesite aumentar el límite de tiempo de ejecución de PHP llamando a set_time_limit().

Después de recuperar un feed, puede leer los datos del feed o las entradas contenidas en el feed usando los accesores definidos en cada una de las clases de modelo de datos o los accesores mágicos. Aquí hay un ejemplo:

$client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
$gdata = new Zend_Gdata($client);
$query = new Zend_Gdata_Query(
        'http://www.blogger.com/feeds/blogID/posts/default');
$query->setMaxResults(10);
$feed = $gdata->getFeed($query);
foreach ($feed as $entry) {
    // using the magic accessor
    echo 'Title: ' . $entry->title->text;
    // using the defined accessors
    echo 'Content: ' . $entry->getContent()->getText();
}

Después de recuperar una entrada, puede actualizar esa entrada y guardar los cambios de vuelta en el servidor. Aquí hay un ejemplo:

$client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
$gdata = new Zend_Gdata($client);
$query = new Zend_Gdata_Query(
        'http://www.blogger.com/feeds/blogID/posts/default');
$query->setMaxResults(10);
$feed = $gdata->getFeed($query);
foreach ($feed as $entry) {
    // update the title to append 'NEW'
    echo 'Old Title: ' . $entry->title->text;
    $entry->title->text = $entry->title->text . ' NEW';

    // update the entry on the server
    $newEntry = $entry->save();
    echo 'New Title: ' . $newEntry->title->text;
}

El objeto Zend_Gdata tiene una función insertEntry() con la que puede subir datos para guardar nuevas entradas en los servicios de Google Data.

Puede usar las clases de modelo de datos de cada servicio para construir la entrada apropiada que se publicará en los servicios de Google. La función insertEntry() aceptará un hijo de Zend_Gdata_App_Entry como datos para publicar en el servicio. El método devuelve un hijo de Zend_Gdata_App_Entry que representa el estado de la entrada tal como fue devuelto por el servidor.

Alternativamente, podría construir la estructura XML de una entrada como una cadena y pasar la cadena a la función insertEntry().

$gdata = new Zend_Gdata($authenticatedHttpClient);

$entry = $gdata->newEntry();
$entry->title = $gdata->newTitle('Playing football at the park');
$content =
    $gdata->newContent('We will visit the park and play football');
$content->setType('text');
$entry->content = $content;

$entryResult = $gdata->insertEntry($entry,
        'http://www.blogger.com/feeds/blogID/posts/default');

echo 'The <id> of the resulting entry is: ' . $entryResult->id->text;

Para publicar entradas, debe estar usando un Zend_Http_Client autenticado que haya creado usando las clases Zend_Gdata_AuthSub o Zend_Gdata_ClientLogin.

Opción 1: El objeto Zend_Gdata tiene una función delete() con la que puede eliminar entradas de los servicios de Google Data. Pase el valor de la URL de edición de una entrada de feed al método delete().

Opción 2: Alternativamente, puede llamar a $entry->delete() en una entrada recuperada de un servicio de Google.

$gdata = new Zend_Gdata($authenticatedHttpClient);
// a Google Data feed
$feedUri = ...;
$feed = $gdata->getFeed($feedUri);
foreach ($feed as $feedEntry) {
    // Option 1 - delete the entry directly
    $feedEntry->delete();
    // Option 2 - delete the entry by passing the edit URL to
    // $gdata->delete()
    // $gdata->delete($feedEntry->getEditLink()->href);
}

Para eliminar entradas, debe estar usando un Zend_Http_Client autenticado que haya creado usando las clases Zend_Gdata_AuthSub o Zend_Gdata_ClientLogin.