CakePHP 4.0 -如何根据字段创建和显示验证错误？

在CakePHP 4.0中，处理表单验证错误是一个常见的任务，它可以帮助用户理解他们的输入为何不符合要求，并指导他们如何修正。以下是如何根据字段创建和显示验证错误的基础概念和相关步骤：

基础概念

验证错误：当用户提交表单时，如果输入的数据不符合模型中定义的验证规则，就会产生验证错误。

模型验证：CakePHP使用模型来定义验证规则。这些规则通常在模型的Validation文件夹中的.php文件里定义。

错误显示：验证错误通常在视图中显示，以便用户可以看到哪些字段有问题以及问题的性质。

类型

内置验证器：如NotEmpty, Email, Numeric等。
自定义验证器：开发者可以根据需要创建自己的验证逻辑。

应用场景

注册表单：确保用户名、邮箱和密码符合要求。
订单处理：验证客户输入的地址、电话号码等信息。
搜索功能：确保搜索查询的格式正确。

如何创建和显示验证错误

在模型中定义验证规则

首先，在你的模型中定义验证规则。例如，在src/Model/Table/UsersTable.php中：

namespace App\Model\Table;

use Cake\ORM\Table;
use Cake\Validation\Validator;

class UsersTable extends Table
{
    public function validationDefault(Validator $validator): Validator
    {
        $validator
            ->notEmptyString('username', 'A username is required')
            ->add('username', 'unique', [
                'rule' => 'validateUnique',
                'provider' => 'table',
                'message' => 'This username has already been taken.'
            ]);

        $validator
            ->notEmptyString('email', 'An email is required')
            ->add('email', 'valid', ['rule' => 'email'])
            ->add('email', 'unique', [
                'rule' => 'validateUnique',
                'provider' => 'table',
                'message' => 'This email has already been used.'
            ]);

        return $validator;
    }
}

在控制器中处理验证

在控制器中，使用模型的newEntity方法创建一个新的实体，并使用save方法尝试保存它。如果验证失败，错误将被存储在实体中。

namespace App\Controller;

use App\Controller\AppController;
use App\Model\Entity\User;

class UsersController extends AppController
{
    public function add()
    {
        $user = $this->Users->newEmptyEntity();
        if ($this->request->is('post')) {
            $user = $this->Users->patchEntity($user, $this->request->getData());
            if ($this->Users->save($user)) {
                $this->Flash->success(__('The user has been saved.'));
                return $this->redirect(['action' => 'index']);
            }
            $this->Flash->error(__('The user could not be saved. Please try again.'));
        }
        $this->set('user', $user);
    }
}

在视图中显示错误

在视图模板中，使用$user->getError('fieldName')来获取特定字段的错误信息，并将其显示给用户。

// src/Template/Users/add.php
<?= $this->Form->create($user) ?>
<fieldset>
    <legend><?= __('Add User') ?></legend>
    <?= $this->Form->control('username', ['error' => $user->getError('username')]) ?>
    <?= $this->Form->control('email', ['error' => $user->getError('email')]) ?>
    <?= $this->Form->control('password') ?>
</fieldset>
<?= $this->Form->button(__('Submit')) ?>
<?= $this->Form->end() ?>