README

将Liform集成到Symfony中的组件。Liform是一个库，用于将Symfony表单序列化为JSON模式。可用于与liform-react或json-editor一起使用，或任何基于json-schema的表单生成器。

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

LiformBundle生成JSON模式表示，充当文档，并可用于验证您的数据，如果您愿意，还可以使用生成器生成表单。

安装

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

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

步骤 1：下载组件

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

$ composer require limenius/liform-bundle

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

步骤 2：启用组件

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

// app/AppKernel.php

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

            new Limenius\LiformBundle\LimeniusLiformBundle(),
        );

        // ...
    }

    // ...
}

用法

将表单序列化为JSON模式

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

然后$schema将包含以下JSON模式表示

{  
   "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-schemas中的信息

Liform的目标是从表单中提取尽可能多的数据，以便在模式中有一个完整的表示，包括验证和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还允许您添加扩展来定制所有类型的默认行为。
在以下示例中，我们使用扩展来向表示表单action参数的模式添加submit_url属性。

<?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的启发。

limenius / liform-bundle

维护者

详细信息