Documentation

導入 - Zend_Gdata

導入

注意:このドキュメントでは、英語版のリビジョン 22744 の更新内容をスキップしています。

Google Data API は、Google のオンラインサービスに対するプログラマ向けのインターフェイスです。 Google data Protocol は » Atom Publishing Protocol に基づいており、クライアントアプリケーションからのデータの問い合わせ、 データの投稿、更新、削除などを標準の HTTP と Atom syndication formation で行います。 Zend_Gdata コンポーネントは PHP 5 用のインターフェイスで、Google Data に PHP からアクセスするためのものです。 Zend_Gdata コンポーネントは、Atom Publishing Protocol を実装したその他のサービスへのアクセスもサポートしています。

Google Data API についての詳細な情報は » http://code.google.com/apis/gdata/ を参照ください。

Zend_Gdata でアクセスできるサービスには次のようなものがあります。

  • Google Calendar は、オンラインカレンダーアプリケーションです。

  • Google Spreadsheets は、オンラインで共同作業を行えるスプレッドシートツールです。 アプリケーションで使用するデータの保存場所としても使用できます。

  • Google Documents List は、その Google アカウントに保存されているすべてのスプレッドシートやワープロ文書、 プレゼンテーションの一覧を取得します。

  • Google Provisioning は、Google Apps がホストするドメイン上の ユーザアカウントやニックネーム、グループ、そしてメーリングリストの 作成、取得、更新、削除を行うものです。

  • Picasa Web Albums は、オンラインの写真共有アプリケーションです。

  • Google Analytics は、訪問者統計アプリケーションです。

  • » Google Blogger は、人気のあるインターネットプロバイダです。 "ボタンひとつで簡単に" 記事を配信できます。

  • Google CodeSearch を使用すると、さまざまなプロジェクトが公開しているソースコードを検索できます。

  • Google Notebook は、メモ帳の内容を一般に公開できます。

Note: サポートしていないサービス
Zend_Gdata には、これら以外の Google のサービス (例えば検索、Gmail、翻訳、マップなど) に対するインターフェイスは含まれていません。 Google Data API をサポートしているサービスにのみ対応しています。

Zend_Gdata の構造

Zend_Gata は、いくつかの型のクラスを組み合わせたものです。

  • サービスクラス - これは Zend_Gdata_App を継承したものです。 Zend_GdataZend_Gdata_Spreadsheets といったその他のクラスもここに含まれます。 これらのクラスは APP や GData サービス とのやり取りを行うもので、 フィードを取得したりエントリを取得したり、 あるいはエントリを投稿したり更新したり削除したりといったことができます。

  • クエリクラス - これは Zend_Gdata_Query を継承したものです。 各サービス専用のクラス、たとえば Zend_Gdata_Spreadsheets_ListQueryZend_Gdata_Spreadsheets_CellQuery もここに含まれます。 クエリクラスは、GData サービスからデータを取得するためのクエリを作成するものです。 setUpdatedMin()setStartIndex()、そして getPublishedMin() といったメソッドが存在します。 クエリクラスには、出来上がったクエリの URL を生成するためのメソッド getQueryUrl もあります。 また、 getQueryString() メソッドを使用すると、URL のクエリ文字列部分を取得できます。

  • フィードクラス - これは Zend_Gdata_App_Feed を継承したものです。 Zend_Gdata_FeedZend_Gdata_Spreadsheets_SpreadsheetFeedZend_Gdata_Spreadsheets_ListFeed といったその他のクラスもここに含まれます。 これらのクラスはサービスから取得したエントリのフィードを表すものです。 サービスから返されたデータを取得するために使用します。

  • エントリクラス - これは Zend_Gdata_App_Entry を継承したものです。 Zend_Gdata_EntryZend_Gdata_Spreadsheets_ListEntry といったその他のクラスもここに含まれます。 これらのクラスは、サービスから取得したエントリを表すものです。また、 サービスに送信するデータを作成するためにも用います。 エントリのプロパティの値(たとえばスプレッドシートのセルの値など) を設定できるだけでなく、このオブジェクトを使用して 既存エントリの更新や削除のリクエストを送信することもできます。 たとえば $entry->save() をコールすると、変更した内容を元のエントリに書き戻します。また $entry->delete() はそのエントリをサーバから削除します。

  • その他のデータモデルクラス - これは Zend_Gdata_App_Extension を継承したものです。ここには、 Zend_Gdata_App_Extension_Title (atom:title XML 要素を表します) や Zend_Gdata_Extension_When (GData Event "Kind" で使用する gd:when XML 要素を表します)、そして Zend_Gdata_Extension_Cell (Google Spreadsheets で使用する gs:cell XML 要素を表します) といったクラスが含まれます。 これらのクラスは、サービスから取得したデータを保存したり サービスに送信するデータを構築したりするために用いるものです。 プロパティへのアクセス用のメソッドが用意されています。たとえば setText() はその要素の子テキストノードの内容を設定し、 getText() はその要素のテキストノードの内容を取得します。 また getStartTime() は When 要素の開始時刻属性を取得します。 そのほかにも同様のメソッドがあります。 データモデルクラスには、その他のメソッドもあります。 getDOM() は、その要素とすべての子要素を DOM 形式で表したものを返し、 transferFromDOM() は DOM ツリーをもとにしたデータモデルを作成します。

Google サービスの使用法

Google データサービスは、Atom Publishing Protocol (APP) および Atom syndication format に基づいたサービスです。 Zend_Gdata コンポーネントを用いて APP や Google サービスを扱うには、Zend_Gdata_AppZend_Gdata そして Zend_Gdata_Spreadsheets などのサービスクラスを使用する必要があります。 サービスクラスには、サービスからデータのフィードを取得したり 新しいエントリをフィードに挿入したり 既存のエントリを更新したり削除したりといったメソッドがあります。

注意: Zend_Gdata を用いた実際に動作するサンプルプログラムが demos/Zend/Gdata ディレクトリにあります。 このサンプルはコマンドラインで動かすように作られていますが、 ウェブアプリケーション版にも簡単に書き換えられるでしょう。

Zend_Gdata クラスのインスタンスの取得

Zend Framework の命名規約では、すべてのクラスは その存在位置のディレクトリ構造に基づいた名前をつける必要があります。 たとえば Spreadsheets に関する拡張クラスは Zend/Gdata/Spreadsheets/Extension/... 配下に置かれ、 その結果、クラス名は Zend_Gdata_Spreadsheets_Extension_... となります。ということは、スプレッドシートのセル要素のインスタンスを作成しようとしたら、 恐ろしく長い名前をタイプすることになるということです!

ということで、すべてのサービスクラス (Zend_Gdata_AppZend_GdataZend_Gdata_Spreadsheets など) に特別なファクトリメソッドを用意するようにしました。 これを用いることで、データモデルやクエリ、 その他のクラスのインスタンスをより簡単に作成できるようになります。 このファクトリメソッドは、マジックメソッド __call を用いて実装しています。このメソッドで、 $service->newXXX(arg1, arg2, ...) というコールをすべて処理しています。 XXX の値に基づいて、登録されているすべての 'パッケージ' からクラスを探します。 以下に例を示します。

  1. $ss = new Zend_Gdata_Spreadsheets();
  2.  
  3. // Zend_Gdata_App_Spreadsheets_CellEntry を作成します
  4. $entry = $ss->newCellEntry();
  5.  
  6. // Zend_Gdata_App_Spreadsheets_Extension_Cell を作成します
  7. $cell = $ss->newCell();
  8. $cell->setText('My cell value');
  9. $cell->setRow('1');
  10. $cell->setColumn('3');
  11. $entry->cell = $cell;
  12.  
  13. // ... $entry を使用して、Google Spreadsheet の内容を更新します

継承ツリー内にある各サービス用クラス内で、 適切な 'パッケージ' (ディレクトリ) を登録します。 ファクトリメソッドは、これを使用してクラスを探します。

Google Data クライアント認証

ほとんどの Google Data サービスは、 個人データへのアクセスやデータの保存、削除の前に Google サーバに対する認証を要求します。 Google Data の認証用に提供される実装は AuthSub および ClientLogin の二種類があります。 Zend_Gdata ではこれら両方の方式に対するインターフェイスを用意しています。

Google Data サービスに対するその他大半の問い合わせは、 認証を必要としません。

依存性

Zend_GdataZend_Http_Client を用いてリクエストを google.com に送信し、結果を取得します。 ほとんどの Google Data リクエストに対する応答は Zend_Gdata_App_Feed あるいは Zend_Gdata_App_Entry クラスのサブクラスで返されます。

Zend_Gdata は、PHP アプリケーションの稼動しているホストが インターネットに直接つながっていることを想定しています。 Zend_Gdata クライアントは Google Data サーバへの接続を行います。

新しい Gdata クライアントの作成

Zend_Gdata_App クラス、Zend_Gdata クラス、 あるいはそのサブクラスのひとつのオブジェクトを作成します。 各サブクラスではサービス固有のヘルパーメソッドを提供します。

Zend_Gdata_App のコンストラクタに渡すオプションの引数は Zend_Http_Client のインスタンスです。このパラメータを渡さなかった場合は、 Zend_Gdata はデフォルトの Zend_Http_Client オブジェクトを作成します。 これには、プライベートフィードにアクセスするための認証データは設定されていません。 Zend_Http_Client オブジェクトを自分で指定すると、 クライアントオブジェクトに対する設定オプションを指定できます。

  1. $client = new Zend_Http_Client();
  2. $client->setConfig( ...オプション... );
  3.  
  4. $gdata = new Zend_Gdata($client);

Zend Framework 1.7 以降、プロトコルのバージョン管理のサポートが追加されました。 これにより、クライアントおよびサーバで新機能をサポートしつつ、 過去との互換性を保持できるようになります。 ほとんどのサービスはバージョン管理を自前で行う必要はありませんが、 Zend_Gdata のインスタンスを直接作成する場合 (サブクラスを使わない場合) は、必要なプロトコルのバージョンを指定してサーバの機能にアクセスする必要があります。

  1. $client = new Zend_Http_Client();
  2. $client->setConfig( ...オプション... );
  3.  
  4. $gdata = new Zend_Gdata($client);
  5. $gdata->setMajorProtocolVersion(2);
  6. $gdata->setMinorProtocolVersion(null);

認証済みの Zend_Http_Client オブジェクトを作成する方法については、 認証のセクションも参照ください。

共通のクエリパラメータ

パラメータを指定することで、Zend_Gdata での問い合わせをカスタマイズできます。 クエリのパラメータは、 Zend_Gdata_Query のサブクラスを使用して指定します。 Zend_Gdata_Query クラスにはクエリパラメータを設定するメソッドが含まれ、 これを用いて GData サービスにアクセスします。 たとえば Spreadsheets のような個々のサービスでも クエリクラスを用意しており、そのサービスやフィードに合わせた独自のパラメータを定義しています。 Spreadsheets の CellQuery クラスは Cell Feed に対する問い合わせを行い、ListQuery クラスは List Feed に対する問い合わせを行います。 それぞれのフィードに対して別々のパラメータを指定できます。 GData 全体で使用できるパラメータについて、 以下で説明します。

  • q パラメータはテキストのクエリ文字列を指定します。 パラメータの値は文字列となります。

    このパラメータを設定するには setQuery() 関数を使用します。

  • alt パラメータはフィードの形式を指定します。 このパラメータには atomrssjson、 あるいは json-in-script のいずれかを指定します。 このパラメータを指定しなかった場合、デフォルトのフィードの形式は atom となります。 注意: Zend_Gdata で処理できるのは、 atom フィード形式の出力だけであることに注意しましょう。 Zend_Http_Client を使用するとその他の形式のフィードも取得できます。 その際は、Zend_Gdata_Query クラスやそのサブクラスが作成したクエリ URL を使用します。

    このパラメータを設定するには setAlt() 関数を使用します。

  • maxResults パラメータはフィード内のエントリ数を制限します。 整数値を指定します。返されるフィード内のエントリの数は、 この値を超えることはありません。

    このパラメータを設定するには setMaxResults() 関数を使用します。

  • startIndex パラメータは、 フィードで返される最初のエントリの番号を指定します。 それ以前の番号のエントリは読み飛ばされます。

    このパラメータを設定するには setStartIndex() 関数を使用します。

  • updatedMin パラメータおよび updatedMax パラメータは、エントリの日付の範囲を指定します。 updatedMin を指定すると、 それより前に更新されたエントリはフィードに含まれません。 同様に、updatedMax で指定した日付より後で更新されたエントリもフィードに含まれません。

    これらのパラメータには、タイムスタンプを表す数値を指定します。 あるいは 日付/時刻 を表す文字列を指定することもできます。

    これらのパラメータを設定するには setUpdatedMin() および setUpdatedMax() 関数を使用します。

これらの set 関数に対応する get 関数もあります。

  1. $query = new Zend_Gdata_Query();
  2. $query->setMaxResults(10);
  3. echo $query->getMaxResults();   // 10 を返します

Zend_Gdata クラスでは、 特別なゲッターメソッドおよびセッターメソッドも実装しています。 つまり、パラメータの名前をクラスの仮想的なメンバとして扱うことができます。

  1. $query = new Zend_Gdata_Query();
  2. $query->maxResults = 10;
  3. echo $query->maxResults;        // 10 を返します

すべてのパラメータを消去するには resetParameters() を使用します。複数のクエリで Zend_Gdata を使いまわす場合などに便利です。

  1. $query = new Zend_Gdata_Query();
  2. $query->maxResults = 10;
  3. // ...フィードを取得します...
  4.  
  5. $gdata->resetParameters();      // すべてのパラメータを消去します
  6. // ...別のフィードを取得します...

フィードの取得

getFeed() を使用して、指定した URI からフィードを取得します。 この関数は、getFeed の二番目の引数で指定したクラスのインスタンスを返します。 このクラスのデフォルトは Zend_Gdata_Feed です。

  1. $gdata = new Zend_Gdata();
  2. $query = new Zend_Gdata_Query(
  3.         'http://www.blogger.com/feeds/blogID/posts/default');
  4. $query->setMaxResults(10);
  5. $feed = $gdata->getFeed($query);

この後の節で、各 Google Data サービス用のヘルパークラス固有の関数について説明します。これらの関数により、 対応するサービスにあわせた適切な URI からフィードを取得できるようになります。

複数ページのフィードの扱い方

多くのエントリが含まれるフィードを取得した場合、 そのフィードはいくつかの「ページ」に分かれていることがあるかもしれません。 そのような場合には、各ページには次のページへのリンクが含まれることになります。 このリンクにアクセスするには getLink('next') を使用します。 この例は、フィードの次のページを取得する方法を示すものです。

  1. function getNextPage($feed) {
  2.     $nextURL = $feed->getLink('next');
  3.     if ($nextURL !== null) {
  4.         return $gdata->getFeed($nextURL);
  5.     } else {
  6.         return null;
  7.     }
  8. }

もしこのようにページに分かれているのが気に入らない場合は、 フィードの最初のページを Zend_Gdata_App::retrieveAllEntriesForFeed() に渡しましょう。そうすると、 すべてのエントリの内容をひとつのフィードにまとめてくれます。 この関数の使用法を、次の例で示します。

  1. $gdata = new Zend_Gdata();
  2. $query = new Zend_Gdata_Query(
  3.         'http://www.blogger.com/feeds/blogID/posts/default');
  4. $feed = $gdata->retrieveAllEntriesForFeed($gdata->getFeed($query));

大きなフィードに対してこの関数をコールすると、 処理に時間がかかるということに注意しましょう。 set_time_limit()PHP の実行時間制限を拡大する必要があるかもしれません。

フィードやエントリ内のデータの操作

フィードを取得したら、次はそのデータを読み込んだり そこに含まれるエントリを読み込んだりする番です。 これには各データモデルクラスのアクセス用メソッドを使用するか、 あるいはマジックメソッドを使用します。以下に例を示します。

  1. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  2. $gdata = new Zend_Gdata($client);
  3. $query = new Zend_Gdata_Query(
  4.         'http://www.blogger.com/feeds/blogID/posts/default');
  5. $query->setMaxResults(10);
  6. $feed = $gdata->getFeed($query);
  7. foreach ($feed as $entry) {
  8.     // マジックメソッドを使用します
  9.     echo 'Title: ' . $entry->title->text;
  10.     // 定義されているアクセス用メソッドを使用します
  11.     echo 'Content: ' . $entry->getContent()->getText();
  12. }

エントリの更新

エントリを取得したら、それを更新してサーバに保存できます。以下に例を示します。

  1. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  2. $gdata = new Zend_Gdata($client);
  3. $query = new Zend_Gdata_Query(
  4.         'http://www.blogger.com/feeds/blogID/posts/default');
  5. $query->setMaxResults(10);
  6. $feed = $gdata->getFeed($query);
  7. foreach ($feed as $entry) {
  8.     // タイトルに 'NEW' を追加します
  9.     echo 'Old Title: ' . $entry->title->text;
  10.     $entry->title->text = $entry->title->text . ' NEW';
  11.  
  12.     // エントリの内容を更新します
  13.     $newEntry = $entry->save();
  14.     echo 'New Title: ' . $newEntry->title->text;
  15. }

Google サーバへのエントリの送信

Zend_Gdata オブジェクトの関数 insertEntry() にアップロードしたいデータを指定し、 新しいエントリを Google Data サービスに保存します。

各サービス用のデータモデルクラスを使用して適切なエントリを作成し、 Google のサービスに投稿できます。 insertEntry() 関数には、 Zend_Gdata_App_Entry の子クラスに投稿内容を格納して渡します。 このメソッドは Zend_Gdata_App_Entry の子クラスを返します。 これは、サーバから返されたエントリの状態を表します。

もうひとつの方法として、そのエントリの内容を XML 構造の文字列として作成して insertEntry() 関数に渡すこともできます。

  1. $gdata = new Zend_Gdata($authenticatedHttpClient);
  2.  
  3. $entry = $gdata->newEntry();
  4. $entry->title = $gdata->newTitle('Playing football at the park');
  5. $content =
  6.     $gdata->newContent('We will visit the park and play football');
  7. $content->setType('text');
  8. $entry->content = $content;
  9.  
  10. $entryResult = $gdata->insertEntry($entry,
  11.         'http://www.blogger.com/feeds/blogID/posts/default');
  12.  
  13. echo 'この結果のエントリの <id> は、' . $entryResult->id->text;

エントリを送信するには、認証済みの Zend_Http_Client を使用する必要があります。これは、 Zend_Gdata_AuthSub クラスあるいは Zend_Gdata_ClientLogin クラスを使用して作成します。

Google サーバからのデータの削除

方法 1: Zend_Gdata オブジェクトの関数 delete() に削除したいエントリを指定して、Google Data サービスからデータを削除します。 フィードエントリの編集用 URLdelete() メソッドに渡します。

方法 2: あるいは、Google サービスから取得したエントリに対して $entry->delete() をコールすることもできます。

  1. $gdata = new Zend_Gdata($authenticatedHttpClient);
  2. // Google Data のフィード
  3. $feedUri = ...;
  4. $feed = $gdata->getFeed($feedUri);
  5. foreach ($feed as $feedEntry) {
  6.     // 方法 1 - エントリを直接削除します
  7.     $feedEntry->delete();
  8.     // 方法 2 - 編集用 URL を $gdata->delete()
  9.     // に渡してエントリを削除します
  10.     // $gdata->delete($feedEntry->getEditLink()->href);
  11. }

エントリを削除するには、認証済みの Zend_Http_Client を使用する必要があります。これは、 Zend_Gdata_AuthSub クラスあるいは Zend_Gdata_ClientLogin クラスを使用して作成します。

Copyright

© 2006-2021 by Zend by Perforce. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.

Contacts