En su forma más simple, dojo.data requiere que se proporcione el nombre del campo identificador en cada elemento, y un conjunto de elementos (datos). Puede pasarlos mediante el constructor, o mediante mutadores:

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

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

También puede añadir un elemento a la vez, o agregar elementos, usando addItem() y addItems().

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

$data->addItems($someMoreItems);

	¡Use siempre un identificador!
	Todo almacén de datos dojo.data requiere que la columna identificadora se proporcione como metadato, incluyendo Zend_Dojo_Data. De hecho, si intenta añadir elementos sin un identificador, se lanzará una excepción.

Cada elemento individual puede ser uno de los siguientes:

Puede adjuntar colecciones de los elementos anteriores mediante addItems() o setItems() (sobrescribe todos los elementos establecidos previamente); al hacerlo, puede pasar un único argumento:

Si desea especificar un campo que actúe como etiqueta para el elemento, llame a setLabel():

$data->setLabel('name');

Finalmente, también puede cargar un elemento Zend_Dojo_Data desde un array JSON de dojo.data, usando el método fromJson().

$data->fromJson($json);

Algunos componentes de Dojo requieren metadatos adicionales junto con la carga útil de dojo.data. Como ejemplo, dojox.grid.Grid puede obtener datos dinámicamente de un dojox.data.QueryReadStore. Para que la paginación funcione correctamente, cada carga útil de retorno debe contener una clave numRows con el número total de filas que podría devolver la consulta. Con estos datos, la cuadrícula sabe cuándo continuar haciendo pequeñas peticiones al servidor para subconjuntos de datos y cuándo dejar de hacer más peticiones (es decir, ha llegado a la última página de datos). Esta técnica es útil para servir grandes conjuntos de datos en sus cuadrículas sin cargar el conjunto completo de una sola vez.

Zend_Dojo_Data permite asignar propiedades de metadatos al objeto. A continuación se ilustra su uso:

// Set the "numRows" to 100
$data->setMetadata('numRows', 100);

// Set several items at once:
$data->setMetadata(array(
    'numRows' => 100,
    'sort'    => 'name',
));

// Inspect a single metadata value:
$numRows = $data->getMetadata('numRows');

// Inspect all metadata:
$metadata = $data->getMetadata();

// Remove a metadata item:
$data->clearMetadata('numRows');

// Remove all metadata:
$data->clearMetadata();

Además de actuar como un contenedor de datos serializable, Zend_Dojo_Data también proporciona la capacidad de manipular y recorrer los datos de diversas formas.

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

Todos los elementos se referencian mediante el campo identificador. Dado que los identificadores deben ser únicos, puede usar los valores de este campo para obtener registros individuales. Hay dos formas de hacerlo: con el método getItem(), o mediante notación de array.

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

// Or use array notation:
$item = $data['foo'];

Si conoce el identificador, puede usarlo para recuperar un elemento, actualizarlo, eliminarlo, crearlo o comprobar su existencia:

// Update or create an item:
$data['foo'] = array('title' => 'Foo', 'email' => 'foo@foo.com');

// Delete an item:
unset($data['foo']);

// Test for an item:
if (isset($data[foo])) {
}

También puede recorrer todos los elementos en un bucle. Internamente, todos los elementos se almacenan como arrays.

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

O incluso contar cuántos elementos tiene:

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

Finalmente, como la clase implementa __toString(), también puede convertirla a JSON simplemente mostrándola o convirtiéndola a cadena:

echo $data; // echo as JSON string

$json = (string) $data; // cast to string == cast to JSON