dstotijn\yii2jsv\JsonSchemaValidator

Complexity

Total Complexity

17

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	2	Features	3

3 Methods

Rating	Name	Duplication	Size	Complexity
C	init()	0	32	8
B	validateAttribute()	0	32	5
B	validateValue()	0	25	4

<?php
namespace dstotijn\yii2jsv;

use JsonSchema\Uri\UriRetriever;
use JsonSchema\Validator as JSValidator;
use Yii;
use yii\base\InvalidConfigException;
use yii\validators\Validator;

/**
 * JsonSchemaValidator validates a value against a JSON Schema file.
 *
 * The URI of the schema file must be defined via the [[schema]] property.
 *
 * @author David Stotijn <dstotijn@gmail.com>
 */
class JsonSchemaValidator extends Validator
{
    /**
     * @var string The URI of the JSON schema file.
     */
    public $schema;

    /**
     * @var string User-defined error message used when the schema is missing.
     */
    public $schemaEmpty;

    /**
     * @var string User-defined error message used when the schema isn't a string.
     */
    public $schemaNotString;

    /**
     * @var string User-defined error message used when the value is not a string.
     */
    public $notString;

    /**
     * @var string User-defined error message used when the value is not a valid JSON string.
     */
    public $notJsonString;

    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();

        if ($this->schemaEmpty === null) {
            $this->schemaEmpty = 'The "schema" property must be set.';
        }

        if ($this->schemaNotString === null) {
            $this->schemaNotString = 'The "schema" property must be a a string.';
        }

        if ($this->message === null) {
            $this->message = Yii::t('app', '{property}: {message}.');
        }

        if ($this->notString === null) {
            $this->notString = Yii::t('app', 'The value must be a string.');
        }

        if ($this->notJsonString === null) {
            $this->notJsonString = Yii::t('app', 'The value must be a valid JSON string.');
        }

        if (empty($this->schema)) {
            throw new InvalidConfigException($this->schemaEmpty);
        }

        if (!is_string($this->schema)) {
            throw new InvalidConfigException($this->schemaNotString);
        }
    }

    /**
     * @inheritdoc
     */
    public function validateAttribute($model, $attribute)
    {
        if (!is_string($model->$attribute)) {
            $this->addError($model, $attribute, $this->notString);
            return;
        }

        $value = json_decode($model->$attribute);
        if (json_last_error()) {
            $this->addError($model, $attribute, $this->notJsonString);
        }

        $retriever = new UriRetriever();
        $schema = $retriever->retrieve($this->schema);

        $validator = new JSValidator();
        $validator->check($value, $schema);

        if (!$validator->isValid()) {
            foreach ($validator->getErrors() as $error) {
                $this->addError(
                    $model,
                    $attribute,
                    $this->message,
                    [
                        'property' => $error['property'],
                        'message' => ucfirst($error['message']),
                    ]
                );
            }
        }
    }

    /**
     * Validates a value.
     *
     * @param string $value A JSON encoded string to validate.
     * @return array|null An array of error data, or null if the data is valid.
     */
    protected function validateValue($value)
    {
        if (!is_string($value)) {
            return [$this->notString, []];
        }

        $value = json_decode($value);
        if (json_last_error()) {
            return [$this->notJsonString, []];
        }

        $retriever = new UriRetriever();
        $schema = $retriever->retrieve($this->schema);

        $validator = new JSValidator();
        $validator->check($value, $schema);

        if (!$validator->isValid()) {
            $errors = $validator->getErrors();
            $error = reset($errors);
            return [$this->message, ['property' => $error['property'], 'message' => ucfirst($error['message'])]];
        }

        return null;
    }
}