nystudio107 / craft-retour

src/console/controllers/StatsController.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\console\controllers;

use Craft;
use nystudio107\retour\Retour;
use yii\console\Controller;

/**
 * Retour Stats command
 *
 * @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 StatsController extends Controller
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var null|int
     */
    public ?int $limit = null;

    // Protected Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var    array|bool

Tag value for @var tag indented incorrectly; expected 1 spaces but found 4

     */
    protected array|bool $allowAnonymous = [
    ];

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

    /**

Missing short description in doc comment

     * @param string $actionID

Missing parameter comment

     *
     * @return array
     */
    public function options($actionID): array
    {
        return [
            'limit',
        ];
    }

    /**
     * Trim the Retour statistics database table
     *
     * @return int
     */
    public function actionTrim(): int
    {
        echo Craft::t('retour', 'Trimming statistics') . PHP_EOL;
        $affectedRows = Retour::$plugin->statistics->trimStatistics($this->limit);

The method trimStatistics() does not exist on null.

        echo Craft::t(
                'retour',

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.

                'Trimmed {rows} from retour_stats table',

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.

                ['rows' => $affectedRows]

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.

            ) . PHP_EOL;

This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 12.

        return 0;
    }

    // Protected Methods
    // =========================================================================
}