Realtime::getBodyHtml() - Code Metrics - Inspection of "Fixed a bug where the settings dropdown were maske..." - dukt/analytics - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( d38550...af508d )

by Benjamin

created 2020-09-18 14:01 UTC

Realtime::getBodyHtml() B

↳ Parent: Realtime

Complexity

Conditions	6
Paths	6

Size

Total Lines	58
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	6
eloc	33
c	3
b	0
f	0
nc	6
nop	0
dl	0
loc	58
rs	8.7697

How to fix Long Method

<?php
/**
 * @link      https://dukt.net/analytics/
 * @copyright Copyright (c) 2020, Dukt
 * @license   https://github.com/dukt/analytics/blob/master/LICENSE.md
 */

namespace dukt\analytics\widgets;

use Craft;
use craft\helpers\Json;
use dukt\analytics\Plugin as Analytics;
use dukt\analytics\web\assets\realtimereportwidget\RealtimeReportWidgetAsset;
use craft\web\View;

class Realtime extends \craft\base\Widget
{
    // Properties
    // =========================================================================

    public $viewId;

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

    /**
     * @inheritdoc
     */
    public static function isSelectable(): bool
    {
        $plugin = Craft::$app->getPlugins()->getPlugin('analytics');

        if (!$plugin) {
            return false;
        }

        $settings = $plugin->getSettings();

        if (empty($settings['enableRealtime'])) {
            return false;
        }

        return parent::isSelectable();
    }

    /**
     * @inheritdoc
     */
    public static function displayName(): string
    {
        return Craft::t('analytics', 'Active users');
    }

    /**
     * @inheritdoc
     */
    public static function icon()
    {
        return Craft::getAlias('@dukt/analytics/icons/realtime-report.svg');

    }

    /**
     * @inheritDoc IWidget::getBodyHtml()
     *
     * @return string|false
     * @throws \Twig_Error_Loader
     * @throws \yii\base\Exception
     * @throws \yii\base\InvalidConfigException
     */
    public function getBodyHtml()
    {
        $view = Craft::$app->getView();

        if (Analytics::$plugin->getAnalytics()->checkPluginRequirements()) {
            if (Analytics::$plugin->getSettings()->enableWidgets) {
                $reportingViews = Analytics::$plugin->getViews()->getViews();

                if (count($reportingViews) > 0) {
                    $widgetSettings = $this->settings;

                    $reportingView = Analytics::$plugin->getViews()->getViewById($widgetSettings['viewId']);

                    if ($reportingView) {

                        $plugin = Craft::$app->getPlugins()->getPlugin('analytics');
                        $pluginSettings = $plugin->getSettings();

                        if (!empty($pluginSettings['enableRealtime'])) {
                            $realtimeRefreshInterval = Analytics::$plugin->getAnalytics()->getRealtimeRefreshInterval();

                            $widgetId = $this->id;
                            $widgetOptions = [
                                'viewId' => $widgetSettings['viewId'],
                                'refreshInterval' => $realtimeRefreshInterval,
                            ];

                            $view->registerTranslations('analytics', [
                                'Minutes ago',
                                'Pageviews',
                                '{count} minute ago',
                                '{count} minutes ago',
                            ]);

                            $view->registerJsFile('//www.gstatic.com/charts/loader.js', [
                                'position' => View::POS_HEAD,
                            ]);
                            $view->registerAssetBundle(RealtimeReportWidgetAsset::class);
                            $view->registerJs('var AnalyticsChartLanguage = "'.Craft::$app->language.'";', true);
                            $view->registerJs('new Analytics.Realtime("widget'.$widgetId.'", '.Json::encode($widgetOptions).');');

                            return $view->renderTemplate('analytics/_components/widgets/Realtime/body', [
                                'reportingView' => $reportingView
                            ]);
                        }

                        return $view->renderTemplate('analytics/_components/widgets/Realtime/disabled');
                    }

                    return $view->renderTemplate('analytics/_special/view-not-configured');
                }

                return $view->renderTemplate('analytics/_special/no-views');
            }

            return $view->renderTemplate('analytics/_components/widgets/Realtime/disabled');
        }

        return $view->renderTemplate('analytics/_special/not-connected');
    }

    /**
     * @inheritdoc
     */
    public static function maxColspan()
    {
        return 1;
    }

    /**
     * @inheritDoc ISavableComponentType::getSettingsHtml()
     *
     * @return string
     * @throws \Twig_Error_Loader
     * @throws \yii\base\Exception
     */
    public function getSettingsHtml()
    {
        $settings = $this->getSettings();
        $reportingViews = Analytics::$plugin->getViews()->getViews();

        if (count($reportingViews) > 0) {
            return Craft::$app->getView()->renderTemplate('analytics/_components/widgets/Realtime/settings', [
                'settings' => $settings,
                'reportingViews' => $reportingViews,
            ]);
        }

        return null;
    }
}


1			<?php
2			/**
3			* @link https://dukt.net/analytics/
4			* @copyright Copyright (c) 2020, Dukt
5			* @license https://github.com/dukt/analytics/blob/master/LICENSE.md
6			*/
7
8			namespace dukt\analytics\widgets;
9
10			use Craft;
11			use craft\helpers\Json;
12			use dukt\analytics\Plugin as Analytics;
13			use dukt\analytics\web\assets\realtimereportwidget\RealtimeReportWidgetAsset;
14			use craft\web\View;
15
16			class Realtime extends \craft\base\Widget
17			{
18			// Properties
19			// =========================================================================
20
21			public $viewId;
22
23			// Public Methods
24			// =========================================================================
25
26			/**
27			* @inheritdoc
28			*/
29			public static function isSelectable(): bool
30			{
31			$plugin = Craft::$app->getPlugins()->getPlugin('analytics');
32
33			if (!$plugin) {
34			return false;
35			}
36
37			$settings = $plugin->getSettings();
38
39			if (empty($settings['enableRealtime'])) {
40			return false;
41			}
42
43			return parent::isSelectable();
44			}
45
46			/**
47			* @inheritdoc
48			*/
49			public static function displayName(): string
50			{
51			return Craft::t('analytics', 'Active users');
52			}
53
54			/**
55			* @inheritdoc
56			*/
57			public static function icon()
58			{
59			return Craft::getAlias('@dukt/analytics/icons/realtime-report.svg');
			0 ignored issues – show Bug Best Practice introduced 2020-09-18 12:10 UTC by Report Bug Copy Issue Report The expression `return Craft::getAlias('...s/realtime-report.svg')` also could return the type `boolean` which is incompatible with the return type mandated by `craft\base\WidgetInterface::icon()` of `null\|string`. Loading history...
60			}
61
62			/**
63			* @inheritDoc IWidget::getBodyHtml()
64			*
65			* @return string\|false
66			* @throws \Twig_Error_Loader
67			* @throws \yii\base\Exception
68			* @throws \yii\base\InvalidConfigException
69			*/
70			public function getBodyHtml()
71			{
72			$view = Craft::$app->getView();
73
74			if (Analytics::$plugin->getAnalytics()->checkPluginRequirements()) {
75			if (Analytics::$plugin->getSettings()->enableWidgets) {
76			$reportingViews = Analytics::$plugin->getViews()->getViews();
77
78			if (count($reportingViews) > 0) {
79			$widgetSettings = $this->settings;
80
81			$reportingView = Analytics::$plugin->getViews()->getViewById($widgetSettings['viewId']);
82
83			if ($reportingView) {
			0 ignored issues – show introduced 2018-10-26 09:34 UTC by Report Bug Copy Issue Report `$reportingView` is of type `dukt\analytics\models\View`, thus it always evaluated to `true`. Loading history...
84			$plugin = Craft::$app->getPlugins()->getPlugin('analytics');
85			$pluginSettings = $plugin->getSettings();
86
87			if (!empty($pluginSettings['enableRealtime'])) {
88			$realtimeRefreshInterval = Analytics::$plugin->getAnalytics()->getRealtimeRefreshInterval();
89
90			$widgetId = $this->id;
91			$widgetOptions = [
92			'viewId' => $widgetSettings['viewId'],
93			'refreshInterval' => $realtimeRefreshInterval,
94			];
95
96			$view->registerTranslations('analytics', [
97			'Minutes ago',
98			'Pageviews',
99			'{count} minute ago',
100			'{count} minutes ago',
101			]);
102
103			$view->registerJsFile('//www.gstatic.com/charts/loader.js', [
104			'position' => View::POS_HEAD,
105			]);
106			$view->registerAssetBundle(RealtimeReportWidgetAsset::class);
107			$view->registerJs('var AnalyticsChartLanguage = "'.Craft::$app->language.'";', true);
108			$view->registerJs('new Analytics.Realtime("widget'.$widgetId.'", '.Json::encode($widgetOptions).');');
109
110			return $view->renderTemplate('analytics/_components/widgets/Realtime/body', [
111			'reportingView' => $reportingView
112			]);
113			}
114
115			return $view->renderTemplate('analytics/_components/widgets/Realtime/disabled');
116			}
117
118			return $view->renderTemplate('analytics/_special/view-not-configured');
119			}
120
121			return $view->renderTemplate('analytics/_special/no-views');
122			}
123
124			return $view->renderTemplate('analytics/_components/widgets/Realtime/disabled');
125			}
126
127			return $view->renderTemplate('analytics/_special/not-connected');
128			}
129
130			/**
131			* @inheritdoc
132			*/
133			public static function maxColspan()
134			{
135			return 1;
136			}
137
138			/**
139			* @inheritDoc ISavableComponentType::getSettingsHtml()
140			*
141			* @return string
142			* @throws \Twig_Error_Loader
143			* @throws \yii\base\Exception
144			*/
145			public function getSettingsHtml()
146			{
147			$settings = $this->getSettings();
148			$reportingViews = Analytics::$plugin->getViews()->getViews();
149
150			if (count($reportingViews) > 0) {
151			return Craft::$app->getView()->renderTemplate('analytics/_components/widgets/Realtime/settings', [
152			'settings' => $settings,
153			'reportingViews' => $reportingViews,
154			]);
155			}
156
157			return null;
158			}
159			}
160

dukt / analytics

Push — develop ( d38550...af508d )

Realtime::getBodyHtml() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like