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
166
167
168
169
170
171
172
|
<?php
/*
** Zabbix
** Copyright (C) 2001-2019 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
class CSchemaValidator extends CValidator {
/**
* Array of required field names.
*
* @var array
*/
public $required = [];
/**
* Error message if a required field is missing.
*
* @var string
*/
public $messageRequired;
/**
* Error message if an unsupported field is given.
*
* @var string
*/
public $messageUnsupported;
/**
* Array of validators where keys are object field names and values are either CValidator objects or nulls.
*
* If the value is set to null, it will not be validated, but no $messageUnsupported error will be triggered.
*
* @var array
*/
protected $validators = [];
/**
* Array of validators to validate the whole object.
*
* @var array
*/
protected $postValidators = [];
public function __construct(array $options = []) {
// set validators via the public setter method
if (isset($options['validators'])) {
foreach ($options['validators'] as $field => $validator) {
$this->setValidator($field, $validator);
}
}
unset($options['validator']);
// set post validators via the public setter method
if (isset($options['postValidators'])) {
foreach ($options['postValidators'] as $validator) {
$this->addPostValidator($validator);
}
}
unset($options['validator']);
parent::__construct($options);
}
/**
* Checks each object field against the given validator, and then the whole object against the post validators.
*
* @param array $array
*
* @return bool
*/
public function validate($array) {
$required = array_flip($this->required);
$unvalidatedFields = array_flip(array_keys($array));
// field validators
foreach ($this->validators as $field => $validator) {
unset($unvalidatedFields[$field]);
// if the value is present
if (isset($array[$field])) {
// validate it if a validator is given, skip it otherwise
if ($validator && !$validator->validate($array[$field])) {
$this->setError($validator->getError());
return false;
}
}
// if no value is given, check if it's required
elseif (isset($required[$field])) {
$this->error($this->messageRequired, $field);
return false;
}
}
// check if any unsupported fields remain
if ($unvalidatedFields) {
reset($unvalidatedFields);
$field = key($unvalidatedFields);
$this->error($this->messageUnsupported, $field);
return false;
}
// post validators
foreach ($this->postValidators as $validator) {
if (!$validator->validate($array)) {
$this->setError($validator->getError());
return false;
}
}
return true;
}
/**
* Set a validator for a field.
*
* @param $field
* @param CValidator $validator
*/
public function setValidator($field, CValidator $validator = null) {
$this->validators[$field] = $validator;
}
/**
* Add a post validator.
*
* @param CValidator $validator
*/
public function addPostValidator(CValidator $validator) {
$this->postValidators[] = $validator;
}
/**
* Set the object name for the current validator and all included validators.
*
* @param string $name
*/
public function setObjectName($name) {
parent::setObjectName($name);
foreach ($this->validators as $validator) {
if ($validator) {
$validator->setObjectName($name);
}
}
foreach ($this->postValidators as $validator) {
$validator->setObjectName($name);
}
}
}
|
