nystudio107\twigfield\validators\TwigObjectTemplateValidator

Complexity

Total Complexity

5

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

1 Method

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

<?php
/**
 * Twigfield for Craft CMS
 *
 * Provides a twig editor field with Twig & Craft API 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\twigfield\validators;

use Craft;
use Exception;
use nystudio107\twigfield\events\RegisterTwigValidatorVariablesEvent;
use yii\base\Model;
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   Twigfield

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

 * @since     1.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 TwigObjectTemplateValidator extends Validator
{
    // Constants
    // =========================================================================

    /**

Missing short description in doc comment

     * @event RegisterTwigValidatorVariablesEvent The event that is triggered to allow
     *        you to register Variables to be passed down to the Twig context during
     *        Twig template validation
     *
     * ```php
     * use nystudio107\twigfield\validators\TwigTemplateValidator;
     * use nystudio107\twigfield\events\RegisterTwigValidatorVariablesEvent;
     * use yii\base\Event;
     *
     * Event::on(TwigTemplateValidator::class,
     *     TwigTemplateValidator::EVENT_REGISTER_TWIG_VALIDATOR_VARIABLES,
     *     function(RegisterTwigValidatorVariablesEvent $event) {
     *         $event->object = $myObject;
     *         $event->variables['variableName'] = $variableValue;
     *     }
     * );
     * ```
     */
    const EVENT_REGISTER_TWIG_VALIDATOR_VARIABLES = 'registerTwigValidatorVariables';

    /**

Missing short description in doc comment

     * @var mixed The object that should be passed into `renderObjectTemplate()` during the template rendering
     */
    public $object = null;

    /**

Missing short description in doc comment

     * @var array Variables in key => value format that should be available during the template rendering
     */
    public $variables = [];

    // 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)
    {
        /** @var Model $model */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $value = $model->$attribute;
        $error = null;
        if (!empty($value) && is_string($value)) {
            try {
                $event = new RegisterTwigValidatorVariablesEvent([

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'object' => $this->object,
                    'variables' => $this->variables,
                ]);

For multi-line function calls, the closing parenthesis should be on a new line.

                $this->trigger(self::EVENT_REGISTER_TWIG_VALIDATOR_VARIABLES, $event);
                Craft::$app->getView()->renderObjectTemplate($value, $event->object, $event->variables);
            } catch (Exception $e) {
                $error = Craft::t(
                    'twigfield',
                    'Error rendering template string -> {error}',
                    ['error' => $e->getMessage()]
                );
            }
        } else {
            $error = Craft::t('twigfield', '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__);
        }
    }
}