README

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

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

LiformBundle 生成 JSON schema 表示，用作文档，可用于验证您的数据，如果需要，还可以用于生成表单。

安装

首先，请注意，在 Limenius/symfony-react-sandbox 中有一个包含此包示例实现的完整示例，包括 React、Webpack 和 Symfony 标准版，供您使用。

您可以自由地克隆它、运行它、实验，并将您需要的部分复制到项目中。因为这个包主要关注前端，您需要有一个兼容的前端设置。

安装包

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

composer require limenius/liform-bundle

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

用法

将表单序列化为 JSON Schema

        $form = $this->createForm(CarType::class, $car, ['csrf_protection' => false]);
        $schema = json_encode($this->get('liform')->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 的子项。
为此，您应该创建一个新的服务定义，并添加 liform.transformer 标签。您需要通过将标签的 form_type 属性设置为相应的 block_prefix 来指定您的转换器将应用于哪些表单类型。

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

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

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

扩展默认行为

除了添加自定义的Transformer来自定义特定表单类型的序列化之外，Liform还允许您添加扩展来自定义所有类型的默认行为。
以下示例中，我们使用扩展添加了一个submit_url属性，该属性表示表单的action参数。

<?php

use Limenius\Liform\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;
    }
}

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

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

序列化初始值

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

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

序列化错误

此包注册了一个标准化器，将带有错误的表单序列化到一个数组中。这部分未经许可直接取自FOSRestBundle。复制以下语句以使用此功能。

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

包含标准化表单错误的数组的格式与liform-react包兼容。

许可证

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

LICENSE.md

致谢

使用解析器和减少器转换表单的技术灵感来源于Symfony Console Form。

survos / liform-bundle

维护者

详细信息