Caution この章では1.0のフォームシステムをまだ利用しているadminジェネレーターを説明しています。CRUDジェネレーターに関する情報は新しいフォームシステムを利用する"symfony Forms in Action" bookに移動しました。
多くのアプリケーションはデータベースに保存されたデータに基づいており、それにアクセスするためのインターフェイスを提供します。symfonyはPropelのオブジェクトに基づいたデータ操作機能を提供するモジュール作成の反復的なタスクを自動化します。オブジェクトモデルが適切に定義したのであれば、symfonyはサイト全体の管理機能(administration)も自動的に生成します。この章では、symfonyに搭載された2つのジェネレーター: scaffoldingジェネレーターとadministrationジェネレーターをお教えします。後者は完全な構文による特別な設定ファイルに依存するので、この章の多くはadministrationジェネレーターのさまざまな可能性について説明します。
Webアプリケーションにおいて、データアクセスのオペレーションはつぎのように分類できます:
これらのオペレーションは共通なので、頭文字を取った専用の略語であるCRUD(Create、Retrieval、Update、Deletion)が存在します。多くのページはこれらの1つに還もとできます。たとえば、フォーラムのアプリケーションにおいて、最新投稿のリストは検索オペレーション(retrieve)で、投稿への返答は作成オペレーション(create)に対応します。
任意のテーブルに対するCRUDオペレーションを実装する基本的なアクションとテンプレートはWebアプリケーション内部で繰り返し作られます。symfonyにおいて、バックエンドインターフェイスの初期の部分を加速するために、モデルレイヤーはCRUDオペレーションを生成できるようにするための十分な情報を持ちます。
この章全体を通して、リストはシンプルな例に基づいたsymfonyのadminジェネレーターの機能を示します。これによって8章を思い出すでしょう。これは2つのArticle
クラスとComment
クラスを含む、blogのアプリケーションのよく知られた例です。図14-1で描かれているように、リスト14-1はスキーマを示します。
リスト14-1 - blogのアプリケーションのschema.yml
の例
propel:
blog_article:
_attributes: { phpName: Article }
id:
title: varchar(255)
content: longvarchar
created_at:
blog_comment:
_attributes: { phpName: Comment }
id:
article_id:
author: varchar(255)
content: longvarchar
created_at:
図14-1 データモデルの例
コード生成を可能にするためにスキーマ作成の期間で従わなければならない特別なルールは存在しません。symfonyはスキーマをそのまま使用し、administrationを生成するためにスキーマの属性を解釈します。
TIP この章を最大限に活用するには、例の内容を実際に行う必要があります。リストで説明されたすべてのステップを眺めるのであれば、symfonyが何を生成し、生成されたコードで何が行われるのかということをより理解できるようになります。以まえに説明されたようなデータ構造を作成したり、
blog_article
とblog_comment
テーブルをともなうデータベースを作成したり、サンプルデータをこのデータベースに投入したくなるでしょう。
symfonyは、アプリケーションのバックエンドのために、schema.yml
ファイルからのモデルクラス定義に基づいて、モジュールを作成できます。生成されたadministrationモジュールだけを用いてサイト全体のadministrationを作成できます。このセクションの例においてbackend
アプリケーションに追加されたadministraionモジュールを説明します。プロジェクトがbackend
アプリケーションを持たない場合、generate:app
タスクを呼び出してスケルトンを作成してください:
> php symfony generate:app backend
administrationモジュールはgenerator.yml
という名前の特別な設定ファイルを通してモデルを解釈します。すべての生成されたコンポーネントとモジュールの外見を拡張するためにgenerator.yml
ファイルを変更できます。このようなモジュールは通常のモジュールメカニズムからの恩恵を受けます(レイアウト、バリデーション、ルーティング、カスタム設定、オートロードなど)。独自機能を生成されたadministrationに統合するために、生成されたアクションもしくはテンプレートをオーバーライドすることもできますが、generator.yml
はもっとも共通の要件を考慮して、PHPのコードの使いかたを限定的なものにします。
NOTE adminジェネレーターはsymfonyのバリデーションシステムを使うので、
sfCompat10
プラグインが自動的に有効になります。
symfonyによって、モジュールを基本単位としてadministrationをビルドします。モジュールはpropel:init-admin
タスクを利用するPropelオブジェクトに基づいて生成されます:
> php symfony propel:init-admin backend article Article
この呼び出しだけでbackend
アプリケーションのなかにArticle
クラスの定義に基づいたarticle
モジュールが作成されるので、つぎのURLからアクセスできます:
http://localhost/backend.php/article
図14-5、図14-6で描かれている生成されたモジュールの外見は商業用のアプリケーションとしてそのまま利用できるほど十分に洗練されています。
図14-5 - backend
アプリケーション内部のarticle
モジュールのlist
ビュー
図14-6 - バックエンドでarticle
モジュールのedit
ビュー
apps/backend/modules/article/
ディレクトリ内のadministrationのArticle
モジュールのコードは初期化だけ行われたので空です。このモジュールの生成されたコードを吟味するための最良の方法はブラウザーを利用してこれと情報のやりとりをすることとcache/
フォルダーの内容を確認することです。リスト14-4はキャッシュで見つかる生成されたアクションとテンプレートのリストを表示します。
リスト14-4 - 生成されたadministrationの要素(cache/backend/ENV/modules/article/
)
// actions/actions.class.phpにおいて
create // editにフォワードする
delete //レコードを削除する
edit // レコードのフィールドを修正するためにフォームを表示する
// フォーム投稿を扱う
index // listに進む
list // テーブルのすべてのレコードのリストを表示する
save // editに進む
// templates/において
_edit_actions.php
_edit_footer.php
_edit_form.php
_edit_header.php
_edit_messages.php
_filters.php
_list.php
_list_actions.php
_list_footer.php
_list_header.php
_list_messages.php
_list_td_actions.php
_list_td_stacked.php
_list_td_tabular.php
_list_th_stacked.php
_list_th_tabular.php
editSuccess.php
listSuccess.php
これは生成されたadministrationモジュールがおもに2つのビュー、edit
ビューとlist
ビューで構成されることを示します。コードを見てみると、モジュール性が非常に高く、読みやすく拡張性のあるものであることがわかります。
生成されたadministrationモジュールはYAML形式のgenerator.yml
設定ファイルで見つかるパラメーターに依存します。新しく生成されたadministrationモジュールのデフォルト設定を見るには、リスト14-5で再現されている、backend/modules/article/config/
ディレクトリに設置されたgenerator.yml
ファイルを開いてください。
リスト14-5 - ジェネレーターのデフォルト設定(backend/modules/article/config/generator.yml
)
generator:
class: sfPropelAdminGenerator
param:
model_class: Article
theme: default
この設定は基本的なadministrationを生成するために十分なものです。カスタマイズ内容はparam
キー下にtheme
の行以降に追加します(generator.yml
ファイルの下側に追加されたすべての行は少なくとも適切にインデントされた4つの空白スペースで始めなければならないことを意味します)。リスト14-6はカスタマイズされた典型的なgenerator.yml
を示しています。
リスト14-6 - 典型的なジェネレーターの完全な設定
generator:
class: sfPropelAdminGenerator
param:
model_class: Article
theme: default
fields:
author_id: { name: Article author }
list:
title: List of all articles
display: [title, author_id, category_id]
fields:
published_on: { params: date_format='dd/MM/yy' }
layout: stacked
params: |
%%is_published%%<strong>%%=title%%</strong><br /><em>by %%author%%
in %%category%% (%%published_on%%)</em><p>%%content_summary%%</p>
filters: [title, category_id, author_id, is_published]
max_per_page: 2
edit:
title: Editing article "%%title%%"
display:
"Post": [title, category_id, content]
"Workflow": [author_id, is_published, created_on]
fields:
category_id: { params: disabled=true }
is_published: { type: plain}
created_on: { type: plain, params: date_format='dd/MM/yy' }
author_id: { params: size=5 include_custom=>> Choose an author << }
published_on: { credentials: }
content: { params: rich=true tinymce_options=height:150 }
つぎのセクションでこの設定ファイルで利用可能なすべてのパラメーターの詳細内容を説明します。
ジェネレーターの設定ファイルはとても強力で、生成されたadministrationを多くの方法で変更できます。しかしこの機能には代償があります: 全体の構文の記述が読んで学ぶには長いので、文章で説明したら、この章がこの本でもっとも長くなってしまいます。ですのでsymfonyのWebサイトはこの構文を学ぶための助けになる追加リソースを提示します: administrationジェネレーターのチートシートが図14-7で再現されてます。http://www.symfony-project.org/uploads/assets/sfAdminGeneratorRefCard.pdfから保存し、この章のつぎの例を読むときにこれを頭のなかにとどめておいてください。
このセクションの例は、Comment
クラス定義に基づいて、administrationのcomment
モジュールと同様に、administrationのarticle
モジュールを調整します。propel:init-admin
タスクで後者を作成してください:
> php symfony propel:init-admin backend comment Comment
図14-7 - administrationジェネレーターのチートシート
デフォルトでは、list
ビューのカラムとedit
ビューのフィールドはschema.yml
で定義されたカラムです。generator.yml
によって、どのフィールドが表示され、隠されるかを選ぶことが可能で、これらがオブジェクトモデルに直接対応していなくても、独自のフィールドを追加できます。
administrationジェネレーターはschema.yml
ファイルのカラムごとにfield
を作ります。fields
キーの下で、それぞれのフィールドの表示方法やフォーマット方法などを修正できます。たとえば、リスト14-7で示されるフィールドの設定はtitle
フィールド用のカスタムラベルクラスと入力タイプ、そしてcontent
フィールド用のラベルとツールチップを定義します。つぎのセクションでそれぞれのパラメーターが動作する方法を詳細に説明します。
リスト14-7 - カラムに対してカスタムラベルを設定する
generator:
class: sfPropelAdminGenerator
param:
model_class: Article
theme: default
fields:
title: { name: Article Title, type: textarea_tag, params: class=foo }
content: { name: Body, help: Fill in the article body }
リスト14-8でお手本が示されているように、すべてのビューに対するこのデフォルトの定義に加えて、任意のビュー(list
とedit
)のためのフィールドの設定をオーバーライドできます。
リスト14-8 - ビュー単位でグローバルな設定ビューをオーバーライドする
generator:
class: sfPropelAdminGenerator
param:
model_class: Article
theme: default
fields:
title: { name: Article Title }
content: { name: Body }
list:
fields:
title: { name: Title }
edit:
fields:
content: { name: Body of the article }
一般的な原則があります: fields
キーの下のモジュール全体に対して設定される任意の設定も後に続くビュー固有の領域(list
とedit
)でオーバーライドできます。
fields
セクションで定義したフィールドはそれぞれのビューに対して表示、隠す、順番に並べるなど、さまざまな方法で分類できます。display
キーはこの目的のために使われます。たとえば、comment
モジュールのフィールドを順番に並べるには、リスト14-9のコードを使います。
リスト14-9 表示フィールドを選択する(modules/comment/config/generator.yml
)
generator:
class: sfPropelAdminGenerator
param:
model_class: Comment
theme: default
fields:
article_id: { name: Article }
created_at: { name: Published on }
content: { name: Body }
list:
display: [id, article_id, content]
edit:
display:
NONE: [article_id]
Editable: [author, content, created_at]
図14-8のようにlist
は3つのカラムを表示し、図14-9のように、edit
フォームは2つのグループに集められた4つのフィールドを表示します。
図14-8 - comment
モジュールのlist
ビュー内部のカスタムカラム設定
図14-9 - comment
モジュールのedit
ビュー内部でフィールドを分類する
display
設定を2つの方法で利用できます:
list
ビューのように、フィールドをシンプルな配列に記入します。NONE
を使います。値は順番に並べられたカラム名の配列です。TIP デフォルトでは、主キーのカラムはどちらのビューでも決して現れません。
当然のことながら、generator.yml
で設定されたフィールドはスキーマで定義された実際のカラムに対応している必要はありません。関連するクラスがカスタムゲッターを提供する場合、これをlist
ビューのためのフィールドとして使うことができます; ゲッターかつ/もしくはセッターが存在する場合、このクラスはedit
ビューでも利用できます。たとえば、リスト14-10のように、ArticleモデルをgetNbComments()
メソッドで拡張できます。
リスト14-10 - カスタムゲッターをモデルに追加する(lib/model/Article.class.php
)
[php]
public function getNbComments()
{
return $this->countComments();
}
リスト14-11のように、nb_comments
は生成モジュールのなかのフィールドとして利用できます(ゲッターはcamelCaseバージョンのフィールド名を使います)。
リスト14-11 - カスタムゲッターはadministrationモジュールに対して追加カラムを提供する(backend/modules/article/config/generator.yml
)
generator:
class: sfPropelAdminGenerator
param:
model_class: Article
theme: default
list:
display: [id, title, nb_comments, created_at]
article
モジュールのlist
ビューの結果は図14-10で示されます。
図14-10 - article
モジュールのlist
ビュー内のカスタムフィールド
カスタムフィールドは生のデータ以上のものを表示するためにHTMLのコードも返すことができます。たとえば、リスト14-12で示されるようなComment
クラスをgetArticleLink()
メソッドで拡張できます。
リスト14-12 - HTMLを返すカスタムゲッターを追加する(lib/model/Comment.class.php
)
[php]
public function getArticleLink()
{
return link_to($this->getArticle()->getTitle(), 'article/edit?id='.$this->getArticleId());
}
リスト14-11と同じ構文でこの新しいゲッターをcomment/list
ビュー内のカスタムフィールドとして使うことができます。リスト14-13の例と、図14-11の結果をご覧ください。ゲッター(記事のハイパーリンク)によって出力されるHTMLのコードは記事の主キーの代わりに2番目のカラムに現れます。
リスト14-13 - HTML結果を返すカスタムゲッターは追加カラムとしても使える(modules/comment/config/generator.yml
)
generator:
class: sfPropelAdminGenerator
param:
model_class: Comment
theme: default
list:
display: [id, article_link, content]
図14-11 - comment
モジュールのlist
ビュー内部のカスタムフィールド
モデルに設置されたコードはプレゼンテーションから独立していなければなりません。前出のgetArticleLink()
メソッドの例はレイヤー分離の原則を順守していません。ビューのコードのなかにはモデルレイヤーに現れるものがあるからです。正しい方法で、同じ結果を実現するには、カスタムフィールドに対応したHTMLを出力するコードは部分テンプレートで対応するほうがベターです。幸いにして、administrationジェネレーターによってアンダースコアのプレフィックスを持つフィールド名を宣言できます。この場合、リスト14-13のgenerator.yml
ファイルはリスト14-14のように修正されます。
リスト14-14 - _
のプレフィックスをつけることで部分テンプレートを追加カラムとして使うことができる
list:
display: [id, _article_link, created_at]
これを機能させるには、リスト14-15で示されるように、_article_link.php
部分テンプレートをmodules/comment/tempaltes/
ディレクトリのなかに作らなければなりません。
リスト14-15 - list
ビューのための部分テンプレートの例(modules/comment/templates/_article_link.php
)
<?php echo link_to($comment->getArticle()->getTitle(), 'article/edit?id='.$comment->getArticleId()) ?>
部分テンプレートフィールドの部分テンプレートテンプレートはクラスによって命名された変数(この例では$comment
)を通して現在のオブジェクトにアクセスできることに注意してください。たとえば、UserGroup
という名前のクラスのためにビルドされたモジュールに対して、部分テンプレートは$user_group
変数を通して現在のオブジェクトにアクセスできるようになります。
レイヤー分離の原則が順守されることを除いて、結果は図14-11と同じです。レイヤー分離の原則を順守することに慣れたら、アプリケーションはより維持しやすくなります。
部分テンプレートフィールドのパラメーターをカスタマイズする必要がある場合、field
キーの下で通常のフィールドと同じ事を行います。アンダースコア(_
)をキーの先頭に含めないでください。リスト14-16をご覧ください。
リスト14-16 - 部分テンプレートフィールドのプロパティはfields
キーの下でカスタマイズできる
fields:
article_link: { name: Article }
部分テンプレートがロジックで混雑するようになったら、おそらくはこれをコンポーネントで置き換えたいと思うでしょう。リスト14-17のように、_
のプレフィックスを~
に変更することで、コンポーネントフィールドを定義できます。
リスト14-17 - コンポーネントは追加のカラムとして利用できる。~
のプレフィックスを使う
...
list:
display: [id, ~article_link, created_at]
生成されたテンプレートにおいて、現在のモジュールのarticleLink
コンポーネントを呼び出すことでこれは生成されます。
NOTE カスタムと部分テンプレートのフィールドは
list
ビュー、edit
ビューのなかと、フィルターに対して利用できます。いくつかのビューに対して同じ部分テンプレートを使う場合、コンテキスト('list'
、'edit'
、もしくは'filter'
)が$type
変数に保存されます。
edit
ビューとlist
ビューの外見を変更するために、テンプレートを変えたいと思うことがあります。しかしこれらは自動的に生成されるので、これを行うのはあまりよいアイディアではありません。代わりにgenerator.yml
設定ファイルを使用すべきです。モジュール性を損なうことなくほとんどすべての必要なことを行うことができるからです。
フィールドのカスタムセットに加えて、list
ページとedit
ページはカスタムページタイトルを持ちます。たとえば、article
ビューのタイトルをカスタマイズしたい場合、リスト14-18のように行います。edit
ビューの結果は図14-12に描かれています
リスト14-18 - それぞれのビューに対してカスタムタイトルを設定する(backend/modules/article/config/generator.yml
)
list:
title: List of Articles
...
edit:
title: Body of article %%title%%
display: [content]
図14-12 - article
モジュールのedit
ビュー内部のカスタムタイトル
デフォルトのタイトルはクラスの名前を使うので、モデルが明白なクラスの名前を使うのであれば、これらのクラス名で十分であることはよくあります。
TIP
generator.yml
の文字列の値において、フィールドの値は%%
で囲まれたフィールドの名前を通してアクセスできます。
list
とedit
ビュー内部において、表示されるフィールドを記述するための助けになるツールチップを追加できます。たとえば、ツールチップをcomment
モジュールのedit
ビューのarticle_id
フィールドに追加するには、リスト14-19のように、help
プロパティをfields
定義のなかに追加します。結果は図14-13に示されています。
リスト14-19 - edit
ビューでツールチップを設定する(modules/comment/config/generator.yml
)
edit:
fields:
...
article_id: { help: The current comment relates to this article }
図14-13 - comment
モジュールのedit
ビュー内部のツールチップ
list
ビューにおいて、ツールチップはカラムヘッダーに表示されます; edit
ビュー内において、これらはinputの下に現れます。
リスト14-20でお手本が示されているように、date_format
パラメーターを使うことで同時にカスタム書式で日付を表示できます。
リスト14-20 list
ビューのなかで日付の書式設定をする
list:
fields:
created_at: { name: Published, params: date_format='dd/MM' }
このパラメーターは以前の章で説明されたformat_date()
ヘルパーと同じフォーマットパラメーターをとります。
SIDEBAR administrationテンプレートは国際化の準備ができています
生成されたテンプレートのなかで見つかるすべてのテキストは自動的に国際化されます(たとえば、
__()
ヘルパーへの呼び出しに囲まれます)。このことは、以前の章で説明されたように、apps/frontend/i18n/
ディレクトリ内において、語句の翻訳をXLIFFファイルに追加することで、生成されたadministrationを簡単に翻訳できることを意味します。
list
ビューは、表形式、もしくはすべての詳細な内容が一行に積み重ねられた状態で、レコードの詳細を表示できます。これはフィルター、パジネーションとソート機能も含みます。これらの機能は設定によって変更できます。詳細はつぎのセクションで説明します。
デフォルトでは、list
ビューとedit
ビュー間のハイパーリンクは主キーのカラムによって生じています。図14-11に戻ると、コメントリストのid
カラムがそれぞれのコメントの主キーを表示するだけでなく、ユーザーがedit
ビューにアクセスすることを許可するハイパーリンクを提供します。
別のカラム上に現れるレコードの詳細へのハイパーリンクが望ましいのであれば、display
キーの等号(=
)をプレフィックスとしてカラムの名前に追加します。リスト14-21はlist
コメントの表示されるフィールドからid
を除去して代わりにcontent
フィールド上にハイパーリンクを置く方法を示しています。図14-14のスクリーンショットを確認してください。
リスト14-21 - edit
ビューのためのハイパーリンクをlist
ビューに移動させる(modules/comment/config/gererator.yml
)
list:
display: [article_link, =content]
図14-14 - comment
モジュールのlist
ビューのなかで、リンクを別のカラム上のedit
ビューに移動させる
デフォルトでは、以前示されたように、list
ビューは、フィールドがカラムとして表示されるtabular
レイアウトを使います。しかしstacked
レイアウトを使用してフィールドをテーブルの全長を詳しく記述する単独の文字列に連結することもできます。stacked
レイアウトを選ぶ場合、params
キーにリストのそれぞれの行の値を定義するパターンを組み込まなければなりません。たとえば、リスト14-22はcomment
モジュールのlist
ビューに対してstacked
レイヤーを定義します。結果は図14-15です。
リスト14-22 - list
ビューでstacked
レイアウトを使う(modules/comment/cofig/generator.yml
)
list:
layout: stacked
params: |
%%=content%% <br />
(sent by %%author%% on %%created_at%% about %%article_link%%)
display: [created_at, author, content]
図14-15 - comment
モジュールのlist
ビュー内部のstackedレイアウト
tabular
レイアウトはdisplay
キーの下でフィールドの配列を必要としますが、stacked
レイアウトはそれぞれのレコードに対して生成されたHTMLコードのためにparams
キーを使うことに留意してください。しかしながら、インタラクティブなソートに対して利用できるカラムヘッダーを決定するためにdisplay
配列がstacked
レイアウトでも使われます
list
ビューにおいて、フィルターのインタラクションのセットを追加できます。これらのフィルターによって、ユーザーは結果をより少なく表示して速く望むものに到達できます。フィールド名の配列で、filters
キーの下にフィルターを設定します。たとえば、図14-16のフィルターボックスと同じようなものを表示するには、リスト14-23のように、article_id
、author
フィールド、とcreated_at
フィールド上のフィルターをコメントのlist
ビューに追加します。これを機能させるには、__toString()
メソッドをArticle
クラス(たとえば、記事のtitle
を返す)に追加する必要があります。
リスト14-23 - list
ビューでフィルターを設定する(modules/comment/config/generator.yml
)
list:
filters: [article_id, author, created_at]
layout: stacked
params: |
%%=content%% <br />
(sent by %%author%% on %%created_at%% about %%article_link%%)
display: [created_at, author, content]
図14-16 - comment
モジュールのlist
ビュー内部のフィルター
symfonyによって表示されるフィルターはカラム型に依存します:
comment
モジュール内のauthor
フィールド)に対して、フィルターはワイルドカード(*
)によるテキストベースの検索を可能にするテキスト入力です。comment
モジュール内部のarticle_id
フィールドのリスト)に対して、フィルターは関連するテーブルのレコードのドロップダウンリストです。通常のobject_select_tag()
に関しては、ドロップダウンリストのオプションは関連するクラスの__toString()
メソッドによって返されるものです。comment
カラム内のcreated_at
フィールド)に対して、フィルターはリッチな日付タグのペアで(カレンダーウィジェットによって入力されたテキストフィールド)、時間の間隔を選択できるようにします。true
とfalse
とtrue or false
オプションを持つドロップダウンリストです。最後の値はフィルターを再初期化します。リストのなかで部分テンプレートフィールドを使うことと同じように、symfonyが独自に処理できないフィルターを作成するために部分テンプレートフィルターも利用できます。たとえば、2つの値(open
とclosed
)だけ含むstate
フィールドが存在するが、何らかの理由で、テーブルのリレーションを使う代わりにこれらの値をフィールドに直接保存する理由がある場合を想像してください。このフィールドのシンプルなフィールド(のstring
型)はテキストベースの検索ですが、あなたが欲しいと思うものはおそらく値のドロップダウンリストです。これを部分テンプレートフィルターで実現することは簡単です。リスト14-24の実装例をご覧ください。
リスト14-24 - 部分テンプレートフィルターを使う
[php]
// templates/_state.phpにおいて、部分テンプレートを定義する
<?php echo select_tag('filters[state]', options_for_select(array(
'' => '',
'open' => 'open',
'closed' => 'closed',
), isset($filters['state']) ? $filters['state'] : '')) ?>
// config/generator.ymlにおいて部分テンプレートフィルターをフィルターリストに追加する
list:
filters: [date, _state]
部分テンプレートが$filters
の値にアクセス可能で、フィルターの現在の値を取得するために便利であることを覚えておいてください。
空の値を探すためにとても便利な最後の1つのオプションがあります。著者を持たないコメントを表示するコメントのリストをフィルタリングしたい場合を想像してください。問題はauthorのフィルターを空のままにしておく場合、これが無視されることです。解決方法はリスト14-25のように、filter_is_empty
フィールド設定をtrue
に設定と、フィルターは追加のチェックボックスを表示するので、図14-17で図示されているように、空の値を探すことができます。
リスト14-25 - list
ビュー内部のauthor
フィールドの上に空の値のフィルタリングを追加する
list:
fields:
author: { filter_is_empty: true }
filters: [article_id, author, created_at]
図14-17 - 空のauthor
の値をフィルタリングすることを可能にする
list
ビューにおいて、図14-18で示されるように、テーブルのヘッダーはリストを再び順番に並べるために使われるハイパーリンクです。これらのヘッダーはtabular
レイアウトとstacked
レイアウトの両方で表示されます。これらのリンクをクリックするとリストの順番を再配置するsort
パラメーターでページがリロードされます。
図14-18 - list
ビューのテーブルヘッダーはソートをコントロールする
あるひとつのカラムによってソートされたリストを直接指定する構文を再利用できます:
[php]
<?php echo link_to('日付順のコメントリスト', 'comment/list?sort=created_at&type=desc' ) ?>
generator.yml
ファイルのlist
ビューに対して直接デフォルトのsort
の順番を定義することも可能です。構文はリスト14-26で示された例に従います。
リスト14-26 - list
ビューのなかでsort
フィールドのデフォルトを設定する
list:
sort: created_at
# ソートの順番を指定するための、代替構文
sort: [created_at, desc]
NOTE 実際のカラムに対応するフィールドだけが、ソートのコントロール機能に変換されます。カスタムもしくは部分テンプレートフィールドには対応していません。
生成されたadministrationは大きなテーブルさえも効率的に処理します。list
ビューがデフォルトでパジネーションを使うからです。テーブル内の実際の列の数がページごとの列の最大数を越えるとき、パジネーションのコントロール機能がリストの底に現れます。たとえば、図14-19はページごとに表示される5つのコメントの制限ではなく、テーブル内で6つのテストのコメントを持つコメントのリストを表示しますが、ページごとに表示されるコメント数は最大5まで制限されています。パジネーションはよいパフォーマンスとユーザービリティを保証します。データベースから表示される列のみが効率的に検索され、administrationモジュールによって何百万の列をかかえるテーブルでさえも管理できるからです。
図14-19 - パジネーションのコントロール機能は長いリスト上に現れる
max_per_page
パラメーターによってそれぞれのページが表示されるレコードの数をカスタマイズできます:
list:
max_per_page: 5
デフォルトでは、administrationジェネレーターはレコードのリストを検索するdoSelect()
を使います。しかし、リストで関連するオブジェクトを使う場合、リストを表示するために必要なデータベースクエリの数は急に増えることがあります。たとえば、コメントのリストで記事の名前を表示したい場合、関連するArticle
オブジェクトを検索するために追加クエリがリスト内のそれぞれの投稿に対して必要です。ですので、クエリの数を最適化するために、doSelectJoinXXX()
メソッドを使うページャーを強制したい場合があるかもしれません。これはpeer_method
パラメーターで指定できます。
list:
peer_method: doSelectJoinArticle
18章ではJoinの概念についてより広範囲に説明します。
edit
ビューにおいて、ユーザーは任意のレコードに対してそれぞれのカラムの値を修正できます。symfonyはカラムのデータ型にしたがって表示する入力のタイプを決定します。symfonyはobject_*_tag()
ヘルパーを生成し、そのヘルパーに編集するオブジェクトとプロパティを渡します。たとえば、ユーザーがtitle
フィールドを編集できることを記事のedit
ビューの設定が保証する場合です:
edit:
display: [title, ...]
このカラムはスキーマでvarchar
型として定義されているので、edit
ページはタイトルを編集するための通常のテキスト入力タグを表示します。
[php]
<?php echo object_input_tag($article, 'getTitle') ?>
デフォルトの型からフィールドへの変換ルールはつぎのとおりです:
integer
、float
、char
、varchar(size)
として定義されたカラムはedit
ビュー内でobject_input_tag()
として現れます。longvarchar
として定義されたカラムはobject_textarea_tag()
として現れます。object_select_tag()
として現れます。boolean
として定義されたカラムはobject_checkbox_tag()
として現れます。timestamp
もしくはdate
として定義されたカラムはobject_input_date_tag()
として現れます。任意のフィールドに対してカスタム入力タイプを指定するためにこれらのルールをオーバーライドしたい場合を考えます。その範囲で、fields
定義内のtype
パラメーターを特定のフォームヘルパー名に設定します。生成されたobject_*_tag()
オプションに関しては、params
パラメーターで変更可能です。リスト14-27の例をご覧ください。
リスト14-27 - edit
ビューに対してカスタム入力タイプとパラメーターを設定する
generator:
class: sfPropelAdminGenerator
param:
model_class: Comment
theme: default
edit:
fields:
## 入力をドロップし、プレーンテキストを表示するだけ
id: { type: plain }
## 入力は編集可能ではない
author: { params: disabled=true }
## 入力はテキストエリアT(object_textarea_tag)
content: { type: textarea_tag, params: rich=true css=user.css tinymce_options=width:330 }
## 入力は選択 (object_select_tag)
article_id: { params: include_custom=Choose an article }
...
param
パラメーターは生成されたobject_*_tag()
にオプションとして渡されます。たとえば、先のarticle_id
に対するparams
の定義はつぎのようにテンプレートのなかで生成されます:
[php]
<?php echo object_select_tag($comment, 'getArticleId', 'related_class=Article', 'include_custom=Choose an article') ?>
このことは通常フォームヘルパーで利用できるすべてのオプションはedit
ビューでカスタマイズできることを意味します。
部分テンプレートフィールドはlist
ビューのようにedit
ビューで使用できます。違いは、アクションにおいて、部分テンプレートフィールドによって送られたリクエストパラメーターの値にしたがって、カラムの更新を手動で扱わなければならないことです。symfonyは(実際のカラムに対応する)通常のフィールドを処理する方法を理解していますが、部分テンプレートフィールド内にインクルードした入力を処理する方法を推測することはできません。
たとえば、利用可能なフィールドがid
、nickname
、とpassword
であるUser
クラスのためのadministrationモジュールを想像してください。サイトの管理者はユーザーの要望に応じてパスワードを変更できなければなりませんが、edit
ビューはセキュリティの理由からパスワードフィールドの値を表示してはなりません。代わりに、値を変更するためにサイトの管理者が入力できる空のパスワード入力を表示します。このようなedit
ビューのためのジェネレーターの設定はリスト14-28と同じです。
リスト14-28 - 部分テンプレートフィールドをedit
ビューに含める
edit:
display: [id, nickname, _newpassword]
fields:
newpassword: { name: Password, help: Enter a password to change it, leave the field blank to keep the current one }
templates/_newpassword.php
部分テンプレートはつぎのようなコードを含みます:
[php]
<?php echo input_password_tag('newpassword', '') ?>
この部分テンプレートは、オブジェクトフォームヘルパーではなく、シンプルなフォームヘルパーを使うことに注意してください。フォームの入力を投入するために現在のUser
オブジェクトからパスワードの値を検索するとユーザーのパスワードが公開されてしまう可能性があるので、望ましくないからです。
では、アクションのなかでオブジェクトを更新するためにこのコントロール機能から値を使うには、アクションのなかでupdateUserFromrequest()
メソッドを拡張する必要があります。これを行うには、リスト14-29のように、部分テンプレートフィールドの入力に対してカスタムふるまいを持つメソッドを、同じ名前でアクションのファイルのなかに作ります。
リスト14-29 - アクションの部分テンプレートフィールドを処理する(modules/user/actions/actions.class.php
)
[php]
class userActions extends autouserActions
{
protected function updateUserFromRequest()
{
// 部分テンプレートフィールドの入力を扱う
$password = $this->getRequest()->getParameter('newpassword');
if ($password)
{
$this->user->setPassword($password);
}
// symfonyに別のフィールドを扱う
parent::updateUserFromRequest();
}
}
NOTE 実際の世界において、通常の場合、間違った入力を避けるために
user/edit
ビューは2つのpassword
フィールドを含みます。実際には、10章で見た通り、これはバリデーターを通して行われます。administraionによって生成されたモジュールは通常のモジュールと同じようにこのメカニズムから恩恵を受けます。
スキーマがテーブルのリレーションを定義する場合、生成されたadministrationモジュールはこれを活用して、より自動化されたコントロール方法を提供するので、リレーションの管理作業が大いに簡素化されます。
1対多のテーブルのリレーションはadministrationジェネレーターによって考慮されます。以前の図14-1で記述されたように、blog_comment
テーブルはarticle_id
フィールドを通してblog_article
テーブルとの関係を持ちます。Comment
クラスのモジュールをadministrationジェネレーターによって初期化する場合、comment/edit
アクションはblog_article
テーブル内の利用可能なレコードのIDを示すarticle_id
をドロップダウンリストとして表示します(説明図は図14-9を再度確認)。
加えて、Article
オブジェクトで__toString()
メソッドを定義する場合、ドロップダウンのオプションのテキストは主キーの代わりにこのメソッドを使います。
article
モジュール(多対一のリレーション)内部の記事に関連するコメントのリストを表示する場合、部分テンプレートフィールドの方法によってモジュールを少しカスタマイズする必要があります。
symfonyはテーブルの多対多のリレーションも考慮しますが、これらをスキーマで定義できないので、いくつかのパラメーターをgenerator.yml
ファイルに追加する必要があります。
多対多のリレーションの実装は中間のテーブルを必要とします。たとえば、blog_article
とblog_author
の間に多対多のリレーションがある場合(複数人によって記事が書かれ、当然のごとく著者は複数の記事を書くことができる)、図14-20に示すように、データベースはつねにblog_article_author
などと呼ばれるテーブルに帰結します。
図14-20 - 多対多のリレーションを実装するためにthrough_classを利用する
モデルはArticleAuthor
と呼ばれるクラスを持ち、administrationジェネレーターが必要とする唯一のものです。しかし、これをフィールドのthrough_class
パラメーターとして渡さなければなりません。
たとえば、Article
クラスに基づいて生成されたモジュールにおいて、リスト14-30のようにgenerator.yml
を書く場合、Author
クラスによる新しい多対多のリレーションを作るためにフィールドを追加できます。
リスト14-30 - through_class
パラメーターで多対多のリレーションを扱う
edit:
fields:
article_author: { type: admin_double_list, params: through_class=ArticleAuthor }
フィールドは既存のオブジェクト間のリンクを処理するので、通常のドロップダウンリストは十分ではありません。そのためには特別な入力タイプを使わなければなりません。symfonyは2つのリストの関連するメンバーを助けする3つのウィジェットを提供します(図14-21に描かれています):
admin_double_list
は2つの拡張された選択のコントロール機能のセットで、最初のリスト(利用可能な要素)から2番目のリスト(選択された要素)に要素を切り替えるボタンがあります。admin_select_list
は多くの要素を選択できる拡張された選択のコントロール機能です。admin_check_list
はチェックボックスタグのリストです。図14-21 - 多対多のリレーションに対して利用できるコントロール機能
administrationモジュールはユーザーが通常のCRUDオペレーションを実行できるようにしますが、ビューに対して独自のインタラクションを追加するもしくは可能なインタラクションを制限することもできます。たとえば、リスト14-31で示されているインタラクションを定義することでarticle
モジュール上のデフォルトのすべてのCRUDアクションにアクセスできるようになります。
リスト14-31 - それぞれのビューに対してインタラクションを定義する(backend/modules/article/config/generator.yml
)
list:
title: List of Articles
object_actions:
_edit: ~
_delete: ~
batch_actions:
_delete: ~
actions:
_create: ~
edit:
title: Body of article %%title%%
actions:
_list: ~
_save: ~
_save_and_add: ~
_delete: ~
list
ビューにおいて、アクションの設定が3つ存在します: すべてのオブジェクトに対して利用可能なアクション(object_actions
)、オブジェクトの選択に対して利用可能なアクション(batch_actions
)、ページ全体に対して利用可能なアクション(actions
)です。リスト14-31で定義されたリストのインタラクションは図14-22のようにレンダリングします。それぞれの行はレコードを編集するためのボタンとレコードを削除するためのボタン、それらに加えて、レコードの選択を削除するためにそれぞれの行の上に1つのチェックボックスを表示します。リストの一番下で、1つのボタンによって新しいレコードを作ることができます。
図14-22 - list
ビュー内部のインタラクション
edit
ビューにおいて、一度に編集されるレコードは1つだけであり、(actions
のもとで)定義するアクションのセットは1つだけです。リスト14-31で定義されたedit
インタラクションは図14-23のようにレンダリングされます。save
アクションとsave_and_add
アクションは現在の編集をレコードに保存します。これらのアクションの違いは、save
アクションは保存したあとで現在のレコード上にedit
ビューを表示するのに対して、save_adn_add
アクションは別のレコードを追加するために空のempty
ビューを表示することです。save_and_add
アクションは続けざまに多くのレコードを追加するときに非常に便利なショートカットです。delete
アクションの位置に関しては、これはほかのボタンから分離されているので、ユーザーが誤ってクリックすることはありません。
アンダースコア(_
)で始まるインタラクション名はsymfonyに対してこれらのアクションに対応するデフォルトのアイコンとアクションを使うように伝えます。administrationジェネレーターは_edit
、_delete
、_list
、_save
、_save_and_add
、と_create
を理解します。
図14-23 - edit
ビュー内部のインタラクション
しかしカスタムインタラクションを追加することもできます。この場合リスト14-32で示されるように、アンダースコアで始まらない名前、と現在のモジュールのなかのターゲットのアクションを指定しなければなりません。
リスト14-32 - カスタムインタラクションを定義する
list:
title: List of Articles
object_actions:
_edit: -
_delete: -
addcomment: { name: Add a comment, action: addComment, icon: backend/addcomment.png }
図14-24で示されるように、リストにおけるそれぞれのアクションはweb/images/addcomment.png
を表示します。これをクリックすることで現在のモジュール内でaddComment
アクションを呼び出すことが行われます。現在のオブジェクトの主キーはリクエストパラメーターに自動的に追加されます。
図14-24 - list
ビュー内部のカスタムインタラクション
addComment
アクションはリスト14-33のように実装できます。
リスト14-33 - カスタムインタラクションアクション(actions/actions.class.php
)
[php]
public function executeAddComment($request)
{
$comment = new Comment();
$comment->setArticleId($request->getParameter('id'));
$comment->save();
$this->redirect('comment/edit?id='.$comment->getId());
}
バッチスクリプトはsf_admin_batch_selection
リクエストパラメーターのなかで選択されたレコードの主キーの配列を受けとります。
アクションについて最後の一言です: あるカテゴリのためにアクションを完全に抑制したい場合、リスト14-34で示されるように、空のリストを使います。
リスト14-34 - list
ビューのすべてのアクションを除去する
list:
title: List of Articles
actions: {}
あなたのプロジェクトのcache/
ディレクトリのなかで生成された_edit_form.php
テンプレートを見る場合、form
フィールドが特別な命名規約を使っていることがわかります。生成されたedit
ビューにおいて、入力名はアンダースコアの構文のモデルクラスの名前と角かっこで囲まれたフィールド名を連結することで作られます。
たとえば、Article
クラスのためのedit
ビューがtitle
フィールドを持つ場合、テンプレートはリスト14-35のようになりフィールドはarticle[title]
として識別されます。
リスト14-35 - 生成された入力名の構文
// generator.yml
generator:
class: sfPropelAdminGenerator
param:
model_class: Article
theme: default
edit:
display: [title]
// _edit_form.php テンプレートの結果
<?php echo object_input_tag($article, 'getTitle', array('control_name' => 'article[title]')) ?>
// 結果のHTML
<input type="text" name="article[title]" id="article[title]" value="My Title" />
これは内部のフォームの扱い処理の間において多くの利点があります。しかしながら、10章で説明されたように、バリデーション設定が少し扱いにくくなるので、fields
定義において、角かっこの[]
を波かっこの{}
に変更しなければなりません。バリデーターに対してフィールド名をパラメーターとして使うときもまた、生成されたHTMLのコードで現れるものとしてその名前を使うべきです(すなわち引用符で波かっこを囲む形式)。生成されたフォームのための特別なバリデーターの構文の詳細についてはリスト14-36を参照してください。
リスト14-36 - administrationで生成されたフォームのためのバリデーターファイルの構文
## フィールドリストのなかの角かっこを波かっこで置き換える
fields:
article{title}:
required:
msg: You must provide a title
## バリデーターパラメーターに対して、引用符で囲んだオリジナルのフィールド名を使う
sfCompareValidator:
check: "user[newpassword]"
compare_error: The password confirmation does not match the password.
特定のadministrationモジュールに対して、利用可能なフィールドとインタラクションはログインしたユーザーのクレデンシャルによって変化します(symfonyのセキュリティ機能の説明に関しては6章を参照)。
適切なクレデンシャルを持つユーザーのみに対して表示されるようにするためにジェネレーター内部のフィールドはcredentials
パラメーターを考慮に入れます。これはlist
ビューとedit
ビューに対して機能します。加えて、ジェネレーターはクレデンシャルにしたがってインタラクションも隠すことができます。リスト14-37はこれらの機能のお手本を示しています。
リスト14-37 - クレデンシャルを使う(generator.yml
)
## idカラムはadminクレデンシャルを持つユーザーに対してのみ表示される
list:
title: List of Articles
layout: tabular
display: [id, =title, content, nb_comments]
fields:
id: { credentials: [admin] }
## addcommentインタラクションはadminクレデンシャルを持ったユーザーに制限される
list:
title: List of Articles
object_actions:
_edit: -
_delete: -
addcomment: { credentials: [admin], name: Add a comment, action: addComment, icon: backend/addcomment.png }
独自のスタイルシートを適用するだけでなく、デフォルトのテンプレートでオーバーライドすることで、生成されたモジュールのプレゼンテーションが既存のグラフィカルな表にマッチするように、そのモジュールを修正できます。
生成されたHTMLコードは構造化された内容を持つので、プレゼンテーションであなたが望むことを大いに行うことができます。
リスト14-38で示されるように、css
パラメーターを生成されたジェネレーターの設定に追加することで、administrationモジュールに対して、デフォルトの代わりにカスタムCSSを定義できます。
リスト14-38 - デフォルトの代わりにカスタムスタイルシートを使う
generator:
class: sfPropelAdminGenerator
param:
model_class: Comment
theme: default
css: mystylesheet
もう一つの方法として、ビュー単位でスタイルをオーバーライドするためにモジュールのview.yml
によって提供されるメカニズムも利用できます。
list
ビューとedit
ビューはヘッダーとフッター部分テンプレートを系統的に含むことができます。administrationモジュールのtemplates/
ディレクトリのなかにはそのような部分テンプレートは存在しませんが、部分テンプレートを自動的にインクルードするには以下の名前の1つを追加する必要があります:
_list_header.php
_list_footer.php
_edit_header.php
_edit_footer.php
たとえば、カスタムヘッダーをarticle/edit
ビューに追加したい場合、リスト14-39のように_edit_header.php
という名前のファイルを作ります。これは追加の設定なしで動作します。
リスト14-39 - edit
ヘッダー部分テンプレートの例(modules/articles/template/_edit_header.php
)
[php]
<?php if ($article->getNbComments() > 0): ?>
<h2>この記事には<?php echo $article->getNbComments() ?>のコメントがあります</h2>
<?php endif; ?>
edit
部分テンプレートはクラスによって命名された変数を通していつでも現在のオブジェクトにアクセスでき、list
部分テンプレートは$pager
変数を通していつでも現在のページャーにアクセスできることに留意してください。
SIDEBAR administrationアクションをカスタムパラメーターで呼び出す
administrationモジュールアクションは
link_to()
ヘルパーのquery_string
引数を使用してカスタムパラメーターを受けとることができます。たとえば、記事に対するコメントへのリンクを持つprevious_edit_header
部分テンプレートを拡張するには、つぎのように書きます:
[php]
<?php if ($article->getNbComments() > 0): ?>
<h2>この記事には<?php echo link_to($article->getNbComments().'のコメント', 'comment/list', array('query_string' => 'filter=filter&filters%5Barticle_id%5D='.$article->getId())) ?>があります</h2>
<?php endif; ?>
SIDEBAR
このクエリの文字列パラメーターはより読みやすいエンコードされたバージョンです。
[php] 'filter=filter&filters[article_id]='.$article->getId()
これは
$article
に関連するコメントだけを表示するためにコメントをフィルタリングします。query_string
引数を使うことで、ソートの順番かつ/またはカスタムlistビューを表示するフィルターを指定することもできます。これはカスタムインタラクションに対しても便利です。
カスタム要件を満たすために、モジュールのtemplates/
フォルダーのなかでオーバーライドできるフレームワークから継承された別の部分テンプレートが存在します。
ジェネレーターのテンプレートは個別にオーバーライドできる小さな部分に分割可能で、アクションは一つずつ変更できます。
しかしながら、同じ方法でいくつかのモジュールに対してこれらをオーバーライドしたいのであれば、おそらくは再利用可能なテーマを作るべきです。テーマ(theme)はテンプレートとアクションの完全なセットで、generator.yml
の始めでテーマの値に指定された場合、administrationモジュールのなかで使用できます。デフォルトのテーマと一緒に、symfonyは$sf_symfony_lib_dir/plugins/sfPropelPlugin/data/generator/sfPropelAdmin/default/
で定義されたファイルを使います。
テーマのファイルは$sf_symfony_lib_dir/plugins/sfPropelPlugin/data/generator/sfPropelAdmin/default/template/
ディレクトリ内部の、プロジェクトのツリー構造に設置しなければならず、デフォルトのテーマからファイルをコピーすることで新しいテーマを使い始めることができます($sf_symfony_lib_dir/plugins/sfPropelPlugin/data/generator/sfPropelAdmin/default/template/
ディレクトリに設置されます)。こうすることで、カスタムテーマテーマを用いるために必要なすべてのファイルがきちんと存在することになります:
// [theme_name]/template/templates/内の、部分テンプレート
_edit_actions.php
_edit_footer.php
_edit_form.php
_edit_header.php
_edit_messages.php
_filters.php
_list.php
_list_actions.php
_list_footer.php
_list_header.php
_list_messages.php
_list_td_actions.php
_list_td_stacked.php
_list_td_tabular.php
_list_th_stacked.php
_list_th_tabular.php
// [theme_name]/template/actions/actions.class.php内のアクション
processFilters() // リクエストフィルターを処理する
addFiltersCriteria() // フィルターをCriteriaオブジェクトに追加する
processSort()
addSortCriteria()
テンプレートファイルは実際にはテンプレートのテンプレート(templates of templates)であることに注意してください。すなわち、PHPのファイルはジェネレーターの設定に基づいたテンプレートを生成する特別なユーティリティによって解析されます(これはコンパイレーションフェーズ(compilation phase)と呼ばれます)。生成されたテンプレートが実際にブラウジングしている間に実行されるPHPのコードを含まなければならないので、テンプレートのテンプレートは最初のパスの間にPHPのコードを実行しないようにするために代替構文を使います。リスト14-40はデフォルトのテンプレートのテンプレートの抜粋です。
リスト14-40 - テンプレートのテンプレートの構文
[php]
<?php foreach ($this->getPrimaryKey() as $pk): ?>
[?php echo object_input_hidden_tag($<?php echo $this->getSingularName() ?>,'get<?php echo $pk->getPhpName() ?>') ?]
<?php endforeach; ?>
このリストにおいて、(コンパイル時に)<?
によって導入されたPHPのコードは即座に実行され、[?
によって導入されたものは実行時のみに実行されますが、テンプレートエンジンは最後には[?
タグを<?
タグに変換するのでテンプレートの結果はつぎのようになります:
[php]
<?php echo object_input_hidden_tag($article, 'getId') ?>
テンプレートのテンプレートは扱いにくいので、独自のテーマを作りたい場合、もっともお勧めすることはデフォルトのテーマから始め、少しずつ修正し、頻繁にテストすることです。
TIP ジェネレーターのテーマをプラグインのパッケージにすることができるので、再利用性が高くなり、複数のアプリケーションにまたがってデプロイすることが簡単になります。詳細な情報は17章を参照してください。
-
SIDEBAR 独自のジェネレーターを開発する
administrationジェネレーターはsymfonyの内部コンポーネントのセットを使います。内部コンポーネントはキャッシュ内部に生成されたアクションとテンプレート、テーマの使用、テンプレートのテンプレートの解析を自動化します。
このことはsymfonyが既存のジェネレーターとは似ているもしくは完全に異なる独自のジェネレーターを作るためのすべてのツールを提供することを意味します。モジュールの生成は
sfGeneratorManager
クラスのgenerate()
メソッドで管理されます。たとえば、administrationを生成するために、symfonyは内部でつぎのコードを呼び出します:[php] $generator_manager = new sfGeneratorManager(); $data = $generator_manager->generate('sfPropelAdminGenerator', $parameters);
独自のジェネレーターを開発したい場合、
sfGeneratorManeger
クラスとsfGenerator
クラスのAPIドキュメントを見て、sfAdminGenerator
クラスとsfCRUDGenerator
クラスを例としてください。
バックエンドのアプリケーションを自動的に生成したい場合、基本はよく定義されたスキーマとオブジェクトモデルです。administrationのカスタマイズによって生成されたモジュールのカスタマイゼーションの大半は設定を通して行われます。
generator.yml
ファイルは生成されたバックエンドのプログラミングにおいて中心的な役割を果たします。このファイルによって内容、機能、list
ビューとedit
ビューの見た目を完全にカスタマイズできます。またPHPのコードを一行も書かずに、フィールドラベル、ツールチップ、フィルター、ソートの順番、ページのサイズ、入力タイプ、外部のリレーション、カスタムインタラクション、とクレデンシャルをYAMLで直接管理できます。
administrationジェネレーターが必要な機能をネイティブにサポートしない場合、アクションをオーバーライドする部分テンプレートフィールドと機能は完全な拡張性を提供します。それに加えて、テーマのメカニズムのおかげで、administrationジェネレーターのメカニズムへの適合方法を再利用できます。