(1)
(0)
(0)
(0)
Total: 1 DAY5: ログインフォームとパジネーション
ログインフォームとパジネーション
４日目ではリファクタリングを中心に作業を行いました。
５日目の内容はログインフォームの実装と質問ページにページ送りの機能（パジネーション）を実装していきます。
sfForm フォームフレームワーク
今日の流れで一番理解しなくてはならないことはフォームの処理をsymfonyで行う箇所でしょう。
symfony1.1からはsfFormというフォーム処理のためのフォームフレームワークを使うことが前提になっています。
なんだかsymfonyそのものもフレームワークなのにややこしいなぁと思われる方が多いと思います。
これはフォーム処理に関する部分をsymfonyそのものの機能に依存しないようにすることでアクション部分のコードがスッキリし、役割が明確にできるというメリットがあります。
また、その一方で書かなくてはなならないコード量は増えてしまいます。そういう点ではデメリットかもしれません。
それに覚えなくてはならないことも増えますので、学習コストという面でもデメリットかもしれません。
しかし、それ以上にアクションがフォームに関するバリデーションの処理から解放されたことのメリットのほうが大きいと思います。
本家ではこのsfFormに関する専用のドキュメントが用意されています。
詳しいことはThe symfony form bookで理解してください。
日本語情報についてはこちらから確認できます。
ログインフォーム
では、さっそくログインフォームを作っていきます。
まずはログインフォームの入力画面を表示するまでの流れを作ります。
最初に考えることはこのログインフォームへのリンクをどこに設置するかです。
普通はログインフォームへのリンクは全てのページにあると便利ですよね。なので全ページで共通して利用するテンプレートであるレイアウトにリンクを埋め込みます。
./app/frontend/templates/layout.php
つぎにこのリンク先であるuserモジュールを作成します。
-
$ ./symfony generate:module frontend user
そして、ログインアクションを用意しましょう。
ポイントはsfFormを使うことです。
ユーザーフォームのオブジェクトを取得してくる処理も行います。
今回利用するフォームはユーザーモデルに関連するフォームです。
そのため、
./lib/form/doctrine/UserForm.class.php
を派生したユーザーログインフォームクラスを用意します。
./lib/form/doctrine/LoginUserForm.class.php
まずは、基底クラスとなるUserForm.class.phpを実装していきます。
このファイルではこれから派生していく各フォームで共通となる処理を記述します。
本当はさらに基底となるクラスが/baseディレクトリに作成されているのですが、メッセージを変えたり、バリデーションを作成したりしたいので、UserFrom.class.phpできちんと定義をしておくことにします。
また記述方法がいくつかありますが、ここでは冗長な書き方になっていますが、各項目単位で書いていく方法にしています。
また、ログインフォームではリクエストされた値が合っているかどうかの確認が必要です。
そのため、グローバルバリデータとしてvalidUserメソッドでデータベースに問い合わせるようにしています。
この辺りはsfFormフレームワークを理解していないとややこしいのですが、どのように実装しているかは解りやすいかと思います。
-
...
-
public function configure()
-
{
-
// unset fields
-
'created_at',
-
);
-
foreach ($unset_fields as $value) {
-
$this->offsetUnset($value);
-
}
-
//////////////////////////////////////////////////
-
// nickname
-
$key = 'nickname';
-
$this->widgetSchema[$key] = new sfWidgetFormInput();
-
$this->widgetSchema->setLabel($key, 'ニックネーム');
-
$this->validatorSchema[$key] = new sfValidatorString();
-
$_min = 6;
-
$this->validatorSchema[$key]->setMessage('min_length', sprintf('ニックネームの文字数は%d文字以上で入力してください', $_min));
-
$this->validatorSchema[$key]->setOption('min_length', $_min);
-
$_max = 50;
-
$this->validatorSchema[$key]->setMessage('max_length', sprintf('ニックネームの文字数は%d文字以内で入力してください', $_max));
-
$this->validatorSchema[$key]->setOption('max_length', $_max);
-
$this->validatorSchema[$key]->setOption('required', true);
-
$this->validatorSchema[$key]->setMessage('required', 'ニックネームは必須です');
-
//////////////////////////////////////////////////
-
// first_name
-
$key = 'first_name';
-
$this->widgetSchema[$key] = new sfWidgetFormInput();
-
$this->widgetSchema->setLabel($key, '名前');
-
$this->validatorSchema[$key] = new sfValidatorString();
-
$_max = 50;
-
$this->validatorSchema[$key]->setOption('max_length', $_max);
-
//////////////////////////////////////////////////
-
// last_name
-
$key = 'last_name';
-
$this->widgetSchema[$key] = new sfWidgetFormInput();
-
$this->widgetSchema->setLabel($key, '苗字');
-
$this->validatorSchema[$key] = new sfValidatorString();
-
$_max = 50;
-
$this->validatorSchema[$key]->setOption('max_length', $_max);
-
}
次にLoginUserForm.class.phpを作成します。
これはログインフォームのためのクラスです。
UserForm.class.phpを親クラスとし、ログイン用に変更点があれば記述します。
今回は以下の点をログインフォームのために変更しています。
* パスワードを入力させるのでパスワード用のWidgetを作成
* リファラーをhiddenで渡すのでhiddenのwidgetを作成
* first_name, last_nameは不要なのでUnset
./lib/form/doctrine/LoginUserForm.class.php
-
...
-
public function configure()
-
{
-
parent::configure();
-
// unset fields
-
'created_at',
-
'first_name',
-
'last_name',
-
);
-
foreach ($unset_fields as $value) {
-
$this->offsetUnset($value);
-
}
-
//////////////////////////////////////////////////
-
// password
-
$key = 'password';
-
$this->widgetSchema[$key] = new sfWidgetFormInputPassword();
-
$this->widgetSchema->setLabel($key, 'パスワード');
-
$this->validatorSchema[$key] = new sfValidatorString();
-
$this->validatorSchema[$key]->setOption('required', true);
-
$this->validatorSchema[$key]->setMessage('required', 'パスワードは必須です');
-
//////////////////////////////////////////////////
-
// referer
-
$key = 'referer';
-
$this->widgetSchema[$key] = new sfWidgetFormHiden();
-
$this->validatorSchema[$key] = new sfValidatorPass();
-
// setDefault
-
'referer' => sfContext::getInstance()->getRequest()->getReferer(),
-
));
-
// check valid user
-
)));
-
}
-
public function validUser($validator, $values)
-
{
-
// ToDo: implement after...
-
return $values;
-
}
認証済みのフラグはユーザークラスに対して行います。
そこで、validUserメソッドで定義したsetLoginAuthをユーザークラスに実装しておきます。
メソッド名と実装方法を6日目に変更しますのでこの時点ではmyUserクラスに切り分けしているという点にだけ着目しておいてください。
./apps/frontend/lib/myUser.class.php
-
<?php
-
-
class myUser extends sfBasicSecurityUser
-
{
-
public function setloginAuth($is_login, $user)
-
{
-
$this->setAuthenticated($is_login);
-
$this->addCredential('subscriber');
-
$this->setAttribute('subscriber_id', $user->getId(), 'subscriber');
-
$this->setAttribute('nickname', $user->getNickname(), 'subscriber');
-
}
-
}
次にユーザーモジュールのログインアクションを実装します。
まずはフォームを表示できればいいので、さきほど作成したフォームインスタンスを作成し、
ビューで利用できるように$this->formにアサインしているだけです。
-
./apps/frontend/modules/user/actions/actions.class.php
-
public function executeLogin(sfWebRequest $request)
-
{
-
// get sfForm object
-
$this->form = new LoginUserForm();
-
-
return sfView::SUCCESS;
-
}
symfony1.0系との違いはアクションの引数に$requestを持っているということですね。
あとは、テンプレートを用意します。
symfony1.0までのaskeetではフォームヘルパーを使ってフォームを作成していましたが、すでにsfFormのウィジットによって作成できるので、フォームヘルパーは不要です。
そのため、コードはフォームのコンテンツをecho $formで出力しているだけです。
「submitボタンがそのまま書かれているではないか」と思われる方がいるかもしれませんが、もともとヘルパーやウィジットで自動生成させるパーツは動的に決定されるパーツだけです。
ボタンなどはそのままHTMLを記述することがフレームワークに依存しないことからも自然ですね。
-
<div id="login">
-
<h3>ログイン</h3>
-
<form action="<?php echo url_for('user/login') ?>" method="POST">
-
<table>
-
<tr>
-
<td colspan="2" style="text-align: right"><input type='submit' value="サインイン"></td>
-
</tr>
-
</table>
-
</form>
-
</div>
これでできた画面は以下のようになります。
ログインアクションの実装
次に実際のログインボタンを押されたときの処理を実装します。
実装する内容は以下の点です。
1. フォームの値の検証
3. 検証結果による画面遷移の分岐
./apps/frontend/modules/user/actions/actions.class.php
-
public function executeLogin(sfWebRequest $request)
-
{
-
// get sfForm object
-
$this->form = new LoginUserForm();
-
// check Request Method
-
if (!$request->isMethod('post')) {
-
return sfVieww::SUCCESS;
-
}
-
// login check
-
$this->form->bind($request->getParameter('user'));
-
if ($this->form->isValid()) {
-
return $this->redirect($request->getParameter('user[referer]', @homepage));
-
}
-
return sfView::SUCCESS;
-
}
次にさきほどのLoginUserFormクラスにログインチェックの実装(validUserメソッド）を行いましょう。
そのために、
* データベースへの問い合わせ
* OKであればユーザーのセッションに認証済みのフラグをたてる
の作業が必要になります。
またこの時点では本家と同じくパスワードのチェックは行わず、ユーザーがデータベースに存在すればログインできるようにします。
./lib/form/doctrine/LoginUserForm.class.php
-
public function validUser($validator, $values)
-
{
-
// if nickname is empty, not check.
-
if ($values['nickname'] == "") {
-
return $values;
-
}
-
// check if valid user.
-
// TODO: refactaring this code, not to access Doctrine directly.
-
$user = Doctrine_Query::create()
-
->from('User')
-
->where('nickname = ?', $values['nickname'])
-
->execute();
-
if ($user->count() != 1) {
-
throw new sfValidatorError($validator, '該当するユーザーがいません');
-
return $values;
-
}
-
// set auth
-
$sf_user = sfContext::getInstance()->getUser();
-
$sf_user->setLoginAuth(true, $user[0]);
-
-
return $values;
-
}
認証済みのフラグはユーザークラスに対して行います。
そこで、validUserメソッドで定義したsetLoginAuthをユーザークラスに実装しておきます。
./apps/frontend/lib/myUser.class.php
-
<?php
-
-
class myUser extends sfBasicSecurityUser
-
{
-
public function setloginAuth($is_login, $user='')
-
{
-
$this->setAuthenticated($is_login);
-
if ($is_login) {
-
$this->addCredential('subscriber');
-
$this->setAttribute('subscriber_id', $user->getId(), 'subscriber');
-
$this->setAttribute('nickname', $user->getNickname(), 'subscriber');
-
} else {
-
$this->clearCredentials();
-
$this->getAttributeHolder()->removeNamespace('subscriber');
-
}
-
}
-
}
symfonyに用意されている充実したUserクラスを利用することで、認証済みのフラグであったり、権限などの設定を行っています。
詳細についてはユーザーの認証についてのドキュメントを参照してください
以前のaskeetのアクションのコードと比べてコードがすっきりしていることがわかります。
次にログアウトの処理を実装します。
ログアウト時は先ほど用意したsetLoginAuthをfalseで設定し、ルーティングでhomepageで設定したURLへリダイレクトさせます。
./apps/frontend/modules/user/actions/actions.class.php
-
public function executeLogout(sfWebRequest $request)
-
{
-
$this->getUser()->setLoginAuth(false);
-
$this->redirect(@homepage);
-
}
次に、ログインとログアウトのリンクをログイン状態によって変更するようにします。
ログインのリンクはレイアウトに設置したので、レイアウトを変更します。
./apps/frontend/templates/layout.php
-
<?php if ($sf_user->isAuthenticated()): ?>
-
<li><?php echo link_to($sf_user->getAttribute('nickname', '', 'subscriber').' profile', 'user/profile') ?></li>
-
<?php else: ?>
-
<?php endif ?>
これで、ログイン、ログアウトを行うとメニューが切り替わることが確認できます。
質問ページでページャ
次に行う実装はパジネーションです。
いわゆる10件以上は次のページへというリンクで制御するあれですね。
今回利用しているDoctrineがページャの機能を持っているのでそれを利用して実装してみます。
なので、本家の解説とは異なります。
日本語ではprocess S+D Doctrineの使い方のまとめ - ページ処理が参考になります。
まずは、一覧取得画面を用意します。
一覧画面はindexアクションで行うようにしているので、本家にあるlistアクションはindexアクションへフォワードさせています。
./apps/frontend/modules/question/actions/actions.class.php
-
public function executeIndex($request)
-
{
-
// ToDo: refactaring below
-
$q = Doctrine_Query::create()
-
->from('Question');
-
$pager = new Doctrine_Pager($q, 1, 2);
-
$this->questionList = $pager->execute();
-
$this->pager = $pager;
-
}
-
-
public function executeList($request)
-
{
-
$this->forward('question', 'index');
-
}
一覧表示はIndexアクションで行っているのでそこにページャであるDoctrine_Pagerを使って実装しています。
DQL、ページ番号、表示する記事数を引数として渡してインスタンスを作成し、executeメソッドを呼ぶだけなので簡単ですね。
ここでは仮に１ページに２つずつ表示させるようにし、１ページ目を実際に表示しようとしています。
executeした結果はDoctrineレコードを返すので、これをquestionListとして新しくセットしています。
あとは、テンプレートにパジネーション部分の実装を行います。
./apps/frontend/modules/question/template/indexSuccess.php
-
<div id="question_pager">
-
<?php if ($pager->haveToPaginate()): ?>
-
-
<?php for ($page_no = 1, $max = $pager->getLastPage(); $page_no <= $max; $page_no++): ?>
-
<?php echo link_to_unless($page_no == $pager->getPage(), $page_no, 'question/list?page='.$page_no) ?>
-
<?php endfor; ?>
-
-
<?php endif; ?>
-
</div>
詳しい説明は行いませんが、アクションで取得したpagerから
* $pager->haveToPaginate() ... パジネートできるだけの項目があるかどうか
* $pager->getPreviousPage() ... １つ前のページ番号を取得
* $pager->getLastPage() ... 最後のページ番号を取得
* $pager->getPage() ... 現在のページ番号を取得
* $pager->getNextPage() ... 次のページ番号を取得
を利用しています。
すると以下のようなパジネートが完成しました。
あとは、実際にパジネートされるように、ページ番号をアクションに渡して上げるようにします。
また、ページに表示する質問数はアプリケーションの設定ファイルで変更できるようにします。
まずはさきほどのアクションでDoctrine_Pagerインスタンス作成の引数を変更します。
./apps/frontend/modules/question/actions/actions.class.php
-
$pager = new Doctrine_Pager($q, $request->getParameter('page'), sfConfig::get('app_pager_homepage_max'));
pageというパラメータを渡してあげるのと、sfConfig::getで設定ファイルから取得するようにしました。
あとは、設定ファイル(app.yml)に設定値を書き込みます。
./apps/frontend/config/app.yml
-
all:
-
pager:
-
homepage_max: 2
設定ファイルの仕組みについては設定の章を参考にしてください。
ルーティングの追加
これ本家のものと同じですね。
* ページ番号を直接URLに埋め込めるようにする
./apps/frontend/config/routing.yml
-
popular_questions:
-
url: /index/:page
-
param: { module: question, action: index }
これで、
http://symfony.centos5.localhost/askeet/frontend_dev.php/index/2
で質問一覧ページが指定したページ番号で表示されます。
* ログイン画面へのスマートなURLを用意する
-
login:
-
url: /login
-
param: { module: user, action: login }
これで、
http://symfony.centos5.localhost/askeet/frontend_dev.php/login
ログイン画面が表示されます。
リファクタリング
さて、本日の最後はリファクタリングです。
今日の実装してきたコードの中でモデルの扱い部分が散乱してしまっていることに注目してください。
* LoginUserFormクラスから直接Doctrine_Queryを呼び出している
* executeIndexアクションで直接Doctrine_Queryを呼び出している
これらをモデル部分に閉じ込めてしまいましょう。
ログインできるユーザーかどうか
ログインできるユーザーを取得するメソッドをモデル(User.class.php)に追加します。
./lib/model/doctrine/User.class.php
-
{
-
return Doctrine_Query::create()
-
->from('User')
-
->where('nickname = ?', $nickname)
-
->execute();
-
}
./lib/model/doctrine/Question.class.php
-
{
-
return Doctrine_Query::create()
-
->from('Question');
-
}
あとは、呼び出しもとをこれらを使用するように書き換えます。
./lib/form/doctrine/LoginUserForm.class.php
-
public function validUser($validator, $values)
-
{
-
// if nickname is empty, not check.
-
if ($values['nickname'] == "") {
-
return $values;
-
}
-
// check if valid user.
-
$user = User::getValidUserByNickname($values['nickname']);
-
if ($user->count() != 1) {
-
throw new sfValidatorError($validator, '該当するユーザーがいません');
-
return $values;
-
}
-
// set auth
-
$sf_user = sfContext::getInstance()->getUser();
-
$sf_user->setLoginAuth(true, $user[0]);
-
-
return $values;
-
}
./apps/frontend/modules/question/actions/actions.class.php
-
public function executeIndex($request)
-
{
-
// ToDo: refactaring below
-
$q = Question::createGetAllDql();
-
$pager = new Doctrine_Pager($q, 1, 2);
-
$this->questionList = $pager->execute();
-
$this->pager = $pager;
-
}
コーディング量が減ったわけではありませんが、「データベースへ問い合わせしている実態はモデルにある」というルールで統一できました。
最後に、本家にあわせてこの一覧画面は再利用されるので_list.phpという名前のパーシャルにしてしまいましょう。
個人的には、アクションでの実装ではなくコンポーネントによる実装が綺麗になると思うので、納得できませんが。。
それはおいおいリファクタリングすることにするとします。
./apps/frontend/modules/question/templates/indexSuccess.php
./apps/frontend/modules/question/templates/_list.php
-
<?php foreach($questionList as $question): ?>
-
<div class="interested_block">
-
</div>
-
-
-
<div class="question_body">
-
</div>
-
<?php endforeach ?>
-
-
<div id="question_pager">
-
<?php if ($pager->haveToPaginate()): ?>
-
-
<?php for ($page_no = 1, $max = $pager->getLastPage(); $page_no <= $max; $page_no++): ?>
-
<?php echo link_to_unless($page_no == $pager->getPage(), $page_no, 'question/list?page='.$page_no) ?>
-
<?php endfor; ?>
-
-
<?php endif; ?>
-
</div>
また次回
６日目はセキュリティー関連とフォームのバリデーションについて行う予定です。
ただし、フォーム関連はsfFormで今日かなり実装できてしまっています。
やはりsymfony1.2ではsfFormをどこまで使いこなせるかがポイントになりそうです。
また、ここまでのソースは以下のリポジトリからチェックアウトすることができます。
http://svn.1ms.jp/public/symfony/askeet12/tags/release_day_5
関連するその他の記事
Comments
Leave a Reply