Liform 项目使用教程

Liform 项目使用教程

Liform PHP library to render Symfony Forms to JSON Schema 项目地址: https://gitcode.com/gh_mirrors/li/Liform

1. 项目目录结构及介绍

Liform 项目的目录结构如下：

Liform/
├── src/
│   └── Limenius/
│       └── Liform/
│           ├── Transformer/
│           └── Resolver.php
├── tests/
│   └── Limenius/
│       └── Liform/
│           └── Tests/
├── .gitignore
├── composer.json
├── LICENSE
├── phpcs.xml.dist
├── phpstan-baseline.neon
├── phpstan.neon
├── phpunit.xml.dist
└── README.md

目录结构介绍

• src/: 包含项目的核心代码，主要逻辑和功能实现。

  • Limenius/Liform/: 项目的主要代码目录。
    • Transformer/: 包含各种表单字段转换器的实现。
    • Resolver.php: 负责解析和设置表单字段的转换器。

• tests/: 包含项目的单元测试代码。

  • Limenius/Liform/Tests/: 包含各种测试用例。

• .gitignore: Git 忽略文件列表。

• composer.json: Composer 依赖管理文件。

• LICENSE: 项目许可证文件。

• phpcs.xml.dist: PHP CodeSniffer 配置文件。

• phpstan-baseline.neon: PHPStan 基线配置文件。

• phpstan.neon: PHPStan 配置文件。

• phpunit.xml.dist: PHPUnit 配置文件。

• README.md: 项目说明文档。

2. 项目启动文件介绍

Liform 项目没有传统的“启动文件”，因为它是一个库，而不是一个独立的应用程序。项目的核心功能是通过 src/Limenius/Liform/Resolver.php 和 src/Limenius/Liform/Transformer/ 目录下的各种转换器实现的。

Resolver.php

Resolver.php 是 Liform 项目的关键文件之一，负责解析和设置表单字段的转换器。它通过 setTransformer 方法来注册和配置不同的转换器，以便在序列化表单时使用。

use Limenius\Liform\Resolver;
use Limenius\Liform\Liform;
use Limenius\Liform\Transformer;

$resolver = new Resolver();
$resolver->setTransformer('text', Transformer\StringTransformer::class);
$resolver->setTransformer('textarea', Transformer\StringTransformer::class, 'textarea');

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

Transformer 目录

Transformer/ 目录下包含各种表单字段转换器的实现。每个转换器负责将特定类型的表单字段转换为 JSON Schema 格式。

3. 项目配置文件介绍

Liform 项目的配置主要通过 composer.json 和 phpunit.xml.dist 等文件进行管理。

composer.json

composer.json 是 Composer 的配置文件，用于管理项目的依赖和元数据。

{
    "name": "survos/liform",
    "description": "PHP library to render Symfony Forms to JSON Schema",
    "license": "MIT",
    "require": {
        "php": ">=7.1",
        "symfony/form": "^4.4|^5.0",
        "symfony/options-resolver": "^4.4|^5.0"
    },
    "autoload": {
        "psr-4": {
            "Limenius\\Liform\\": "src/Limenius/Liform"
        }
    },
    "require-dev": {
        "phpunit/phpunit": "^8.0|^9.0",
        "squizlabs/php_codesniffer": "^3.5",
        "phpstan/phpstan": "^0.12"
    }
}

phpunit.xml.dist

phpunit.xml.dist 是 PHPUnit 的配置文件，用于配置测试环境和测试套件。

<phpunit bootstrap="vendor/autoload.php" colors="true">
    <testsuites>
        <testsuite name="Liform Test Suite">
            <directory>tests</directory>
        </testsuite>
    </testsuites>
    <filter>
        <whitelist processUncoveredFilesFromWhitelist="true">
            <directory suffix=".php">src</directory>
        </whitelist>
    </filter>
</phpunit>

通过这些配置文件，Liform 项目能够管理依赖、运行测试并确保代码质量。

Liform PHP library to render Symfony Forms to JSON Schema 项目地址: https://gitcode.com/gh_mirrors/li/Liform