En su forma más simple, dojo.data requiere que se proporcione el nombre del campo identificador en cada item, y un conjunto de items (datos). Puede pasarlos tanto via el constructor, o via mutators:

$data = new Zend_Dojo_Data('id', $items);

$data = new Zend_Dojo_Data();
$data->setIdentifier('id')
     ->addItems($items);

También puede añadir un solo item a la vez, o agregar items utilizando addItem() y addItems() .

$data = new Zend_Dojo_Data($identifier, $items);
$data->addItem($someItem);

$data->addItems($someMoreItems);

Los items individuales pueden ser uno de los siguientes:

Puede adjuntar colecciones de los items anteriores via addItems() o setItems() (sobreescribe todos los items previamente establecidos); cuando lo haga, puede pasar un solo argumento:

Si quiere especificar un campo que actuará como una etiqueta para el item, llame a setLabel() :

$data->setLabel('name');

Por último, también puede cargar un item Zend_Dojo_Data de un array JSON dojo.data, utilizando el método fromJson() .

$data->fromJson($json);

Algunos componentes de Dojo requieren metadatos adicionales junto al conjunto de datos de dojo.data. Como ejemplo, dojox.grid.Grid puede tirar datos dinámicamente desde un dojox.data.QueryReadStore . Para que la paginación funcione correctamente, cada conjunto de datos de regreso debería contener una clave numRows con el número total de filas que podrían ser devueltas por la consulta. Con estos datos, la plantilla sabe cuando seguir haciendo pequeños pedidos de subconjuntos de datos al servidor y cuando dejar de hacer más peticiones (es decir, ha llegado a la última página de datos). Esta técnica es útil para despachar grandes conjuntos de datos en sus plantillas sin cargar todo el conjunto de una sola vez.

Zend_Dojo_Data permite asignar propiedades a los metadatos como al objeto. Lo siguiente ilustra su uso:

// Establece el "numRows" a 100
$data->setMetadata('numRows', 100);

// Establece varios items a la vez:
$data->setMetadata(array(
    'numRows' => 100,
    'sort'    => 'name',
));

// Inspecciona un único valor de metadatos:
$numRows = $data->getMetadata('numRows');

// Inspecciona todos los metadatos:
$metadata = $data->getMetadata();

// Elimina un item de metadatos:
$data->clearMetadata('numRows');

// Elimina todos los metadatos:
$data->clearMetadata();

Además de actuar como un contenedor de datos serializable, Zend_Dojo_Data también ofrece la posibilidad de manipular y recorrer los datos en una variedad de formas.

Zend_Dojo_Data implementa las interfaces ArrayAccess , Iterator , y Countable . Por lo tanto, puede usar la recopilación de datos casi como si fuera un array.

Todos los items son referenciados por el identificador de campo. Dado que los identificadores deben ser únicos, puede usar los valores de este campo para sacar los registros individuales. Hay dos maneras de hacer esto: con el método getItem() , o via notación de array.

// Usando getItem():
$item = $data->getItem('foo');

// O usando notación de array:
$item = $data['foo'];

Si conoce el identificador, puede utilizarlo para recuperar un item, actualizarlo, borrarlo, crearlo, o probarlo:

// Actualizar o crear un item:
$data['foo'] = array('title' => 'Foo', 'email' => 'foo@foo.com');

// Borrar un item:
unset($data['foo']);

// Efectuar una prueba para un item:
if (isset($data[foo])) {
}

También puede hacer un loop sobre todos los items. Internamente, todos los items se almacenan como arrays.

foreach ($data as $item) {
    echo $item['title'] . ': ' . $item['description'] . "\n";
}

O inclusive contar para ver cuántos ítems tiene:

echo count($data), " items encontrados!";

Por último, como la clase implementa __toString() , también puede convertirlo a JSON simplemente con "echo" de PHP o convertirlo a string:

echo $data; // echo como un string JSON

$json = (string) $data; // conversión a string == conversión a JSON