Symfony2:从控制器中回显JSON以在ExtJS 4网格中使用 [英] Symfony2: Echoing JSON From a Controller for Use in an ExtJS 4 Grid

问题描述

我刚开始使用Symfony2，我试图弄清楚从控制器(例如People)中回显JSON以用于ExtJS 4网格的正确方法是什么.

当我使用香草MVC方法进行所有操作时，我的控制器将使用名为getList的方法，该方法将调用People模型的getList方法，获取结果并执行以下操作:

<?php
class PeopleController extends controller {
    public function getList() {
        $model = new People();
        $data = $model->getList();
        echo json_encode(array(
            'success' => true,
            'root' => 'people',
            'rows' => $data['rows'],
            'count' => $data['count']
        ));
    }
}
?>

• 在Symfony2中这种行为是什么样的?
• 控制器是否适合这种行为?
• (在Symfony中)解决此类问题的最佳实践是什么?

解决方案

控制器是否适合这种行为?

是的

在Symfony2中这种行为是什么样的?

(在Symfony中)解决此类问题的最佳实践是什么?

在symfony中，它看起来很像，但是有一些细微差别.

我想建议我的处理方法.让我们从路由开始:

# src/Scope/YourBundle/Resources/config/routing.yml

ScopeYourBundle_people_list:
    pattern:  /people
    defaults: { _controller: ScopeYourBundle:People:list, _format: json }

_format参数不是必需的，但是稍后您将看到为什么它很重要.

现在让我们来看看控制器

<?php
// src/Scope/YourBundle/Controller/PeopleController.php
namespace Overseer\MainBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller; 

class PeopleController extends Controller
{   
  public function listAction()
  {
    $request = $this->getRequest();

    // if ajax only is going to be used uncomment next lines
    //if (!$request->isXmlHttpRequest())
      //throw $this->createNotFoundException('The page is not found');

    $repository = $this->getDoctrine()
          ->getRepository('ScopeYourBundle:People');

    // now you have to retrieve data from people repository.
    // If the following code looks unfamiliar read http://symfony.com/doc/current/book/doctrine.html
    $items = $repository->findAll();
    // or you can use something more sophisticated:
    $items = $repository->findPage($request->query->get('page'), $request->query->get('limit'));
    // the line above would work provided you have created "findPage" function in your repository

    // yes, here we are retrieving "_format" from routing. In our case it's json
    $format = $request->getRequestFormat();

    return $this->render('::base.'.$format.'.twig', array('data' => array(
      'success' => true,
      'rows' => $items,
      // and so on
    )));
  }
  // ...
}    

控制器以路由配置中设置的格式呈现数据.在我们的例子中，它是json格式.

以下是可能的模板的示例:

{# app/Resourses/views/base.json.twig #}
{{ data | json_encode | raw }}

这种方法的优点(我是说使用_format)是，如果您决定从json切换到xml等问题，那就没有问题-只需在路由配置中替换_format，然后创建相应的模板即可. /p>

I'm just getting started with Symfony2 and I'm trying to figure out what the correct approach is for echoing out JSON from a controller (e.g., People) for use in an ExtJS 4 grid.

When I was doing everything using a vanilla MVC approach, my controller would have method called something like getList that would call the People model's getList method, take those results and do something like this:

<?php
class PeopleController extends controller {
    public function getList() {
        $model = new People();
        $data = $model->getList();
        echo json_encode(array(
            'success' => true,
            'root' => 'people',
            'rows' => $data['rows'],
            'count' => $data['count']
        ));
    }
}
?>

• What does this kind of behavior look like in Symfony2?
• Is the controller the right place for this kind of behavior?
• What are the best practices (within Symfony) for solving this kind of problem?

解决方案

Is the controller the right place for this kind of behavior?

Yes.

What does this kind of behavior look like in Symfony2?

What are the best practices (within Symfony) for solving this kind of problem?

In symfony it looks pretty much alike, but there are couple of nuances.

I want to suggest my approach for this stuff. Let's start from routing:

# src/Scope/YourBundle/Resources/config/routing.yml

ScopeYourBundle_people_list:
    pattern:  /people
    defaults: { _controller: ScopeYourBundle:People:list, _format: json }

The _format parameter is not required but you will see later why it's important.

Now let's take a look at controller

<?php
// src/Scope/YourBundle/Controller/PeopleController.php
namespace Overseer\MainBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller; 

class PeopleController extends Controller
{   
  public function listAction()
  {
    $request = $this->getRequest();

    // if ajax only is going to be used uncomment next lines
    //if (!$request->isXmlHttpRequest())
      //throw $this->createNotFoundException('The page is not found');

    $repository = $this->getDoctrine()
          ->getRepository('ScopeYourBundle:People');

    // now you have to retrieve data from people repository.
    // If the following code looks unfamiliar read http://symfony.com/doc/current/book/doctrine.html
    $items = $repository->findAll();
    // or you can use something more sophisticated:
    $items = $repository->findPage($request->query->get('page'), $request->query->get('limit'));
    // the line above would work provided you have created "findPage" function in your repository

    // yes, here we are retrieving "_format" from routing. In our case it's json
    $format = $request->getRequestFormat();

    return $this->render('::base.'.$format.'.twig', array('data' => array(
      'success' => true,
      'rows' => $items,
      // and so on
    )));
  }
  // ...
}    

Controller renders data in the format which is set in the routing config. In our case it's the json format.

Here is example of possible template:

{# app/Resourses/views/base.json.twig #}
{{ data | json_encode | raw }}

The advantage of this approach (I mean using _format) is that it if you decide to switch from json to, for example, xml than no problem - just replace _format in routing config and, of course, create corresponding template.

这篇关于Symfony2:从控制器中回显JSON以在ExtJS 4网格中使用的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！