flipbox\craft\hubspot\cp\controllers\view\AbstractController

Complexity

Total Complexity

13

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

0%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getBaseActionPath()	0	4	1
A	getBaseCpPath()	0	4	1
A	getBaseContinueEditingUrl()	0	4	1
A	getConnections()	0	4	1
A	findDefaultConnection()	0	7	1
A	findActiveConnection()	0	22	4
A	invalidConnectionModel()	0	13	1
A	baseVariables()	0	36	2
A	insertVariables()	0	11	1

<?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 <hello@flipboxfactory.com>
 * @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([

The expression \flipbox\craft\hubspot\records\Connection::findOne(array('enabled' => true, 'handle' => $selectedConnection)) ?: $this->findDefaultConnection(); 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\controllers\view\AbstractController::findActiveConnection of type flipbox\craft\hubspot\records\Connection|null.

            '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');
    }
}