Getting Started with symfony

symfonyでは、同じデータモデルを共有するアプリケーション(application)はプロジェクト(project)に再分類されます。多くのプロジェクトでは、2つの異なるアプリケーション: フロントエンド(frontend)とバックエンド(backend)が用意されます。

プロジェクトの作成

sfproject/ディレクトリから、symfonyプロジェクトを実際に作成するためにgenerate:projectタスクを実行します:

$ php lib/vendor/symfony/data/bin/symfony generate:project PROJECT_NAME

Windowsでは次のようになります:

c:\> php lib\vendor\symfony\data\bin\symfony generate:project PROJECT_NAME

generate:projectタスクはsymfonyプロジェクトに必要なデフォルトのディレクトリ構造を生成します:

なぜsymfonyはこんなに多くのファイルを生成するのか？ フルスタックフレームワークを使う主な利点の1つは開発プロセスを標準化することです。 symfonyのファイルとディレクトリのデフォルト構造のおかげで、symfonyの知識がある開発者であればsymfonyプロジェクトのメンテナンスを引き継ぐことができます。 数分のうちに、開発者はコードに飛び込み、バグを修正し、新しい機能を追加できるようになります。

タスクを実行するときに書かなければならない文字数を短くするためにgenerate:projectタスクはプロジェクトのルートディレクトリでsymfonyショートカットも作りました。

ですので今後は、symfonyプログラムへのフルパスを使う代わりに、symfonyショートカットを使うことができます。

アプリケーションの作成

generate:appタスクを実行してfrontendアプリケーションを作ります:

$ php symfony generate:app --escaping-strategy=on --csrf-secret=UniqueSecret frontend

symfonyショートカットは実行可能なファイルなので、Unixユーザーはsymfonyを'./symfony'に置き換えることができます。

Windowsでは'symfony.bat'ファイルをプロジェクトにコピーして'php symfony'の代わりに'symfony'を使うことができます:

c:\> copy lib\vendor\symfony\data\bin\symfony.bat .

引数として渡されるアプリケーションの名前をもとに、generate:appタスクはアプリケーションに必要なデフォルトのディレクトリ構造をapps/frontend/ディレクトリで作ります:

generate:appタスクを呼び出すとき、セキュリティに関連する2つのオプションを渡すこともできます:

• --escaping-strategy: XSS攻撃を阻止する出力エスケーピングを有効にする
• --csrf-secret: CSRF攻撃を阻止するセッショントークンを有効にする

タスクにこれらの2つのオプションを渡すことで、Webでもっともよく知られる2つの脆弱性から将来の開発をセキュアにしました。 これで作業は終わりです。 symfonyはあなたに代わって自動的にセキュリティ対策を行います。

XSS(クロスサイトスクリプティング)もしくはCSRF(クロスサイトリクエストフォージェリ)を知らなければ、これらのセキュリティの脆弱性を学ぶために時間をかけてください。

ディレクトリ構造

新しく作成したプロジェクトにアクセスしてみる前に、Webサーバーが書き込みできるようにcache/とlog/ディレクトリに書き込みできるようにこれらのディレクトリの書き込みパーミッションを適切なレベルに設定する必要があります:

$ chmod 777 cache/ log/

バージョン管理ツールを使う方々のための豆知識

symfonyはsymfonyプロジェクトの2つのディレクトリ、cache/とlog/にのみ書き込みます。 バージョン管理ツールはこれらのディレクトリの内容を無視します(たとえばSubversionの場合svn:ignoreプロパティを編集します)。

データベースを設定する

最初にやりたいことの1つはおそらくプロジェクトのデータベース接続を設定することです。 symfonyフレームワークはPDOが サポートするデータベース(MySQL、PostgreSQL、SQLite、Oracle、MSSQL、・・・)をすべてサポートします。 PDOの上に、symfonyは2つのORMツール: PropelとDoctrineを搭載しています。 PropelはデフォルトのORM(オブジェクトリレーショナルマッピング)ですが、Doctrineに切り替えるのはきわめて簡単です(詳細な情報は次のセクションを参照)。

configure:databaseタスクを使えばデータベースの設定は簡単にできます:

$ php symfony configure:database "mysql:host=localhost;dbname=dbname" root mYsEcret

configure:databaseタスクは3つの引数: PDO DSN、データベースにアクセスするユーザー名、とパスワードを受け取ります。 開発サーバーのデータベースにアクセスする必要がない場合、3番目の引数を省略します。

Doctrineに切り替える

Propelの代わりにDoctrineを使うことを決めた場合、sfDoctrinePluginを有効にしてsfPropelPluginを無効にする必要があります。これはconfig/ProjectConfiguration.class.phpの次のコードを変更することで実現できます:

public function setup()
{
  $this->enableAllPluginsExcept(array('sf#PropelPlugin', 'sfCompat10Plugin'));
}

これらの変更を行った後で、次のコマンド群を立ち上げます:

$ php symfony plugin:publish-assets
$ php symfony cc
$ rm web/sfPropelPlugin
$ rm config/propel.ini
$ rm config/schema.yml
$ rm config/databases.yml

Doctrine用のデータベースを設定するには次のコマンドを実行します:

$ php symfony configure:database --name=doctrine --class=sfDoctrineDatabase "mysql:host=localhost;dbname=jobeet" root mYsEcret