littlegiant / silverstripe-config-validator

为 SilverStripe 框架提供构建时配置验证。

安装: 128

依赖: 0

建议者: 0

安全: 0

星标: 4

关注者: 2

分支: 1

类型:silverstripe-vendormodule

1.0 2018-07-30 04:21 UTC

This package is auto-updated.

Last update: 2024-09-16 08:36:03 UTC


README

一个用于在构建时验证 SilverStripe 配置的模块。

Screenshot of config validation failure screen

安装

通过 composer 安装并运行 /dev/build?flush=all。这是一个零配置安装。

composer require littlegiant/silverstripe-config-validator

验证配置

配置通过实现 OwnConfigValidatorClassConfigValidator 接口进行验证。

如果类 MyClass 验证自身的配置,它应该实现 OwnConfigValidator

如果类 MyClass 验证一个或多个其他类的配置(例如 MyOtherClass),它应该实现 ClassConfigValidator,并且其 getConfigValidatedClasses() 方法应该返回一个包含 MyOtherClass::class 的数组。这是一种逐步添加对供应商提供的(例如核心 / 模块)类配置验证的好方法,而无需向这些包提交更改。

这些接口的实现不是互斥的(即,一个类可以实现这两个接口,并且它将验证自身和其他类。)

通过添加任何错误到 ClassConfigValidationResult::addError() 来验证配置。如果任何配置验证失败,/dev/build 将在数据库构建之前终止,并显示所有需要修正的配置验证错误。