AbstractController::insertVariables() - Code Metrics - flipboxfactory/craft-hubspot - Measure and Improve Code Quality continuously with Scrutinizer

AbstractController::insertVariables() A
last analyzed 2019-12-10 06:19 UTC

↳ Parent: AbstractController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	0
cts	6
cp	0
rs	9.9
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://flipboxfactory.com/software/hubspot/license
 * @link       https://www.flipboxfactory.com/software/hubspot/
 */

namespace flipbox\craft\hubspot\cp\controllers\view;

use Craft;
use craft\web\Controller;
use flipbox\craft\ember\helpers\UrlHelper;
use flipbox\craft\hubspot\cp\Cp as CpModule;
use flipbox\craft\hubspot\HubSpot;
use flipbox\craft\hubspot\records\Connection;
use yii\base\DynamicModel;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 *
 * @property CpModule $module
 */
abstract class AbstractController extends Controller
{
    /**
     * The index view template path
     */
    const TEMPLATE_BASE = 'hubspot' . '/_cp';

    /*******************************************
     * BASE PATHS
     *******************************************/

    /**
     * @return string
     */
    protected function getBaseActionPath(): string
    {
        return HubSpot::getInstance()->getUniqueId() . '/cp';
    }

    /**
     * @return string
     */
    protected function getBaseCpPath(): string
    {
        return HubSpot::getInstance()->getUniqueId();
    }

    /**
     * @param string $endpoint
     * @return string
     */
    protected function getBaseContinueEditingUrl(string $endpoint = ''): string
    {
        return $this->getBaseCpPath() . $endpoint;
    }

    /*******************************************
     * CONNECTIONS
     *******************************************/

    /**
     * @return array
     */
    protected function getConnections(): array
    {
        return Connection::findAll(['enabled' => true]);
    }

    /**
     * @return Connection|null
     */
    protected function findDefaultConnection()
    {
        return Connection::findOne([
            'enabled' => true,
            'handle' => HubSpot::getInstance()->getSettings()->getDefaultConnection()
        ]);
    }

    /**
     * @return Connection|null
     */
    protected function findActiveConnection()
    {
        $selectedConnection = Craft::$app->getRequest()->getParam(
            'connection',
            HubSpot::getInstance()->getSettings()->getDefaultConnection()
        );

        $connection = Connection::findOne([

            'enabled' => true,
            'handle' => $selectedConnection
        ]) ?: $this->findDefaultConnection();

        if ($connection === null) {
            $connections = $this->getConnections();

            if (count($connections) === 1) {
                return reset($connections);
            }
        }

        return $connection;
    }

    /**
     * @return DynamicModel
     */
    protected function invalidConnectionModel(): DynamicModel
    {
        $model = new DynamicModel();
        $model->addError(
            'connection',
            'Invalid connection. ' .
            '<a href="' . UrlHelper::cpUrl('hubspot/settings/connections') . '">' .
            'Manage connections to HubSpot' .
            '</a>.'
        );

        return $model;
    }

    /*******************************************
     * VARIABLES
     *******************************************/

    /**
     * @inheritdoc
     */
    protected function baseVariables(array &$variables = [])
    {
        $module = HubSpot::getInstance();

        $title = HubSpot::t("HubSpot");

        // Settings
        $variables['settings'] = $module->getSettings();
        $variables['title'] = $title;

        // Connections
        $variables['availableConnections'] = $this->getConnections();
        $variables['defaultConnection'] = $this->findDefaultConnection();
        $variables['activeConnection'] = $this->findActiveConnection();

        // Path to controller actions
        $variables['baseActionPath'] = $this->getBaseActionPath();

        // Path to CP
        $variables['baseCpPath'] = $this->getBaseCpPath();

        // Set the "Continue Editing" URL
        $variables['continueEditingUrl'] = $this->getBaseCpPath();

        // Select our sub-nav
        if (!$activeSubNav = Craft::$app->getRequest()->getSegment(2)) {
            $activeSubNav = 'queries';
        }
        $variables['selectedSubnavItem'] = 'hubspot.' . $activeSubNav;

        // Breadcrumbs
        $variables['crumbs'][] = [
            'label' => $title,
            'url' => UrlHelper::url(HubSpot::getInstance()->getUniqueId())
        ];
    }

    /*******************************************
     * UPSERT VARIABLES
     *******************************************/

    /**
     * @param array $variables
     */
    protected function insertVariables(array &$variables)
    {
        // apply base view variables
        $this->baseVariables($variables);

        // Set the "Continue Editing" URL
        $variables['continueEditingUrl'] = $this->getBaseContinueEditingUrl('/{id}');

        // Append title
        $variables['title'] .= ' - ' . HubSpot::t('New');
    }
}


1			<?php
2
3			/**
4			* @copyright Copyright (c) Flipbox Digital Limited
5			* @license https://flipboxfactory.com/software/hubspot/license
6			* @link https://www.flipboxfactory.com/software/hubspot/
7			*/
8
9			namespace flipbox\craft\hubspot\cp\controllers\view;
10
11			use Craft;
12			use craft\web\Controller;
13			use flipbox\craft\ember\helpers\UrlHelper;
14			use flipbox\craft\hubspot\cp\Cp as CpModule;
15			use flipbox\craft\hubspot\HubSpot;
16			use flipbox\craft\hubspot\records\Connection;
17			use yii\base\DynamicModel;
18
19			/**
20			* @author Flipbox Factory <[email protected]>
21			* @since 1.0.0
22			*
23			* @property CpModule $module
24			*/
25			abstract class AbstractController extends Controller
26			{
27			/**
28			* The index view template path
29			*/
30			const TEMPLATE_BASE = 'hubspot' . '/_cp';
31
32			/*******************************************
33			* BASE PATHS
34			*******************************************/
35
36			/**
37			* @return string
38			*/
39			protected function getBaseActionPath(): string
40			{
41			return HubSpot::getInstance()->getUniqueId() . '/cp';
42			}
43
44			/**
45			* @return string
46			*/
47			protected function getBaseCpPath(): string
48			{
49			return HubSpot::getInstance()->getUniqueId();
50			}
51
52			/**
53			* @param string $endpoint
54			* @return string
55			*/
56			protected function getBaseContinueEditingUrl(string $endpoint = ''): string
57			{
58			return $this->getBaseCpPath() . $endpoint;
59			}
60
61			/*******************************************
62			* CONNECTIONS
63			*******************************************/
64
65			/**
66			* @return array
67			*/
68			protected function getConnections(): array
69			{
70			return Connection::findAll(['enabled' => true]);
71			}
72
73			/**
74			* @return Connection\|null
75			*/
76			protected function findDefaultConnection()
77			{
78			return Connection::findOne([
79			'enabled' => true,
80			'handle' => HubSpot::getInstance()->getSettings()->getDefaultConnection()
81			]);
82			}
83
84			/**
85			* @return Connection\|null
86			*/
87			protected function findActiveConnection()
88			{
89			$selectedConnection = Craft::$app->getRequest()->getParam(
90			'connection',
91			HubSpot::getInstance()->getSettings()->getDefaultConnection()
92			);
93
94			$connection = Connection::findOne([
			0 ignored issues – show Bug Compatibility introduced 2019-06-21 04:24 UTC by Report Bug Copy Issue Report The expression `\flipbox\craft\hubspot\r...indDefaultConnection();` of type `yii\db\ActiveRecordInterface\|array\|null` adds the type `array` to the return on line 107 which is incompatible with the return type documented by `flipbox\craft\hubspot\cp...r::findActiveConnection` of type `flipbox\craft\hubspot\records\Connection\|null`. Loading history...
95			'enabled' => true,
96			'handle' => $selectedConnection
97			]) ?: $this->findDefaultConnection();
98
99			if ($connection === null) {
100			$connections = $this->getConnections();
101
102			if (count($connections) === 1) {
103			return reset($connections);
104			}
105			}
106
107			return $connection;
108			}
109
110			/**
111			* @return DynamicModel
112			*/
113			protected function invalidConnectionModel(): DynamicModel
114			{
115			$model = new DynamicModel();
116			$model->addError(
117			'connection',
118			'Invalid connection. ' .
119			'<a href="' . UrlHelper::cpUrl('hubspot/settings/connections') . '">' .
120			'Manage connections to HubSpot' .
121			'</a>.'
122			);
123
124			return $model;
125			}
126
127			/*******************************************
128			* VARIABLES
129			*******************************************/
130
131			/**
132			* @inheritdoc
133			*/
134			protected function baseVariables(array &$variables = [])
135			{
136			$module = HubSpot::getInstance();
137
138			$title = HubSpot::t("HubSpot");
139
140			// Settings
141			$variables['settings'] = $module->getSettings();
142			$variables['title'] = $title;
143
144			// Connections
145			$variables['availableConnections'] = $this->getConnections();
146			$variables['defaultConnection'] = $this->findDefaultConnection();
147			$variables['activeConnection'] = $this->findActiveConnection();
148
149			// Path to controller actions
150			$variables['baseActionPath'] = $this->getBaseActionPath();
151
152			// Path to CP
153			$variables['baseCpPath'] = $this->getBaseCpPath();
154
155			// Set the "Continue Editing" URL
156			$variables['continueEditingUrl'] = $this->getBaseCpPath();
157
158			// Select our sub-nav
159			if (!$activeSubNav = Craft::$app->getRequest()->getSegment(2)) {
160			$activeSubNav = 'queries';
161			}
162			$variables['selectedSubnavItem'] = 'hubspot.' . $activeSubNav;
163
164			// Breadcrumbs
165			$variables['crumbs'][] = [
166			'label' => $title,
167			'url' => UrlHelper::url(HubSpot::getInstance()->getUniqueId())
168			];
169			}
170
171			/*******************************************
172			* UPSERT VARIABLES
173			*******************************************/
174
175			/**
176			* @param array $variables
177			*/
178			protected function insertVariables(array &$variables)
179			{
180			// apply base view variables
181			$this->baseVariables($variables);
182
183			// Set the "Continue Editing" URL
184			$variables['continueEditingUrl'] = $this->getBaseContinueEditingUrl('/{id}');
185
186			// Append title
187			$variables['title'] .= ' - ' . HubSpot::t('New');
188			}
189			}
190

flipboxfactory / craft-hubspot

AbstractController::insertVariables() A last analyzed 2019-12-10 06:19 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

AbstractController::insertVariables() A
last analyzed 2019-12-10 06:19 UTC