In seiner einfachsten Form, verlangt dojo.data dass der Name des Identifikatorfelds in jedem Element angegeben wird, und ein Set von Elementen (Daten). Man kann diese entweder über den Konstruktor übergeben, oder über Mutatoren:

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

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

Man kann jederzeit ein einzelnes Element hinzufügen, oder Elemente anfügen, indem addItem() und addItems() verwendet wird.

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

$data->addItems($someMoreItems);

Individuelle Elemente können die folgenden sein:

Man kann Kollektionen der obigen Elemente über addItems() oder setItems() hinzufügen (überschreibt alle vorher gesetzte Elemente); wenn das getan wird, kann man ein einzelnes Argument setzen:

Wenn man ein Feld spezifizieren will das als Label für das Element agieren soll, kann setLabel() aufgerufen werden:

$data->setLabel('name');

Letztendlich kann man auch ein Zend_Dojo_Data Element von einem dojo.data JSON Array geladen werden, indem die fromJson() Methode verwendet wird.

$data->fromJson($json);

Einige Dojo Komponenten benötigen zusätzliche Metadaten zusammen mit dem dojo.data Payload zurückgegeben werden. Als Beispiel kann dojox.grid.Grid Daten dynamisch von einem dojox.data.QueryReadStore herausziehen. Damit die Seitenweise Darstellung richtig funktioniert, sollte jeder zurückgegebene Payload einen numRows Schlüssel mit der kompletten Anzahl an Zeilen enthalten, die von der Abfrage zurückgegeben wird. Mit diesen Daten weiß der Grid (a) wann er weitere kleine Anfragen an den Server abschicken muß für Subsets von Daten, und (b) wann er aufhören soll weitere Anfragen zu erstellen (z.B., wenn er die letzte Seite der Daten erreicht hat). Diese Technik ist nützlich wenn große Sets an Daten im Grid geliefert werden sollen, ohne das man das komplette Set auf einmal laden muß.

Zend_Dojo_Data erlaubt die Zuordnung von Metadaten Eigenschaften zum Objekt. Das folgende zeigt die Verwendung:

// Setzt "numRows" auf 100
$data->setMetadata('numRows', 100);

// Setzt verschiedene Items auf einmal:
$data->setMetadata(array(
    'numRows' => 100,
    'sort'    => 'name',
));

// Zeigt einen einzelnen Metadaten Wert:
$numRows = $data->getMetadata('numRows');

// Zeigt alle Metadaten:
$metadata = $data->getMetadata();

// Entfernt ein Metadaten Item:
$data->clearMetadata('numRows');

// Entfernt alle Metadaten:
$data->clearMetadata();

Neben der Funktion als serialisierbarer Datenkontainer bietet Zend_Dojo_Data auch die Möglichkeit Daten auf verschiedenen Wegen zu manipulieren und zu durchlaufen.

Zend_Dojo_Data implementiert die Interfaces ArrayAccess, Iterator und Countable. Deshalb kann man die Datenkollektion genauso verwenden kann wie wenn Sie ein Array wäre.

Alle Elemente werden durch das Identifikatorfeld referenziert. Da Identifikatoren eindeutig sein müssen, können die Werte dieses Feldes verwendet werden um individuelle Einträge zu holen. Es gibt zwei Wege um das zu tun: mit der getItem() Methode, oder über die Array Schreibweise.

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

// Oder verwenden der Array Schreibweise:
$item = $data['foo'];

Wenn man den Identifikator kennt, kann man Ihn verwende um ein Element zu erhalten, es upzudaten, es zu löschen, es zu erstellen oder es zu testen:

// Updaten oder Erstellen eines Elements:
$data['foo'] = array('title' => 'Foo', 'email' => 'foo@foo.com');

// Löschen eines Elements:
unset($data['foo']);

// Testen eines Elements:
if (isset($data[foo])) {
}

Man kann genauso über alle Elemente iterieren. Intern werden alle Elemente als Arrays gespeichert.

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

Oder Sie sogar zählen um zu sehen wie viele Elemente man hat:

echo count($data), " Elemente gefunden!";

Letztendlich kann man, da die Klasse __toString() implementiert, Sie auch zu JSON casten indem man Sie einfach ausgibt, oder Sie zu einem String castet:

echo $data; // Ausgabe als JSON String

$json = (string) $data; // Casten zu einem String == casten zu JSON