README

将 Liform 集成到 Symfony 的 Bundle。Liform 是一个将 Symfony 表单序列化为 JSON schema 的库。适用于 jsonform-react 或 json-editor，或任何基于 json-schema 的表单生成器。

维护与客户端技术（如 JavaScript）中的表单匹配的 Symfony 表单非常繁琐。维护此类表单的文档也很繁琐。而且，它也容易出错。

LiformBundle 生成一个 JSON schema 表示形式，充当文档，可用于验证您的数据，如果需要，还可以使用生成器生成表单。

安装

首先，请注意，您可以在 Limenius/symfony-react-sandbox 找到一个完整的示例，包括使用 React、Webpack 和 Symfony 标准版的示例实现，这包括此 Bundle 的示例实现。

您可以随意克隆它、运行它、进行实验，并将您需要的部分复制到项目中。因为此 Bundle 主要关注前端，所以您需要有兼容的前端设置。

步骤 1: 下载 Bundle

打开控制台，导航到您的项目目录，并执行以下命令以下载此 Bundle 的最新稳定版本

$ composer require limenius/jsonform-bundle

此命令要求您全局安装了 Composer，如 Composer 文档的 安装章节 中所述。

步骤 2: 启用 Bundle

然后，通过在您的项目 app/AppKernel.php 文件中添加以下行来启用此 Bundle

// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...

            new Effiana\JsonFormBundle\LimeniusLiformBundle(),
        );

        // ...
    }

    // ...
}

用法

将表单序列化为 JSON Schema

        $form = $this->createForm(CarType::class, $car, ['csrf_protection' => false]);
        $schema = json_encode($this->get('jsonform')->transform($form));

然后 $schema 将包含一个类似以下的 JSON Schema 表示形式

{  
   "title":null,
   "properties":{  
      "name":{  
         "type":"string",
         "title":"Name",
         "propertyOrder":1
      },
      "color":{  
         "type":"string",
         "title":"Color",
         "attr":{  
            "placeholder":"444444"
         },
         "default":"444444",
         "description":"3 hexadecimal digits",
         "propertyOrder":2
      },
      "drivers":{  
         "type":"array",
         "title":"hola",
         "items":{  
            "title":"Drivers",
            "properties":{  
               "firstName":{  
                  "type":"string",
                  "propertyOrder":1
               },
               "familyName":{  
                  "type":"string",
                  "propertyOrder":2
               }
            },
            "required":[  
               "firstName",
               "familyName"
            ],
            "type":"object"
         },
         "propertyOrder":3
      }
   },
   "required":[  
      "name",
      "drivers"
   ]
}

提取到 JSON-schema 的信息

Liform 的目标是尽可能从表单中提取数据，以便在 schema 中有完整的表示，包括验证和 UI 提示。目前支持以下选项。

有关更多详细信息，请查看Liform 文档。

使用您自己的转换器

Liform 通过递归检查表单，为每个子表单找到（解析）正确的转换器，并使用该转换器构建相应的 json-schema 片段。因此，如果您想修改特定表单类型的转换方式，您可以添加一个转换器，并配置它应用于具有特定 block_prefix 的所有子表单。
为此，您应该创建一个新的服务定义，并添加 jsonform.transformer 标签。您需要通过设置标签的 form_type 属性为相应的 block_prefix 来指定您的转换器将应用于哪些表单类型。

在下面的示例中，我们正在重用 StringTransformer 类。通过指定标签的 widget 属性，我们可以将转换器限制为仅适用于具有该特定小部件的类型。

services:
    app.jsonform.file_type.transformer:
        class: "%jsonform.transformer.string.class%"
        parent: Effiana\JsonForm\Transformer\AbstractTransformer
        tags:
            - { name: jsonform.transformer, form_type: file, widget: file_widget }

当然，您可以使用您自己的 Transformer 类，只需确保在实现时实现所需的 Effiana\JsonForm\Transformer\TransformerInterface 即可。

扩展默认行为

除了添加自己的变压器来定制特定表单类型的序列化之外，Liform 还允许您添加扩展来定制所有类型的默认行为。
在下面的示例中，我们使用扩展向表示表单 action 参数的模式添加一个 submit_url 属性。

<?php

use Effiana\JsonForm\Transformer\ExtensionInterface;
use Symfony\Component\Form\FormInterface;

class FormDataExtension implements ExtensionInterface
{
    /**
     * @param FormInterface $form
     * @param array         $schema
     *
     * @return array
     */
    public function apply(FormInterface $form, array $schema)
    {
        if (!$form->isRoot()) {
            return $schema;
        }

        if (!$form->getConfig()->hasOption('action')) {
            return $schema;
        }

        $schema['submit_url'] = $form->getConfig()->getOption('action');

        return $schema;
    }
}

确保您的扩展类实现了所需的 Effiana\JsonForm\Transformer\ExtensionInterface。要注册您的扩展，创建一个新的服务定义，并向其中添加 jsonform.extension 标签。

services:
    app.jsonform.form_data.extension:
        class: MyProject\Application\Liform\FormDataExtension
        tags:
            - { name: jsonform.extension }

序列化初始值

此包注册了一个规范化器，将 FormView 类序列化为一个数组，该数组与您的 json-schema 匹配初始值。以下示例显示了如何在控制器操作中使用此功能。

$serializer = $this->get('serializer');
$initialValues = $serializer->normalize($form);

序列化错误

此包注册了一个规范化器，将带有错误的表单序列化为一个数组。这部分内容无耻地借鉴了 FOSRestBundle。复制以下语句以使用此功能。

$serializer = $this->get('serializer');
$errors = $serializer->normalize($form);

包含规范化表单错误的数组的格式与 jsonform-react 包兼容。

许可证

此包在 MIT 许可证下发布。有关完整的版权和许可信息，请查看与源代码一起分发的 LICENSE 文件。

LICENSE.md

致谢

使用解析器和减少器转换表单的技术受到了 Symfony Console Form 的启发。

effiana / jsonform-bundle

维护者

详细信息