链式 $_POST 验证器

这个示例的重头戏已经在前面的示例中完成了,核心功能由Application\Filter\AbstractFilter定义。核心功能由Application\Filter\AbstractFilter定义。实际的验证是由一个验证回调数组来完成的。

如何做…

1.查看前面的示例,链式$_POST过滤器。我们将在这个示例中使用所有的类和配置文件,除非这里有说明。

  1. 首先,我们定义一个验证回调的配置数组。与前面的配方一样,每个回调应该实现Application\Filter\CallbackInterface,并且应该返回Application\Filter\Result的实例。验证器将采取这种通用形式。
  1. use Application\Filter\ { Result, Messages, CallbackInterface };
  2. $config = [
  3. // validator callbacks
  4. 'validators' => [
  5. 'key' => new class () implements CallbackInterface
  6. {
  7. public function __invoke($item, $params) : Result
  8. {
  9. // validation logic goes here
  10. return new Result($valid, $error);
  11. }
  12. },
  13. // etc.

3.接下来,我们定义了一个Application\Filter\Validator类,它在分配的数组中循环,根据其分配的验证器回调测试每个数据项。我们使这个类扩展了AbstractFilter,以便提供前面描述的核心功能。

  1. namespace Application\Filter;
  2. class Validator extends AbstractFilter
  3. {
  4. // code
  5. }
  1. 在这个类中,我们定义了一个核心的process()方法,它扫描一个数据数组,并根据分配的数组应用验证器。如果没有为这个数据集分配验证器,我们就简单地返回$valid的当前状态(即为TRUE)。
  1. public function process(array $data)
  2. {
  3. $valid = TRUE;
  4. if (!(isset($this->assignments)
  5. && count($this->assignments))) {
  6. return $valid;
  7. }
  1. 否则,我们将$this->results初始化为一个Result对象数组,其中$item属性设置为TRUE$messages属性为空数组。
  1. foreach ($data as $key => $value) {
  2. $this->results[$key] = new Result(TRUE, array());
  3. }
  1. 然后我们复制$this->assignments并检查是否有全局过滤器(由”*“键标识)。如果有,我们运行processGlobal(),然后取消设置”*“键。
  1. $toDo = $this->assignments;
  2. if (isset($toDo['*'])) {
  3. $this->processGlobalAssignment($toDo['*'], $data);
  4. unset($toDo['*']);
  5. }
  1. 最后,我们循环处理任何剩余的赋值,调用 processAssignment()。这是检查assignments数组中是否有任何字段从数据中丢失的理想场所。注意,如果任何验证回调返回FALSE,我们将$valid设置为FALSE
  1. foreach ($toDo as $key => $assignment) {
  2. if (!isset($data[$key])) {
  3. $this->results[$key] =
  4. new Result(FALSE, $this->missingMessage);
  5. } else {
  6. $this->processAssignment(
  7. $assignment, $key, $data[$key]);
  8. }
  9. if (!$this->results[$key]->item) $valid = FALSE;
  10. }
  11. return $valid;
  12. }
  1. 您还记得,每个赋值都与数据字段有键,并代表该字段的回调数组。因此,在processGlobalAssignment()中,我们需要循环浏览回调数组。但在这种情况下,由于这些赋值是全局的,我们还需要循环浏览整个数据集,并依次应用每个全局过滤器。

  2. 与等效的Application\Filter\Fiter::processGlobalAssignment()方法相比,我们需要调用mergeValidationResults()。原因是,如果$result->item的值已经是FALSE,我们需要确保它不会随后被一个TRUE的值覆盖。链中任何返回FALSE的验证器必须覆盖任何其他验证结果。

  1. protected function processGlobalAssignment($assignment, $data)
  2. {
  3. foreach ($assignment as $callback) {
  4. if ($callback === NULL) continue;
  5. foreach ($data as $k => $value) {
  6. $result = $this->callbacks[$callback['key']]
  7. ($value, $callback['params']);
  8. $this->results[$k]->mergeValidationResults($result);
  9. }
  10. }
  11. }
  1. 当我们定义了processAssignment(),以类似于processGlobalAssignment()的方式,我们需要执行分配给每个数据键的剩余回调,再次调用mergeValidationResults()
  1. protected function processAssignment($assignment, $key, $value)
  2. {
  3. foreach ($assignment as $callback) {
  4. if ($callback === NULL) continue;
  5. $result = $this->callbacks[$callback['key']]
  6. ($value, $callback['params']);
  7. $this->results[$key]->mergeValidationResults($result);
  8. }
  9. }

如何做…

与前面的示例一样,一定要定义以下类。

  • Application\Filter\Result
  • Application\Filter\CallbackInterface
  • Application\Filter\Messages
  • Application\Filter\AbstractFilter

你可以使用chap_06_post_data_config_messages.php文件,前面的示例中也有介绍。

接下来,在Application\Filter文件夹中创建一个Validator.php文件。放置步骤3至10中描述的代码。

接下来,创建一个chap_06_post_data_config_callbacks.php回调配置文件,其中包含验证回调的配置,如步骤2所述。每个回调都应该遵循这个通用模板。

  1. 'validation_key' => new class () implements CallbackInterface
  2. {
  3. public function __invoke($item, $params) : Result
  4. {
  5. $error = array();
  6. $valid = /* perform validation operation on $item */
  7. if (!$valid)
  8. $error[] = Messages::$messages['validation_key'];
  9. return new Result($valid, $error);
  10. }
  11. }

现在你可以创建一个chap_06_post_data_validation.php调用脚本,初始化自动加载并包含配置脚本。

  1. <?php
  2. require __DIR__ . '/../Application/Autoload/Loader.php';
  3. Application\Autoload\Loader::init(__DIR__ . '/..');
  4. include __DIR__ . '/chap_06_post_data_config_messages.php';
  5. include __DIR__ . '/chap_06_post_data_config_callbacks.php';

接下来,定义一个赋值数组,将数据字段映射到验证器回调键。

  1. $assignments = [
  2. 'first_name' => [ ['key' => 'length',
  3. 'params' => ['min' => 1, 'max' => 128]],
  4. ['key' => 'alnum',
  5. 'params' => ['allowWhiteSpace' => TRUE]],
  6. ['key' => 'required','params' => []] ],
  7. 'last_name'=> [ ['key' => 'length',
  8. 'params' => ['min' => 1, 'max' => 128]],
  9. ['key' => 'alnum',
  10. 'params' => ['allowWhiteSpace' => TRUE]],
  11. ['key' => 'required','params' => []] ],
  12. 'address' => [ ['key' => 'length',
  13. 'params' => ['max' => 256]] ],
  14. 'city' => [ ['key' => 'length',
  15. 'params' => ['min' => 1, 'max' => 64]] ],
  16. 'state_province'=> [ ['key' => 'length',
  17. 'params' => ['min' => 1, 'max' => 32]] ],
  18. 'postal_code' => [ ['key' => 'length',
  19. 'params' => ['min' => 1, 'max' => 16] ],
  20. ['key' => 'alnum',
  21. 'params' => ['allowWhiteSpace' => TRUE]],
  22. ['key' => 'required','params' => []] ],
  23. 'phone' => [ ['key' => 'phone', 'params' => []] ],
  24. 'country' => [ ['key' => 'in_array',
  25. 'params' => $countries ],
  26. ['key' => 'required','params' => []] ],
  27. 'email' => [ ['key' => 'email', 'params' => [] ],
  28. ['key' => 'length',
  29. 'params' => ['max' => 250] ],
  30. ['key' => 'required','params' => [] ] ],
  31. 'budget' => [ ['key' => 'float', 'params' => []] ]
  32. ];

对于测试数据,使用前面配方中描述的chap_06_post_data_filtering.php文件中定义的好数据和坏数据。之后,你就可以创建一个Application\Filter\Validator实例,并测试数据。

  1. $validator = new Application\Filter\Validator($config['validators'], $assignments);
  2. $validator->setSeparator(PHP_EOL);
  3. $validator->process($badData);
  4. echo $validator->getMessageString(40, '%14s : %-26s' . PHP_EOL);
  5. var_dump($validator->getItemsAsArray());
  6. $validator->process($goodData);
  7. echo $validator->getMessageString(40, '%14s : %-26s' . PHP_EOL);
  8. var_dump($validator->getItemsAsArray());

正如预期的那样,好的数据不会产生任何验证错误。另一方面,坏数据会产生以下输出:

链式 $_POST 验证器 - 图1

注意,缺失的字段,addressstate_province验证为FALSE,并返回缺失项目消息。