AbstractViewController::availableEnvironments() - Code Metrics - Inspection of "wip" - flipboxfactory/patron - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 8e20cf...0b23aa )

by Nate

created 2018-12-06 23:52 UTC

AbstractViewController::availableEnvironments() A

↳ Parent: AbstractViewController

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	7
ccs	0
cts	6
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php

namespace flipbox\patron\cp\controllers\view\providers;

use Craft;
use craft\helpers\UrlHelper;
use flipbox\patron\cp\Cp;
use flipbox\patron\Patron;
use flipbox\patron\records\Provider;

/**
 * @property Cp $module
 */
abstract class AbstractViewController extends \flipbox\patron\cp\controllers\view\AbstractViewController
{
    /**
     * The index view template path
     */
    const TEMPLATE_BASE = 'patron/_cp/provider';

    /*******************************************
     * ENVIRONMENTS
     *******************************************/

    /**
     * @param Provider $provider
     * @return array
     */
    protected function availableEnvironments(Provider $provider): array
    {
        $usedEnvironments = array_keys($provider->environments);
        $allEnvironments = Patron::getInstance()->getSettings()->getEnvironments();

        return array_diff($allEnvironments, $usedEnvironments);
    }

    /*******************************************
     * TABS
     *******************************************/

    /**
     * @param Provider $provider
     * @return array
     */
    protected function getTabs(Provider $provider): array
    {
        if ($provider->getId() === null) {
            return [];
        }

        $baseUrl = Craft::$app->getRequest()->getSegment(1) . '/' .
            Craft::$app->getRequest()->getSegment(2) . '/' .
            Craft::$app->getRequest()->getSegment(3);

        return [
            'general' => [
                'label' => Craft::t('patron', 'General'),
                'url' => UrlHelper::url($baseUrl . '/')
            ],
            'tokens' => [
                'label' => Craft::t('patron', 'Tokens'),
                'url' => UrlHelper::url($baseUrl . '/tokens')
            ]
        ];
    }

    /*******************************************
     * PATHS
     *******************************************/

    /**
     * @inheritdoc
     */
    protected function getBaseCpProviderPath(): string
    {
        return parent::getBaseCpPath() . '/providers/' . Craft::$app->getRequest()->getSegment(3);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * @inheritdoc
     */
    protected function getBaseCpProvidersPath(): string
    {
        return parent::getBaseCpPath() . '/providers';
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * @return string
     */
    protected function getBaseActionPath(): string
    {
        return parent::getBaseActionPath() . '/providers';
    }

    /**
     * @return string
     */
    protected function getBaseCpPath(): string
    {
        return parent::getBaseCpPath() . '/providers';
    }

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

    /**
     * Set base variables used to generate template views
     *
     * @param array $variables
     */
    protected function baseVariables(array &$variables = [])
    {
        parent::baseVariables($variables);

        // Page title
        $variables['title'] .= ': ' . Craft::t('patron', "Providers");

        // Breadcrumbs
        $variables['crumbs'][] = [
            'label' => Craft::t('patron', "Providers"),
            'url' => UrlHelper::url(Patron::getInstance()->getUniqueId() . '/providers')
        ];
    }

    /**
     * @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'] .= ' - ' . Craft::t('patron', 'New');

        // Breadcrumbs
        $variables['crumbs'][] = [
            'label' => Craft::t('patron', 'New'),
            'url' => UrlHelper::url($variables['baseCpPath'] . '/new')
        ];
    }

    /*******************************************
     * UPDATE VARIABLES
     *******************************************/

    /**
     * @param array $variables
     * @param Provider $provider
     * @throws \ReflectionException
     */
    protected function updateVariables(array &$variables, Provider $provider)
    {
        // Apply base view variables
        $this->baseVariables($variables);

        // Set the "Continue Editing" URL
        $variables['continueEditingUrl'] = $this->getBaseContinueEditingUrl('/' . $provider->getId());
        $variables['baseCpProvidersPath'] = $this->getBaseCpProvidersPath();
        $variables['baseCpProviderPath'] = $this->getBaseCpProviderPath();

        // Append title
        $variables['title'] .= ' - ' . $provider->getDisplayName();

        // Breadcrumbs
        $variables['crumbs'][] = [
            'label' => $provider->getDisplayName(),
            'url' => UrlHelper::url(
                Patron::getInstance()->getUniqueId() . '/providers/' . $provider->getId()
            )
        ];
    }
}


1			<?php
2
3			namespace flipbox\patron\cp\controllers\view\providers;
4
5			use Craft;
6			use craft\helpers\UrlHelper;
7			use flipbox\patron\cp\Cp;
8			use flipbox\patron\Patron;
9			use flipbox\patron\records\Provider;
10
11			/**
12			* @property Cp $module
13			*/
14			abstract class AbstractViewController extends \flipbox\patron\cp\controllers\view\AbstractViewController
15			{
16			/**
17			* The index view template path
18			*/
19			const TEMPLATE_BASE = 'patron/_cp/provider';
20
21			/*******************************************
22			* ENVIRONMENTS
23			*******************************************/
24
25			/**
26			* @param Provider $provider
27			* @return array
28			*/
29			protected function availableEnvironments(Provider $provider): array
30			{
31			$usedEnvironments = array_keys($provider->environments);
32			$allEnvironments = Patron::getInstance()->getSettings()->getEnvironments();
33
34			return array_diff($allEnvironments, $usedEnvironments);
35			}
36
37			/*******************************************
38			* TABS
39			*******************************************/
40
41			/**
42			* @param Provider $provider
43			* @return array
44			*/
45			protected function getTabs(Provider $provider): array
46			{
47			if ($provider->getId() === null) {
48			return [];
49			}
50
51			$baseUrl = Craft::$app->getRequest()->getSegment(1) . '/' .
52			Craft::$app->getRequest()->getSegment(2) . '/' .
53			Craft::$app->getRequest()->getSegment(3);
54
55			return [
56			'general' => [
57			'label' => Craft::t('patron', 'General'),
58			'url' => UrlHelper::url($baseUrl . '/')
59			],
60			'tokens' => [
61			'label' => Craft::t('patron', 'Tokens'),
62			'url' => UrlHelper::url($baseUrl . '/tokens')
63			]
64			];
65			}
66
67			/*******************************************
68			* PATHS
69			*******************************************/
70
71			/**
72			* @inheritdoc
73			*/
74			protected function getBaseCpProviderPath(): string
75			{
76			return parent::getBaseCpPath() . '/providers/' . Craft::$app->getRequest()->getSegment(3);
			0 ignored issues – show Comprehensibility Bug introduced 2018-10-30 15:09 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`getBaseCpPath()` instead of `getBaseCpProviderPath()`). Are you sure this is correct? If so, you might want to change this to `$this->getBaseCpPath()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
77			}
78
79			/**
80			* @inheritdoc
81			*/
82			protected function getBaseCpProvidersPath(): string
83			{
84			return parent::getBaseCpPath() . '/providers';
			0 ignored issues – show Comprehensibility Bug introduced 2018-12-07 00:00 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`getBaseCpPath()` instead of `getBaseCpProvidersPath()`). Are you sure this is correct? If so, you might want to change this to `$this->getBaseCpPath()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
85			}
86
87			/**
88			* @return string
89			*/
90			protected function getBaseActionPath(): string
91			{
92			return parent::getBaseActionPath() . '/providers';
93			}
94
95			/**
96			* @return string
97			*/
98			protected function getBaseCpPath(): string
99			{
100			return parent::getBaseCpPath() . '/providers';
101			}
102
103			/*******************************************
104			* VARIABLES
105			*******************************************/
106
107			/**
108			* Set base variables used to generate template views
109			*
110			* @param array $variables
111			*/
112			protected function baseVariables(array &$variables = [])
113			{
114			parent::baseVariables($variables);
115
116			// Page title
117			$variables['title'] .= ': ' . Craft::t('patron', "Providers");
118
119			// Breadcrumbs
120			$variables['crumbs'][] = [
121			'label' => Craft::t('patron', "Providers"),
122			'url' => UrlHelper::url(Patron::getInstance()->getUniqueId() . '/providers')
123			];
124			}
125
126			/**
127			* @param array $variables
128			*/
129			protected function insertVariables(array &$variables)
130			{
131			// Apply base view variables
132			$this->baseVariables($variables);
133
134			// Set the "Continue Editing" URL
135			$variables['continueEditingUrl'] = $this->getBaseContinueEditingUrl('/{id}');
136
137			// Append title
138			$variables['title'] .= ' - ' . Craft::t('patron', 'New');
139
140			// Breadcrumbs
141			$variables['crumbs'][] = [
142			'label' => Craft::t('patron', 'New'),
143			'url' => UrlHelper::url($variables['baseCpPath'] . '/new')
144			];
145			}
146
147			/*******************************************
148			* UPDATE VARIABLES
149			*******************************************/
150
151			/**
152			* @param array $variables
153			* @param Provider $provider
154			* @throws \ReflectionException
155			*/
156			protected function updateVariables(array &$variables, Provider $provider)
157			{
158			// Apply base view variables
159			$this->baseVariables($variables);
160
161			// Set the "Continue Editing" URL
162			$variables['continueEditingUrl'] = $this->getBaseContinueEditingUrl('/' . $provider->getId());
163			$variables['baseCpProvidersPath'] = $this->getBaseCpProvidersPath();
164			$variables['baseCpProviderPath'] = $this->getBaseCpProviderPath();
165
166			// Append title
167			$variables['title'] .= ' - ' . $provider->getDisplayName();
168
169			// Breadcrumbs
170			$variables['crumbs'][] = [
171			'label' => $provider->getDisplayName(),
172			'url' => UrlHelper::url(
173			Patron::getInstance()->getUniqueId() . '/providers/' . $provider->getId()
174			)
175			];
176			}
177			}
178

flipboxfactory / patron

Push — develop ( 8e20cf...0b23aa )

AbstractViewController::availableEnvironments() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like