Previous Next

Zend_Dojo_Data: dojo.data エンベロープ

Dojo には、データを扱うウィジェットのデータを抽象化するための dojo.data コンポーネントが存在します。 このコンポーネントの持つ機能は、 データストアのアタッチ、identifier フィールド (そしてオプションで label フィールド) に関連するメタデータの提供、 問い合わせやソート用の API、 データストアからのレコードの取得などがあります。

dojo.data は、よく XmlHttpRequest と組み合わせて用いられます。 動的なデータをサーバから取得するためにです。 この基本的な仕組みは、QueryReadStore を拡張して URL とクエリ情報を指定するようにします。 サーバ側からは、データを次のような JSON 形式で返します。

{
    identifier: '',
    ',>
    items: [
        { name: '...', label: '...', someKey: '...' },
        ...
    ]
}

Zend_Dojo_Data は、 このような構造をプログラムで作成したりそれを操作したり、 配列や JSON にシリアライズしたりといった機能のシンプルなインターフェイスを提供します。

Zend_Dojo_Data の使用法

もっともシンプルな使用法は、dojo.data に各アイテムの identifier フィールドの名前とアイテムの内容 (データ) を渡すことです。 コンストラクタか、あるいは設定用メソッドで渡します。

Example #1 コンストラクタでの Zend_Dojo_Data の初期化

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

Example #2 設定用メソッドでの Zend_Dojo_Data の初期化

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

アイテムをひとつずつ追加したり複数一括で追加したりするには、それぞれ addItem() および addItems() を使用します。

Example #3 Zend_Dojo_Data へのデータの追加

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

$data->addItems($someMoreItems);

Note: 常に identifier を使うこと!

すべての dojo.data データストアは、identifier カラムがメタデータに存在することを必須としています。 Zend_Dojo_Data でもそれは同じです。 identifier のないアイテムを追加しようとすると、 例外が発生します。

個々のアイテムは、次のいずれかとなります。

  • 連想配列

  • toArray() メソッドを実装したオブジェクト

  • その他のオブジェクト (get_object_vars() でシリアライズされます)

これらのアイテムのコレクションをアタッチするには addItems() あるいは setItems() (既存のアイテムはすべて消去されます) を使用します。 これを使用するときには、引数をひとつ指定します。

  • 配列

  • Traversable インターフェイスを実装したオブジェクト (このインターフェイスは IteratorArrayAccess を含んでいます)。

アイテムの label として働くフィールドを指定したい場合は setLabel() をコールします。

Example #4 Zend_Dojo_Data での label フィールドの指定

$data->setLabel('name');

最後に、Zend_Dojo_Data のアイテムを dojo.data JSON 配列から読み込むには fromJson() メソッドを使用します。

Example #5 JSON からの Zend_Dojo_Data の作成

$data->fromJson($json);

コンテナへのメタデータの追加

Dojo コンポーネントの中には、 dojo.data の中に追加のメタデータを必要とするものもあります。 たとえば dojox.grid.Grid は、データを動的に dojox.data.QueryReadStore から取得することができます。 ページ移動を正しく行うには、返されるデータの中に numRows というキーのデータ (中身はクエリが返す行の数) が必要となります。 これによりグリッドが、サーバ側へのリクエストをいつ送ったらいいのか、 そしていつリクエストが不要になるのか (つまり最終ページに達するのがいつなのか) を知ることができるようになります。 このテクニックを使用すると、大規模なデータセットをグリッドに表示させる際に データ全体をいちどに取得する必要はなくなります。

Zend_Dojo_Data では、 このようなプロパティをオブジェクトのメタデータとして設定することができます。 以下の使用例をご覧ください。

// "numRows" を 100 に設定します
$data->setMetadata('numRows', 100);

// 複数の項目をいちどに設定します
$data->setMetadata(array(
    'numRows' => 100,
    'sort'    => 'name',
));

// メタデータの値を調べます
$numRows = $data->getMetadata('numRows');

// すべてのメタデータを取得します
$metadata = $data->getMetadata();

// メタデータを削除します
$data->clearMetadata('numRows');

// すべてのメタデータを削除します
$data->clearMetadata();

高度な使用法

シリアライズ可能なデータコンテナとしての働きだけではなく、 Zend_Dojo_Data にはデータを様々な方法で操作したり 読み込んだりする機能もあります。

Zend_Dojo_Data は、インターフェイス ArrayAccessIterator および Countable を実装しています。 そのため、データコレクションをまるで配列であるかのように使用することができます。

すべてのアイテムは、その identifier フィールドを用いて参照します。 identifier は一意でなければならないので、 この値を使用すればレコードを特定できるのです。 参照する方法には、getItem() メソッドを使用するものと配列表記を使用するものの 2 通りがあります。

// getItem() を使用します
$item = $data->getItem('foo');

// あるいは配列表記を使用します
$item = $data['foo'];

identifier がわかれば、それを使用してアイテムを取得したり、 あるいは更新したり削除したり作成したり調べたりすることができます。

// アイテムの更新あるいは作成
$data['foo'] = array('title' => 'Foo', 'email' => 'foo@foo.com');

// アイテムの削除
unset($data['foo']);

// アイテムの確認
if (isset($data[foo])) {
}

すべてのアイテムをループ処理することもできます。 内部的には、すべてのアイテムは配列として格納されています。

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

count で、アイテムの総数を調べることも可能です。

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

また、このクラスは __toString() を実装しているので、 JSON への変換は単に echo するか文字列にキャストするだけで可能です。

echo $data; // JSON 文字列として echo

$json = (string) $data; // 文字列へのキャスト == JSON へのキャスト

使用可能なメソッド

上で説明したインターフェイスを実装するのに必要なメソッドに加えて、 次のメソッドが使用可能です。

  • setItems($items): 複数のアイテムを一度に設定し、 それまでそのオブジェクトに設定されていたアイテムをすべて上書きします。 $items は、配列あるいは Traversable オブジェクトでなければなりません。

  • setItem($item, $id = null): 個別のアイテムを設定し、オプションで明示的に identifier を渡します。 それまでにコレクション内にあったアイテムは上書きされます。 アイテムとして指定できるのは、連想配列、あるいは toArray() を実装したオブジェクト、 あるいは public プロパティを持つそれ以外のオブジェクトです。

  • addItem($item, $id = null): 個別のアイテムを追加し、オプションで明示的に identifier を渡します。 コレクション内にそのアイテムが既に存在する場合は例外が発生します。 アイテムとして指定できるのは、連想配列、あるいは toArray() を実装したオブジェクト、 あるいは public プロパティを持つそれ以外のオブジェクトです。

  • addItems($items): 複数のアイテムを一度に追加し、 それを任意のアイテムに追記します。新しく追加するアイテムの中に、 コレクション内の既存のアイテムの identifier と一致するものがある場合は例外が発生します。 $items は、配列あるいは Traversable オブジェクトでなければなりません。

  • getItems(): すべてのアイテムを、配列の配列形式で取得します。

  • hasItem($id): 指定した identifier のアイテムがコレクション内に存在するかどうかを調べます。

  • getItem($id): 指定した identifier のアイテムをコレクションから取得します。 返されるアイテムは連想配列となります。 マッチするアイテムがない場合は、null 値を返します。

  • removeItem($id): 指定した identifier のアイテムをコレクションから削除します。

  • clearItems(): コレクション内のすべてのアイテムを消去します。

  • setIdentifier($identifier): コレクション内の各アイテムの一意な識別子 (identifier) をあらわすフィールドの名前を設定します。

  • getIdentifier(): identifier フィールドの名前を取得します。

  • setLabel($label): アイテムの表示用ラベルとして使用するフィールドの名前を設定します。

  • getLabel(): ラベル用フィールドの名前を取得します。

  • toArray(): オブジェクトを配列にキャストします。 配列には、最低限 'identifier' と 'items' というキーが含まれ、オブジェクトにラベルフィールドが設定されている場合は 'label' というキーも含まれます。

  • toJson(): オブジェクトを JSON 表現にキャストします。

Previous Next
Introduction to Zend Framework
概要
インストール
Zend_Acl
導入
アクセス制御の洗練
高度な使用法
Zend_Amf
導入
Zend_Amf_Server
Zend_Application
導入
Zend_Application Quick Start
Theory of Operation
Examples
コア機能
利用できるリソースプラグイン
Zend_Auth
導入
データベースのテーブルでの認証
ダイジェスト認証
HTTP 認証アダプタ
LDAP 認証
Open ID 認証
Zend_Cache
導入
キャッシュの仕組み
Zend_Cache のフロントエンド
Zend_Cache のバックエンド
Zend_Captcha
導入
Captcha の方法
CAPTCHA アダプタ
Zend_CodeGenerator
導入
Zend_CodeGeneratorサンプル
Zend_CodeGeneratorリファレンス
Zend_Config
導入
動作原理
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
導入
Getopt の規則の宣言
オプションおよび引数の取得
Zend_Console_Getopt の設定
Zend_Controller
Zend_Controller クイックスタート
Zend_Controller の基本
フロントコントローラ
リクエストオブジェクト
標準のルータ
ディスパッチャ
アクションコントローラ
アクションヘルパー
レスポンスオブジェクト
プラグイン
モジュラーディレクトリ構造の規約の使用
MVC での例外
以前のバージョンからの移行
Zend_Currency
Zend_Currency について
通貨の操作方法
以前のバージョンからの移行
Zend_Date
導入
動作原理
基本メソッド
Zend_Date API の概要
日付の作成
日付関数全般用の定数
動作例
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
導入
Zend_Debug
変数の出力
Zend_Dojo
導入
Zend_Dojo_Data: dojo.data エンベロープ
Dojo ビューヘルパー
Dojoフォーム要素とデコレーター
Zend_Dom
導入
Zend_Dom_Query
Zend_Exception
例外の使用法
Zend_Feed
導入
フィードの読み込み
ウェブページからのフィードの取得
RSS フィードの使用
Atom フィードの使用
単一の Atom エントリの処理
フィードおよびエントリの構造の変更
独自のフィードクラスおよびエントリクラス
Zend_File
Zend_File_Transfer
Zend_File_Transfer 用のバリデータ
Filters for Zend_File_Transfer
以前のバージョンからの移行
Zend_Filter
導入
標準のフィルタクラス群
フィルタチェイン
フィルタの書き方
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Zend_Form クイックスタート
Zend_Form_Element を用いたフォーム要素の作成
Zend_Form によるフォームの作成
Zend_Form_Decorator による独自のフォームマークアップの作成
Zend Framework に同梱されている標準のフォーム要素
Zend Framework に同梱されている標準のデコレータ
Zend_Form の国際化
Zend_Form の高度な使用法
Zend_Gdata
導入
AuthSub による認証
Using the Book Search Data API
ClientLogin による認証
Google Calendar の使用法
Google Documents List Data API の使用法
Using Google Health
Google Spreadsheets の使用法
Google Apps Provisioning の使用法
Google Base の使用法
Picasa Web Albums の使用法
YouTube Data API の使用法
Gdata の例外処理
Zend_Http
導入
Zend_Http_Client - 高度な使用法
Zend_Http_Client - 接続アダプタ
Zend_Http_Cookie および Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
導入
Zend_Json
導入
基本的な使用法
Zend_Json の高度な使用法
XML から JSON への変換
Zend_Json_Server - JSON-RPCサーバー
Zend_Layout
導入
Zend_Layout クイックスタート
Zend_Layout の設定オプション
Zend_Layout の高度な使用法
Zend_Ldap
導入
Zend_Loader
ファイルやクラスの動的な読み込み
The Autoloader
Resource Autoloaders
プラグインのロード
Zend_Locale
導入
Zend_Locale の使用法
正規化および地域化
日付および時刻の扱い
サポートするロケール
以前のバージョンからの移行
Zend_Log
概要
ライター
フォーマッタ
フィルタ
Zend_Mail
導入
SMTP 経由での送信
SMTP 接続による複数のメールの送信
異なる転送手段の使用
HTML メール
ファイルの添付
受信者の追加
MIME バウンダリの制御
追加のヘッダ
文字セット
エンコーディング
SMTP 認証
セキュアな SMTP トランスポート
メールメッセージの読み込み
Zend_Measure
導入
計測値の作成
計測値の出力
計測値の操作
計測値の型
Zend_Memory
概要
メモリマネージャ
メモリオブジェクト
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_Navigation
Introduction
画面
Containers
Zend_OpenId
導入
Zend_OpenId_Consumer の基本
Zend_OpenId_Provider
Zend_Paginator
導入
使用法
設定
高度な使用法
Zend_Pdf
導入
PDF ドキュメントの作成および読み込み
PDF ドキュメントへの変更内容の保存
ページの操作
描画
ドキュメントの情報およびメタデータ
Zend_Pdf モジュールの使用例
Zend_ProgressBar
Zend_ProgressBar
Zend_Reflection
導入
Zend_Reflectionサンプル
Zend_Reflectionリファレンス
Zend_Registry
レジストリの使用法
Zend_Rest
導入
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
概要
インデックスの構築
インデックスの検索
クエリ言語
クエリ作成用の API
文字セット
拡張性
Java Lucene との相互運用
応用
ベストプラクティス
Zend_Server
導入
Zend_Server_Reflection
Zend_Service
導入
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Amazon_Ec2
Zend_Service_Amazon_Ec2: Instances
Zend_Service_Amazon_Ec2: Windows Instances
Zend_Service_Amazon_Ec2: Reserved Instances
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Machine Images (AMI)
Zend_Service_Amazon_Ec2: Elastic Block Stroage (EBS)
Zend_Service_Amazon_Ec2: Elastic IP Addresses
Zend_Service_Amazon_Ec2: Keypairs
Zend_Service_Amazon_Ec2: Regions and Availability Zones
Zend_Service_Amazon_Ec2: Security Groups
Zend_Service_Amazon_S3
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
導入
Zend_Service_StrikeIron
Zend_Service_StrikeIron: バンドルされているサービス
Zend_Service_StrikeIron: 応用編
Zend_Service_Technorati
Zend_Service_Twitter
Zend_Service_Yahoo
Zend_Session
導入
基本的な使用法
高度な使用法
グローバルセッションの管理
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDLアクセッサ
自動検出
Zend_Tag
Introduction
Zend_Tag_Cloud
Zend_Test
導入
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
導入
Zend_TimeSync の動作
Zend_Tool_Framework
Introduction
Using the CLI Tool
Architecture
Creating Providers to use with Zend_Tool_Framework
Shipped System Providers
Zend_Tool_Project
Zend_Tool_Project導入
Create A Project
Zend Tool Project Providers
Zend_Translate
導入
Zend_Translate のアダプタ
翻訳アダプタの使用法
以前のバージョンからの移行
Zend_Uri
Zend_Uri
Zend_Validate
導入
標準のバリデーションクラス群
バリデータチェイン
バリデータの書き方
検証メッセージ
Zend_Version
Zend Framework のバージョンの取得
Zend_View
導入
コントローラスクリプト
ビュースクリプト
ビューヘルパー
Zend_View_Abstract
以前のバージョンからの移行
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
導入
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Zend Framework のシステム要件
導入
Zend Framework PHP 標準コーディング規約
概要
PHP ファイルの書式
命名規約
コーディングスタイル
Zend Framework Performance Guide
導入
クラスの読み込み
Zend_Dbパフォーマンス
国際化(i18n)とローカライズ(l10n)
ビューのレンダリング
著作権に関する情報