nystudio107\codefield\validators\JsonValidator

Complexity

Total Complexity

5

Size/Duplication

Total Lines	27
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	validateAttribute()	0	19	5

<?php
/**
 * Code Field plugin for Craft CMS
 *
 * Provides a Code Field that has a full-featured code editor with syntax highlighting & autocomplete
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2022 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\codefield\validators;

use Craft;
use craft\helpers\Json;
use yii\validators\Validator;
use function is_string;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Code Field

Package name "Code Field" is not valid; consider "Code_Field" instead

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     4.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class JsonValidator extends Validator
{
    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

Parameter $model should have a doc-comment as per coding-style.

Parameter $attribute should have a doc-comment as per coding-style.

     * @inheritdoc
     */

Missing @return tag in function comment

    public function validateAttribute($model, $attribute): void
    {
        $value = $model->$attribute;
        $error = null;
        if (!empty($value) && is_string($value)) {
            $json = Json::decodeIfJson($value);
            if (!is_array($json)) {
                $error = Craft::t(
                    'codefield',
                    'This is not valid JSON',
                );
            }
        } else {
            $error = Craft::t('codefield', 'Is not a string.');
        }
        // If there's an error, add it to the model, and log it
        if ($error) {
            $model->addError($attribute, $error);
            Craft::error($error, __METHOD__);
        }
    }
}