291 lines
7 KiB
PHP
291 lines
7 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the JsonSchema package.
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace JsonSchema\Constraints;
|
|
|
|
use JsonSchema\Uri\UriRetriever;
|
|
|
|
/**
|
|
* The Base Constraints, all Validators should extend this class
|
|
*
|
|
* @author Robert Schönthal <seroscho@googlemail.com>
|
|
* @author Bruno Prieto Reis <bruno.p.reis@gmail.com>
|
|
*/
|
|
abstract class Constraint implements ConstraintInterface
|
|
{
|
|
protected $checkMode = self::CHECK_MODE_NORMAL;
|
|
protected $uriRetriever;
|
|
protected $errors = array();
|
|
protected $inlineSchemaProperty = '$schema';
|
|
|
|
const CHECK_MODE_NORMAL = 1;
|
|
const CHECK_MODE_TYPE_CAST = 2;
|
|
|
|
/**
|
|
* @var null|Factory
|
|
*/
|
|
private $factory;
|
|
|
|
/**
|
|
* @param int $checkMode
|
|
* @param UriRetriever $uriRetriever
|
|
* @param Factory $factory
|
|
*/
|
|
public function __construct($checkMode = self::CHECK_MODE_NORMAL, UriRetriever $uriRetriever = null, Factory $factory = null)
|
|
{
|
|
$this->checkMode = $checkMode;
|
|
$this->uriRetriever = $uriRetriever;
|
|
$this->factory = $factory;
|
|
}
|
|
|
|
/**
|
|
* @return UriRetriever $uriRetriever
|
|
*/
|
|
public function getUriRetriever()
|
|
{
|
|
if (is_null($this->uriRetriever))
|
|
{
|
|
$this->setUriRetriever(new UriRetriever);
|
|
}
|
|
|
|
return $this->uriRetriever;
|
|
}
|
|
|
|
/**
|
|
* @return Factory
|
|
*/
|
|
public function getFactory()
|
|
{
|
|
if (!$this->factory) {
|
|
$this->factory = new Factory($this->getUriRetriever());
|
|
}
|
|
|
|
return $this->factory;
|
|
}
|
|
|
|
/**
|
|
* @param UriRetriever $uriRetriever
|
|
*/
|
|
public function setUriRetriever(UriRetriever $uriRetriever)
|
|
{
|
|
$this->uriRetriever = $uriRetriever;
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function addError($path, $message, $constraint='', array $more=null)
|
|
{
|
|
$error = array(
|
|
'property' => $path,
|
|
'message' => $message,
|
|
'constraint' => $constraint,
|
|
);
|
|
|
|
if (is_array($more) && count($more) > 0)
|
|
{
|
|
$error += $more;
|
|
}
|
|
|
|
$this->errors[] = $error;
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function addErrors(array $errors)
|
|
{
|
|
$this->errors = array_merge($this->errors, $errors);
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function getErrors()
|
|
{
|
|
return $this->errors;
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function isValid()
|
|
{
|
|
return !$this->getErrors();
|
|
}
|
|
|
|
/**
|
|
* Clears any reported errors. Should be used between
|
|
* multiple validation checks.
|
|
*/
|
|
public function reset()
|
|
{
|
|
$this->errors = array();
|
|
}
|
|
|
|
/**
|
|
* Bubble down the path
|
|
*
|
|
* @param string $path Current path
|
|
* @param mixed $i What to append to the path
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function incrementPath($path, $i)
|
|
{
|
|
if ($path !== '') {
|
|
if (is_int($i)) {
|
|
$path .= '[' . $i . ']';
|
|
} elseif ($i == '') {
|
|
$path .= '';
|
|
} else {
|
|
$path .= '.' . $i;
|
|
}
|
|
} else {
|
|
$path = $i;
|
|
}
|
|
|
|
return $path;
|
|
}
|
|
|
|
/**
|
|
* Validates an array
|
|
*
|
|
* @param mixed $value
|
|
* @param mixed $schema
|
|
* @param mixed $path
|
|
* @param mixed $i
|
|
*/
|
|
protected function checkArray($value, $schema = null, $path = null, $i = null)
|
|
{
|
|
$validator = $this->getFactory()->createInstanceFor('collection');
|
|
$validator->check($value, $schema, $path, $i);
|
|
|
|
$this->addErrors($validator->getErrors());
|
|
}
|
|
|
|
/**
|
|
* Validates an object
|
|
*
|
|
* @param mixed $value
|
|
* @param mixed $schema
|
|
* @param mixed $path
|
|
* @param mixed $i
|
|
* @param mixed $patternProperties
|
|
*/
|
|
protected function checkObject($value, $schema = null, $path = null, $i = null, $patternProperties = null)
|
|
{
|
|
$validator = $this->getFactory()->createInstanceFor('object');
|
|
$validator->check($value, $schema, $path, $i, $patternProperties);
|
|
|
|
$this->addErrors($validator->getErrors());
|
|
}
|
|
|
|
/**
|
|
* Validates the type of a property
|
|
*
|
|
* @param mixed $value
|
|
* @param mixed $schema
|
|
* @param mixed $path
|
|
* @param mixed $i
|
|
*/
|
|
protected function checkType($value, $schema = null, $path = null, $i = null)
|
|
{
|
|
$validator = $this->getFactory()->createInstanceFor('type');
|
|
$validator->check($value, $schema, $path, $i);
|
|
|
|
$this->addErrors($validator->getErrors());
|
|
}
|
|
|
|
/**
|
|
* Checks a undefined element
|
|
*
|
|
* @param mixed $value
|
|
* @param mixed $schema
|
|
* @param mixed $path
|
|
* @param mixed $i
|
|
*/
|
|
protected function checkUndefined($value, $schema = null, $path = null, $i = null)
|
|
{
|
|
$validator = $this->getFactory()->createInstanceFor('undefined');
|
|
$validator->check($value, $schema, $path, $i);
|
|
|
|
$this->addErrors($validator->getErrors());
|
|
}
|
|
|
|
/**
|
|
* Checks a string element
|
|
*
|
|
* @param mixed $value
|
|
* @param mixed $schema
|
|
* @param mixed $path
|
|
* @param mixed $i
|
|
*/
|
|
protected function checkString($value, $schema = null, $path = null, $i = null)
|
|
{
|
|
$validator = $this->getFactory()->createInstanceFor('string');
|
|
$validator->check($value, $schema, $path, $i);
|
|
|
|
$this->addErrors($validator->getErrors());
|
|
}
|
|
|
|
/**
|
|
* Checks a number element
|
|
*
|
|
* @param mixed $value
|
|
* @param mixed $schema
|
|
* @param mixed $path
|
|
* @param mixed $i
|
|
*/
|
|
protected function checkNumber($value, $schema = null, $path = null, $i = null)
|
|
{
|
|
$validator = $this->getFactory()->createInstanceFor('number');
|
|
$validator->check($value, $schema, $path, $i);
|
|
|
|
$this->addErrors($validator->getErrors());
|
|
}
|
|
|
|
/**
|
|
* Checks a enum element
|
|
*
|
|
* @param mixed $value
|
|
* @param mixed $schema
|
|
* @param mixed $path
|
|
* @param mixed $i
|
|
*/
|
|
protected function checkEnum($value, $schema = null, $path = null, $i = null)
|
|
{
|
|
$validator = $this->getFactory()->createInstanceFor('enum');
|
|
$validator->check($value, $schema, $path, $i);
|
|
|
|
$this->addErrors($validator->getErrors());
|
|
}
|
|
|
|
protected function checkFormat($value, $schema = null, $path = null, $i = null)
|
|
{
|
|
$validator = $this->getFactory()->createInstanceFor('format');
|
|
$validator->check($value, $schema, $path, $i);
|
|
|
|
$this->addErrors($validator->getErrors());
|
|
}
|
|
|
|
/**
|
|
* @param string $uri JSON Schema URI
|
|
* @return string JSON Schema contents
|
|
*/
|
|
protected function retrieveUri($uri)
|
|
{
|
|
if (null === $this->uriRetriever) {
|
|
$this->setUriRetriever(new UriRetriever);
|
|
}
|
|
$jsonSchema = $this->uriRetriever->retrieve($uri);
|
|
// TODO validate using schema
|
|
return $jsonSchema;
|
|
}
|
|
}
|