Ethnaでアプリを作ってみましょう。

Ethnaでアプリを作ってみましょう。

書いた人：itoh@http://www.itt-web.net/bwiki/index.html サンプルダウンロード

私がEthnaで実際にアプリを作る時にこうやるなーって現時点での感じです。サンプルもダウンロードで来ます。表示はWindows風味になっていますがもちろんUnix系でも問題ないです。

今回は、ニュース更新スクリプトを書きます。要件は

• 表画面から新着順にニュースが表示される
• 管理画面からニュースの編集が出来る
• 公開日時と掲載終了日時を設定できて、その期間のみ表示

プロジェクトを作る

適当なところに作ります。

C:\...\Ethna\bin>php generate_project_skelton.php ittsample sample1

最初、適当なところに作ってしまっても移動させる際には、あとでエントリポイント(index.php)をの2行目のincludeのパスをちゃんと設定すれば問題ありません。

ライブラリを整える

Ethnaアプリがが必要とするライブラリを整えます。include_pathに置けばいいのですが、私はEthnaアプリのlibに入れています。つまり今回の場合だと、sample1/libになります。入れるのは

• Ethna本体
• Smarty
• PEAR::DB

です。

DB設計をして、DB設定をして、AppObjectを作成してマネージャに登録

AppObject生成スクリプトがあるので、DBテーブルを先に作っておきます。使ったSQLはschema/に入れておきます。今回は、ethna_sampleというDBにsample1_newsというテーブルを作りました。

DB設定は、DSNをsample1/etc/sample1-ini.phpに記述します。

'dsn' => 'mysql://mysqluserid:mysqluserpassword@mysqlhostname/mysqldbname' ,

という感じです。

で、AppObjectを作ります。sample1/bin/にディレクトリ移動して

C:\...\sample1\bin>php generate_app_object.php sample1_news

でオッケーです。この時、AppManagerとAppObjectを記述したファイルはsample1/libにできるのですが、私はlibには「PEARなど汎用的なもの」を入れることにしているんので、sample1/appに移動させています。

できたSample1_Sample1Newsクラスには、auto_incrementな要素に

seq => true ,

を入れておきます。また、今後のアクションの追加でActionClassで簡単に使えるようにするために、Sample1_ControllerにManagerを登録しておきます。また、また、Sample_Controller.phpにこのマネージャクラスのファイルをincludeさせる必要があります。sample1/app/Sample1_Controller.phpに

include_once 'Sample1_Sample1News.php' ;
class Sample1_Controller extends Ethna_Controller
{
........
	 *	@var	array	マネージャ一覧
	 */
	var $manager = array(
						 'news' => 'Sample1News' )}

としておきます。

アクションの追加

私はデータを入れたいので管理画面から作ります。で、ActionClassを作ります。sample1/bin/にディレクトリ移動して

C:\...\sample1\bin>php generate_action_script.php admin_news

とすると、sample1/app/action/Admin/News.phpが出来ています。

アクションフォームの追加

このファイルのアクションフォームクラスのSample1_Form_AdminNewsに、表画面で作りたいフォーム要素のプロパティを登録します。詳しくは、ダウンロードサンプルをご覧下さい。

テンプレートの作成

ここまで追加したら、デフォルトでは、sample1/tempates/ja/admin/news.tplが必要になります。ここに、先ほどActionFormに追加したフォーム要素を具体的にデザイン配置していきます。 この時、一つ一つ

<input type="text" name="n_title" value="{$form.n_title}" size="20" id="n_title">

とか書いてもいいのですが、typeとかnameとかvalueの属性はActionFormで定義されているものです。そこで、Smartyプレースホルダを使います。Smarty関数を登録するだけです。藤本さんのサンプルを拡張したものがあるので、それをsample1/appディレクトリに置き、Sample1_Controllerクラスでincludeさせます。また、このSmarty関数をSample1_Controllerクラス内の所定の場所で登録します。

include_once('Sample1_SmartyPlugin.php');
....
	/**
	 *	@var	array	smarty function定義
	 */
	var $smarty_function_plugin = array(
   		'smarty_function_form_name',
   		'smarty_function_form_input',
			);

これを登録することで、テンプレート中で、

{form_input name="n_title" attr=" size='20' id='n_title' "}

とすることで、先ほどのタグと同じ効果が得られます。

テキストフォームではあまり効果がありませんが、一番強力なのはセレクトタブの選択タブを自動作成する時に便利です。ActionClassのコンストラクタでセレクトタブのオプションを動的に定義したりするときには必須です。

とりあえず、チェック

ココまできたら、とりあえずチェックします。sample1/www/index.phpをコピーして、自分の好きなDocumentRootのところにもって行ってください。ダウンロードサンプルではpublic_html/sample1/index.phpとしました。それがSample1_Controller.phpを適切にincludeできるようにパスを調整する必要があります。ダウンロードサンプルの場合は、

include_once('../../include/sample1/app/Sample1_Controller.php');
Sample1_Controller::main('Sample1_Controller', 'index');

となっています。このindex.phpにアクセスして表示されるかどうかチェックします。

http://localhost/ittsample/public_html/sample1/

ではEthnaデフォルトのIndexページなので、先ほど作ったActionClassを呼ぶには

http://localhost/ittsample/public_html/sample1/?action_admin_news=1

とします。

次のアクションに繋げる

テンプレートに

<form action="" method="POST">
<input type="hidden" name="action_admin_news_do" value="1">

と書くことで、次のアクションを決めます。*1

そこで、

C:\...\sample1\bin>php generate_action_script.php admin_news_do

として、ActionClass/ActionFormのスクリプトを追加します。

Doのアクションは前のアクションを引き継ぐ

Doのアクションを定義する際には、前のアクションがあっての事なので、前のアクションを継承するように作った方が何かと便利なことが多いです。 コード的にはActionFormを

require_once dirname(__FILE__).'.php'
class Sample1_Form_AdminNewsDo extends Sample1_Form_AdminNews
{
}

として、前のアクションの完全なコピーに。ActionClassも

class Sample1_Action_AdminNewsDo extends Sample1_Action_AdminNews
{
	function Sample1_Action_AdminNewsDo(&$ctl){
		parent::Sample1_Action_AdminNews(&$ctl);
	}
....
}

としてやることで、ActionFormの定義を二度書きせずに済みます。

Doのアクションの具体的処理

Ethnaのチュートリアルにもあるように、prepareメソッドでフォーム値のチェックを行い、performで実働処理をします。

performでの処理は、AppObjectを使うことで極めて簡単に処理できます。 具体的処理は、ソースを見てもらうとして、ポイントは、

• データのプライマリIDがあればUPDATE処理、無ければADD処理
• importFormを継承してそのオブジェクトに適した形にする かなと思います。後者は、Sample1_Sample1Newsクラスを見てみてください。Formから投稿された時点では「公開日」「掲載終了日」は文字列ですからunixtimestampに直してからimportFormしてやる必要があります。

exportFormを使う

逆に、投稿した記事を編集したい場合は、

http://localhost/ittsample/public_html/sample1/?action_admin_news=1&nid=3  

とかにアクセスします。それだけだと、フォームの中身は空のままなので、ActionFormにnid=3の時の値を入れてやります。そのメソッドがexportFormです。

Sample1_Sample1AdminNews::prepare()で、AppObjectを取得して行います。*2

if($this->af->get('nid')){
   $news =& new Sample1_Sample1News(&$this->backend, array('nid'), array($this->af->get('nid')));
   $news->exportForm();
}

だけです。スゴくお手軽ですね。 ただし、この時「公開日」「掲載終了日」はunixtimestampから文字列に直してからexportFormしてやる必要があります。

表で一覧を出す

これでデータが投稿できるようになったので、表面で一覧を出します。

C:\...\sample1\bin>php generate_action_script.php news

で、sample1/app/action/News.phpを編集します。表面では、フォームは必要ないので特に定義しません。その代わり、投稿されたニュースを複数持ってくるという作業が必要になります。これは、Sample1_Sample1News::perform()メソッドで行います

ただし、ActionClassではあくまでActionだけを書きたいので、実際の処理はManagerに任せます。そのため、performには

$news = $this->news->getValidNews();
$this->af->setApp('news', $news);

とだけ書いて、テンプレート側に値を渡してやるだけになります。*3

Managerの仕事

ActionClassは「状態の遷移を決めるだけ」ということにしたいので、面倒な処理はManagerクラスに任せます。実は、Manager*4に任せると、データキャッシュを行っているので、ActionClassで状態の遷移を決めるために取得した値は、ViewClassでテンプレートに渡したい値だった場合にはDBに再問い合わせをせずに済みます。ただし、もちろん「同じQUERYになる場合」です。

authenticateメソッドで権限管理

普通、管理者でないと投稿や投稿記事の編集はできません。EthnaではActionClassのauthenticateメソッドを使うことで楽に権限管理ができます。今回は、権限管理として簡単にBasic認証を使ったと仮定します。./adminディレクトリには、Basic認証がかかってるとします。

エントリポイントの変更

./admin/index.phpにエントリポイントを変更します。もともと2行だけのエントリポイントなので特に苦労することはありませんが、

Sample1_Controller::main('Sample1_Controller', 'admin_news');

としておくと、ここにアクセスした時に、デフォルトのアクションがadmin_newsとなり便利です。

そして、Sample1_Action_AdminNewsクラスのauthenticateメソッドを

	function authenticate(){
		if(!preg_match('/admin/', $_SERVER['SCRIPT_NAME'])){
			exit();
		}
	}

としてやります。こうすることで、さきほどのエントリポイントからはアクセスが出来なくなります。なお、admin_news_doアクションにも自動的にこのauthenticateが引き継がれます。