Debian Codegraph @

vendor/ipl/validator/src/CallbackValidator.php

raw
1 <?php
2
3 namespace ipl\Validator;
4
5 /**
6 * Delegate validation to a callable
7 *
8 * # Example Usage
9 *
10 * $dedup = new CallbackValidator(function ($value, CallbackValidator $validator) {
11 * if (already_exists_in_database($value)) {
12 * $validator->addMessage('Record already exists in database');
13 *
14 * return false;
15 * }
16 *
17 * return true;
18 * });
19 *
20 * $dedup->isValid($id);
21 */
22 class CallbackValidator extends BaseValidator
23 {
24 /** @var callable Validation callback */
25 protected $callback;
26
27 /**
28 * Create a new CallbackValidator
29 *
30 * @param callable $callback Validation callback
31 */
32 public function __construct(callable $callback)
33 {
34 $this->callback = $callback;
35 }
36
37 /**
38 * Check whether the value passes the validation callback
39 *
40 * @param mixed $value
41 *
42 * @return bool
43 */
44 public function isValid($value): bool
45 {
46 // Reset messages from a previous isValid() call.
47 $this->clearMessages();
48
49 return call_user_func($this->callback, $value, $this);
50 }
51 }