README

在 Symfony 2 中使用 ExtJs

Packagist: https://packagist.org.cn/packages/tpg/extjs-bundle

此包的目的是简化 Symfony 2 和 ExtJS 客户端框架之间的集成。它支持

• 根据服务器端实现的实体/模型动态生成 Ext.data.Model。
• 自动将 Ext Remoting 与 Symfony 2 控制器集成。
• 为实体生成 Rest 控制器代码，支持 GET、POST、PUT、PATCH 和 DELETE。

需求

必需

• Symfony 2.3.*
• JMS 0.13.* 序列化库
• Doctrine ORM 或 ODM
• Sensio 2.3.* 生成器

可选

• Rest 控制器代码生成需要 FOSRestBundle 0.12.*

安装

使用 composer

$ composer require tpg/extjs-bundle

启用包

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new JMS\SerializerBundle\JMSSerializerBundle(),
        new \Tpg\ExtjsBundle\TpgExtjsBundle(),
    );
}

添加路由规则

# app/config/routing.yml
tpg_extjs:
  resource: "@TpgExtjsBundle/Resources/config/routing.yml"
  prefix:   /extjs

以下所有文档假设所有 ExtJs 控制器路径都以 /extjs 为前缀。

配置

tpg_extjs:
    entities:
        - @AcmeDemoBundle/Entity/
        - @AcmeDemoBundle/Model/Auto
    remoting:
        bundles:
            - AcmeDemoBundle

测试运行

单元测试是用 PHPUnit 和 Jasmine JS 编写的。如何运行单元测试在 .travis.yml 文件中。

模型/实体代码生成

您可能需要为此功能配置额外的路由规则。要生成 Ext.data.Model 代码，只需包含指向 generateModel.js 的脚本标签即可。

要生成配置中配置的所有实体和文档，

<script type="text/javascript" src="/extjs/generateModel.js"></script>

要生成一些特定实体，

<script type="text/javascript" src="/extjs/generateModel.js?model[]=Acme.DemoBundle.Entity.Person&model[]=Test.TestBundle.Model.Book"></script>

Acme.DemoBundle.Entity.Person 和 Test.TestBundle.Model.Book 是模型的完整命名空间，只需将斜杠 () 替换为点 (.) 即可。

实体类必须使用 Tpg\ExtjsBundle\Annotation\Model 注解，请参阅 Tpg/ExtjsBundle/Tests/Fixtures/Test/TestBundle/Model/*.php 的示例用法。

有一个 Twig 扩展（extjs_model），可以使将模型包含/加载到当前页面变得容易。

要生成并注入当前页面上的 ExtJS 代码，

{{ extjs_model(true, 'Acme.DemoBundle.Entity.Person', 'Test.TestBundle.Model.Book') }}

要通过脚本标签引用和加载 ExtJS 代码，

{{ extjs_model(false, 'Acme.DemoBundle.Entity.Person', 'Test.TestBundle.Model.Book') }}

远程集成

您需要配置远程参数以使 ExtJs Remoting 能够与控制器一起工作。

要生成页面上的远程集成粘合剂，只需包含

<script type="text/javascript" src="/extjs/remoteapi.js"></script>

要使控制器动作可远程访问，您需要用 Tpg\ExtjsBundle\Annotation\Direct 注解函数。

如果控制器参数期望 Symfony\Component\HttpFoundation\Request 对象，那么您需要用只包含一个参数的远程 API 包装参数。您需要将参数包装在数组中。

public function testRequestParamAction(Symfony\Component\HttpFoundation\Request $request) {
    $idResult = $request->query->get("id");
    $nameResult = $request->query->get("name");
}

$idResult 将包含 12，而 $nameResult 将包含 "EFG"。

要调用该远程 API，您需要使用。

Test.testRequestParam({"id":12, "name":"EFG"});

Rest 控制器代码生成

Rest 控制器代码生成是 Sensio 控制器生成器的扩展。生成的控制器将扩展 FOS\RestBundle\Controller\FOSRestController 类。

您需要启用以下包。

new \JMS\SerializerBundle\JMSSerializerBundle(),
new \FOS\RestBundle\FOSRestBundle(),

您还需要确保 fos_rest 的以下配置。

fos_rest:
    service:
        serializer: tpg_extjs.serializer
    routing_loader:
        default_format: json
    param_fetcher_listener: true

生成的控制器在序列化和反序列化过程中为 JMS serializer 上下文设置不同的组。

• get: 在 GET、POST、PUT、PATCH 动作期间对单个实体进行序列化。
• list: 在 GET 动作期间对实体列表进行序列化。
• post: 在 POST 动作期间对单个实体进行反序列化。
• put: 在 PUT 动作期间对单个实体进行反序列化。
• patch: 在 PATCH 动作期间对单个实体进行反序列化。

例如，

要为 Acme.DemoBundle.Entity.Person 实体生成一个 Rest 控制器（PeopleController），

php app/console generate:rest:controller --controller AcmeDemoBundle:People --entity AcmeDemoBundle:Person

实体中的属性需要指定JMS类型，以便反序列化能够正常工作。

只需控制器和实体选项是必需的，其他所有选项都可以保留为默认值。生成器将创建/更新2个文件：

• Acme\DemoBundle\Controller\PeopleController将被生成。
• Acme\DemoBundle\Resources\config\routing.rest.yml将被更新或创建

要将此生成的REST控制器包含到路由表中，只需包含

# app/config/routing.yml
acmedemo_api_rest:
  resource: "@AcemeDemoBundle/Resources/config/routing.rest.yml"
  prefix: /api
  type: rest

使用带有--trait选项的generate:rest:controller支持PHP 5.4特性，生成器将为您生成2个类：

• 特性控制器类
• 实际控制器类

将生成的代码和控制器上的自定义实现分离。这将允许您重新生成控制器，而不会影响您的自定义实现。

在Symfony中将ExtJS Rest Proxy与REST控制器连接

要在ExtJS模型中指定rest代理，您需要

// in file Acme\TestBundle\Entity\Car.php
/**
 * @Extjs\Model
 * @Extjs\ModelProxy("/api/cars")
 * @ORM\Entity
 * @ORM\Table(name="car")
 */
class Car {
...