yii\validators\JsonValidator

Complexity

Total Complexity

4

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	8	2
A	validateValue()	0	11	2

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\validators;

use Yii;
use yii\helpers\Json;

/**
 * This validator checks if the attribute value is a valid JSON string.
 *
 * @since 2.0.14
 */
class JsonValidator extends Validator
{
    /**
     * @var string user-defined error message which is used when the validation fails.
     *
     * You may use the following placeholders in the message:
     *
     * - `{attribute}`: the label of the attribute being validated
     * - `{value}`: the value of the attribute being validated
     */
    public $message;

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

        if ($this->message === null) {
            $this->message = Yii::t('yii', '{attribute} must be a valid JSON string.');
        }
    }

    /**
     * @inheritdoc
     */
    protected function validateValue($value)
    {
        $result = null;

        $isValid = Json::validate($value);
        if ($isValid === false) {
            $result = [$this->message, []];
        }

        return $result;
    }
}