[OpenPNE3]管理画面付きプラグイン(opFreepagePlugin)#3 管理画面編集フォーム作成
前回はopFreepagePluginの管理画面の一覧表示部分を作ってみました。今回はそこにデータを追加するための新規作成・編集削除の2画面を一気に作ります。symfonyを使ったことある人ならば、「propel:generate-crud的な感じ」と言えばソースコードの構成が伝わるかもしれません。
まずはactions.class.phpに以下の6つのメソッドを追加します。
-
public function executeNew(sfWebRequest $request)
-
{
-
$this->form = new FreepageForm();
-
}
-
-
public function executeCreate(sfWebRequest $request)
-
{
-
$this->forward404Unless($request->isMethod('post'));
-
-
$this->form = new FreepageForm();
-
-
$this->processForm($request, $this->form);
-
-
$this->setTemplate('new');
-
}
-
-
public function executeEdit(sfWebRequest $request)
-
{
-
$this->forward404Unless($freepage = FreepagePeer::retrieveByPk($request->getParameter('id')), sprintf('Object freepage does not exist (%s).', $request->getParameter('id')));
-
$this->form = new FreepageForm($freepage);
-
}
-
-
public function executeUpdate(sfWebRequest $request)
-
{
-
$this->forward404Unless($request->isMethod('post') || $request->isMethod('put'));
-
$this->forward404Unless($freepage = FreepagePeer::retrieveByPk($request->getParameter('id')), sprintf('Object freepage does not exist (%s).', $request->getParameter('id')));
-
$this->form = new FreepageForm($freepage);
-
-
$this->processForm($request, $this->form);
-
-
$this->setTemplate('edit');
-
}
-
-
public function executeDelete(sfWebRequest $request)
-
{
-
$request->checkCSRFProtection();
-
-
$this->forward404Unless($freepage = FreepagePeer::retrieveByPk($request->getParameter('id')), sprintf('Object freepage does not exist (%s).', $request->getParameter('id')));
-
$freepage->delete();
-
-
$this->redirect('opFreepagePlugin/list');
-
}
-
-
protected function processForm(sfWebRequest $request, sfFormPropel $form)
-
{
-
$form->bind($request->getParameter($form->getName()), $request->getFiles($form->getName()));
-
if ($form->isValid())
-
{
-
$freepage = $form->save();
-
$this->redirect('opFreepagePlugin/list');
-
}
-
}
これでもうアクションの追加は終わりです。あとは対応するビューの作成とフォームの調整です。
templates/ディレクトリにnewSuccess.phpを作成し、以下のコードを入力します。
-
<?php slot('submenu') ?>
-
<?php include_partial('submenu') ?>
-
<?php end_slot() ?>
-
-
<h2><?php echo __('フリーページの新規作成') ?></h2>
-
続いて、editSuccess.phpを作成し、以下のコードを入力します。
-
<?php slot('submenu') ?>
-
<?php include_partial('submenu') ?>
-
<?php end_slot() ?>
-
-
<h2><?php echo __('フリーページの編集') ?></h2>
-
この2つのビューは新規作成と編集画面に対応するものですが、非常に似ていますし、短いですね。というのも、肝心のフォームの描画は部分テンプレートとして分離しています。templares/ディレクトリに_form.phpを作成して、以下のコードを追加します。
-
<?php include_stylesheets_for_form($form) ?>
-
<?php include_javascripts_for_form($form) ?>
-
-
<form action="<?php echo url_for('opFreepagePlugin/'.($form->getObject()->isNew() ? 'create' : 'update').(!$form->getObject()->isNew() ? '?id='.$form->getObject()->getId() : '')) ?>" method="post" <?php $form->isMultipart() and print 'enctype="multipart/form-data" ' ?>>
-
<?php if (!$form->getObject()->isNew()): ?>
-
<input type="hidden" name="sf_method" value="put" />
-
<?php endif; ?>
-
<table>
-
<tfoot>
-
<tr>
-
<td colspan="2">
-
<?php echo $form->renderHiddenFields() ?>
-
<a href="<?php echo url_for('opFreepagePlugin/index') ?>">キャンセル</a>
-
<?php if (!$form->getObject()->isNew()): ?>
-
<?php echo link_to('削除', 'opFreepagePlugin/delete?id='.$form->getObject()->getId(), array('method' => 'delete', 'confirm' => '本当に削除しますか？')) ?>
-
<?php endif; ?>
-
<input type="submit" value="<?php echo $form->getObject()->isNew() ? '作成' : '更新' ?>" />
-
</td>
-
</tr>
-
</tfoot>
-
<tbody>
-
<?php echo $form->renderGlobalErrors() ?>
-
<tr>
-
<th><?php echo $form['title']->renderLabel() ?></th>
-
<td>
-
<?php echo $form['title']->renderError() ?>
-
<?php echo $form['title'] ?>
-
</td>
-
</tr>
-
<tr>
-
<th><?php echo $form['body']->renderLabel() ?></th>
-
<td>
-
<?php echo $form['body']->renderError() ?>
-
<?php echo $form['body'] ?>
-
</td>
-
</tr>
-
<tr>
-
<th><?php echo $form['app_type']->renderLabel() ?></th>
-
<td>
-
<?php echo $form['app_type']->renderError() ?>
-
<?php echo $form['app_type'] ?>
-
</td>
-
</tr>
-
<tr>
-
<th><?php echo $form['auth']->renderLabel() ?></th>
-
<td>
-
<?php echo $form['auth']->renderError() ?>
-
<?php echo $form['auth'] ?>
-
</td>
-
</tr>
-
</tbody>
-
</table>
-
</form>
この_form部分テンプレートは、新規作成と編集の両方に対応しているテンプレートですので、ところどころで三項演算子の分岐で新規作成時と編集時の描画内容を分けています。このようにフォームの描画部分を１つのファイルにまとめることで、効率の良いコード保守ができるわけです。
一応これでフォームは表示できるのですが、symfonyが自動で生成したフォームは余計なフィールドが混ざっているので、たいていはカスタマイズが必要です。今回もcreated_atやupdated_atを表示させないようにしたり、app_typeやauthの表示方法を変更するために、フォームファイルをカスタマイズします。/plugins/opFreepagePlugin/lib/form/FreepageForm.class.phpを開いて、クラスの中身を以下のように書き換えます。
-
-
public function configure()
-
{
-
-
-
$this->validatorSchema['app_type'] = new sfValidatorChoice(array('choices' => array_keys(self::$app_types)));
-
-
$this->widgetSchema['auth'] = new sfWidgetFormChoice(array('choices' => self::$auths, 'multiple' => false, 'expanded' => true));
-
$this->validatorSchema['auth'] = new sfValidatorChoice(array('choices' => array_keys(self::$auths)));
-
-
'app_type' => 'アプリケーションタイプ',
-
'auth' => '認証が必要',
-
));
-
}
上から順番に処理の内容を言うと、bodyフィールドのcols・rowsの設定、app_typeフィールドをセレクトボックスとし選択肢を限定、authフィールドをオプションボタンとし選択肢を限定、いくつかのフィールドのラベルを変更、となっています。実は最初authフィールドをチェックボックスとして実装したのですが、0と1で判断するauthフィールドとはなぜか相性が良くないらしく、編集時にauth=0のはずがチェックがされた状態で描画されてしまいました。とりあえずオプションボタンにすることで回避できました。
以上で管理画面側は全て出来上がりました。実際に編集画面を見てみるとこんな感じになります。
次回はPC/mobileの実際の表示画面の作成をやります。次回の内容でプラグインの機能部分は終わって、それ以降はプラグインの微調整と、プラグインのリリースなどが待っています。あともう少しでプラグインの完成です！
