nystudio107\retour\validators\UriValidator

Complexity

Total Complexity

4

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	3	1
A	validateAttribute()	0	20	3

<?php
/**
 * Retour plugin for Craft CMS
 *
 * 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 craft\helpers\UrlHelper;
use nystudio107\retour\models\StaticRedirects;
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 UriValidator extends Validator
{
    /**

Missing short description in doc comment

     * @var bool
     */
    public $skipOnEmpty = false;

    /**

Missing short description in doc comment

     * @var bool
     */
    public $skipOnError = false;

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init(): void
    {
        parent::init();
    }

    /**

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
    {
        /** @var StaticRedirects $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;
        $redirectMatchType = 'redirectMatchType';
        // Always remove whitespace
        $value = preg_replace("/\r|\n/", '', $value);
        $value = trim($value);
        $model->$attribute = $value;
        // Only do any kind of validation for exact match redirects
        if ($model->$redirectMatchType !== 'exactmatch') {
            return;
        }
        // Don't mess with URLs that are already full URLs
        if (UrlHelper::isFullUrl($value)) {
            return;
        }
        // Make sure there is a leading /
        $value = '/' . ltrim($value, '/');
        $model->$attribute = $value;
    }
}