nystudio107 / craft-retour

src/validators/DbStringValidator.php

<?php
/**
 * Retour plugin for Craft CMS 3.x
 *
 * Retour allows you to intelligently redirect legacy URLs, so that you don't
 * lose SEO value when rebuilding & restructuring a website
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 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\retour\validators;

use nystudio107\retour\helpers\Text as TextHelper;

use craft\helpers\StringHelper;

use yii\base\InvalidConfigException;
use yii\validators\Validator;

/**

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   Retour

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

 * @since     3.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 DbStringValidator extends Validator
{
    /**

Missing short description in doc comment

     * @var null|int
     */
    public $max = null;


    /**

Missing short description in doc comment

     * @inheritdoc
     * @throws InvalidConfigException

Tag value for @throws tag indented incorrectly; expected 5 spaces but found 1

     */

Missing @return tag in function comment

    public function init()
    {
        parent::init();
        if ($this->max === null) {
            throw new InvalidConfigException('The "max" property must be set.');
        }
    }

    /**

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)
    {
        $value = $model->$attribute;
        $value = TextHelper::cleanupText($value);
        $value = StringHelper::encodeMb4($value);
        $value = TextHelper::truncate($value, $this->max);
        $model->$attribute = $value;
    }
}