nystudio107\webperf\controllers\RecommendationsController

Complexity

Total Complexity

2

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	actionList()	0	15	2

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

use nystudio107\webperf\helpers\Permission as PermissionHelper;

use nystudio107\webperf\models\RecommendationDataSample;

use craft\web\Controller;

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

use nystudio107\webperf\Webperf;
use yii\web\ForbiddenHttpException;

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

use yii\web\Response;

The type yii\web\Response 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 RecommendationsController extends Controller
{
    // Constants
    // =========================================================================

    // 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
    // =========================================================================

    /**
     * Return a list of recommendations
     *
     * @param string $pageUrl

Missing parameter comment

     * @param string $start

Missing parameter comment

     * @param string $end

Missing parameter comment

     * @param int    $siteId

Missing parameter comment

     *
     * @return Response
     * @throws ForbiddenHttpException
     */
    public function actionList(
        $pageUrl = '',
        string $start = '',
        string $end = '',
        $siteId = 0
    ): Response {
        PermissionHelper::controllerPermissionCheck('webperf:recommendations');
        $data = [];
        $stats = Webperf::$plugin->recommendations->data($pageUrl, $start, $end, $siteId);
        if (!empty($stats)) {
            $recSample = new RecommendationDataSample($stats);
            $data = Webperf::$plugin->recommendations->list($recSample);
        }

        return $this->asJson($data);
    }

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