nystudio107\webperf\console\controllers\SamplesController

Complexity

Total Complexity

2

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	options()	0	4	1
A	actionTrim()	0	18	1

<?php
/**
 * Webperf plugin for Craft CMS 3.x
 *
 * Monitor the performance of your webpages through real-world user timing data
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2019 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\webperf\console\controllers;

use nystudio107\webperf\Webperf;

use Craft;

The type Craft was not found. Maybe you did not declare it correctly or list all dependencies?

use yii\console\Controller;

The type yii\console\Controller was not found. Maybe you did not declare it correctly or list all dependencies?

/**

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 indented incorrectly; expected 2 spaces but found 4

 * @package   Webperf

Tag value indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value 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 SamplesController extends Controller
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

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

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

    /**

Missing short description in doc comment

     * @var    bool|array

Tag value indented incorrectly; expected 1 spaces but found 4

     */
    protected $allowAnonymous = [
    ];

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

    /**

Missing short description in doc comment

     * @param string $actionID

Missing parameter comment

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

    /**
     * Trim the Webperf Data Samples and Error Samples database tables
     *
     * @return int
     */
    public function actionTrim(): int
    {
        echo Craft::t('webperf', 'Trimming data samples').PHP_EOL;
        $affectedRows = Webperf::$plugin->dataSamples->trimDataSamples($this->limit);
        echo Craft::t(
            'webperf',
            'Trimmed {rows} from webperf_data_samples table',
            ['rows' => $affectedRows]
        ).PHP_EOL;
        echo Craft::t('webperf', 'Trimming error samples').PHP_EOL;
        $affectedRows = Webperf::$plugin->errorSamples->trimErrorSamples($this->limit);
        echo Craft::t(
            'webperf',
            'Trimmed {rows} from webperf_error_samples table',
            ['rows' => $affectedRows]
        ).PHP_EOL;

        return 0;
    }
}