add to hatena

hatena.comment

add to del.icio.us

add to livedoor.clip

add to Yahoo!Bookmark

(0) Total: 0

DAY3: MVCアーキテクチャ

おさらい

２日目でデータモデルに基づいたモデルクラスの作成方法と、フォームモデルの作成方法について簡単に行ってみました。
３日目ではsymfonyのアーキテクチャについて理解していきましょう。

その中でsymfonyのアプリケーション、モジュール、アクションという概念を理解しておく必要があるので、Definitive Guideを読んでおいてください。

ref: コントローラー層について
ref: 日本語版(1.1)

MVCモデル

最初はsymfonyのMVC構造をみてみましょう。
symfonyはMVC構造をもつフレームワークであることは最初に説明したとおりで、簡単にしか説明していませんでしたね。

データに関する操作はページを表示する操作とはまったく別モノになっています。そしてデータ操作に関するものがModelとして
./lib/model/以下のディレクトリに配置されます。そして、ページ表示に関する操作はViewとして./app/<アプリケーション名>/modules/<モジュール名>/templatesに配置されます。
そしてこれらを結びつける役割をするのがControllerで./app/<アプリケーション名>/modules/<モジュール名>/actions/に配置されます。

詳しいことは以下のページで理解してください。
ref: 02-Exploring-Symfony-s-Code
ref: symfonyのコードを探求する

レイアウトを変更する

symfonyのテンプレートはヘッダーやフッターなどを共通化できるように、レイアウトテンプレートとその中のコンテンツ部分のテンプレートの２つで構成されています。

ここではそのレイアウトテンプレートをみてみましょう。レイアウトは./app/frontend/templates/layout.phpになります。

$ more ./apps/frontend/templates/layout.php

PHP:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<?php include_title() ?>
<link rel="shortcut icon" href="/favicon.ico" />
</head>
<body>
<php echo $sf_content ?>
</body>
</html>

見て解るように$sf_contentが各コンテンツのテンプレートを出力する部分になります。それ以外はヘッダーやフッター部分が何もありません。

そして、このページに２つのスタイルシートを外部ファイルで適用したいとします。

./web/css/main.css
./web/css/layout.css

方法は２つあります。１つは設定ファイルで記述する方法。もう１つはview.ymlという設定ファイルで指定する方法で、
もう１つはテンプレート内で

use_stylesheet('スタイルシート名')

のように指定する方法です。

本家チュートリアルではview.ymlで設定するようにしていますが、あえてその方法を行わずに
layout.phpにてスタイルシートをヘルパ関数で読み込むようにします。

これにも理由があります。
それは、わざわざymlに分離して設定しなくても、layout.phpで一元管理できるからです。
例えば、デザイナーと共同作業で、デザイナー側がスタイルシート名を追加、変更したい場合に
layout.phpだけで対応できたほうが解りやすいですよね？

というわけで、本チュートリアルではview.ymlで設定せずにlayout.phpを使うようにしています。

PHP:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<?php echo include_http_metas() ?>
<?php echo include_metas() ?>
<?php use_stylesheet('main') ?>
<?php use_stylesheet('layout') ?>
<?php echo include_title() ?>
<link rel="shortcut icon" href="/favicon.ico" />
</head>
<body>
<div id="header">
<ul>
<li><?php echo link_to('about', '@homepage') ?></li>
</ul>
<h1><?php echo link_to(image_tag('askeet_logo.gif', 'alt=askeet'), '@homepage') ?></h1>
</div>
<div id="content">
<div id="content_main">
<?php echo $sf_content ?>
<div class="verticalalign"></div>
</div>
<div id="content_bar">
<div class="verticalalign"></div>
</div>
</div>
</body>
</html>

また、ここで利用しているlayout.css, main.cssは
http://svn.1ms.jp/public/symfony/askeet12/release_day_3/web/cssからダウンロードできます。

そして、次のページにアクセスしてスタイルシートが適用されていることを確認します。

http://symfony.centos5.localhost/askeet/question

環境について

symfonyでは動作環境を複数設定しておくことができます。
たとえば、本番環境(prod),開発環境(dev),検証環境(test)などです。

では、これらの個別に設定した環境は動作時にどうやって指定しているのでしょうか？

それは、symfonyでアプリケーションを作成したときに作成されるコントローラーのファイル名が
_dev.phpで終わっている場合、そのコントローラーで表示させると開発環境として動作します。
コントローラーファイルは./web/ディレクトリに作成されるファイルです。

ファイルの中を見れば環境名を指定しているのがわかります。

また、index.phpというファイルが一番最初に作成されます。
これは設定でコントローラー名を省略する設定「no_script_name」を指定した場合に利用されるコントローラーです。

今は深く考えずに、環境が複数設定でき、それらはコントローラーファイルを変更することで対応できることを覚えておきましょう。

標準のhomepageのルーティングルールを再定義する

ルーティングについては下記で理解しておいてください。

ref: Links And The Routing System
ref: リンクとルーティングシステム

現在のルーティング設定は標準のままのため、設定を変更しておきましょう。

C:

homepage:
url: /
param: { module: question, action: index }

本家チュートリアルではactionがlistになっていますが、symfony1.2ではlistアクションはindexアクションで実装されているので
indexアクションを指定しておきましょう。

テストデータの作成

本家チュートリアルと同じテストデータを作成してみます。
ただし、ファイル名は複数存在した場合は名前順で読み込まれることを考慮し、先頭に番号をいれておきます。

./data/fixtures/test/001.user.yml
./data/fixtures/test/002.question.yml
./data/fixtures/test/003.interest.yml

ここではルールとしてリレーションの関係で読み込ませたい順番が存在すると思います。
そこで、ファイルの先頭に数字をつけておくようにしておきます。

各ファイルは以下のようになります。

./data/fixtures/test/001.user.yml

C:

User:
anonymous:
nickname: anonymous
first_name: Anonymous
last_name: Coward
fabien:
nickname: fabpot
first_name: Fabien
last_name: Potencier
francois:
nickname: francoisz
first_name: François
last_name: Zaninotto

./data/fixtures/test/002.question.yml

C:

Question:
q1:
title: What shall I do tonight with my girlfriend?
User: fabien
body: |
We shall meet in front of the Dunkin'Donuts before dinner,
and I haven't the slightest idea of what I can do with her.
She's not interested in programming, space opera movies nor insects.
She's kinda cute, so I really need to find something
that will keep her to my side for another evening.
q2:
title: What can I offer to my step mother?
User: anonymous
body: |
My stepmother has everything a stepmother is usually offered
(watch, vacuum cleaner, earrings, del.icio.us account).
Her birthday comes next week, I am broke, and I know that
if I don't offer her something sweet, my girlfriend
won't look at me in the eyes for another month.
q3:
title: How can I generate traffic to my blog?
User: francois
body: |
I have a very swell blog that talks
about my class and mates and pets and favorite movies.

./data/fixtures/test/003.interest.yml

C:

Interest:
i1: { User: fabien, Question: q1 }
i2: { User: francois, Question: q1 }
i3: { User: francois, Question: q2 }
i4: { User: fabien, Question: q2 }

見て解るように、SQLで作成するよりも直感的でわかりやすいですね。
そして、外部キーは実際にInsertが実行されないとIDが決まらないのですが、各行単位でつけた名前(fabien, anonymouse, francois)で指定できるところがポイントです。

また、PropelでDoctrineで記述方法に違いがあるのことに注意しなくてはなりません。
本家チュートリアルでは外部キーの参照方法が

C:

i1: { user_id: fabien, question_id: q1 }

のように、カラム名は定義しているものと同じで良いのですが、Doctrineの場合は

C:

i1: { User: fabien, Question: q1 }

のようにモデル名を書かなければなりません。
これを間違えると読み込み時にエラーになってしまいますので注意しましょう。

では、実際に初期データを読み込ませてみます。

$ ./symfony doctrine:data-load --dir="data/fixtures/test"
>> doctrine loading data fixtures from "Array"

では実際に画面をみてみましょう

ここで一つ気づく事があります。
created_at, updated_atってsymfonyで勝手に解釈されるといってたのに値が入っていないことです。

正しくはsymfonyで解釈されるのではなくPropel,DoctrineなどのORマッパによって理解されます。
実はDoctrineでの設定を行っていないため、自動で解釈されないのです。

方法は2つあります。１つはschema.ymlで指定する方法。もう1つはモデルクラスに記述する方法です。
schema.ymlに記述する場合は各モデルにactAs: [Timestampable]を追加するだけです。

./config/doctrine/schema.yml

C:

User:
tableName: ask_user
actAs: [Timestampable]
columns:
id:
type: integer(4)
unsigned: 1
primary: true
autoincrement: true

一方、モデルクラスに追加する場合は以下のようにsetUpメソッドにactAsでTimestampableを指定します。
./lib/model/doctrine/モデル名.class.php

PHP:

class User extends BaseUser
{
public function setUp()
{
parent::setup();
$this->actAs('Timestampable');
}
}

もし、updated_atを使わない場合は第２引数で次のように渡す事で無効にできます。

./lib/model/doctrine/モデル名.class.php

PHP:

class User extends BaseUser
{
public function setUp()
{
parent::setup();
$this->actAs('Timestampable', array('updated' => array('disabled' => true)));
}
}

どちらも追加しなければならないという点では同じです。
本チュートリアルではモデルに追記する方法で行います。
理由はschema.ymlはコマンドを実行することで上書きされる可能性があります。
そのときに改めて記述を追加しなければなりません。

それに対して、モデルに書いておけば、コマンドによって上書きされることはありません。
ちょっとした理由ですが、自分だけがコマンドを実行するとは限らないのでこのような配慮は有用です。

ただし、この変更だけでは十分ではありません。
この点については現時点では深くふれずにまずは動くものを作っていきます。

なので、ここまでの変更をUser,Anser,Question,Interest,Relevancyの各ファイルに行っておきます。

モデルでデータの利用

モデルからどうやってデータアクセスしているかはactionクラスを見ればわかります。

./app/frontend/module/question/actions/actions.class.php

PHP:

public function executeIndex()
{
$this->questionList = $this->getQuestionTable()->findAll();
}
private function getQuestionTable()
{
return Doctrine::getTable('Question');
}

getQuestionTable()は自身のクラスで定義されており、つなげて書くと以下と同じです。

PHP:

public function executeIndex()
{
$this->questionList = Doctrine::getTalbe('Question')->findAll();
}

正しい設計、コーディングの方針からはこの書き方はよくありません。
これはDoctrineだからではなく本家チュートリアルも同じです。
なぜなら万が一PropelにORマッパを切り替えたい場面が発生したときにこのままではDoctrineクラス名がハードコーディングされているので簡単にはできません。
本当はORマッパの存在をラップするクラスを１つ用意することが理想です。ただし、最初から複雑な構造にするとチュートリアルが複雑になるためここではこのまま説明を続けます。

このことについては後日していきます。

話を戻しましょう。

データからDoctrineを通して取得したデータは$this->questionListにセットされています。
このリソースはテンプレートでは$questionListで利用できることは最初に説明したとおりですね。
では、テンプレートを見てみます。

アクション名がindexですのでテンプレートはindexSuccess.phpになります。

./app/frontend/module/question/templates/indexSuccess.php

PHP:

...
<?php foreach ($questionList as $question): ?>
<tr>
<td><a href="<?php echo url_for('question/edit?id='.$question['id']) ?>"><?php echo $question['id'] ?></a></td>
<td><?php echo $question['User'] ?></td>
<td><?php echo $question['title'] ?></td>
<td><?php echo $question['body'] ?></td>
<td><?php echo $question['created_at'] ?></td>
<td><?php echo $question['updated_at'] ?></td>
</tr>
<?php endforeach; ?>
<a href="<?php echo url_for('question/edit?id='.$question['id']) ?>"></a>

テンプレートではforeachで取得したquestionの一覧をループ処理しています。
本家チュートリアルのPropelの場合と書き方が異なることがわかります。

実は、Doctrineでも同じ書き方でアクセスすることができます。
PHPらしく配列に慣れている方は配列でもアクセスできるよということですね。

Propelで開発になれてきた方には今までの書き方で書いたほうが混乱しなくてよいですよね。

また、Doctrineでは他の書き方もできるので以下に例をあげておきます。

PHP:

//レコードへのアクセス(nameというカラム)
<?php echo $rec->getName() ?>
<?php echo $rec->name ?>
<?php echo $rec->get('name') ?>
<?php echo $rec['name'] ?>

一覧画面を修正する

では、一覧画面を修正し本家のチュートリアルと同じような画面にしてみます。
異なる点は、リレーションのテーブル参照が複数形(getInterests())でなく単数系(getInterest())になっている点だけですね。

./app/frontend/module/question/templates/indexSuccess.php

PHP:

<?php use_helper('Text') ?>
<h1>popular questions</h1>
<?php foreach($questionList as $question): ?>
<div class="question">
<div class="interested_block">
<div class="interested_mark" id="mark_<?php echo $question->getId() ?>">
<?php echo count($question->getInterest()) ?>
</div>
</div>
<h2><?php echo link_to($question->getTitle(), 'question/show?id='.$question->getId()) ?></h2>
<div class="question_body">
<?php echo truncate_text($question->getBody(), 200) ?>
</div>
</div>
<?php endforeach; ?>

スタイルシートが適用されていれば次のような画面になるはずです。

ここで、詳細表示のリンク先がquestion/showとなっています。
しかし現在のアクションクラスにはexecuteShowというメソッドは用意されていません。

これはsymfony1.2からのCRUDではshowアクションはオプションで指定する必要があります。

なので、再度オプション(--with-show)を指定してshowアクションを作成しておきましょう。

C:

$./symfony doctrine:generate-crud --with-show frontend question Question

あと、このようにタスクを実行した場合にキャッシュが邪魔する場合があるのでキャッシュをクリアしておきます。
これはもはや呪文です。

$./symfony cc

そして、本家と同じく不要な以下のアクションを削除しておくとします。

./app/frontend/module/question/actions/actions.class.php

* executeEdit
* executeUpdate
* executeCreate
* executeDelete

そして修正用のテンプレートファイルを削除します。

./app/frontend/module/question/templates/editSuccess.php

ここまでのソースは以下のリポジトリからチェックアウトすることができます。

http://svn.1ms.jp/public/symfony/askeet12/tags/release_day_3

では、また明日。

関連するその他の記事

10 月 25, 2008 · Filed Under askeet 1.2

Comments

Leave a Reply