nystudio107 / craft-retour

src/widgets/RetourWidget.php

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

use Craft;
use craft\base\Widget;
use nystudio107\retour\assetbundles\retour\RetourWidgetAsset;
use nystudio107\retour\Retour;
use Twig\Error\LoaderError;
use yii\base\Exception;
use yii\base\InvalidConfigException;

/** @noinspection MissingPropertyAnnotationsInspection */

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

/**
 * Retour Widget
 *
 * @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 RetourWidget extends Widget
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var int
     */
    public int $numberOfDays = 30;

    // Static Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function displayName(): string
    {
        return Retour::$settings->pluginName;
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function iconPath(): bool|string
    {
        return Craft::getAlias("@nystudio107/retour/web/assets/dist/img/icon-mask.svg");
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function maxColspan(): ?int
    {
        return 1;
    }

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function rules(): array
    {
        $rules = parent::rules();
        $rules = array_merge(
            $rules,
            [
                ['numberOfDays', 'integer', 'min' => 1],
                ['numberOfDays', 'default', 'value' => 30],
            ]
        );
        return $rules;
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getSettingsHtml(): null|string
    {
        try {
            return Craft::$app->getView()->renderTemplate(
                'retour/_components/widgets/Retour_settings',
                [
                    'widget' => $this,
                ]
            );
        } catch (LoaderError $e) {
            Craft::error($e->getMessage(), __METHOD__);
        } catch (Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        return null;
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getBodyHtml(): null|string
    {
        try {
            Craft::$app->getView()->registerAssetBundle(RetourWidgetAsset::class);
        } catch (InvalidConfigException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        try {
            return Craft::$app->getView()->renderTemplate(
                'retour/_components/widgets/Retour_body',
                [
                    'numberOfDays' => $this->numberOfDays,
                ]
            );
        } catch (LoaderError $e) {
            Craft::error($e->getMessage(), __METHOD__);
        } catch (Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        return null;
    }
}