Nette Schema 项目使用教程

Nette Schema 项目使用教程

schema 📐 Validating data structures against a given Schema. 项目地址: https://gitcode.com/gh_mirrors/schem/schema

1. 项目的目录结构及介绍

Nette Schema 是一个用于验证和标准化数据结构的库，其目录结构如下：

• src/：包含 Schema 类和相关辅助类的源代码。
• tests/：包含用于验证库的功能和性能的单元测试。
• .gitattributes：定义 Git 仓库中文件的属性。
• .gitignore：定义 Git 仓库中要忽略的文件。
• composer.json：定义项目的依赖和元数据。
• license.md：项目的许可信息。
• phpstan.neon：PHPStan 静态分析工具的配置文件。
• readme.md：项目的自述文件，包含项目介绍和使用说明。

2. 项目的启动文件介绍

在 Nette Schema 中，主要的启动文件是 Schema 类。该类负责处理输入数据，根据定义的 schema 进行验证和标准化。

以下是一个简单的示例，展示如何使用 Schema 类：

use Nette\Schema\Processor;
use Nette\Schema\Schema;

$schema = Schema::fromArray([
    'processRefund' => 'bool',
    'refundAmount' => 'int',
]);

$processor = new Processor();

try {
    $normalized = $processor->process($schema, $data);
} catch (ValidationException $e) {
    echo 'Data is invalid: ' . $e->getMessage();
}

在上面的代码中，$schema 是一个包含数据验证规则的数组，$data 是要验证的数据。$processor 是 Schema\Processor 类的实例，它负责执行验证过程。

3. 项目的配置文件介绍

Nette Schema 的配置主要是通过定义 schema 来实现的。这个 schema 描述了数据结构应该是什么样的，包括数据类型、是否必须、默认值等。

下面是一个配置文件示例，展示了如何定义一个 schema：

use Nette\Schema\Expect;

$schema = Expect::structure([
    'processRefund' => Expect::bool(false), // 定义为布尔类型，默认值为 false
    'refundAmount' => Expect::int(null)->required(), // 定义为整型，必须提供
]);

// 可以进一步定义其他规则，如：
$schema = $schema->seq('items')
    ->listOf(Expect::string()); // 定义一个名为 'items' 的列表，列表元素为字符串

在这个配置文件中，我们使用 Expect::structure 来定义一个对象结构，其中 processRefund 是一个布尔值，refundAmount 是一个整数。可以通过链式调用 required() 方法来指定一个字段是必须的。

通过这种方式，你可以创建一个详细的 schema，以验证和标准化你的数据结构。

schema 📐 Validating data structures against a given Schema. 项目地址: https://gitcode.com/gh_mirrors/schem/schema