Maslosoft Mangan API
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 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 <?php
/**
* This software package is licensed under AGPL or Commercial license.
*
* @package maslosoft/mangan
* @licence AGPL or Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
* @copyright Copyright (c) Maslosoft
* @copyright Copyright (c) Others as mentioned in code
* @link https://maslosoft.com/mangan/
*/
namespace Maslosoft\Mangan;
use InvalidArgumentException;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Mangan\Helpers\Validator\Factory;
use Maslosoft\Mangan\Interfaces\ValidatableInterface;
use Maslosoft\Mangan\Meta\ManganMeta;
/**
* Validator
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class Validator implements ValidatableInterface
{
/**
* Model instance
* @var AnnotatedInterface
*/
private $model = null;
/**
* Metadata for model
* @var ManganMeta
*/
private $meta = null;
/**
* Array of error messages.
* Keys are field names, secondary keys are numeric
* @var string[][]
*/
private $errors = [];
public function __construct(AnnotatedInterface $model)
{
$this->model = $model;
$this->meta = ManganMeta::create($this->model);
// Ensure that errors array is initialized - even if does not have validators
foreach (array_keys($this->meta->fields()) as $name)
{
$this->errors[$name] = [];
}
}
/**
* Validate model, optionally only selected fields
* @param string[] $fields
* @return boolean
*/
public function validate($fields = [])
{
$valid = [];
if (empty($fields))
{
$fields = array_keys($this->meta->fields());
}
foreach ($fields as $name)
{
$fieldMeta = $this->meta->field($name);
// Reset errors
$this->errors[$name] = [];
// Check if meta for field exists
if (empty($fieldMeta))
{
throw new InvalidArgumentException(sprintf("Unknown field `%s` in model `%s`", $name, get_class($this->model)));
}
// Validate sub documents
// Skip fields that are not updatable
if ($fieldMeta->owned && $fieldMeta->updatable)
{
if (is_array($this->model->$name))
{
// Handle arrays of documents
foreach ($this->model->$name as $fieldIndex => $model)
{
$validator = new Validator($model);
$isValid = $validator->validate();
$valid[] = (int)$isValid;
if (!$isValid)
{
$errors = [
$name => [
$fieldIndex => $validator->getErrors()
]
];
$this->setErrors($errors);
}
}
} elseif (!empty($this->model->$name))
{
// Handle single documents
$validator = new Validator($this->model->$name);
$isValid = $validator->validate();
$valid[] = (int)$isValid;
if (!$isValid)
{
$errors = [
$name => $validator->getErrors()
];
$this->setErrors($errors);
}
}
}
// Skip field without validators
if (empty($fieldMeta->validators))
{
continue;
}
$valid[] = (int)$this->validateEntity($name, $fieldMeta->validators);
}
// Model validators
$typeValidators = $this->meta->type()->validators;
if (!empty($typeValidators))
{
$typeName = $this->meta->type()->name;
// Reset errors
$this->errors[$typeName] = [];
$valid[] = (int)$this->validateEntity($typeName, $typeValidators);
}
$areAllValid = count($valid) === array_sum($valid);
// For easier debug
if($areAllValid)
{
return true;
}
return false;
}
private function validateEntity($name, $validators)
{
$valid = [];
foreach ($validators as $validatorMeta)
{
// Filter out validators based on scenarios
if (!empty($validatorMeta->on))
{
$on = (array)$validatorMeta->on;
$enabled = false;
foreach ($on as $scenario)
{
if ($scenario === ScenarioManager::getScenario($this->model))
{
$enabled = true;
break;
}
}
if (!$enabled)
{
continue;
}
}
if (!empty($validatorMeta->except))
{
$except = (array)$validatorMeta->except;
$enabled = true;
foreach ($except as $scenario)
{
if ($scenario === ScenarioManager::getScenario($this->model))
{
$enabled = false;
break;
}
}
if (!$enabled)
{
continue;
}
}
// Create validator and validate
$validator = Factory::create($this->model, $validatorMeta, $name);
if ($validator->isValid($this->model, $name))
{
$valid[] = true;
} else
{
$valid[] = false;
$this->errors[$name] = array_merge($this->errors[$name], $validator->getErrors());
// Set errors to model instance if it implements ValidatableInterface
if ($this->model instanceof ValidatableInterface)
{
$this->model->setErrors($this->errors);
}
}
}
return count($valid) === array_sum($valid);
}
public function getErrors()
{
return $this->errors;
}
public function setErrors($errors)
{
foreach ($errors as $field => $errors)
{
$this->errors[$field] = $errors;
}
}
}
API documentation generated by ApiGen