vanilla /
garden-schema
Complex classes like Schema often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Schema, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 13 | class Schema implements \JsonSerializable, \ArrayAccess { |
||
| 14 | /** |
||
| 15 | * Trigger a notice when extraneous properties are encountered during validation. |
||
| 16 | */ |
||
| 17 | const VALIDATE_EXTRA_PROPERTY_NOTICE = 0x1; |
||
| 18 | |||
| 19 | /** |
||
| 20 | * Throw a ValidationException when extraneous properties are encountered during validation. |
||
| 21 | */ |
||
| 22 | const VALIDATE_EXTRA_PROPERTY_EXCEPTION = 0x2; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * @var array All the known types. |
||
| 26 | * |
||
| 27 | * If this is ever given some sort of public access then remove the static. |
||
| 28 | */ |
||
| 29 | private static $types = [ |
||
| 30 | 'array' => ['a'], |
||
| 31 | 'object' => ['o'], |
||
| 32 | 'integer' => ['i', 'int'], |
||
| 33 | 'string' => ['s', 'str'], |
||
| 34 | 'number' => ['f', 'float'], |
||
| 35 | 'boolean' => ['b', 'bool'], |
||
| 36 | 'timestamp' => ['ts'], |
||
| 37 | 'datetime' => ['dt'], |
||
| 38 | 'null' => ['n'] |
||
| 39 | ]; |
||
| 40 | |||
| 41 | /** |
||
| 42 | * @var string The regular expression to strictly determine if a string is a date. |
||
| 43 | */ |
||
| 44 | private static $DATE_REGEX = '`^\d{4}-\d{2}-\d{2}([ T]\d{2}:\d{2}(:\d{2})?)?`i'; |
||
| 45 | |||
| 46 | private $schema = []; |
||
| 47 | |||
| 48 | /** |
||
| 49 | * @var int A bitwise combination of the various **Schema::FLAG_*** constants. |
||
| 50 | */ |
||
| 51 | private $flags = 0; |
||
| 52 | |||
| 53 | /** |
||
| 54 | * @var array An array of callbacks that will filter data in the schema. |
||
| 55 | */ |
||
| 56 | private $filters = []; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * @var array An array of callbacks that will custom validate the schema. |
||
| 60 | */ |
||
| 61 | private $validators = []; |
||
| 62 | |||
| 63 | /** |
||
| 64 | * @var string|Validation The name of the class or an instance that will be cloned. |
||
| 65 | */ |
||
| 66 | private $validationClass = Validation::class; |
||
| 67 | |||
| 68 | |||
| 69 | /// Methods /// |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Initialize an instance of a new {@link Schema} class. |
||
| 73 | * |
||
| 74 | * @param array $schema The array schema to validate against. |
||
| 75 | */ |
||
| 76 | 175 | public function __construct($schema = []) { |
|
| 79 | |||
| 80 | /** |
||
| 81 | * Grab the schema's current description. |
||
| 82 | * |
||
| 83 | * @return string |
||
| 84 | */ |
||
| 85 | 1 | public function getDescription() { |
|
| 88 | |||
| 89 | /** |
||
| 90 | * Set the description for the schema. |
||
| 91 | * |
||
| 92 | * @param string $description The new description. |
||
| 93 | * @throws \InvalidArgumentException Throws an exception when the provided description is not a string. |
||
| 94 | * @return Schema |
||
| 95 | */ |
||
| 96 | 2 | public function setDescription($description) { |
|
| 97 | 2 | if (is_string($description)) { |
|
| 98 | 1 | $this->schema['description'] = $description; |
|
| 99 | 1 | } else { |
|
| 100 | 1 | throw new \InvalidArgumentException("The description is not a valid string.", 500); |
|
| 101 | } |
||
| 102 | |||
| 103 | 1 | return $this; |
|
| 104 | } |
||
| 105 | |||
| 106 | /** |
||
| 107 | * Get a schema field. |
||
| 108 | * |
||
| 109 | * @param string|array $path The JSON schema path of the field with parts separated by dots. |
||
| 110 | * @param mixed $default The value to return if the field isn't found. |
||
| 111 | * @return mixed Returns the field value or `$default`. |
||
| 112 | */ |
||
| 113 | 5 | public function getField($path, $default = null) { |
|
| 114 | 5 | if (is_string($path)) { |
|
| 115 | 5 | $path = explode('.', $path); |
|
| 116 | 5 | } |
|
| 117 | |||
| 118 | 5 | $value = $this->schema; |
|
| 119 | 5 | foreach ($path as $i => $subKey) { |
|
| 120 | 5 | if (is_array($value) && isset($value[$subKey])) { |
|
| 121 | 5 | $value = $value[$subKey]; |
|
| 122 | 5 | } elseif ($value instanceof Schema) { |
|
| 123 | 1 | return $value->getField(array_slice($path, $i), $default); |
|
| 124 | } else { |
||
| 125 | return $default; |
||
| 126 | } |
||
| 127 | 5 | } |
|
| 128 | 5 | return $value; |
|
| 129 | } |
||
| 130 | |||
| 131 | /** |
||
| 132 | * Set a schema field. |
||
| 133 | * |
||
| 134 | * @param string|array $path The JSON schema path of the field with parts separated by dots. |
||
| 135 | * @param mixed $value The new value. |
||
| 136 | * @return $this |
||
| 137 | */ |
||
| 138 | 3 | public function setField($path, $value) { |
|
| 139 | 3 | if (is_string($path)) { |
|
| 140 | 3 | $path = explode('.', $path); |
|
| 141 | 3 | } |
|
| 142 | |||
| 143 | 3 | $selection = &$this->schema; |
|
| 144 | 3 | foreach ($path as $i => $subSelector) { |
|
| 145 | 3 | if (is_array($selection)) { |
|
| 146 | 3 | if (!isset($selection[$subSelector])) { |
|
| 147 | 1 | $selection[$subSelector] = []; |
|
| 148 | 1 | } |
|
| 149 | 3 | } elseif ($selection instanceof Schema) { |
|
| 150 | 1 | $selection->setField(array_slice($path, $i), $value); |
|
| 151 | 1 | return $this; |
|
| 152 | } else { |
||
| 153 | $selection = [$subSelector => []]; |
||
| 154 | } |
||
| 155 | 3 | $selection = &$selection[$subSelector]; |
|
| 156 | 3 | } |
|
| 157 | |||
| 158 | 3 | $selection = $value; |
|
| 159 | 3 | return $this; |
|
| 160 | } |
||
| 161 | |||
| 162 | /** |
||
| 163 | * Get the ID for the schema. |
||
| 164 | * |
||
| 165 | * @return string |
||
| 166 | */ |
||
| 167 | 3 | public function getID() { |
|
| 170 | |||
| 171 | /** |
||
| 172 | * Set the ID for the schema. |
||
| 173 | * |
||
| 174 | * @param string $id The new ID. |
||
| 175 | * @throws \InvalidArgumentException Throws an exception when the provided ID is not a string. |
||
| 176 | * @return Schema |
||
| 177 | */ |
||
| 178 | 1 | public function setID($id) { |
|
| 179 | 1 | if (is_string($id)) { |
|
| 180 | 1 | $this->schema['id'] = $id; |
|
| 181 | 1 | } else { |
|
| 182 | throw new \InvalidArgumentException("The ID is not a valid string.", 500); |
||
| 183 | } |
||
| 184 | |||
| 185 | 1 | return $this; |
|
| 186 | } |
||
| 187 | |||
| 188 | /** |
||
| 189 | * Return the validation flags. |
||
| 190 | * |
||
| 191 | * @return int Returns a bitwise combination of flags. |
||
| 192 | */ |
||
| 193 | 1 | public function getFlags() { |
|
| 196 | |||
| 197 | /** |
||
| 198 | * Set the validation flags. |
||
| 199 | * |
||
| 200 | * @param int $flags One or more of the **Schema::FLAG_*** constants. |
||
| 201 | * @return Schema Returns the current instance for fluent calls. |
||
| 202 | */ |
||
| 203 | 8 | public function setFlags($flags) { |
|
| 211 | |||
| 212 | /** |
||
| 213 | * Whether or not the schema has a flag (or combination of flags). |
||
| 214 | * |
||
| 215 | * @param int $flag One or more of the **Schema::VALIDATE_*** constants. |
||
| 216 | * @return bool Returns **true** if all of the flags are set or **false** otherwise. |
||
| 217 | */ |
||
| 218 | 11 | public function hasFlag($flag) { |
|
| 221 | |||
| 222 | /** |
||
| 223 | * Set a flag. |
||
| 224 | * |
||
| 225 | * @param int $flag One or more of the **Schema::VALIDATE_*** constants. |
||
| 226 | * @param bool $value Either true or false. |
||
| 227 | * @return $this |
||
| 228 | */ |
||
| 229 | 1 | public function setFlag($flag, $value) { |
|
| 230 | 1 | if ($value) { |
|
| 231 | 1 | $this->flags = $this->flags | $flag; |
|
| 232 | 1 | } else { |
|
| 233 | 1 | $this->flags = $this->flags & ~$flag; |
|
| 234 | } |
||
| 235 | 1 | return $this; |
|
| 236 | } |
||
| 237 | |||
| 238 | /** |
||
| 239 | * Merge a schema with this one. |
||
| 240 | * |
||
| 241 | * @param Schema $schema A scheme instance. Its parameters will be merged into the current instance. |
||
| 242 | * @return $this |
||
| 243 | */ |
||
| 244 | 3 | public function merge(Schema $schema) { |
|
| 248 | |||
| 249 | /** |
||
| 250 | * Add another schema to this one. |
||
| 251 | * |
||
| 252 | * Adding schemas together is analogous to array addition. When you add a schema it will only add missing information. |
||
| 253 | * |
||
| 254 | * @param Schema $schema The schema to add. |
||
| 255 | * @param bool $addProperties Whether to add properties that don't exist in this schema. |
||
| 256 | * @return $this |
||
| 257 | */ |
||
| 258 | 3 | public function add(Schema $schema, $addProperties = false) { |
|
| 262 | |||
| 263 | /** |
||
| 264 | * The internal implementation of schema merging. |
||
| 265 | * |
||
| 266 | * @param array &$target The target of the merge. |
||
| 267 | * @param array $source The source of the merge. |
||
| 268 | * @param bool $overwrite Whether or not to replace values. |
||
| 269 | * @param bool $addProperties Whether or not to add object properties to the target. |
||
| 270 | * @return array |
||
| 271 | */ |
||
| 272 | 6 | private function mergeInternal(array &$target, array $source, $overwrite = true, $addProperties = true) { |
|
| 273 | // We need to do a fix for required properties here. |
||
| 274 | 6 | if (isset($target['properties']) && !empty($source['required'])) { |
|
| 275 | 4 | $required = isset($target['required']) ? $target['required'] : []; |
|
| 276 | |||
| 277 | 4 | if (isset($source['required']) && $addProperties) { |
|
| 278 | 3 | $newProperties = array_diff(array_keys($source['properties']), array_keys($target['properties'])); |
|
| 279 | 3 | $newRequired = array_intersect($source['required'], $newProperties); |
|
|
|
|||
| 280 | |||
| 281 | 3 | $required = array_merge($required, $newRequired); |
|
| 282 | 3 | } |
|
| 283 | 4 | } |
|
| 284 | |||
| 285 | |||
| 286 | 6 | foreach ($source as $key => $val) { |
|
| 287 | 6 | if (is_array($val) && array_key_exists($key, $target) && is_array($target[$key])) { |
|
| 288 | 6 | if ($key === 'properties' && !$addProperties) { |
|
| 289 | // We just want to merge the properties that exist in the destination. |
||
| 290 | 1 | foreach ($val as $name => $prop) { |
|
| 291 | 1 | if (isset($target[$key][$name])) { |
|
| 292 | 1 | $this->mergeInternal($target[$key][$name], $prop, $overwrite, $addProperties); |
|
| 293 | 1 | } |
|
| 294 | 1 | } |
|
| 295 | 6 | } elseif (isset($val[0]) || isset($target[$key][0])) { |
|
| 296 | 4 | if ($overwrite) { |
|
| 297 | // This is a numeric array, so just do a merge. |
||
| 298 | 2 | $merged = array_merge($target[$key], $val); |
|
| 299 | 2 | if (is_string($merged[0])) { |
|
| 300 | 2 | $merged = array_keys(array_flip($merged)); |
|
| 301 | 2 | } |
|
| 302 | 2 | $target[$key] = $merged; |
|
| 303 | 2 | } |
|
| 304 | 4 | } else { |
|
| 305 | 3 | $target[$key] = $this->mergeInternal($target[$key], $val, $overwrite, $addProperties); |
|
| 306 | } |
||
| 307 | 6 | } elseif (!$overwrite && array_key_exists($key, $target) && !is_array($val)) { |
|
| 308 | // Do nothing, we aren't replacing. |
||
| 309 | 3 | } else { |
|
| 310 | 5 | $target[$key] = $val; |
|
| 311 | } |
||
| 312 | 6 | } |
|
| 313 | |||
| 314 | 6 | if (isset($required)) { |
|
| 315 | 4 | if (empty($required)) { |
|
| 316 | 1 | unset($target['required']); |
|
| 317 | 1 | } else { |
|
| 318 | 4 | $target['required'] = $required; |
|
| 319 | } |
||
| 320 | 4 | } |
|
| 321 | |||
| 322 | 6 | return $target; |
|
| 323 | } |
||
| 324 | |||
| 325 | // public function overlay(Schema $schema ) |
||
| 326 | |||
| 327 | /** |
||
| 328 | * Returns the internal schema array. |
||
| 329 | * |
||
| 330 | * @return array |
||
| 331 | * @see Schema::jsonSerialize() |
||
| 332 | */ |
||
| 333 | 9 | public function getSchemaArray() { |
|
| 336 | |||
| 337 | /** |
||
| 338 | * Parse a short schema and return the associated schema. |
||
| 339 | * |
||
| 340 | * @param array $arr The schema array. |
||
| 341 | * @param mixed ...$args Constructor arguments for the schema instance. |
||
| 342 | * @return static Returns a new schema. |
||
| 343 | */ |
||
| 344 | 144 | public static function parse(array $arr, ...$args) { |
|
| 349 | |||
| 350 | /** |
||
| 351 | * Parse a schema in short form into a full schema array. |
||
| 352 | * |
||
| 353 | * @param array $arr The array to parse into a schema. |
||
| 354 | * @return array The full schema array. |
||
| 355 | * @throws \InvalidArgumentException Throws an exception when an item in the schema is invalid. |
||
| 356 | */ |
||
| 357 | 144 | protected function parseInternal(array $arr) { |
|
| 389 | |||
| 390 | /** |
||
| 391 | * Parse a schema node. |
||
| 392 | * |
||
| 393 | * @param array $node The node to parse. |
||
| 394 | * @param mixed $value Additional information from the node. |
||
| 395 | * @return array Returns a JSON schema compatible node. |
||
| 396 | */ |
||
| 397 | 138 | private function parseNode($node, $value = null) { |
|
| 398 | 138 | if (is_array($value)) { |
|
| 399 | // The value describes a bit more about the schema. |
||
| 400 | 59 | switch ($node['type']) { |
|
| 401 | 59 | case 'array': |
|
| 402 | 11 | if (isset($value['items'])) { |
|
| 403 | // The value includes array schema information. |
||
| 404 | 4 | $node = array_replace($node, $value); |
|
| 405 | 4 | } else { |
|
| 406 | 7 | $node['items'] = $this->parseInternal($value); |
|
| 407 | } |
||
| 408 | 11 | break; |
|
| 409 | 49 | case 'object': |
|
| 410 | // The value is a schema of the object. |
||
| 411 | 12 | if (isset($value['properties'])) { |
|
| 412 | list($node['properties']) = $this->parseProperties($value['properties']); |
||
| 413 | } else { |
||
| 414 | 12 | list($node['properties'], $required) = $this->parseProperties($value); |
|
| 415 | 12 | if (!empty($required)) { |
|
| 416 | 12 | $node['required'] = $required; |
|
| 417 | 12 | } |
|
| 418 | } |
||
| 419 | 12 | break; |
|
| 420 | 37 | default: |
|
| 421 | 37 | $node = array_replace($node, $value); |
|
| 422 | 37 | break; |
|
| 423 | 59 | } |
|
| 424 | 138 | } elseif (is_string($value)) { |
|
| 425 | 79 | if ($node['type'] === 'array' && $arrType = $this->getType($value)) { |
|
| 426 | 6 | $node['items'] = ['type' => $arrType]; |
|
| 427 | 79 | } elseif (!empty($value)) { |
|
| 428 | 16 | $node['description'] = $value; |
|
| 429 | 16 | } |
|
| 430 | 99 | } elseif ($value === null) { |
|
| 431 | // Parse child elements. |
||
| 432 | 20 | if ($node['type'] === 'array' && isset($node['items'])) { |
|
| 433 | // The value includes array schema information. |
||
| 434 | $node['items'] = $this->parseInternal($node['items']); |
||
| 435 | 20 | } elseif ($node['type'] === 'object' && isset($node['properties'])) { |
|
| 436 | list($node['properties']) = $this->parseProperties($node['properties']); |
||
| 437 | |||
| 438 | } |
||
| 439 | 20 | } |
|
| 440 | |||
| 441 | 138 | if (is_array($node)) { |
|
| 442 | 137 | if (!empty($node['allowNull'])) { |
|
| 443 | 1 | $node['type'] = array_merge((array)$node['type'], ['null']); |
|
| 444 | 1 | } |
|
| 445 | 137 | unset($node['allowNull']); |
|
| 446 | |||
| 447 | 137 | if ($node['type'] === null || $node['type'] === []) { |
|
| 448 | 3 | unset($node['type']); |
|
| 449 | 3 | } |
|
| 450 | 137 | } |
|
| 451 | |||
| 452 | 138 | return $node; |
|
| 453 | } |
||
| 454 | |||
| 455 | /** |
||
| 456 | * Parse the schema for an object's properties. |
||
| 457 | * |
||
| 458 | * @param array $arr An object property schema. |
||
| 459 | * @return array Returns a schema array suitable to be placed in the **properties** key of a schema. |
||
| 460 | */ |
||
| 461 | 93 | private function parseProperties(array $arr) { |
|
| 462 | 93 | $properties = []; |
|
| 463 | 93 | $requiredProperties = []; |
|
| 464 | 93 | foreach ($arr as $key => $value) { |
|
| 465 | // Fix a schema specified as just a value. |
||
| 466 | 93 | if (is_int($key)) { |
|
| 467 | 67 | if (is_string($value)) { |
|
| 468 | 67 | $key = $value; |
|
| 469 | 67 | $value = ''; |
|
| 470 | 67 | } else { |
|
| 471 | throw new \InvalidArgumentException("Schema at position $key is not a valid parameter.", 500); |
||
| 472 | } |
||
| 473 | 67 | } |
|
| 474 | |||
| 475 | // The parameter is defined in the key. |
||
| 476 | 93 | list($name, $param, $required) = $this->parseShortParam($key, $value); |
|
| 477 | |||
| 478 | 93 | $node = $this->parseNode($param, $value); |
|
| 479 | |||
| 480 | 93 | $properties[$name] = $node; |
|
| 481 | 93 | if ($required) { |
|
| 482 | 53 | $requiredProperties[] = $name; |
|
| 483 | 53 | } |
|
| 484 | 93 | } |
|
| 485 | 93 | return array($properties, $requiredProperties); |
|
| 486 | } |
||
| 487 | |||
| 488 | /** |
||
| 489 | * Parse a short parameter string into a full array parameter. |
||
| 490 | * |
||
| 491 | * @param string $key The short parameter string to parse. |
||
| 492 | * @param array $value An array of other information that might help resolve ambiguity. |
||
| 493 | * @return array Returns an array in the form `[string name, array param, bool required]`. |
||
| 494 | * @throws \InvalidArgumentException Throws an exception if the short param is not in the correct format. |
||
| 495 | */ |
||
| 496 | 138 | public function parseShortParam($key, $value = []) { |
|
| 497 | // Is the parameter optional? |
||
| 498 | 138 | if (substr($key, -1) === '?') { |
|
| 499 | 63 | $required = false; |
|
| 500 | 63 | $key = substr($key, 0, -1); |
|
| 501 | 63 | } else { |
|
| 502 | 98 | $required = true; |
|
| 503 | } |
||
| 504 | |||
| 505 | // Check for a type. |
||
| 506 | 138 | $parts = explode(':', $key); |
|
| 507 | 138 | $name = $parts[0]; |
|
| 508 | 138 | $types = []; |
|
| 509 | |||
| 510 | 138 | if (!empty($parts[1])) { |
|
| 511 | 133 | $shortTypes = explode('|', $parts[1]); |
|
| 512 | 133 | foreach ($shortTypes as $alias) { |
|
| 513 | 133 | $found = $this->getType($alias); |
|
| 514 | 133 | if ($found === null) { |
|
| 515 | throw new \InvalidArgumentException("Unknown type '$alias'", 500); |
||
| 516 | } else { |
||
| 517 | 133 | $types[] = $found; |
|
| 518 | } |
||
| 519 | 133 | } |
|
| 520 | 133 | } |
|
| 521 | |||
| 522 | 138 | if ($value instanceof Schema) { |
|
| 523 | 4 | if (count($types) === 1 && $types[0] === 'array') { |
|
| 524 | 1 | $param = ['type' => $types[0], 'items' => $value]; |
|
| 525 | 1 | } else { |
|
| 526 | 3 | $param = $value; |
|
| 527 | } |
||
| 528 | 138 | } elseif (isset($value['type'])) { |
|
| 529 | 3 | $param = $value; |
|
| 530 | |||
| 531 | 3 | if (!empty($types) && $types !== (array)$param['type']) { |
|
| 532 | $typesStr = implode('|', $types); |
||
| 533 | $paramTypesStr = implode('|', (array)$param['type']); |
||
| 534 | |||
| 535 | throw new \InvalidArgumentException("Type mismatch between $typesStr and {$paramTypesStr} for field $name.", 500); |
||
| 536 | } |
||
| 537 | 3 | } else { |
|
| 538 | 134 | if (empty($types) && !empty($parts[1])) { |
|
| 539 | throw new \InvalidArgumentException("Invalid type {$parts[1]} for field $name.", 500); |
||
| 540 | } |
||
| 541 | 134 | if (empty($types)) { |
|
| 542 | 3 | $param = ['type' => null]; |
|
| 543 | 3 | } else { |
|
| 544 | 133 | $param = ['type' => count($types) === 1 ? $types[0] : $types]; |
|
| 545 | } |
||
| 546 | |||
| 547 | // Parsed required strings have a minimum length of 1. |
||
| 548 | 134 | if (in_array('string', $types) && !empty($name) && $required && (!isset($value['default']) || $value['default'] !== '')) { |
|
| 549 | 38 | $param['minLength'] = 1; |
|
| 550 | 38 | } |
|
| 551 | } |
||
| 552 | |||
| 553 | 138 | return [$name, $param, $required]; |
|
| 554 | } |
||
| 555 | |||
| 556 | /** |
||
| 557 | * Add a custom filter to change data before validation. |
||
| 558 | * |
||
| 559 | * @param string $fieldname The name of the field to filter, if any. |
||
| 560 | * |
||
| 561 | * If you are adding a filter to a deeply nested field then separate the path with dots. |
||
| 562 | * @param callable $callback The callback to filter the field. |
||
| 563 | * @return $this |
||
| 564 | */ |
||
| 565 | 1 | public function addFilter($fieldname, callable $callback) { |
|
| 569 | |||
| 570 | /** |
||
| 571 | * Add a custom validator to to validate the schema. |
||
| 572 | * |
||
| 573 | * @param string $fieldname The name of the field to validate, if any. |
||
| 574 | * |
||
| 575 | * If you are adding a validator to a deeply nested field then separate the path with dots. |
||
| 576 | * @param callable $callback The callback to validate with. |
||
| 577 | * @return Schema Returns `$this` for fluent calls. |
||
| 578 | */ |
||
| 579 | 4 | public function addValidator($fieldname, callable $callback) { |
|
| 583 | |||
| 584 | /** |
||
| 585 | * Require one of a given set of fields in the schema. |
||
| 586 | * |
||
| 587 | * @param array $required The field names to require. |
||
| 588 | * @param string $fieldname The name of the field to attach to. |
||
| 589 | * @param int $count The count of required items. |
||
| 590 | * @return Schema Returns `$this` for fluent calls. |
||
| 591 | */ |
||
| 592 | 3 | public function requireOneOf(array $required, $fieldname = '', $count = 1) { |
|
| 646 | |||
| 647 | /** |
||
| 648 | * Validate data against the schema. |
||
| 649 | * |
||
| 650 | * @param mixed $data The data to validate. |
||
| 651 | * @param bool $sparse Whether or not this is a sparse validation. |
||
| 652 | * @return mixed Returns a cleaned version of the data. |
||
| 653 | * @throws ValidationException Throws an exception when the data does not validate against the schema. |
||
| 654 | */ |
||
| 655 | 144 | public function validate($data, $sparse = false) { |
|
| 671 | |||
| 672 | /** |
||
| 673 | * Validate data against the schema and return the result. |
||
| 674 | * |
||
| 675 | * @param mixed $data The data to validate. |
||
| 676 | * @param bool $sparse Whether or not to do a sparse validation. |
||
| 677 | * @return bool Returns true if the data is valid. False otherwise. |
||
| 678 | */ |
||
| 679 | 21 | public function isValid($data, $sparse = false) { |
|
| 687 | |||
| 688 | /** |
||
| 689 | * Validate a field. |
||
| 690 | * |
||
| 691 | * @param mixed $value The value to validate. |
||
| 692 | * @param ValidationField $field A validation object to add errors to. |
||
| 693 | * @param bool $sparse Whether or not this is a sparse validation. |
||
| 694 | * @return mixed|Invalid Returns a clean version of the value with all extra fields stripped out or invalid if the value |
||
| 695 | * is completely invalid. |
||
| 696 | */ |
||
| 697 | 144 | protected function validateField($value, ValidationField $field, $sparse = false) { |
|
| 729 | |||
| 730 | /** |
||
| 731 | * Validate an array. |
||
| 732 | * |
||
| 733 | * @param mixed $value The value to validate. |
||
| 734 | * @param ValidationField $field The validation results to add. |
||
| 735 | * @param bool $sparse Whether or not this is a sparse validation. |
||
| 736 | * @return array|Invalid Returns an array or invalid if validation fails. |
||
| 737 | */ |
||
| 738 | 20 | protected function validateArray($value, ValidationField $field, $sparse = false) { |
|
| 793 | |||
| 794 | /** |
||
| 795 | * Validate a boolean value. |
||
| 796 | * |
||
| 797 | * @param mixed $value The value to validate. |
||
| 798 | * @param ValidationField $field The validation results to add. |
||
| 799 | * @return bool|Invalid Returns the cleaned value or invalid if validation fails. |
||
| 800 | */ |
||
| 801 | 27 | protected function validateBoolean($value, ValidationField $field) { |
|
| 810 | |||
| 811 | /** |
||
| 812 | * Validate a date time. |
||
| 813 | * |
||
| 814 | * @param mixed $value The value to validate. |
||
| 815 | * @param ValidationField $field The validation results to add. |
||
| 816 | * @return \DateTimeInterface|Invalid Returns the cleaned value or **null** if it isn't valid. |
||
| 817 | */ |
||
| 818 | 11 | protected function validateDatetime($value, ValidationField $field) { |
|
| 843 | |||
| 844 | /** |
||
| 845 | * Validate a float. |
||
| 846 | * |
||
| 847 | * @param mixed $value The value to validate. |
||
| 848 | * @param ValidationField $field The validation results to add. |
||
| 849 | * @return float|Invalid Returns a number or **null** if validation fails. |
||
| 850 | */ |
||
| 851 | 10 | protected function validateNumber($value, ValidationField $field) { |
|
| 859 | /** |
||
| 860 | * Validate and integer. |
||
| 861 | * |
||
| 862 | * @param mixed $value The value to validate. |
||
| 863 | * @param ValidationField $field The validation results to add. |
||
| 864 | * @return int|Invalid Returns the cleaned value or **null** if validation fails. |
||
| 865 | */ |
||
| 866 | 35 | protected function validateInteger($value, ValidationField $field) { |
|
| 875 | |||
| 876 | /** |
||
| 877 | * Validate an object. |
||
| 878 | * |
||
| 879 | * @param mixed $value The value to validate. |
||
| 880 | * @param ValidationField $field The validation results to add. |
||
| 881 | * @param bool $sparse Whether or not this is a sparse validation. |
||
| 882 | * @return object|Invalid Returns a clean object or **null** if validation fails. |
||
| 883 | */ |
||
| 884 | 82 | protected function validateObject($value, ValidationField $field, $sparse = false) { |
|
| 896 | |||
| 897 | /** |
||
| 898 | * Validate data against the schema and return the result. |
||
| 899 | * |
||
| 900 | * @param array|\ArrayAccess $data The data to validate. |
||
| 901 | * @param ValidationField $field This argument will be filled with the validation result. |
||
| 902 | * @param bool $sparse Whether or not this is a sparse validation. |
||
| 903 | * @return array|Invalid Returns a clean array with only the appropriate properties and the data coerced to proper types. |
||
| 904 | * or invalid if there are no valid properties. |
||
| 905 | */ |
||
| 906 | 79 | protected function validateProperties($data, ValidationField $field, $sparse = false) { |
|
| 978 | |||
| 979 | /** |
||
| 980 | * Validate a string. |
||
| 981 | * |
||
| 982 | * @param mixed $value The value to validate. |
||
| 983 | * @param ValidationField $field The validation results to add. |
||
| 984 | * @return string|Invalid Returns the valid string or **null** if validation fails. |
||
| 985 | */ |
||
| 986 | 63 | protected function validateString($value, ValidationField $field) { |
|
| 1075 | |||
| 1076 | /** |
||
| 1077 | * Validate a unix timestamp. |
||
| 1078 | * |
||
| 1079 | * @param mixed $value The value to validate. |
||
| 1080 | * @param ValidationField $field The field being validated. |
||
| 1081 | * @return int|Invalid Returns a valid timestamp or invalid if the value doesn't validate. |
||
| 1082 | */ |
||
| 1083 | 5 | protected function validateTimestamp($value, ValidationField $field) { |
|
| 1094 | |||
| 1095 | /** |
||
| 1096 | * Validate a null value. |
||
| 1097 | * |
||
| 1098 | * @param mixed $value The value to validate. |
||
| 1099 | * @param ValidationField $field The error collector for the field. |
||
| 1100 | * @return null|Invalid Returns **null** or invalid. |
||
| 1101 | */ |
||
| 1102 | 1 | protected function validateNull($value, ValidationField $field) { |
|
| 1103 | 1 | if ($value === null) { |
|
| 1104 | return null; |
||
| 1105 | } |
||
| 1106 | 1 | $field->addError('invalid', ['messageCode' => '{field} should be null.', 'status' => 422]); |
|
| 1107 | 1 | return Invalid::value(); |
|
| 1108 | } |
||
| 1109 | |||
| 1110 | /** |
||
| 1111 | * Validate a value against an enum. |
||
| 1112 | * |
||
| 1113 | * @param mixed $value The value to test. |
||
| 1114 | * @param ValidationField $field The validation object for adding errors. |
||
| 1115 | * @return mixed|Invalid Returns the value if it is one of the enumerated values or invalid otherwise. |
||
| 1116 | */ |
||
| 1117 | 141 | protected function validateEnum($value, ValidationField $field) { |
|
| 1136 | |||
| 1137 | /** |
||
| 1138 | * Call all of the filters attached to a field. |
||
| 1139 | * |
||
| 1140 | * @param mixed $value The field value being filtered. |
||
| 1141 | * @param ValidationField $field The validation object. |
||
| 1142 | * @return mixed Returns the filtered value. If there are no filters for the field then the original value is returned. |
||
| 1143 | */ |
||
| 1144 | 144 | protected function callFilters($value, ValidationField $field) { |
|
| 1154 | |||
| 1155 | /** |
||
| 1156 | * Call all of the validators attached to a field. |
||
| 1157 | * |
||
| 1158 | * @param mixed $value The field value being validated. |
||
| 1159 | * @param ValidationField $field The validation object to add errors. |
||
| 1160 | */ |
||
| 1161 | 142 | protected function callValidators($value, ValidationField $field) { |
|
| 1181 | |||
| 1182 | /** |
||
| 1183 | * Specify data which should be serialized to JSON. |
||
| 1184 | * |
||
| 1185 | * This method specifically returns data compatible with the JSON schema format. |
||
| 1186 | * |
||
| 1187 | * @return mixed Returns data which can be serialized by **json_encode()**, which is a value of any type other than a resource. |
||
| 1188 | * @link http://php.net/manual/en/jsonserializable.jsonserialize.php |
||
| 1189 | * @link http://json-schema.org/ |
||
| 1190 | */ |
||
| 1191 | public function jsonSerialize() { |
||
| 1226 | |||
| 1227 | /** |
||
| 1228 | * Look up a type based on its alias. |
||
| 1229 | * |
||
| 1230 | * @param string $alias The type alias or type name to lookup. |
||
| 1231 | * @return mixed |
||
| 1232 | */ |
||
| 1233 | 133 | protected function getType($alias) { |
|
| 1244 | |||
| 1245 | /** |
||
| 1246 | * Get the class that's used to contain validation information. |
||
| 1247 | * |
||
| 1248 | * @return Validation|string Returns the validation class. |
||
| 1249 | */ |
||
| 1250 | 144 | public function getValidationClass() { |
|
| 1253 | |||
| 1254 | /** |
||
| 1255 | * Set the class that's used to contain validation information. |
||
| 1256 | * |
||
| 1257 | * @param Validation|string $class Either the name of a class or a class that will be cloned. |
||
| 1258 | * @return $this |
||
| 1259 | */ |
||
| 1260 | 1 | public function setValidationClass($class) { |
|
| 1268 | |||
| 1269 | /** |
||
| 1270 | * Create a new validation instance. |
||
| 1271 | * |
||
| 1272 | * @return Validation Returns a validation object. |
||
| 1273 | */ |
||
| 1274 | 144 | protected function createValidation() { |
|
| 1284 | |||
| 1285 | /** |
||
| 1286 | * Check whether or not a value is an array or accessible like an array. |
||
| 1287 | * |
||
| 1288 | * @param mixed $value The value to check. |
||
| 1289 | * @return bool Returns **true** if the value can be used like an array or **false** otherwise. |
||
| 1290 | */ |
||
| 1291 | 82 | private function isArray($value) { |
|
| 1294 | |||
| 1295 | /** |
||
| 1296 | * Cast a value to an array. |
||
| 1297 | * |
||
| 1298 | * @param \Traversable $value The value to convert. |
||
| 1299 | * @return array Returns an array. |
||
| 1300 | */ |
||
| 1301 | 3 | private function toObjectArray(\Traversable $value) { |
|
| 1314 | |||
| 1315 | /** |
||
| 1316 | * Return a sparse version of this schema. |
||
| 1317 | * |
||
| 1318 | * A sparse schema has no required properties. |
||
| 1319 | * |
||
| 1320 | * @return Schema Returns a new sparse schema. |
||
| 1321 | */ |
||
| 1322 | 2 | public function withSparse() { |
|
| 1326 | |||
| 1327 | /** |
||
| 1328 | * The internal implementation of `Schema::withSparse()`. |
||
| 1329 | * |
||
| 1330 | * @param array|Schema $schema The schema to make sparse. |
||
| 1331 | * @param \SplObjectStorage $schemas Collected sparse schemas that have already been made. |
||
| 1332 | * @return mixed |
||
| 1333 | */ |
||
| 1334 | 2 | private function withSparseInternal($schema, \SplObjectStorage $schemas) { |
|
| 1362 | |||
| 1363 | /** |
||
| 1364 | * Filter a field's value using built in and custom filters. |
||
| 1365 | * |
||
| 1366 | * @param mixed $value The original value of the field. |
||
| 1367 | * @param ValidationField $field The field information for the field. |
||
| 1368 | * @return mixed Returns the filtered field or the original field value if there are no filters. |
||
| 1369 | */ |
||
| 1370 | 144 | private function filterField($value, ValidationField $field) { |
|
| 1399 | |||
| 1400 | /** |
||
| 1401 | * Whether a offset exists. |
||
| 1402 | * |
||
| 1403 | * @param mixed $offset An offset to check for. |
||
| 1404 | * @return boolean true on success or false on failure. |
||
| 1405 | * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
||
| 1406 | */ |
||
| 1407 | 5 | public function offsetExists($offset) { |
|
| 1410 | |||
| 1411 | /** |
||
| 1412 | * Offset to retrieve. |
||
| 1413 | * |
||
| 1414 | * @param mixed $offset The offset to retrieve. |
||
| 1415 | * @return mixed Can return all value types. |
||
| 1416 | * @link http://php.net/manual/en/arrayaccess.offsetget.php |
||
| 1417 | */ |
||
| 1418 | 2 | public function offsetGet($offset) { |
|
| 1421 | |||
| 1422 | /** |
||
| 1423 | * Offset to set. |
||
| 1424 | * |
||
| 1425 | * @param mixed $offset The offset to assign the value to. |
||
| 1426 | * @param mixed $value The value to set. |
||
| 1427 | * @link http://php.net/manual/en/arrayaccess.offsetset.php |
||
| 1428 | */ |
||
| 1429 | 1 | public function offsetSet($offset, $value) { |
|
| 1432 | |||
| 1433 | /** |
||
| 1434 | * Offset to unset. |
||
| 1435 | * |
||
| 1436 | * @param mixed $offset The offset to unset. |
||
| 1437 | * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
||
| 1438 | */ |
||
| 1439 | 1 | public function offsetUnset($offset) { |
|
| 1442 | |||
| 1443 | /** |
||
| 1444 | * Validate a field against a single type. |
||
| 1445 | * |
||
| 1446 | * @param mixed $value The value to validate. |
||
| 1447 | * @param string $type The type to validate against. |
||
| 1448 | * @param ValidationField $field Contains field and validation information. |
||
| 1449 | * @param bool $sparse Whether or not this should be a sparse validation. |
||
| 1450 | * @return mixed Returns the valid value or `Invalid`. |
||
| 1451 | */ |
||
| 1452 | 143 | protected function validateSingleType($value, $type, ValidationField $field, $sparse) { |
|
| 1490 | |||
| 1491 | /** |
||
| 1492 | * Validate a field against multiple basic types. |
||
| 1493 | * |
||
| 1494 | * The first validation that passes will be returned. If no type can be validated against then validation will fail. |
||
| 1495 | * |
||
| 1496 | * @param mixed $value The value to validate. |
||
| 1497 | * @param string[] $types The types to validate against. |
||
| 1498 | * @param ValidationField $field Contains field and validation information. |
||
| 1499 | * @param bool $sparse Whether or not this should be a sparse validation. |
||
| 1500 | * @return mixed Returns the valid value or `Invalid`. |
||
| 1501 | */ |
||
| 1502 | 24 | private function validateMultipleTypes($value, array $types, ValidationField $field, $sparse) { |
|
| 1565 | } |
||
| 1566 |
Loading history...
This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.
To visualize
will produce issues in the first and second line, while this second example
will produce no issues.