はじめに
本連載では、PHP上で動作するアプリケーションフレームワークであるZend Frameworkについて紹介していきます。今回は、Zend Frameworkの1.8から導入されたRADのツールのコマンドラインインターフェイスを提供しているZend_Toolモジュールの紹介をします。
Zend_Tool自体は汎用的なツールを書くための枠組みになっていますが、現段階では、コマンドラインからZend Framework MVC プロジェクトを管理するための機能だけが組み込まれています。今回の記事では、このプロジェクトを管理する機能(Zend_Toolではプロバイダと呼びます)を紹介した後で、Zend_Toolの機能を拡張する方法について見ていきたいと思います。
対象読者
PHPの基本構文は一通り理解しているが、フレームワークを利用したことはないという方を対象としています。
必要な環境
Zend FrameworkはPHP 5.2.4以降とWebサーバがインストールされている環境で利用可能です。本稿ではWebサーバとしてApache 2.2を、OSにWindows XPを採用し、アプリケーションを作成していきます。
以下に、今回アプリケーション作成/動作確認に用いた環境を示します(インストールにあたっては最新安定版の使用を推奨します)。各項目の詳細なインストール手順は、「サーバサイド技術の学び舎 - WINGS」より「サーバサイド環境構築設定手順」を参照ください。
- Windows XP SP3
- PHP 5.3.0
- Apache 2.2.12b
LinuxやFreeBSDなどUNIX系OSをお使いの方もコマンドはほぼ一緒ですので、パスなどは適宜読み替えてください。
Zend_Toolの概要
Zend_ToolはZend_Tool_FrameworkクラスとZend_Tool_Projectクラスの2つのクラスからなるモジュールです。Zend_Tool_Frameworkは、主にアプリケーションを管理するツールを作成するための骨組みを提供します(実際は汎用的な枠組みなので、アプリケーションを管理するツールに留まらず、さまざまなアプリケーションを作成することにも利用できます)。
また、Zend_Tool_ProjectクラスはZend_Tool_Frameworkの枠組みを利用してMVCアプリケーションのプロジェクトを管理するための機能を提供するクラスです。Zend_Toolを利用する仕組みは図1のようになっています。
ユーザーから見ての直接のフロントエンドはツーリングクライアントと呼ばれています。このツーリングクライアントはZend Toolモジュールの一部ではなく、Zend_Toolモジュールの機能を利用するための外部プログラムです。
このツーリングクライアントへのインターフェイスを提供するZend_Toolモジュール内部のオブジェクトのことをクライアントと呼びます(ツーリングクライアントとクライアントは別のものですので注意してください)。
実際のサービスを提供するオブジェクトはプロバイダと呼ばれています。次の段階では、クライアントがプロバイダを呼び出して、サービスが提供されます。なお、多くのプロバイダは複数のサービスを提供することができます。その際に提供するサービスのことをアクションと呼びます。
この他にも利用できるクライアントやプロバイダに関する情報を管理するレジストリ、必要に応じてプロバイダやクライアントを作成するローダなどが存在します。また、このレジストリに登録されている情報のことをマニフェストと呼びます。
例えば、MVCアプリケーションのスケルトンを作成するために「zf.bat create project codezine」を実行したとしましょう。その場合は、
- ユーザーから命令を受ける「zf.bat」とその下請けの「zf.php」がツーリングクライアント
- zf.phpに対応する窓口「Zend_Tool_Framework_Client_Consoleクラス」がクライアント
- そこから「Projectプロバイダ」を提供する「Zend_Tool_Project_Provider_Projectクラス」がプロバイダ
- その「Zend_Tool_Project_Provider_Projectクラス」の「createアクション」に引数「codezine」が渡され、実際の作業を行う
という流れになっています。
このように、機能を提供するプロバイダとインターフェイスを提供するクライアントとが分かれているので、同じインターフェイスからさまざまな機能を呼び出したり、逆に一旦実装した機能を異なるインターフェイスから共通して利用することができます
それでは、まず順番に標準で添付されているプロバイダの紹介をしたいと思います。