Home | Symfony2Doc

ご注意

Symfony2日本語翻訳ドキュメントは内容が古くなっております。公式サイトの英語ドキュメントを参照してください。

blogチュートリアル(5) ブログ閲覧ページの作成

Note

この記事は、Symfony 2.5.6 で動作確認しています。

ページの作成

Symfony2 で新しくページを作成する場合、主に2つのステップが必要になります(参考:ガイドブックのSymfony2 でのページ作成)。

  • ルート(route)の作成 : ルーティングはURIとコントローラを関連付ける役割があります。Symfony2 は Web リクエストを元に、定義されたルーティングの中からマッチするものを見つけ出し、そのコントローラのアクションを実行します。
  • コントローラの作成 : コントローラはWebリクエストを受け取って何らかの処理をした後に、Symfony2 のResponseオブジェクトを返す役割をになっています。
  • (必要に応じて) テンプレートの作成 : コントローラでレンダリングするテンプレートファイルです。

ルーティングの作成

デフォルトでは、アプリケーション全体のルーティング設定ファイルは app/config/routing.yml です。 ほかの Symfony2 のアプリケーションと同様に、YAML、XML、PHPの形式で記述することができます。 コントローラに直にアノテーションを書いてルーティングを定義する方法もありますが、ここでは標準的な YAML 形式で記述します。

以前実行した generate:bundle コマンドによって、app/config/routing.yml に以下の記述が追加されています。

# app/config/routing.yml
MyBlogBundle:
    resource: "@MyBlogBundle/Resources/config/routing.yml"
    prefix:   /

この記述で、以下のようにルーティング名(MyBlogBundleblog)と prefix(//blog) を変更します。

# app/config/routing.yml
blog:
    resource: "@MyBlogBundle/Resources/config/routing.yml"
    prefix: /blog

このルーティング定義の意味は、「/blog から始まる URI に対応するルーティングは MyBlogBundle バンドル内の Resources/config/routing.yml で定義している。このルーティングルールを blog と呼ぶ」となります。 このように Symfony2 では、あるルーティング定義ファイルから別のルーティング定義ファイルを読み込むことができます。

次に、読み込まれる側のルーティング定義ファイルを記述します。自動生成された状態では /hello/{name} という URL に対する ルーティング定義が記述されていますが、すべて削除して次のように書き換えてください:

# src/My/BlogBundle/Resources/config/routing.yml
blog_index:
    pattern:  /
    defaults: { _controller: MyBlogBundle:Default:index }

blog_show:
    pattern:  /{id}/show
    defaults: { _controller: MyBlogBundle:Default:show }

1つのルーティングルールは、2つの要素で成り立っています。 1つ目の要素の pattern は、どのようなURIがこのルート(route)にマッチするかを表しています。 このパターンが評価される際はprefixも考慮されることに注意してください(/blog)。 もう1つの要素の defaults は、どのコントローラが実行されるかを表しています。

さきほどのprefix定義を含めて考えると、/blog/ というURIでアクセスされたときに、MyBlogBundleDefault コントローラの index アクションを実行するように定義しています。 このルーティングルールに対して、blog_indexという名前をつけています。

他にもルーティングの定義では、プレースホルダー シンタックスなどを含む、柔軟で強力な機能がたくさんあります。 詳しくは、ガイドブックのルーティングを参照してください。

コントローラの作成

さきほど作成したルーティングでは、/blog/ というURIでアクセスされると、MyBlogBundle:Default:index がフレームワークによって実行されるように定義しました。 ページの作成の2つ目のステップとして、コントローラを作成していきます。

init:bundle コマンドでバンドルを作成しているので、MyBlogBundle にはすでに DefaultController が作られているでしょう。 ファイルの中を次のように変更します:

<?php
// src/My/BlogBundle/Controller/DefaultController.php
namespace My\BlogBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;

class DefaultController extends Controller
{
    public function indexAction()
    {
        $em = $this->getDoctrine()->getManager();
        $posts = $em->getRepository('MyBlogBundle:Post')->findAll();
        return $this->render('MyBlogBundle:Default:index.html.twig', array('posts' => $posts));
    }

    public function showAction($id)
    {
        $em = $this->getDoctrine()->getManager();
        $post = $em->find('MyBlogBundle:Post', $id);
        return $this->render('MyBlogBundle:Default:show.html.twig', array('post' => $post));
    }
}

コントローラの各アクションは、メソッドの返り値として Response オブジェクトを返す必要があります。 render() メソッドを使うと、テンプレートを描画してその Response オブジェクトを返す一連の流れを 簡単に記述することができます。

index アクション(indexAction() メソッド)の中身を見てみましょう。

最初の行では、Doctrin2の EntityManager オブジェクトを取得しています。 Doctrine2では、すべてのDB操作を EntityManager を通じて行います。

2行目では、Postモデルの Repository オブジェクトを取得し、findAll() メソッドで全件取得しています。 Doctrine2の Repository オブジェクトは、個々のモデルに対するクエリのカプセル化を行うことができます。 Repository オブジェクトはモデルごとに独自のクラスとして定義して、独自のメソッドを定義することができます。 モデルごとに定義しなかった場合は、Doctrine2の標準の Repository オブジェクトが採用されます。

3行目では、render() メソッドを用いて、テンプレートファイルを描画し、Response オブジェクトを返却しています。 テンプレートファイルの命名規則は、以下のようになっています。

BundleName:ControllerName:TemplateName

例えば MyBlogBundle:Default:index.html.twig であれば、MyBlogBundle がバンドル名、Default がコントローラ名、index.html.twig がテンプレート名を指します。 この時、テンプレートファイルは src/My/BlogBundle/Resources/views/Default/index.html.twig を参照します。

blog comments powered by Disqus