SectionsController::actionDashboard() - Code Metrics - Inspection of "Fixed an issue where an error would be thrown on t..." - nystudio107/craft-webperf - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 8e3034...babf10 )

by Andrew

created 2019-03-15 17:29 UTC

SectionsController::actionDashboard() A

↳ Parent: SectionsController

Complexity

Conditions	3
Paths	4

Size

Total Lines	52
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	35
dl	0
loc	52
rs	9.36
c	0
b	0
f	0
cc	3
nc	4
nop	2

How to fix Long Method

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

 * @copyright Copyright (c) 2019 nystudio107

 */


namespace nystudio107\webperf\controllers;

use nystudio107\webperf\Webperf;
use nystudio107\webperf\assetbundles\webperf\WebperfDashboardAsset;
use nystudio107\webperf\helpers\MultiSite as MultiSiteHelper;
use nystudio107\webperf\helpers\Permission as PermissionHelper;

use Craft;
filter:
    dependency_paths: ["lib/*"]
use craft\helpers\UrlHelper;
filter:
    dependency_paths: ["lib/*"]
use craft\web\Controller;
filter:
    dependency_paths: ["lib/*"]

use yii\base\InvalidConfigException;
filter:
    dependency_paths: ["lib/*"]
use yii\web\NotFoundHttpException;
filter:
    dependency_paths: ["lib/*"]
use yii\web\Response;
filter:
    dependency_paths: ["lib/*"]

/**

 * @author    nystudio107

 * @package   Webperf

 * @since     1.0.0

 */

class SectionsController extends Controller
{
    // Constants
    // =========================================================================

    const DOCUMENTATION_URL = 'https://github.com/nystudio107/craft-webperf/';

    const WEBHOOKS_PLUGIN_HANDLE = 'webhooks';

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

    protected $allowAnonymous = [];

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

    /**

     * @param string|null $siteHandle

     * @param bool        $showWelcome

     *
     * @return Response
     * @throws NotFoundHttpException
     * @throws \yii\web\ForbiddenHttpException
     */
    public function actionDashboard(string $siteHandle = null, bool $showWelcome = false): Response
    {
        $variables = [];
        PermissionHelper::controllerPermissionCheck('webperf:dashboard');
        // Trim the statistics
        Webperf::$plugin->dataSamples->trimOrphanedSamples(1024);
        Webperf::$plugin->dataSamples->trimDataSamples();
        // Get the site to edit
        $siteId = MultiSiteHelper::getSiteIdFromHandle($siteHandle);
        $pluginName = Webperf::$settings->pluginName;
        $templateTitle = Craft::t('webperf', 'Dashboard');
        $view = Craft::$app->getView();
        // Asset bundle
        try {
            $view->registerAssetBundle(WebperfDashboardAsset::class);
        } catch (InvalidConfigException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
        $variables['baseAssetsUrl'] = Craft::$app->assetManager->getPublishedUrl(
            '@nystudio107/webperf/assetbundles/webperf/dist',
            true
        );
        // Enabled sites
        MultiSiteHelper::setMultiSiteVariables($siteHandle, $siteId, $variables);
        $variables['controllerHandle'] = 'dashboard';
        // Basic variables
        $variables['fullPageForm'] = false;
        $variables['docsUrl'] = self::DOCUMENTATION_URL;
        $variables['pluginName'] = $pluginName;
        $variables['title'] = $templateTitle;
        $siteHandleUri = Craft::$app->isMultiSite ? '/'.$siteHandle : '';
        $variables['crumbs'] = [
            [
                'label' => $pluginName,
                'url' => UrlHelper::cpUrl('webperf'),
            ],
            [
                'label' => $templateTitle,
                'url' => UrlHelper::cpUrl('webperf/dashboard'.$siteHandleUri),
            ],
        ];
        $variables['docTitle'] = "{$pluginName} - {$templateTitle}";
        $variables['selectedSubnavItem'] = 'dashboard';
        $variables['showWelcome'] = $showWelcome;
        $variables['settings'] = Webperf::$settings;
        // Set the default date range
        $now = new \DateTime();
        $variables['end'] = $now->format('Y-m-d');
        $variables['start'] = $now->modify('-1 year')->format('Y-m-d');

        // Render the template
        return $this->renderTemplate('webperf/dashboard/index', $variables);
    }

    /**

     * @param string|null $siteHandle

     *
     * @return Response
     * @throws NotFoundHttpException
     * @throws \yii\web\ForbiddenHttpException
     */
    public function actionPagesIndex(string $siteHandle = null): Response
    {
        $variables = [];
        PermissionHelper::controllerPermissionCheck('webperf:performance');
        // Trim the statistics
        Webperf::$plugin->dataSamples->trimOrphanedSamples(1024);
        Webperf::$plugin->dataSamples->trimDataSamples();
        // Get the site to edit
        $siteId = MultiSiteHelper::getSiteIdFromHandle($siteHandle);
        $pluginName = Webperf::$settings->pluginName;
        $templateTitle = Craft::t('webperf', 'Performance');
        $view = Craft::$app->getView();
        // Asset bundle
        try {
            $view->registerAssetBundle(WebperfDashboardAsset::class);
        } catch (InvalidConfigException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
        $variables['baseAssetsUrl'] = Craft::$app->assetManager->getPublishedUrl(
            '@nystudio107/webperf/assetbundles/webperf/dist',
            true
        );
        // Enabled sites
        MultiSiteHelper::setMultiSiteVariables($siteHandle, $siteId, $variables);
        $variables['controllerHandle'] = 'performance';

        // Basic variables
        $variables['fullPageForm'] = false;
        $variables['docsUrl'] = self::DOCUMENTATION_URL;
        $variables['pluginName'] = $pluginName;
        $variables['title'] = $templateTitle;
        $siteHandleUri = Craft::$app->isMultiSite ? '/'.$siteHandle : '';
        $variables['crumbs'] = [
            [
                'label' => $pluginName,
                'url' => UrlHelper::cpUrl('webperf'),
            ],
            [
                'label' => $templateTitle,
                'url' => UrlHelper::cpUrl('webperf/performance'.$siteHandleUri),
            ],
        ];
        $variables['docTitle'] = "{$pluginName} - {$templateTitle}";
        $variables['selectedSubnavItem'] = 'performance';
        $variables['settings'] = Webperf::$settings;
        // Set the default date range
        $now = new \DateTime();
        $variables['end'] = $now->format('Y-m-d');
        $variables['start'] = $now->modify('-1 year')->format('Y-m-d');

        // Render the template
        return $this->renderTemplate('webperf/performance/index', $variables);
    }

    /**

     * @param string      $pageUrl

     * @param string|null $siteHandle

     *
     * @return Response
     * @throws NotFoundHttpException
     * @throws \yii\web\ForbiddenHttpException
     */
    public function actionPageDetail(string $pageUrl, string $siteHandle = null): Response
    {
        $variables = [];
        PermissionHelper::controllerPermissionCheck('webperf:performance-detail');
        // Trim the statistics
        Webperf::$plugin->dataSamples->trimOrphanedSamples(1024);
        Webperf::$plugin->dataSamples->trimDataSamples();
        // Get the site to edit
        $siteId = MultiSiteHelper::getSiteIdFromHandle($siteHandle);
        $pluginName = Webperf::$settings->pluginName;
        $templateTitle = Craft::t('webperf', 'Performance Detail');
        $view = Craft::$app->getView();
        // Asset bundle
        try {
            $view->registerAssetBundle(WebperfDashboardAsset::class);
        } catch (InvalidConfigException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
        $variables['baseAssetsUrl'] = Craft::$app->assetManager->getPublishedUrl(
            '@nystudio107/webperf/assetbundles/webperf/dist',
            true
        );
        // Enabled sites
        MultiSiteHelper::setMultiSiteVariables($siteHandle, $siteId, $variables);
        $variables['controllerHandle'] = 'performance/page-detail';

        // Basic variables
        $variables['fullPageForm'] = false;
        $variables['docsUrl'] = self::DOCUMENTATION_URL;
        $variables['pluginName'] = $pluginName;
        $variables['title'] = $templateTitle;
        $siteHandleUri = Craft::$app->isMultiSite ? '/'.$siteHandle : '';
        $variables['crumbs'] = [
            [
                'label' => $pluginName,
                'url' => UrlHelper::cpUrl('webperf'),
            ],
            [
                'label' => Craft::t('webperf', 'Performance'),
                'url' => UrlHelper::cpUrl('webperf/performance'.$siteHandleUri),
            ],
            [
                'label' => $templateTitle,
                'url' => UrlHelper::cpUrl('webperf/performance/page-detail'.$siteHandleUri, [

                    'pageUrl' => $pageUrl
                ]),
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
            ],
        ];
        $variables['docTitle'] = "{$pluginName} - {$templateTitle}";
        $variables['selectedSubnavItem'] = 'performance';
        $variables['pageUrl'] = $pageUrl;
        $variables['pageTitle'] = Webperf::$plugin->dataSamples->pageTitle($pageUrl, $siteId);
        $variables['settings'] = Webperf::$settings;
        $variables['webpageTestApiKey'] = Webperf::$settings->webpageTestApiKey;
        if (Webperf::$craft31 && $variables['webpageTestApiKey']) {
            $variables['webpageTestApiKey'] = Craft::parseEnv($variables['webpageTestApiKey']);
        }
        // Set the default date range
        $now = new \DateTime();
        $variables['end'] = $now->format('Y-m-d');
        $variables['start'] = $now->modify('-1 year')->format('Y-m-d');

        // Render the template
        return $this->renderTemplate('webperf/performance/page-detail', $variables);
    }


    /**

     * @param string|null $siteHandle

     *
     * @return Response
     * @throws NotFoundHttpException
     * @throws \yii\web\ForbiddenHttpException
     */
    public function actionErrorsIndex(string $siteHandle = null): Response
    {
        $variables = [];
        PermissionHelper::controllerPermissionCheck('webperf:errors');
        // Trim the statistics
        Webperf::$plugin->errorSamples->trimErrorSamples();
        // Get the site to edit
        $siteId = MultiSiteHelper::getSiteIdFromHandle($siteHandle);
        $pluginName = Webperf::$settings->pluginName;
        $templateTitle = Craft::t('webperf', 'Errors');
        $view = Craft::$app->getView();
        // Asset bundle
        try {
            $view->registerAssetBundle(WebperfDashboardAsset::class);
        } catch (InvalidConfigException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
        $variables['baseAssetsUrl'] = Craft::$app->assetManager->getPublishedUrl(
            '@nystudio107/webperf/assetbundles/webperf/dist',
            true
        );
        // Enabled sites
        MultiSiteHelper::setMultiSiteVariables($siteHandle, $siteId, $variables);
        $variables['controllerHandle'] = 'errors';

        // Basic variables
        $variables['fullPageForm'] = false;
        $variables['docsUrl'] = self::DOCUMENTATION_URL;
        $variables['pluginName'] = $pluginName;
        $variables['title'] = $templateTitle;
        $siteHandleUri = Craft::$app->isMultiSite ? '/'.$siteHandle : '';
        $variables['crumbs'] = [
            [
                'label' => $pluginName,
                'url' => UrlHelper::cpUrl('webperf'),
            ],
            [
                'label' => $templateTitle,
                'url' => UrlHelper::cpUrl('webperf/errors'.$siteHandleUri),
            ],
        ];
        $variables['docTitle'] = "{$pluginName} - {$templateTitle}";
        $variables['selectedSubnavItem'] = 'errors';
        $variables['settings'] = Webperf::$settings;
        // Set the default date range
        $now = new \DateTime();
        $variables['end'] = $now->format('Y-m-d');
        $variables['start'] = $now->modify('-1 year')->format('Y-m-d');

        // Render the template
        return $this->renderTemplate('webperf/errors/index', $variables);
    }

    /**

     * @param string      $pageUrl

     * @param string|null $siteHandle

     *
     * @return Response
     * @throws NotFoundHttpException
     * @throws \yii\web\ForbiddenHttpException
     */
    public function actionErrorsDetail(string $pageUrl, string $siteHandle = null): Response
    {
        $variables = [];
        PermissionHelper::controllerPermissionCheck('webperf:errors-detail');
        // Trim the statistics
        Webperf::$plugin->errorSamples->trimErrorSamples();
        // Get the site to edit
        $siteId = MultiSiteHelper::getSiteIdFromHandle($siteHandle);
        $pluginName = Webperf::$settings->pluginName;
        $templateTitle = Craft::t('webperf', 'Errors Detail');
        $view = Craft::$app->getView();
        // Asset bundle
        try {
            $view->registerAssetBundle(WebperfDashboardAsset::class);
        } catch (InvalidConfigException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
        $variables['baseAssetsUrl'] = Craft::$app->assetManager->getPublishedUrl(
            '@nystudio107/webperf/assetbundles/webperf/dist',
            true
        );
        // Enabled sites
        MultiSiteHelper::setMultiSiteVariables($siteHandle, $siteId, $variables);
        $variables['controllerHandle'] = 'errors/page-detail';

        // Basic variables
        $variables['fullPageForm'] = false;
        $variables['docsUrl'] = self::DOCUMENTATION_URL;
        $variables['pluginName'] = $pluginName;
        $variables['title'] = $templateTitle;
        $siteHandleUri = Craft::$app->isMultiSite ? '/'.$siteHandle : '';
        $variables['crumbs'] = [
            [
                'label' => $pluginName,
                'url' => UrlHelper::cpUrl('webperf'),
            ],
            [
                'label' => Craft::t('webperf', 'Errors'),
                'url' => UrlHelper::cpUrl('webperf/errors'.$siteHandleUri),
            ],
            [
                'label' => $templateTitle,
                'url' => UrlHelper::cpUrl('webperf/errors/page-detail'.$siteHandleUri, [

                    'pageUrl' => $pageUrl
                ]),
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
            ],
        ];
        $variables['docTitle'] = "{$pluginName} - {$templateTitle}";
        $variables['selectedSubnavItem'] = 'errors';
        $variables['pageUrl'] = $pageUrl;
        $variables['pageTitle'] = Webperf::$plugin->errorSamples->pageTitle($pageUrl, $siteId);
        $variables['settings'] = Webperf::$settings;
        // Set the default date range
        $now = new \DateTime();
        $variables['end'] = $now->format('Y-m-d');
        $variables['start'] = $now->modify('-1 year')->format('Y-m-d');

        // Render the template
        return $this->renderTemplate('webperf/errors/page-detail', $variables);
    }

    /**

     * @param string|null $siteHandle

     *
     * @return Response
     * @throws NotFoundHttpException
     * @throws \yii\web\ForbiddenHttpException
     */
    public function actionAlerts(string $siteHandle = null): Response
    {
        $variables = [];
        PermissionHelper::controllerPermissionCheck('webperf:alerts');
        // Get the site to edit
        $siteId = MultiSiteHelper::getSiteIdFromHandle($siteHandle);
        $pluginName = Webperf::$settings->pluginName;
        $templateTitle = Craft::t('webperf', 'Alerts');
        $view = Craft::$app->getView();
        // Asset bundle
        try {
            $view->registerAssetBundle(WebperfDashboardAsset::class);
        } catch (InvalidConfigException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
        $variables['baseAssetsUrl'] = Craft::$app->assetManager->getPublishedUrl(
            '@nystudio107/webperf/assetbundles/webperf/dist',
            true
        );
        // Enabled sites
        MultiSiteHelper::setMultiSiteVariables($siteHandle, $siteId, $variables);
        $variables['controllerHandle'] = 'alerts';
        // Basic variables
        $variables['fullPageForm'] = true;
        $variables['docsUrl'] = self::DOCUMENTATION_URL;
        $variables['pluginName'] = $pluginName;
        $variables['title'] = $templateTitle;
        $siteHandleUri = Craft::$app->isMultiSite ? '/'.$siteHandle : '';
        $variables['crumbs'] = [
            [
                'label' => $pluginName,
                'url' => UrlHelper::cpUrl('webperf'),
            ],
            [
                'label' => $templateTitle,
                'url' => UrlHelper::cpUrl('webperf/alerts'.$siteHandleUri),
            ],
        ];
        $variables['docTitle'] = "{$pluginName} - {$templateTitle}";
        $variables['selectedSubnavItem'] = 'alerts';
        $variables['settings'] = Webperf::$settings;
        $variables['webhooks'] = Craft::$app->getPlugins()->getPlugin(self::WEBHOOKS_PLUGIN_HANDLE);

        // Render the template
        return $this->renderTemplate('webperf/alerts/index', $variables);
    }
}


1			<?php
2			/**
3			* Webperf plugin for Craft CMS 3.x
4			*
5			* Monitor the performance of your webpages through real-world user timing data
6			*
7			* @link https://nystudio107.com
			0 ignored issues – show Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @copyright tag Loading history...
8			* @copyright Copyright (c) 2019 nystudio107
			0 ignored issues – show Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
9			*/
			0 ignored issues – show Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history...
10
11			namespace nystudio107\webperf\controllers;
12
13			use nystudio107\webperf\Webperf;
14			use nystudio107\webperf\assetbundles\webperf\WebperfDashboardAsset;
15			use nystudio107\webperf\helpers\MultiSite as MultiSiteHelper;
16			use nystudio107\webperf\helpers\Permission as PermissionHelper;
17
18			use Craft;
			0 ignored issues – show Bug introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report The type `Craft` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
19			use craft\helpers\UrlHelper;
			0 ignored issues – show Bug introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report The type `craft\helpers\UrlHelper` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
20			use craft\web\Controller;
			0 ignored issues – show Bug introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report The type `craft\web\Controller` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
21
22			use yii\base\InvalidConfigException;
			0 ignored issues – show Bug introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report The type `yii\base\InvalidConfigException` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
23			use yii\web\NotFoundHttpException;
			0 ignored issues – show Bug introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report The type `yii\web\NotFoundHttpException` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
24			use yii\web\Response;
			0 ignored issues – show Bug introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report The type `yii\web\Response` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
25
26			/**
			0 ignored issues – show Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
27			* @author nystudio107
			0 ignored issues – show Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @package tag Loading history... Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history... Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Tag value indented incorrectly; expected 2 spaces but found 4 Loading history...
28			* @package Webperf
			0 ignored issues – show Coding Style introduced 2019-01-02 04:57 UTC by Report Bug Copy Issue Report Tag value indented incorrectly; expected 1 spaces but found 3 Loading history...

nystudio107 / craft-webperf

Push — develop ( 8e3034...babf10 )

SectionsController::actionDashboard() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like