Zend_Dojo_Data: dojo.data Envelopes
Dojo bietet Datenabstraktionen für daten-aktivierte Widgets über seine
dojo.data Komponente. Diese Komponente bietet die Möglichkeit einen
Datenspeicher hinzuzufügen, einige Metadaten betreffend dem Identifikatorfeld zu liefern und
optional ein Labelfeld, und eine API für das Abfragen, Sortieren und
Empfangen von Einträgen und Sets von Einträgen von der Datenquelle.
dojo.data wird oft mit XmlHttpRequest verwendet um dynamisch Daten vom
Server zu holen. Der primäre Mechanismus hierfür ist die Erweiterung von QueryReadStore um
auf eine URL zu zeigen und die Anfrageinformation zu spezifizieren. Die
Serverseite gibt dann Daten im folgenden JSON Format zurück:
',
',>
items: [
{ name: '...', label: '...', someKey: '...' },
...
]
}
]]>
Zend_Dojo_Data bietet ein einfaches Interface für das
programmtechnische erstellen solcher Strukturen, der Interaktion mit Ihnen, und deren
Serialisierung in ein Array oder JSON.
Verwendung von Zend_Dojo_Data
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:
Initialisierung von Zend_Dojo_Data über den Konstruktor
Initialisierung von Zend_Dojo_Data über Mutatoren
setIdentifier('id')
->addItems($items);
]]>
Man kann jederzeit ein einzelnes Element hinzufügen, oder Elemente anfügen, indem
addItem() und addItems() verwendet
wird.
Hinzufügen von Daten bei Zend_Dojo_Data
addItem($someItem);
$data->addItems($someMoreItems);
]]>
Immer einen Identifikator verwenden!
Für jeden dojo.data Datenspeicher muß die Identifikatorspalte
als Metadaten angegeben werden, inklusive Zend_Dojo_Data.
Fakt ist das, wenn man versucht Elemente ohne Identifikator hinzuzufügen, eine
Ausnahme geworfen wird.
Individuelle Elemente können die folgenden sein:
Assoziative Arrays
Objekte die eine toArray() Methode implementieren
Jedes andere Objekt (wird über get_object_vars()
serialisiert)
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:
Arrays
Objekte die das Traversable implementieren, welches die
Interfaces Iterator und
ArrayAccess enthält.
Wenn man ein Feld spezifizieren will das als Label für das Element agieren soll, kann
setLabel() aufgerufen werden:
Spezifizierung eines Labelfeldes in Zend_Dojo_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.
Zend_Dojo_Data von JSON aus bekanntgeben
fromJson($json);
]]>
Den Containern Metadaten hinzufügen
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:
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();
]]>
Gehobenere Verwendungsfälle
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.
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:
'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.
Oder Sie sogar zählen um zu sehen wie viele Elemente man hat:
Letztendlich kann man, da die Klasse __toString()
implementiert, Sie auch zu JSON casten indem man Sie einfach ausgibt,
oder Sie zu einem String castet:
Vorhandene Methoden
Neben den Methoden die notwendig sind um die oben beschriebenen Interfaces zu
implementieren sind die folgenden Methoden vorhanden.
setItems($items): Setzt mehrere Elemente auf
einmal, und überschreibt alle vorher im Objekt gesetzten.
$items sollte ein Array oder ein
Traversable Objekt sein.
setItem($item, $id = null): Setzt ein
individuelles Element, indem optional ein expliziter Identifikator
übergeben wird. Überschreibt das Element wenn es bereits in der Kollektion
ist. Gültige Elemente enthalten assoziative Arrays, Objekte die
toArray() implementieren, oder jedes Objekt mit
öffentlichen Eigenschaften.
addItem($item, $id = null): Fügt ein individuelles
Element hinzu, indem optional ein expliziter Identifikator übergeben wird.
Wirft eine Ausnahme wenn das Element bereits in der Kollektion existiert.
Gültige Elemente enthalten assoziative Arrays, Objekte die
toArray() implementieren, oder jedes Objekt mit
öffentlichen Eigenschaften.
addItems($items): Fügt mehrere Elemente auf einmal
hinzu, indem Sie allen aktuellen Elementen angefügt werden. Wirft eine
Ausnahme wenn irgendeines der neuen Elemente einen Identifikator hat der zu
einem bereits in der Kollektion vorhandenen Identifikator passt.
$items sollte ein Array oder ein
Traversable Objekt sein.
getItems(): Gibt alle Elemente als Array von
Arrays zurück.
hasItem($id): Erkennt ob ein Element mit dem
angegebenen Identifikator in der Kollektion existiert oder nicht.
getItem($id): Gibt ein Element mit dem angegebenen
Identifikator von der Kollektion zurück; das zurückgegebene Element ist ein
assoziatives Array. Wenn kein Element passt, wird ein
NULL Wert zurückgegeben.
removeItem($id): Entfernt ein Element mit dem
angegebenen Identifikator von der Kollektion.
clearItems(): Entfernt alle Elemente von der
Kollektion.
setIdentifier($identifier): Setzt den Namen des
Feldes das den eindeutigen Identifikator repräsentiert für jedes Element
in der Kollektion.
getIdentifier(): Gibt den Namen des
Identifikatorfeldes zurück.
setLabel($label): Setzt den Namen eines Feldes
das als Anzeigelabel für ein Element verwendet wird.
getLabel(): Gibt den Namen des Labelfeldes zurück.
toArray(): Castet das Objekt zu einem Array. Das
Array enthält mindestens die Schlüssel 'identifier' und 'items', und den
Schlüssel 'label' wenn ein Labelfeld im Objekt gesetzt wurde.
toJson(): Castet das Objekt zu einer
JSON Repräsentation.