README

基于规则验证表单数据的库。

安装

通过 Composer

$ composer require forestry/form-validator

使用方法

创建验证器

$validator = new Forestry\FormValidator\Validator();

为表单定义规则集

$rules = [
    'name' => 'alpha|required',
    'age' => 'num|required',
];

验证表单数据

$validator->validate($_POST, $rules);

if ($validator->hasErrors()) {
    $errors = $validator->getErrors();
}

显示错误消息

<label for="name">Name</label>
<input type="text" name="name" id="name">
<?= (!empty(Forestry\FormValidator\Validator::error('name')) ? Forestry\FormValidator\Validator::error('name') : '') ?>

您还可以使用自定义标记包裹错误消息

Forestry\FormValidator\Validator::error('confirm_password', '<span class="text-danger">{message}</span>');

规则

该软件包包含以下内置规则

same 规则示例

使用此规则，您可以为两个字段定义必须具有相同的值，例如密码字段

$rules['password'] = 'required|min:8';
$rules['confirm_password'] = 'same:password';

自定义消息

除了使用默认的错误消息外，您还可以为每个规则传递一个自定义的消息

$rules['tos'] = "required--Please accept the terms of service";

自定义规则

您可以定义自己的规则

首先，创建一个类，该类实现了 Forestry\FormValidator\SimpleRuleInterface 或 Forestry\FormValidator\ParameterRuleInterface。后一个用于具有参数的规则。

use Forestry\FormValidator\SimpleRuleInterface;

MyRule implements SimpleRuleInterface
{
    public function validate($value)
    {
        // Your code.
    }
    
    public function getMessage($value)
    {
        // Your code.
    }
}

然后，使用名称和完全限定的类名注册您的规则。

$validator->registerRule('myrule', '\MyRule');

如果您想更改已注册的规则，请使用 updateRule() 方法。

$validator->updateRule('url', '\MyRule');

测试

$ phpunit

贡献

有关详细信息，请参阅CONTRIBUTING。

鸣谢

• daniel-melzer
• 所有贡献者

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。