limenius/liform
将 Symfony 表单转换为 Json Schema 的库
Requires
- php: ^7.4|^8.0
- symfony/form: ^5.4|^6.0
- symfony/serializer: ^5.4|^6.0
- symfony/translation: ^5.4|^6.0
- symfony/translation-contracts: ^1.0|^2.1|^3.0
- symfony/validator: ^5.4|^6.0
Requires (Dev)
README
此分支还合并了 git@github.com:answear/Liform.git。
Liform 是一个库，可以将 Symfony 表单序列化为 JSON schema。它可以与 liform-react 或 json-editor 一起使用，或使用基于 json-schema 的任何其他表单生成器。
它由 LiformBundle 使用，但也可以作为独立的库使用。
维护与客户端技术（如 JavaScript）中的表单相匹配的后端表单非常令人烦恼。维护此类表单的文档也同样令人烦恼，并且容易出错。
Liform 生成一个 JSON schema 表示形式，该表示形式作为文档，可用于记录、验证您的数据，如果您想的话，还可以使用生成器生成表单。
安装
打开控制台，进入您的项目目录，然后执行以下命令以下载此库的最新稳定版本
composer require survos/liform
此命令要求您全局安装了 Composer，如 Composer 文档中的 安装章节 所述。
Liform 采用其类的 PSR-4 规范名称，这意味着您可以轻松地将
Liform类加载到自己的自动加载器中。
使用方法
将表单序列化为 JSON Schema
use Limenius\Liform\Resolver; use Limenius\Liform\Liform; use Limenius\Liform\Liform\Transformer; $resolver = new Resolver(); $resolver->setTransformer('text', Transformer\StringTransformer); $resolver->setTransformer('textarea', Transformer\StringTransformer, 'textarea'); // more transformers you might need, for a complete list of what is used in Symfony // see https://github.com/Limenius/LiformBundle/blob/master/Resources/config/transformers.xml $liform = new Liform($resolver); $form = $this->createForm(CarType::class, $car, ['csrf_protection' => false]); $schema = json_encode($liform->transform($form));
并且 $schema 将包含如下的 JSON Schema 表示形式
{
"title":null,
"properties":{
"name":{
"type":"string",
"title":"Name",
"propertyOrder":1
},
"color":{
"type":"string",
"title":"Color",
"attr":{
"placeholder":"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"
]
}
使用自己的转换器
Liform 通过递归检查表单，为每个子项找到（解析）正确的转换器，并使用该转换器构建对应的 json-schema 部分。因此，如果您想修改特定表单类型的转换方式，您应该设置一个与该 block_prefix 匹配的转换器。
为此，您可以使用 Resolver 类的 setTransformer 方法。在这种情况下，我们正在重用 StringTransformer，通过覆盖 widget 属性并将其设置为 my_widget 来实现，但您也可以使用您自己的转换器。
use Limenius\Liform\Liform; $stringTransformer = $this->get('liform.transformer.string'); $resolver = $this->get('liform.resolver'); $resolver->setTransformer('file', $stringTransformer, 'file_widget'); $liform = new Liform($resolver);
序列化初始值
此库提供了一个规范化器，可以将 FormView（您可以使用 $form->createView() 创建一个）序列化为初始值数组。
use Limenius\Liform\Serializer\Normalizer\FormViewNormalizer; $encoders = array(new XmlEncoder(), new JsonEncoder()); $normalizers = array(new FormViewNormalizer()); $serializer = new Serializer($normalizers, $encoders); $initialValues = $serializer->normalize($form),
以获得与您的 json-schema 匹配的初始值数组。
序列化错误
此库提供了一个规范化器，可以将带有错误的表单序列化为数组。这部分是从 FOSRestBundle 中毫不客气地借用的。要使用此功能，请在您的控制器操作中复制以下代码
use Limenius\Liform\Serializer\Normalizer\FormErrorNormalizer; $encoders = array(new XmlEncoder(), new JsonEncoder()); $normalizers = array(new FormErrorNormalizer()); $serializer = new Serializer($normalizers, $encoders); $errors = $serializer->normalize($form),
以获得包含您的表单错误的数组。如果使用 liform-react，它可以理解此格式。
提取到 JSON-schema 的信息
Liform 的目标是尽可能从表单中提取数据，以便在 schema 中有一个完整的表示，包括验证和 UI 提示。目前支持以下选项。
一些数据可以从常用的表单属性中提取，但是，某些属性将使用一个特殊的liform数组来提供，该数组作为表单选项传递。为了更方便地实现，提供了一个表单扩展。请参阅AddLiformExtension.php
必需
如果字段是必需的（在Symfony中默认如此），它将在模式中反映出来。
class DummyType extends AbstractType { public function buildForm(FormBuilderInterface $builder, array $options) { $builder ->add('someText', Type\TextType::class); } }
{
"title":"dummy",
"type":"object",
"properties":{
"someText":{
"type":"string",
"title":"someText",
"propertyOrder":1
}
},
"required":[
"someText"
]
}
小部件
有时你可能想以不同于该类型默认行为的方式渲染一个字段。通过使用liform属性，你可以指定一个特定的小部件，以确定如何渲染该字段。
如果提供了liform的widget属性，如下所示
class DummyType extends AbstractType { public function buildForm(FormBuilderInterface $builder, array $options) { $builder ->add('someText', Type\TextType::class, [ 'liform' => [ 'widget' => 'my_widget' ] ]); } }
生成的模式将包含该widget选项
{
"title":"dummy",
"type":"object",
"properties":{
"someText":{
"type":"string",
"widget":"my_widget",
"title":"someText",
"propertyOrder":1
}
},
"required":[
"someText"
]
}
标签/标题
如果你提供了label，它将用作模式中的标题。
class DummyType extends AbstractType { public function buildForm(FormBuilderInterface $builder, array $options) { $builder ->add('someText', Type\TextType::class, [ 'label' => 'Some text', ]); } }
{
"title":"dummy",
"type":"object",
"properties":{
"someText":{
"type":"string",
"title":"Some text",
"propertyOrder":1
}
},
"required":[
"someText"
]
}
模式
如果提供了attr的pattern属性，如下所示
class DummyType extends AbstractType { public function buildForm(FormBuilderInterface $builder, array $options) { $builder ->add('someText', Type\TextType::class, [ 'attr' => [ 'pattern' => '.{5,}', ], ]); } }
它将被提取为pattern选项，因此可以用于验证。注意，除了这些之外，提供给attr的所有内容都将被保留。
{
"title":"dummy",
"type":"object",
"properties":{
"someText":{
"type":"string",
"title":"someText",
"attr":{
"pattern":".{5,}"
},
"pattern":".{5,}",
"propertyOrder":1
}
},
"required":[
"someText"
]
}
描述
如果提供了liform的description属性，如下所示，它将被提取到模式中
class DummyType extends AbstractType { public function buildForm(FormBuilderInterface $builder, array $options) { $builder ->add('someText', Type\TextType::class, [ 'label' => 'Some text', 'liform' => [ 'description' => 'This is a help message', ] ]); } }
{
"title":"dummy",
"type":"object",
"properties":{
"someText":{
"type":"string",
"title":"Some text",
"description":"This is a help message",
"propertyOrder":1
}
},
"required":[
"someText"
]
}
许可证
此库受MIT许可证的约束。请参阅文件中的完整许可证。
LICENSE.md
致谢
使用解析器和缩减器转换表单的技术灵感来源于Symfony Console Form