nystudio107\retour\models\Redirects

Complexity

Total Complexity

4

Size/Duplication

Total Lines	153
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	behaviors()	0	5	1
A	rules()	0	59	1
A	init()	0	6	2

<?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\models;

use nystudio107\retour\validators\DbStringValidator;
use nystudio107\retour\validators\ParsedUriValidator;
use nystudio107\retour\validators\UriValidator;
use yii\behaviors\AttributeTypecastBehavior;

/**

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 Redirects extends DbModel
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var int The id of the redirect.
     */
    public int $id = 0;

    /**

Missing short description in doc comment

     * @var null|int The siteId of the redirect (0 or null for all sites).
     */
    public ?int $siteId = null;

    /**

Missing short description in doc comment

     * @var int The id of the Element associated with this redirect (unused/vestigial).
     */
    public int $associatedElementId = 0;

    /**

Missing short description in doc comment

     * @var bool Whether the redirect is enabled or not.
     */
    public bool $enabled = true;

    /**

Missing short description in doc comment

     * @var string The unparsed URL pattern that Retour should match.
     */
    public string $redirectSrcUrl = '';

    /**

Missing short description in doc comment

     * @var string The parsed URL pattern that Retour should match.
     */
    public string $redirectSrcUrlParsed = '';

    /**

Missing short description in doc comment

     * @var string Should the legacy URL be matched by path or by full URL?
     */
    public string $redirectSrcMatch = '';

    /**

Missing short description in doc comment

     * @var string Whether an `exactmatch` or `regexmatch` should be used when matching the URL.
     */
    public string $redirectMatchType = '';

    /**

Missing short description in doc comment

     * @var string The URL that should be redirected to.
     */
    public string $redirectDestUrl = '';

    /**

Missing short description in doc comment

     * @var int The http status code that should be used for the redirect.
     */
    public int $redirectHttpCode = 301;

    /**

Missing short description in doc comment

     * @var int The number of times this redirect has been hit.
     */
    public int $hitCount = 0;

    /**

Missing short description in doc comment

     * @var string A datetime string of when this redirect was last hit
     */
    public string $hitLastTime = '';

    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function init(): void
    {
        parent::init();
        // If the redirectSrcUrl starts with `http`, default the match type to `fullurl`
        if (strpos($this->redirectSrcUrl, 'http') === 0) {
            $this->redirectSrcMatch = 'fullurl';
        }
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function rules(): array
    {
        return [
            ['id', 'integer'],
            ['siteId', 'integer'],
            ['siteId', 'default', 'value' => null],
            ['associatedElementId', 'default', 'value' => 0],
            ['associatedElementId', 'integer'],
            ['enabled', 'boolean'],
            ['redirectSrcMatch', 'string'],
            ['redirectSrcMatch', 'in', 'range' => ['pathonly', 'fullurl']],
            ['redirectSrcMatch', 'default', 'value' => 'pathonly'],
            ['redirectSrcMatch', DbStringValidator::class, 'max' => 32],
            ['redirectMatchType', 'string'],
            ['redirectMatchType', 'in', 'range' => ['exactmatch', 'regexmatch']],
            ['redirectMatchType', 'default', 'value' => 'exactmatch'],
            ['redirectMatchType', DbStringValidator::class, 'max' => 32],
            [
                [
                    'redirectSrcUrl',
                    'redirectSrcUrlParsed',
                    'redirectDestUrl',
                ],
                'default',
                'value' => '',
            ],
            ['redirectSrcUrlParsed', ParsedUriValidator::class, 'source' => 'redirectSrcUrl'],
            [
                [
                    'redirectSrcUrl',
                    'redirectSrcUrlParsed',
                    'redirectDestUrl',
                ],
                UriValidator::class,
            ],
            [
                [
                    'redirectSrcUrl',
                    'redirectSrcUrlParsed',
                    'redirectMatchType',
                    'redirectDestUrl',
                ],
                DbStringValidator::class,
                'max' => 255,
            ],
            [
                [
                    'redirectSrcUrl',
                    'redirectSrcUrlParsed',
                    'redirectDestUrl',
                ],
                'string',
            ],
            ['redirectHttpCode', 'integer'],
            ['redirectHttpCode', 'default', 'value' => 301],
            ['redirectHttpCode', 'in', 'range' => [301, 302, 307, 308, 410]],
            ['hitCount', 'default', 'value' => 0],
            ['hitCount', 'integer'],
            ['hitLastTime', 'safe'],
        ];
    }

    /**

Missing short description in doc comment

     * @return array
     */
    public function behaviors(): array
    {
        return [
            'typecast' => [
                'class' => AttributeTypecastBehavior::class,
                // 'attributeTypes' will be composed automatically according to `rules()`
            ],
        ];
    }
}