-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathValidationInterface.php
More file actions
165 lines (143 loc) · 4.78 KB
/
ValidationInterface.php
File metadata and controls
165 lines (143 loc) · 4.78 KB
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<?php
declare(strict_types=1);
/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace CodeIgniter\Validation;
use CodeIgniter\Database\BaseConnection;
use CodeIgniter\HTTP\RequestInterface;
/**
* Expected behavior of a validator
*/
interface ValidationInterface
{
/**
* Runs the validation process, returning true/false determining whether
* validation was successful or not.
*
* @param array|null $data The array of data to validate.
* @param string|null $group The predefined group of rules to apply.
* @param array|BaseConnection|non-empty-string|null $dbGroup The database group to use.
*/
public function run(?array $data = null, ?string $group = null, $dbGroup = null): bool;
/**
* Check; runs the validation process, returning true or false
* determining whether or not validation was successful.
*
* @param array|bool|float|int|object|string|null $value Value to validate.
* @param array|string $rules
* @param list<string> $errors
* @param string|null $dbGroup The database group to use.
*
* @return bool True if valid, else false.
*/
public function check($value, $rules, array $errors = [], $dbGroup = null): bool;
/**
* Takes a Request object and grabs the input data to use from its
* array values.
*/
public function withRequest(RequestInterface $request): ValidationInterface;
/**
* Sets an individual rule and custom error messages for a single field.
*
* The custom error message should be just the messages that apply to
* this field, like so:
*
* [
* 'rule' => 'message',
* 'rule' => 'message',
* ]
*
* @param array|string $rules
*
* @return $this
*/
public function setRule(string $field, ?string $label, $rules, array $errors = []);
/**
* Stores the rules that should be used to validate the items.
*/
public function setRules(array $rules, array $messages = []): ValidationInterface;
/**
* Returns all of the rules currently defined.
*/
public function getRules(): array;
/**
* Checks to see if the rule for key $field has been set or not.
*/
public function hasRule(string $field): bool;
/**
* Get rule group.
*
* @param string $group Group.
*
* @return list<string> Rule group.
*/
public function getRuleGroup(string $group): array;
/**
* Set rule group.
*
* @param string $group Group.
*
* @return void
*/
public function setRuleGroup(string $group);
/**
* Returns the error for a specified $field (or empty string if not set).
*/
public function getError(string $field): string;
/**
* Returns the array of errors that were encountered during
* a run() call. The array should be in the following format:
*
* [
* 'field1' => 'error message',
* 'field2' => 'error message',
* ]
*
* @return array<string,string>
*/
public function getErrors(): array;
/**
* Sets the error for a specific field. Used by custom validation methods.
*/
public function setError(string $alias, string $error): ValidationInterface;
/**
* Resets the class to a blank slate. Should be called whenever
* you need to process more than one array.
*/
public function reset(): ValidationInterface;
/**
* Loads custom rule groups (if set) into the current rules.
*
* Rules can be pre-defined in Config\Validation and can
* be any name, but must all still be an array of the
* same format used with setRules(). Additionally, check
* for {group}_errors for an array of custom error messages.
*
* @param non-empty-string|null $group
*
* @return array
*/
public function loadRuleGroup(?string $group = null);
/**
* Checks to see if an error exists for the given field.
*/
public function hasError(string $field): bool;
/**
* Returns the rendered HTML of the errors as defined in $template.
*/
public function listErrors(string $template = 'list'): string;
/**
* Displays a single error in formatted HTML as defined in the $template view.
*/
public function showError(string $field, string $template = 'single'): string;
/**
* Returns the actual validated data.
*/
public function getValidated(): array;
}