6日目はバリデーションの実装なのですが、どうも symfony1.1 からバリデーションの実装方法が結構変わっているようです。

validate ディレクトリに yml ファイルでバリデーションを定義してもちっとも有効にならず悩んでいたのですが、下記のような記事を見つけました。
[Think IT] 第3回：フォームフレームワークを使おう！ (1/3)

上記記事によると 1.1 ではフォームフレームワークを使用するようです。

フォームフレームワークは開発に必須の機能であり、symfony 1.1を使うのであれば、使用方法を覚える必要があります。また新しく覚えることが増えてしまいますが、symfony 1.1を使うのであれば、避けては通れない道です。

1.1 からフォーム周りがどうも大きく変更されているようです。setteings.yml で
compat_10: on
とかすると 1.0 の形式でもいけそうなのですが、せっかくなので最新バージョンのやり方で覚えたいと思います。

The Definitive Guide to symfonyの翻訳

公式サイトにaskeetと呼ばれる24日分のチュートリアルが存在しますが、askeet公開時点と比べてsymfonyが0.6系から1.0系と大きくバージョンアップされており、できれば1.0系で動作が確認されている他の最新のチュートリアルから始めることをお勧めしております。

ということで下記のチュートリアルをやることにします。
MyFirstSymfonyProjectJapanese – symfony – Trac

ログイン処理

ログインリンク追加

askeet/apps/frontend/templates/layout.php
about のリンクの前に入れる

<li><?php echo link_to('sign in', 'user/login') ?></li>

デバッグモードだと symfony のツールバーにログインのリンクが隠れてしまう。[sf]ボタンをクリックするとデバッグ用のツールバーを隠すことができます。

ユーザモジュールの追加

symfony init-module frontend user

上記コマンドを実行すると下記のようなファイルが作成されます。

>> dir+      /home/askeet/apps/frontend/modules/user/actions
>> file+     /home/askeet/apps/frontend/modu.../user/actions/actions.class.php
>> dir+      /home/askeet/apps/frontend/modules/user/templates
>> file+     /home/askeet/apps/frontend/modu...user/templates/indexSuccess.php
>> file+     /home/askeet/test/functional/frontend/userActionsTest.php
>> tokens    /home/askeet/test/functional/frontend/userActionsTest.php
>> tokens    /home/askeet/apps/frontend/modu.../user/actions/actions.class.php
>> tokens    /home/askeet/apps/frontend/modu...user/templates/indexSuccess.php

ログインアクション

askeet/apps/frontend/modules/user/actions/actions.class.php

public function executeLogin()
{
  $this->getRequest()->setAttribute('referer', $this->getRequest()->getReferer());

  return sfView::SUCCESS;
}

これは仮の処理でとりあえずログインフォームを表示するだけの処理です。

ログインビュー

ログインフォームを表示するビューを作成します。
askeet/apps/frontend/modules/user/templates/loginSuccess.php

<?php echo form_tag('user/login') ?>

  <fieldset>

  <div class="form-row">
    <label for="nickname">nickname:</label>
    <?php echo input_tag('nickname', $sf_params->get('nickname')) ?>
  </div>

  <div class="form-row">
    <label for="password">password:</label>
    <?php echo input_password_tag('password') ?>
  </div>

  </fieldset>

  <?php echo input_hidden_tag('referer', $sf_request->getAttribute('referer')) ?>
  <?php echo submit_tag('sign in') ?>

</form>

さっそく先ほど作成したリンクからログインフォームを表示させてみると
Call to undefined function form_tag()
とエラーになった。Form ヘルパーが使えていないようです。
調べたところ

<?php use_helper('Form'); ?>

として使用するヘルパーを宣言しないといけないようです。バージョンが変わってデフォルトで使用できるヘルパーが変わったのでしょうか。

これでログインフォームが表示できるようになりました。

ログイン処理

先ほど仮に入れた処理を削除してログイン処理を実装します。
しかし、まだデータベースにパスワードフィールドがないので存在するユーザならパスワードが何でも認証します。
askeet/apps/frontend/modules/user/templates/loginSuccess.php

public function executeLogin()
{
  if ($this->getRequest()->getMethod() != sfRequest::POST)
  {
    // display the form
    $this->getRequest()->setAttribute('referer', $this->getRequest()->getReferer());
  }
  else
  {
    // handle the form submission
    $nickname = $this->getRequestParameter('nickname');

    $c = new Criteria();
    $c->add(UserPeer::NICKNAME, $nickname);
    $user = UserPeer::doSelectOne($c);

    // nickname exists?
    if ($user)
    {
      // password is OK?
      if (true)
      {
        $this->getUser()->setAuthenticated(true);
        $this->getUser()->addCredential('subscriber');

        $this->getUser()->setAttribute('subscriber_id', $user->getId(), 'subscriber');
        $this->getUser()->setAttribute('nickname', $user->getNickname(), 'subscriber');

        // redirect to last page
        return $this->redirect($this->getRequestParameter('referer', '@homepage'));
      }
    }
  }
}

ログアウト処理

public function executeLogout()
{
  $this->getUser()->setAuthenticated(false);
  $this->getUser()->clearCredentials();
  $this->getUser()->getAttributeHolder()->removeNamespace('subscriber');
  $this->redirect('@homepage');
}

レイアウトの変更

ログイン状態によってログインフォームへのリンク部分を変更するようにレイアウトを変更します。

<?php if ($sf_user->isAuthenticated()): ?>
  <li><?php echo link_to('sign out', 'user/logout') ?></li>
  <li><?php echo link_to($sf_user->getAttribute('nickname', '', 'subscriber').' profile', 'user/profile') ?></li>
<?php else: ?>
  <li><?php echo link_to('sign in/register', 'user/login') ?></li>
<?php endif ?>

ログインしていない場合は[sign in/register]を表示し、ログインしている場合は[sign out]とログインしているユーザ名を表示しリンク先をプロフィール表示画面にします。

実際にログインしてみる

テストデータを見るとユーザが3名ほど登録されています。その中から[fabpot]というユーザでログインしてみます。nicknameに[fabpot]、パスワードは空で[sign in]ボタンをクリックすると認証後に質問一覧ページにリダイレクトされました。

ページ処理

一覧表示アクションの修正

1ページに表示する質問数を取得してページ処理する処理を追加する
askeet/apps/frontend/modules/question/actions.class.php

public function executeIndex ()
{
  $pager = new sfPropelPager('Question', sfConfig::get('app_pager_homepage_max'));

  $c = new Criteria();
  $c->addDescendingOrderByColumn(QuestionPeer::INTERESTED_USERS);
  $pager->setCriteria($c);
  $pager->setPage($this->getRequestParameter('page', 1));
  $pager->setPeerMethod('doSelectJoinUser');
  $pager->init();

  $this->question_pager = $pager;
}

アプリケーション設定ファイルを変更

設定ファイル(app.yml) に1ページに表示する質問数を追加する
askeet/apps/frontend/config/app.yml

all:
  pager:
    homepage_max: 2

この設定を取得するには下記のようにします。

sfConfig::get('app_pager_homepage_max')

これで ‘2′ が取得できる。この部分は1ページの質問数を設定している部分です。現在3つしか質問がないので1ページに2つの質問を表示することによりページング処理のテストを行います。

ビューの変更

一覧を表示する foreach の部分を下記に変更。これでページ処理された一覧を取得。

<?php foreach($question_pager->getResults() as $question): ?>

一覧の下にページナビゲーションを追加

<div id="question_pager">
<?php if ($question_pager->haveToPaginate()): ?>
  <?php echo link_to('&laquo;', 'question/list?page=1') ?>
  <?php echo link_to('&lt;', 'question/list?page='.$question_pager->getPreviousPage()) ?>

  <?php foreach ($question_pager->getLinks() as $page): ?>
    <?php echo link_to_unless($page == $question_pager->getPage(), $page, 'question/list?page='.$page) ?>
    <?php echo ($page != $question_pager->getCurrentMaxLink()) ? '-' : '' ?>
  <?php endforeach; ?>

  <?php echo link_to('&gt;', 'question/list?page='.$question_pager->getNextPage()) ?>
  <?php echo link_to('&raquo;', 'question/list?page='.$question_pager->getLastPage()) ?>
<?php endif; ?>
</div>

ルーティングの変更

apps/frontend/config/routing.yml

popular_questions:
  url:   /index/:page
  param: { module: question, action: list } 

login:
  url:   /login
  param: { module: user, action: login }

リファクタリング

（チュートリアル通りなので省略）

ここまで進めてきて自分の環境とチュートリアルの環境が違う（question/list アクションが index だったり）のがどうもやりにくいので合せることにしました。

SVNレポジトリより routing.yml を落としてきてまずルーティングを合せました。
次に question コントローラの index アクションを list アクションに変更、indexSccess.php を listSuccess.php に変更。
これですっきりしました。

昨日までに作成した質問の一覧画面から質問の個別表示ページ
http://askeet/frontend_dev.php/question/show/id/1
にアクセスするとエラーになる。調べると show アクションもビューもない。

そこで actions.class.php に下記コードを追加

public function executeShow()
{
   $this->question = QuestionPeer::retrieveByPk($this->getRequestParameter('id'));
   $this->forward404Unless($this->question);
}

askeet/apps/frontend/modules/question/templates/showSuccess.php を作成する

<?php use_helper('Date') ?>

<div class="interested_block">
  <div class="interested_mark">
    <?php echo count($question->getInterests()) ?>
  </div>
</div>

<h2><?php echo $question->getTitle() ?></h2>

<div class="question_body">
  <?php echo $question->getBody() ?>
</div>

<div id="answers">
<?php foreach ($question->getAnswers() as $answer): ?>
  <div class="answer">
    posted by <?php echo $answer->getUser()->getFirstName().' '.$answer->getUser()->getLastName() ?>
    on <?php echo format_date($answer->getCreatedAt(), 'p') ?>
    <div>
      <?php echo $answer->getBody() ?>
    </div>
  </div>
<?php endforeach; ?>
</div>

再度 http://askeet/frontend_dev.php/question/show/id/1 にアクセスすると表示できました。

URL からのパラメータの受け取り方

URL が http://askeet/frontend_dev.php/question/show/id/1 の場合

$id = $this->getRequestParameter('id')

これで $id=1 になる。

http://askeet/frontend_dev.php/question/show/id/1/myparam/myvalue

$param = $this->getRequestParameter('myparam');

これで $param = ‘myvalue’ になる。

テストデータの追加

answer テーブルにデータを追加するために askeet/data/fixtures/test_data.yml にチュートリアルにあるデータを追加して symfony コマンドを実行

symfony propel-load-data frontend

データ追加後の画面表示

追加した回答データが表示されている。

注意点は symfony propel-load-data コマンドを実行するとDBから一度データを全て削除して insert しなおすので各データの ID が変わります。そのために URL の /show/id/x の x の部分もデータをロードするたびに変わります。

モデルの変更

ユーザ名をビューで組み立てるのではなくモデルで組み立てる
askeet/lib/model/User.php

public function __toString()
{
  return $this->getFirstName().' '.$this->getLastName();
}

askeet/frontend/modules/question/templates/showSuccess.php

posted by <?php echo $answer->getUser()->getFirstName().' '.$answer->getUser()->getLastName() ?>

という部分を下記に変更する

posted by <?php echo $answer->getUser() ?>

__toString というマジックメソッドにすることによりビューでは User クラスのインスタンスを echo するだけでフルネームが表示できるようになりました。

マジックメソッドに関しては過去のエントリを参照
PHP5 マジックメソッド

リファクタリング

ビューの showSuccess.php と listSuccess.php には重複している部分があります。

<div class="interested_block">
  <div class="interested_mark">
    <?php echo count($question->getInterests()) ?>
  </div>
</div>

上記コードを askeet/apps/frontend/modules/question/templates/_interested_user.php というファイル名で作成して、
showSuccess.php と listSuccess.php の該当部分を下記コードに修正します。

<?php include_partial('interested_user', array('question' => $question)) ?>

この _interested_user.php のようなファイルをパーシャルといい、ファイル名の先頭はアンダースコアにして、ビューからインクルードするときはアンダースコアを入れずに指定します。第2引数にパーシャルに渡す引数を指定できます。パーシャルは HTML の共通化をするときに用いられます。

モデルの変更（テーブルにカラムを追加）

schema.yml の ask_question テーブルに下記の行を追加

interested_users: { type: integer, default: '0' }

下記コマンドを実行してテーブルを再作成

symfony propel-build-all

データを再度挿入

symfony propel-load-data frontend

（このやり方でいいのかな？間違っていたらコメントで教えてください）

追加したカラムに Interest テーブルにレコードが追加される度に更新されるようにする
askeet/lib/model/Interest.php

public function save($con = null)
{
  $con = Propel::getConnection();
  try
  {
    $con->begin();

    $ret = parent::save($con);

    // update interested_users in question table
    $question = $this->getQuestion();
    $interested_users = $question->getInterestedUsers();
    $question->setInterestedUsers($interested_users + 1);
    $question->save($con);

    $con->commit();

    return $ret;
  }
  catch (Exception $e)
  {
    $con->rollback();
    throw $e;
  }
}

上記コードはトランザクションを使っています。

テンプレートの変更
_interested_user.php

<?php echo count($question->getInterests() ?>

を

<?php echo $question->getInterestedUsers() ?>

に変更する

このままで質問を再表示させると interested_users カラムには何も入っていないので関心数が表示されません。そこで再度データを挿入しなおします。

symfony propel-load-data frontend

回答モデルにも同じことをする

これは繰り返しなので省略

MVC モデル

MVC の各ファイルの場所

モデル

askeet/lib/model/

ビュー

askeet/apps/frontend/modules/question/templates/

コントローラ

askeet/apps/frontend/modules/question/actions/

レイアウトの変更

askeet/apps/frontend/templates/layout.php がアプリのレイアウトになる。このファイルをチュートリアルに書かれているコードに修正する。
また、CSS（main.css, layout.css) を チュートリアルの SVN レポジトリからダウンロードして askeet/web/css に入れる。

追加した CSS をレイアウトで読み込むようにビューの設定ファイルを修正
frontend/config/view.yml

stylesheets: [main, layout]

CSS を追加した画面です。

テストデータ

askeet/data/fixtures/test_data.yml を作成
チュートリアルにあるように batch プログラムを作るが askeet/apps/frontend/config/config.php がないとエラーになる。調べてたところ下記コマンドでテストデータを読み込めました。

symfony propel-load-data frontend

バージョンの違いによるものと思います。

テストデータ入れた後の画面です。

ビューの変更

チュートリアルで変更しているビューは listSuccess.php だが該当のファイルはない。askeet/apps/frontend/modules/question/templates/indexSuccess.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="interested_in_<?php echo $question->getId() ?>">
        <?php echo count($question->getInterests()) ?>
      </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; ?>

また、コントローラからビューへ渡される変数名は $questions ではなく $questionList になります。（上記ソースは $questionList に変更してあります）

ここまでの画面です。

データベースの設定

データベース askeet を作成

$ mysqladmin -u username -p --default-character-set=utf8 create askeet

databases.yml を設定

全てコメントアウトされているのでコメントをはずしてdsn を修正、最後に encoding: utf8 を追加

all:
  propel:
    class:          sfPropelDatabase
    param:
      dsn:          mysql://username:password@localhost/askeet
      encoding:     utf8

schema.yml 設定

schema.xml を作成して schema.yml を作成する方法が書かれていますが、面倒なので直接 askeet/config/schema.yml を作成しました。

propel.ini の下記の部分を修正

propel.database.createUrl  = mysql://username:password@localhost/
propel.database.url        = mysql://username:password@localhost/askeet

データベースとモデルの作成

$ symfony propel-build-all

というコマンドでデータベース、モデルをいっぺんに作成。上記コマンドは下記コマンドをそれぞれ実行するようです。

• symfony propel-build-model
• symfony propel-build-sql
• symfony propel-insert-sql

CRUD の作成

Scaffolding 機能を使用して CRUD 用のアクションメソッドと最低限のテンプレートを作成

$ symfony propel-generate-crud frondend question Question

http://askeet/question にアクセスすると一覧、新規登録、編集、削除ができる画面にアクセスできます。

試しにデータを入れたり、編集削除してみました。日本語も大丈夫ですね。

うまく表示できない場合はデバッグモード http://askeet/frontend_dev.php/question にアクセスするとエラーがどこで起きているか確認できます。

Your are not allowed to access this file. Check frontend_dev.php for more information.

と表示されてしまう件ですが、解決しました。

原因は /home/askeet/web/frontend_dev.php の4行目～7行目で

if (!in_array(@$_SERVER['REMOTE_ADDR'], array('127.0.0.1')))
{
  die('Your are not allowed to access this file. Check '.basename(__FILE__).' for more information.');
}

となっていて他の IP からのアクセスを拒否していました。

デバッグモードなのでセキュリティ的にも当然なのですが、私は LAN 内に Linux サーバを置いて LAN 内からのみアクセスできるようにして他の端末のブラウザからアクセスしていたためにこれに引っかかってしまいました。

そこで、アクセスする端末のローカルIPアドレスを指定することにより無事デバッグモードが表示できるようになりました。

インストール

まず PEAR をアップデート

$ pear upgrade PEAR

symfony プロジェクトの PEAR チャネルを登録

$ pear channel-discover pear.symfony-project.com

symfony をインストール

$ pear install symfony/symfony

とここで

symfony/symfony requires PHP extension "dom"
No valid packages found
install failed

というエラーがでる

# yum install php-xml

で php-xml を入れると symfony をインストールできました。
インストールの確認をしておきます。

$ symfony -V
symfony version 1.1.0 (/usr/share/pear/symfony)

プロジェクトの作成

askeet プロジェクトのディレクトリを作成します。

$ mkdir /home/askeet
$ cd /home/askeet
$ symfony init-project askeet

作成したディレクトリで symfony コマンドを実行して adkeet プロジェクトを作成します。下記のようなファイルが作成されました。

>> dir+      /home/askeet/web
>> file+     /home/askeet/web/.htaccess
>> dir+      /home/askeet/web/images
>> dir+      /home/askeet/web/uploads
>> dir+      /home/askeet/web/uploads/assets
>> dir+      /home/askeet/web/js
>> file+     /home/askeet/web/robots.txt
>> dir+      /home/askeet/web/css
>> file+     /home/askeet/web/css/main.css
>> dir+      /home/askeet/config
>> file+     /home/askeet/config/properties.ini
>> file+     /home/askeet/config/ProjectConfiguration.class.php
>> file+     /home/askeet/config/databases.yml
>> file+     /home/askeet/config/propel.ini
>> file+     /home/askeet/config/schema.yml
>> file+     /home/askeet/config/rsync_exclude.txt
>> dir+      /home/askeet/plugins
>> dir+      /home/askeet/lib
>> dir+      /home/askeet/doc
>> dir+      /home/askeet/test
>> dir+      /home/askeet/test/functional
>> dir+      /home/askeet/test/bootstrap
>> file+     /home/askeet/test/bootstrap/functional.php
>> file+     /home/askeet/test/bootstrap/unit.php
>> dir+      /home/askeet/test/unit
>> dir+      /home/askeet/data
>> file+     /home/askeet/symfony
>> dir+      /home/askeet/log
>> dir+      /home/askeet/apps
>> dir+      /home/askeet/cache
>> tokens    /home/askeet/config/properties.ini
>> tokens    /home/askeet/config/propel.ini
>> tokens    /home/askeet/config/ProjectConfiguration.class.php
>> chmod 777 /home/askeet/cache
>> chmod 777 /home/askeet/log
>> chmod 777 /home/askeet/web/uploads
>> chmod 777 /home/askeet/symfony
>> chmod 777 /home/askeet/web/uploads/assets

次に frontend というアプリケーションを作成します。

symfony init-app frontend

アプリケーション用の下記ファイルが作成されました。

>> dir+      /home/askeet/apps/frontend/config
>> file+     /home/askeet/apps/frontend/config/app.yml
>> file+     /home/askeet/apps/frontend/config/settings.yml
>> file+     /home/askeet/apps/frontend/config/factories.yml
>> file+     /home/askeet/apps/frontend/config/security.yml
>> file+     /home/askeet/apps/frontend/config/filters.yml
>> file+     /home/askeet/apps/frontend/config/view.yml
>> file+     /home/askeet/apps/frontend/config/routing.yml
>> file+     /home/askeet/apps/frontend/config/cache.yml
>> file+     /home/askeet/apps/frontend/conf...licationConfiguration.class.php
>> dir+      /home/askeet/apps/frontend/modules
>> dir+      /home/askeet/apps/frontend/lib
>> file+     /home/askeet/apps/frontend/lib/myUser.class.php
>> dir+      /home/askeet/apps/frontend/i18n
>> dir+      /home/askeet/apps/frontend/templates
>> file+     /home/askeet/apps/frontend/templates/layout.php
>> tokens    /home/askeet/apps/frontend/config/settings.yml
>> file+     /home/askeet/web/index.php
>> file+     /home/askeet/web/frontend_dev.php
>> tokens    /home/askeet/web/index.php
>> tokens    /home/askeet/web/frontend_dev.php
>> rename    /home/askeet/apps/frontend/conf...frontendConfiguration.class.php
>> tokens    /home/askeet/apps/frontend/conf...frontendConfiguration.class.php
>> chmod 777 /home/askeet/cache
>> chmod 777 /home/askeet/log
>> chmod 777 /home/askeet/web/uploads
>> chmod 777 /home/askeet/symfony
>> chmod 777 /home/askeet/web/uploads/assets
>> dir+      /home/askeet/test/functional/frontend

httpd.conf の設定

作成したプロジェクトにアクセスできるように httpd.conf を設定します。

その前に PEAR のデータのパスを調べておきます

pear config-show
....
PEAR data directory            data_dir         /usr/share/pear/data
....

symfony のデフォルトの CSS や画像は symfony のデータディレクトリにあるので、そのデータディレクトリのパスを httpd.conf で指定するために必要です。私の環境では /usr/share/pear/data でした。

httpd.conf に以下を追加

<VirtualHost *:80>
  ServerName askeet
  DocumentRoot "/home/askeet/web"
  DirectoryIndex index.php
  Alias /sf /usr/share/pear/data/symfony/web/sf

  <Directory "/home/askeet/web">
   AllowOverride All
  </Directory>
</VirtualHost>

Alias /sf /usr/share/pear/data/symfony/web/sf の部分を先ほど調べたパスに合せます。
設定後、設定を反映させるために Apache を再起動させます。

ここまでで http://askeet/ にアクセスすると下記のような画面になります。

また、symfony ではデバッグモードというのがあるそうで
http://askeet/frontend_dev.php/ にアクセスすると表示できるそうです。
ただ、なぜか下記のようなエラーメッセージがでてしまいアクセスすることができませんでした。

Your are not allowed to access this file. Check frontend_dev.php for more information.

原因を調査中なのですが今日は時間切れのようなので明日続きを調べたいと思います。

まだ、最初の方を読んだだけなのですが、パラパラと読みながら Askeet などもやってみようかなと思っています。とりあえず symfony をやるモチベーションをアップするためにブログに書いておいた。

ちょうど CakePHP 勉強会で yando さんの CakePHP と symfony の比較を聞いたばかりなので始めるにはいいタイミングかも。

symfony×PHP [LLフレームワークBooks] (LLフレームワークBOOKS # 3)

森川 穣
￥ 2,079
単行本（ソフトカバー）
技術評論社