controllerに書くアノテーションについて

SensioFrameworkExtraBundle

Symfony2 では、アノテーションとして Routing の情報等を書くけど、そのアノテーションに関する情報がまとまってなくて、どっかにないかなーと思っていたら、ドキュメントにあったので、紹介 + 自分なりにまとめてみます。

とりあえず、アノテーションに以下の5つの機能があるっぽい

• @Route and @Method : ルーティングの情報や、ルートに許可されるHTTPメソッドを指定
• @ParamConverter : リクエストの内容をオブジェクトに変換する機能を使用することを指定
• @Template : テンプレート名を指定する
• @Cache : HTTPキャッシュを作成するためのアノテーション

@Route and @Method

ドキュメントはコチラ → @Route and @Method

view plainprint?

1. /** 
2.  * @Route("/{id}", requirements={"id" = "\d+"}, defaults={"foo" = "bar"}) 
3.   */  
4. public function showAction($id)  
5. {  
6. }  

/**
 * @Route("/{id}", requirements={"id" = "\d+"}, defaults={"foo" = "bar"})
  */
public function showAction($id)
{
}

• @Route() では、第一引数で pattern 情報を指定
• requirements には, 正規表現などで、Route 情報に制限をかけられる
• defaults で、デフォルトで渡されるパラメータの値を設定可能
• @Routeを複数指定することもできる

view plainprint?

1. use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;  
2. use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;  
3.   
4. /** 
5.  * @Route("/blog") 
6.  */  
7. class PostController extends Controller  
8. {  
9.     /** 
10.      * @Route("/edit/{id}") 
11.      * @Method({"GET", "POST"}) 
12.      */  
13.     public function editAction($id)  
14.     {  
15.     }  
16. }  

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;

/**
 * @Route("/blog")
 */
class PostController extends Controller
{
    /**
     * @Route("/edit/{id}")
     * @Method({"GET", "POST"})
     */
    public function editAction($id)
    {
    }
}

• クラスに対して @Route 情報を記述することで、全アクションに対して機能させることも可能
• @Method({"GET", "POST"}) のように、@Method() を使用して、HTTPメソッドに制限をかけることができる。

@ParamConverter

ドキュメントはコチラ → @ParamConverter

リクエストの内容をオブジェクトに変換する機能を使用。

view plainprint?

1. use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;  
2. use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;  
3.   
4. /** 
5.  * @Route("/blog/{id}") 
6.  * @ParamConverter("post", class="SensioBlogBundle:Post") 
7.  */  
8. public function showAction(Post $post)  
9. {  
10. }  

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;

/**
 * @Route("/blog/{id}")
 * @ParamConverter("post", class="SensioBlogBundle:Post")
 */
public function showAction(Post $post)
{
}

• SensioBlogBundle:Post でPostオブジェクトがなかったら 404NotFoundが返される。
• 全てのコンバーターはParamConverterInterfaceを実装してつくる

詳細はドキュメントを参照。

@Template

ドキュメントはコチラ → @Template

view plainprint?

1. use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;  
2.   
3. :  
4.   
5. /** 
6.  * @Template("SensioBlogBundle:Post:show") 
7.  */  
8. public function showAction1($id)  
9. {  
10.     // get the Post  
11.     $post = ...;  
12.   
13.     return array('post' => $post);  
14. }  
15.   
16. /** 
17.  * @ParamConverter("post", class="SensioBlogBundle:Post") 
18.  * @Template("SensioBlogBundle:Post:show", vars={"post"}) 
19.  */  
20. public function showAction2(Post $post)  
21. {  
22. }  

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;

:

/**
 * @Template("SensioBlogBundle:Post:show")
 */
public function showAction1($id)
{
    // get the Post
    $post = ...;

    return array('post' => $post);
}

/**
 * @ParamConverter("post", class="SensioBlogBundle:Post")
 * @Template("SensioBlogBundle:Post:show", vars={"post"})
 */
public function showAction2(Post $post)
{
}

• @Template("SensioBlogBundle:Post:show")のように、テンプレートを指定することが可能
• vars を指定することで、テンプレートにデータを渡すことも可能

@Cache

ドキュメントはコチラ → @Cache

view plainprint?

1. /** 
2.  * @Cache(expires="tomorrow") 
3.  */  
4. class BlogController extends Controller  
5. {  
6.     /** 
7.      * @Cache(expires="+2 days") 
8.      */  
9.     public function indexAction()  
10.     {  
11.     }  
12. }  

/**
 * @Cache(expires="tomorrow")
 */
class BlogController extends Controller
{
    /**
     * @Cache(expires="+2 days")
     */
    public function indexAction()
    {
    }
}

このようにして、expiresでキャッシュの有効期限を指定して、キャッシュを簡単に作成可能


詳しくは、ドキュメント参照でお願いします。
とりあえず、アノテーションに関してはこんな感じ！

Posted in: annotation,routing