(2)
(0)
(0)
(0)
Total: 2 symfony1.4(1.3)で簡単に確認画面を作るアドミンジェネレータ
exDoctrineThemePlusPlugin
すでに議論され尽くしている感がある「確認画面を作る方法」ですが、symfony1.3以降で簡単に確認画面を作成できるテーマを作成しましたので紹介します。
既に参考になるsymfonyでの確認画面の作成方法についての記事
今回紹介するプラグインを使わなくても色々な方法でsymfonyに確認画面を追加する方法については記事があります。
気をつけなくてはならないのは使用するsymfonyのバージョンによって全く動かないことがあると思いますのでバージョンの確認が必要です。
- sfFormとセッションを使った確認画面の作成方法
アシアルさん: symfonyのFormで確認画面を実装する方法(symfony1.2以上) - symfony1.2から利用できるルーティング機能を使って確認画面を作ってみる。確認画面ではhiddenタグを出力
sfObjectRouteで確認画面を作ってみる(symfony1.2以上) -
symfony1.0で利用できるアドミンジェネレーターに確認画面を追加できるプラグイン(symfony1.1まで)
sfPropelAdminGeneratorPlusPlugin
exDoctrineThemePlusPluginとは?
これはsfPropelAdminGeneratorPlusPluginとほぼ同じ機能で、このプラグインを利用すれば、タスクを実行するだけでアドミンジェネレータで確認画面付きのモジュールが作成できます。
また、作成したモジュールはgenerator.ymlでちょこっとは制御することが可能です。
入力画面に戻るためにセッションを利用していたりするのでセッションが使えることが前提になります。
プラグインをインストールする
GitHubからプラグインのソース一式をとってきます。gitが入っている環境であれば以下の手順でダウンロードできます。
$cd YOURSYMFONYPRJECTO_ROOT/plugins/
$git clone git://github.com/brtriver/exDoctrineThemePlusPlugin.git ./exDoctrineThemePlusPlugin
もし、gitの環境がない場合は GitHubのページの右上にある「Download Source」をクリックしてソースをZIPなどでダウンロードしてください。
プロジェクトでプラグインが利用できるようにする
プロジェクトのconfig/ProjectConfiguration.class.phpファイルでこのプラグンが利用できるようにenablePluginsに追加します。
-
class ProjectConfiguration extends sfProjectConfiguration
-
{
-
public function setup()
-
{
-
$this->enablePlugins('sfDoctrinePlugin', 'exDoctrineThemePlusPlugin');
-
}
-
}
プラグインのスタイルシートを適用する
このプラグインにはアドミンジェネレータで利用するスタイルシートを含んでいます。
このスタイルシートを利用するので以下のコマンドを叩いておきます。
$./symfony plugin:publish-assets
これで公開ディレクトリ以下にプラグイン名のディレクトリが作成されプラグインのスタイルシートが参照できるようになります。
キャッシュをクリアする
最後にキャッシュをクリアしておきます。
$./symfony cache:clear
これで、準備は整いました。
symfonyのタスクとしてdoctrine:generate-admin-plusが表示されれば成功です。
$./symfony list doctrine
....
:generate-admin-plus Generates a Doctrine admin module with the process to confirm input values
...
アドミンジェネレータで追加画面付きのモジュールを作成する
基本はgenerate-adminタスクと同じです。何も考えずにコマンドを叩けばOKです。
$./symfony doctrine:generate-admin-plus admin application routeormodel
routing.yml
このアドミンジェネレーターはオブジェクトルーティングを利用して確認画面の遷移を実装しています。そのため、routing.ymlには以下のような記述が追加されます。
-
article:
-
class: sfDoctrineRouteCollectionPlus
-
options:
-
model: Article
-
with_wildcard_routes: true
-
with_separated_confirm: true
classでsfDoctrineRouteCollectionPlusが指定されていることと、widh_separated_confirmという新しいオプションが存在していることが通常のルーティングと異なります。
このオプションでなんとなく気づかれると思いますが、確認画面のOn, Offはwith_separated_confirmをtrueにするかfalseにするかで切り替えることができます。
そして、generator.ymlでテーマをadmin-plusに設定すれば確認画面のための設定が完了します。
generator.yml
generator.ymlは以下のようになります。
-
generator:
-
class: sfDoctrineGenerator
-
param:
-
model_class: Article
-
theme: admin-plus
-
non_verbose_templates: true
-
with_show: false
-
singular: ~
-
plural: ~
-
route_prefix: article
-
with_doctrine_route: true
-
actions_base_class: sfActions
-
-
config:
-
actions: ~
-
fields: ~
-
list: ~
-
filter: ~
-
form: ~
-
edit: ~
-
new: ~
-
confirm: ~
themeとしてadmin-plusが指定されています。このテーマを利用しないと確認画面処理が行われません。
また、configとして確認画面用のconfirmが用意されていますが、それほど融通が効くことができません。
displayを変更したりするぐらいです。
もし、すでにアドミンジェネレーターで作成したモジュールに対してこのタスクを実行してもルーティングやgenerator.ymlは書き換えられないかもしれません。
その場合は、手動で上記２項目に変更を行う必要があります。
使用方法のまとめと注意点
切り替え方法
- さきほども説明しましたが、Objectルーティングによって確認画面への画面遷移を実装しているので、確認画面を利用しない場合は以下の設定変更を行います。
- routing.ymlのwith_separated_confirmをfalseにする
- generator.ymlのthemeをadminにする
セッションが利用できることが前提
- 確認画面から入力画面に戻るのにセッションを利用しています。そのため、セッションが利用できることが前提になります。
簡単なフォームでのみ利用可能
- 画像のアップロードなどは対応していません。フォームの入れ子のものも対応していません。シンプルなフォームのみ対応しています。
おまけ
実はdefault-plusというテーマも含んであり、このテーマを利用すれば管理画面付きモジュールのひな形作成ができます。
アドミンジェネレータとは実装も異なっていたりしますが、CakePHPのBakeのようにがっつりと確認画面付きのモジュールのひな形が欲しい場合は役にたつかもしれません。
使い方も簡単でdoctrine:generate-moduleで--theme="default-plus"を指定するだけです。
$./symfony doctrine:generate-module --theme="default-plus" frontend article Article
既存のモジュールがあればファイルを上書きしてしまいますので注意してください。
もっと楽をできるために!
この記事では具体的な実装方法にはあまり深く触れないようにしました。知らなくても簡単な確認画面であればコマンドを叩くだけで作成できるのがsymfonyの良いところでもあります。
またこのように(大変ですが)拡張すればこんなこともできるよ！というところが伝われば幸いです。
関連するその他の記事
Comments
Leave a Reply