1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
<?php
declare(strict_types=1);
namespace Askonomm\Validator;
/**
* The Validator takes in an array of fields, an array of
* validators and optionally an array of rules. If no rules
* are provided, default rules will be used instead, which are:
*
* - `ValidatorRules::len()`
* - `ValidatorRules::email()`
* - `ValidatorRules::required()`
*
* The key of each item in the `$fields` array must correspond to the
* the key of each item in the `$validators` array, so that Validator
* would know how to connect the two to each other.
*
* The `$validators` must have a value that is a string where the rules
* are separated by a `|` character, and each rule must match the key of
* the rule. Additionally, each rule can take in a modifier, where the name
* of the rule and the modifier is separated by a `:` character.
*
* For example, say we have a rule called `len` which takes a modifier that
* lets that rule validate the length of a string, in such a case we'd write
* that rule as `len:8`, which would indicate using a `len` rule and passing
* a modifier with the value `8` to it.
*
* Example usage of Validator:
*
* ```php
* $fields = ['email' => 'asko@bien.ee'];
* $validators = ['email' => 'required|email'];
* $validator = new Validator($fields, $validators);
*
* if ($validator->fails()) {
* return $validator->errors();
* }
* ```
*
* @author Asko Nomm <asko@bien.ee>
*/
class Validator
{
private array $errors = [];
public function __construct(
private array $fields,
private array $validators,
array $rules = [],
) {
if (empty($rules)) {
$this->rules = $this->defaultRules();
}
$this->validate();
}
/**
* Returns the default, built-in validation rules.
*
* @return array
*/
public function defaultRules(): array
{
return [
'len' => ValidatorRules::len(),
'email' => ValidatorRules::email(),
'required' => ValidatorRules::required(),
];
}
/**
* Runs `$this->validators` over `$this->fields` to construct
* potential errors that will be stored as an array of strings
* in `$this->errors`.
*
* @return void
*/
private function validate(): void
{
foreach ($this->validators as $field => $validator) {
$value = $this->fields[$field];
foreach (explode('|', $validator) as $item) {
if (str_contains($item, ':')) {
[$name, $modifier] = explode(':', $item);
if (!$this->rules[$name]['validates']($value, $modifier)) {
$this->errors[] = $this->rules[$name]['error']($field, $modifier);
}
} else {
if (!$this->rules[$item]['validates']($value)) {
$this->errors[] = $this->rules[$item]['error']($field);
}
}
}
}
}
/**
* Returns a boolean `true` if there have been any errors.
* Returns `false` otherwise.
*
* @return boolean
*/
public function fails(): bool
{
return count($this->errors) !== 0;
}
/**
* Returns an array of strings where each string
* is a single error that happened during validation.
*
* @return array
*/
public function errors(): array
{
return $this->errors;
}
/**
* If errors are present, returns the first one.
* Otherwise returns an empty string.
*
* @return string
*/
public function firstError(): string
{
if (count($this->errors) > 0) {
return $this->errors[0];
}
return '';
}
}
|
