控制器

Controller基底類別 ¶

出於方便的考慮，Symfony提供了一個可選的Controller基底類別。如果你繼承它，它不會改變你控制器的任何工作原理，而且你還能夠很容易的繼承一些幫助方法和服務容器（可看，下面的訪問其他容器）：允許你在系統中訪問每一個有用的對象，類似一個數組對像一樣。這些有用的對像被稱為服務，並且symfony附帶這些服務對象，可以渲染模板，還可以記錄日誌資訊等。

在頂部使用use語句新增Controller類，然後修改HelloController去繼承它。如下所示：

// src/AppBundle/Controller/HelloController.phpnamespace AppBundle\Controller; use Symfony\Bundle\FrameworkBundle\Controller\Controller; class HelloController extends Controller{
    // ...}

而無論你是否使用Controller基類，這些幫助方法只是讓你可以方便地使用Symfony的核心功能。其實查看核心功能的最好方式就是看Controller類別本身。

產生URL ¶

generateUrl()能夠產生一個URL給路由器的輔助方法。

重定向 ¶

如果你想將使用者重新導向到另一個頁面,請使用redirectToRoute() 方法：

public function indexAction(){
    return $this->redirectToRoute('homepage');     // redirectToRoute is equivalent to using redirect() and generateUrl() together:
    // return $this->redirect($this->generateUrl('homepage'));}

預設情況下，redirectToRoute()方法執行302（暫時）重定向。如果要執行301（永久）重定向，請修改第2個參數：

public function indexAction(){
    return $this->redirectToRoute('homepage', array(), 301);}

從定向到外部網站，使用redirect()並傳入外部URL：

public function indexAction(){
    return $this->redirect('http://symfony.com/doc');}

更多細節，請參考框架起步之路由。

use Symfony\Component\HttpFoundation\RedirectResponse; 
public function indexAction()
{
    return new RedirectResponse($this->generateUrl('homepage'));
    }

渲染模板 ¶

如果你使用HTML，你應該想要去渲染一個模板。 render()方法可以用來渲染模板並且可以把輸出的內容放到你的Response 物件：

// renders app/Resources/views/hello/index.html.twig
return $this->render('hello/index.html.twig', array('name' => $name));

模板也可以防止在更深層的子目錄。但應該避免創建不必要的深層結構：

// renders app/Resources/views/hello/greetings/index.html.twigreturn $this->render('hello/greetings/index.html.twig', array(
    'name' => $name));

模板可以在任何格式的檔案中以一種通用的方式去渲染內容。雖然在大多數情況下，你使用模板來渲染HTML內容，模板也可以輕鬆地產生JavaScript，CSS，XML或你能想到的任何其他格式。若要了解如何使不同的範本格式，請參考建立並使用範本中的「範本格式」。

訪問其他服務 ¶

Symfony塞了很多有用對象，成為服務。這些服務用於呈現模板，發送電子郵件，查詢資料庫，以及你能夠想到的任何其他的」工作「。當你安裝一個新的bundle,它也可能會帶來更多的服務。

當繼承controller基底類別後，你可以透過get()方法來存取任何Symfony的服務。以下列舉了一些常見服務：

$templating = $this->get('templating'); 
$router = $this->get('router'); 
$mailer = $this->get('mailer');

到底存在哪些服務？我想要看所有的服務，請使用debug:container命令列查看：

$ php bin/console debug:container

更多資訊請看服務容器

管理錯誤和404頁面 ¶

如果有些動作沒找到，將會回傳一個404回應。為此，你需要拋出一個異常。如果你繼承了基礎的Controller類，你可以執行以下操作：

public function indexAction(){
    // retrieve the object from database
    $product = ...;
    if (!$product) {
        throw $this->createNotFoundException('The product does not exist');
    }     return $this->render(...);}

createNotFoundException() 方法建立了一個特殊的NotFoundHttpException對象，來觸發symfony內部的http的404響應。

當然，你也可以自由地拋出你控制器中的任何Exception類，Symfony將自動回傳HTTP回應碼500。

throw new \Exception('Something went wrong!');

在每個範例中，一個帶有格式的錯誤頁被顯示給最終用戶，而一個全是錯誤的調試頁會被顯示給開發者（當在調試模式app_dev.php 查看該頁時- 可查看配置Symfony（和環境））。

這些錯誤頁都是可以自訂的。要知道更多請閱讀“如何自訂錯誤頁面”。

Request物件作為一個控制器參數 ¶

如果你需要取得查詢參數，抓取請求頭或取得一個上傳檔案？這些資訊都儲存在Symfony的Request物件。在你的控制器裡取得它們，只需要加入Request物件作為一個參數並強制類型為Request類別：

use Symfony\Component\HttpFoundation\Request;
public function indexAction($firstName, $lastName, Request $request){
$page = $request->query->get('page', 1);     // ...}

管理Session ¶

Symfony提供了一個好用的Session對象，它能夠儲存有關使用者的信息（它可以是使用瀏覽器的人、bot或Web服務）之間的請求。預設情況下，Symfony透過使用PHP的原生Session來保存cookie中的屬性。

去取得這個session，需要呼叫Request 物件的getSession()方法。這個方法會傳回一個SessionInterface，它用最簡單的方法來儲存和抓取session的資料：

use Symfony\Component\HttpFoundation\Request; public function indexAction(Request $request){
    $session = $request->getSession();     // store an attribute for reuse during a later user request
    $session->set('foo', 'bar');     // get the attribute set by another controller in another request
    $foobar = $session->get('foobar');     // use a default value if the attribute doesn't exist
    $filters = $session->get('filters', array());}

這些屬性將會在該使用者session的有效期限內保留。

Flash Message ¶

你也可以在使用者session中儲存一些指定的訊息，這個訊息被稱為「flash message」（訊息條子）。證據規定，flash訊息只能夠使用一次：當你取回它們的時候它們會自動的消失。這種特性使得「flash」訊息特別適合儲存使用者通知。

讓我們看看我們處理表單提交的範例：

use Symfony\Component\HttpFoundation\Request; public function updateAction(Request $request){
    $form = $this->createForm(...);     $form->handleRequest($request);     if ($form->isValid()) {
        // do some sort of processing         $this->addFlash(
            'notice',
            'Your changes were saved!'
        );         // $this->addFlash is equivalent to $this->get('session')->getFlashBag()->add         return $this->redirectToRoute(...);
    }     return $this->render(...);}

在處理請求之後，控制器設定了一個名為notice的flash訊息，然後重定向。名稱（notice）並不重要 – 它就是一個確定訊息的識別符。

接下來是模板（或者是更好的，在你的基礎佈局模板），從session中讀取每一條訊息：

XML:{% for flash_message in app.session.flashBag.get('notice') %}    <div class="flash-notice">
        {{ flash_message }}    </div>{% endfor %}

PHP:<?php foreach ($view['session']->getFlash('notice') as $message): ?>
    <div class="flash-notice">        <?php echo "<div class='flash-error'>$message</div>" ?>
    </div><?php endforeach ?>

通常使用的 notice，warning和error作為不同類型提示訊息的鍵，但是你可以使用任何你需要的鍵。

要求和回應物件 ¶

如前面所提到的，框架的Request 物件會作為控制器的參數傳入並強制指定資料類型為Request 類別：

use Symfony\Component\HttpFoundation\Request; public function indexAction(Request $request){
    $request->isXmlHttpRequest(); // is it an Ajax request?     $request->getPreferredLanguage(array('en', 'fr'));     // retrieve GET and POST variables respectively
    $request->query->get('page');
    $request->request->get('page');     // retrieve SERVER variables
    $request->server->get('HTTP_HOST');     // retrieves an instance of UploadedFile identified by foo
    $request->files->get('foo');     // retrieve a COOKIE value
    $request->cookies->get('PHPSESSID');     // retrieve an HTTP request header, with normalized, lowercase keys
    $request->headers->get('host');
    $request->headers->get('content_type');}

這個Request類別有一些公共的屬性和方法，它們能夠傳回任何你需要的請求資訊。

就像Request一樣，Response物件也有一個公共的headers屬性。它是一個ResponseHeaderBag它有一些不錯的方法來getting和setting回應頭。頭名的規範化使得 Content-Type等於content-type甚至等於content_type，它們都是一樣的。

對於控制器，唯一的要求就是傳回一個Response物件。 Response類別是一個PHP對於HTTP回應的一個抽象，一個基於文字的訊息填充HTTP頭，其內容傳回客戶端：

use Symfony\Component\HttpFoundation\Response; 
// create a simple Response with a 200 status code (the default)$response = new Response('Hello '.$name, Response::HTTP_OK); 
// create a CSS-response with a 200 status code
$response = new Response('<style> ... </style>');
$response->headers->set('Content-Type', 'text/css');

也有一些特殊的類別能夠簡化某種回應：

• 對於JSON：這是一個JosnResponse。可查看 建立一個JOSN回應。

• 對於檔案操作：這是 BinaryFileResponse。可查看 Serving Files。

• 對於串流回應，有StreamedResponse。請看：流化一個回應

JSON Helper ¶

// ...public function indexAction(){
// returns '{"username":"jane.doe"}' and sets the proper Content-Type header
return $this->json(array('username' => 'jane.doe'));    
// the shortcut defines three optional arguments
// return $this->json($data, $status = 200, $headers = array(), $context = array());}