はじめに
本連載では、PHP上で動作するアプリケーションフレームワークであるZend Frameworkについて紹介していきます。今回はAdobe Flash Player(以下、Flash)とZend Frameworkの橋渡しをするモジュール、Zend_Amfの紹介をします。
Zend_AmfのAMFはAction Message Formatの略で、Flashとサーバとの間で情報のやりとりをするためのフォーマットです。Zend_Amfを利用すれば、手軽にFlashからのリクエストを受けたり、処理の結果を返したりできます。
対象読者
PHPの基本構文は一通り理解しているが、フレームワークを利用したことはないという方を対象としています。
必要な環境
Zend FrameworkはPHP 5.2.3以降とWebサーバがインストールされている環境で利用可能です。本稿ではWebサーバとしてApache 2.2を、OSにWindows XPを採用し、アプリケーションを作成していきます。
以下に、今回アプリケーション作成/動作確認に用いた環境を示します(インストールにあたっては最新安定版の使用を推奨します)。各項目の詳細なインストール手順は、「サーバサイド技術の学び舎 - WINGS」より「サーバサイド環境構築設定手順」を参照ください。
- Windows XP SP2
- PHP 5.2.8
- Apache 2.2.11
LinuxやFreeBSDなどUNIX系OSを使用している方もコマンドはほぼ一緒ですので、パスなどは適宜読み替えてください。
また、今回の記事ではFlex 3 SDKを利用してFlashのサンプルを作成しました。Flex 3 SDKのインストール方法については、改めて後述します。
なお、Flashアプリの開発については本稿の範囲を越えてしまいますのでここでは扱いません。こちらについてはアドビのサイトにあるチュートリアルが参考になると思います。このチュートリアルは、基本的にはFlexのための統合開発環境であるFlex Builderの利用を前提にした、Flashアプリの開発についての解説になっています。
本稿で使っているFlex 3 SDKを用いたアプリの開発については、英語での解説になりますが、Adobe - Flex Developer Center: Quick Startsが参考になります。
Zend_Amfの動作
Zend_AmfはFlashからのリクエストを処理するモジュールです。今回はFlashからのテキスト受け取り、そのテキストに現在の時刻をあわせて返すサンプルを作成することについて考えてみます。そのために、まずFlashとZend_Amfの間での情報のやりとりの流れから見ていきましょう。
Flashからのリクエストを実際に処理するのはZend_Amf_Server
クラスのオブジェクトです。Flashから送られて来たリクエストを受け取り(図1(1))、リクエストを解析し適切なメソッドを選び(図1(2))、そのメソッドによる処理の結果をFlashへ返します(図1(3))。
実際に処理を行うのはメソッドは、通常はZend_Amf_Server
に登録された外部のものです。図1に対応する処理の流れをコード風に表現するとリスト1のようになります。
$server = new Zend_Amf_Server(); //(0)実際に処理をするメソッドの登録 $server->addFunction('関数1'); $server->addFunction('関数2'); ... //(1)(2)リクエストの解析と実際の処理 $result = $server->handle(); //(3)処理の結果を返す echo $result;
なお、Zend_Amf_Server
のメソッドのうち、主なものを先に紹介しておきます。
分類 | メソッド名 | 引数 | 説明 |
登録 | setClass | $class, $namespace, $argv | $classはクラス名ないしオブジェクトで、$classのメソッド全てをAMFを処理するメソッドとして登録する。$namepsaceはAMFから呼び出される際のネームスペース。$argvは$functionが呼び出された場合に追加される引数。$namespace、$argvは省略可能。 |
addFunction | $function, $namespace,... | $functionは追加したいメソッドの名前ないしコールバック関数。$namespaceはAMFから呼び出される際のネームスペース。それ以降に引数があった場合には、それらの引数は$functionが呼び出された場合に引数に追加される。$namespace以降は省略可能。 | |
addDirectory | $dir | 登録したメソッドを含むクラスの定義ファイルが格納されているディレクトリ$dirを追加する。 | |
getDirectory | (なし) | メソッドが格納されているディレクトリを配列で返す。 | |
getFunctions | (なし) | 登録されているメソッドの配列を返す。 | |
listMethods | (なし) | 登録されているメソッドの名前の配列を返す。 | |
実行 | handle | $request | クライエントから受け取ったAMFを処理する。引数の$requestは省略可能で、その場合の値はnull。 |
その他 | setClassMap | $asClass, $phpClass | アクションスクリプト(Flashアプリ側のソースファイル)のクラス$asClassとPHPのクラス$phpClassを対応づける。 |
setProduction | $flag | 製品版モード(エラーがあっても無闇に出力しないモード)にする。 | |
isProduction | (引数なし) | 製品版モードになっているかを返す。 |