Settings::rules() - Code Metrics - Inspection of "Addressing project config and read-only mode issue..." - flipboxfactory/patron - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 424357...36238a )

by Nate

created 2020-10-23 16:09 UTC

Settings::rules() A

↳ Parent: Settings

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

<?php

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

namespace flipbox\patron\models;

use Craft;
use craft\base\Model;
use craft\helpers\StringHelper;
use craft\validators\UriValidator;
use flipbox\craft\ember\helpers\UrlHelper;
use flipbox\craft\ember\views\Template;
use flipbox\craft\ember\views\ViewInterface;
use yii\base\Exception;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 */
class Settings extends Model
{
    /**
     * The callback url path
     */
    const DEFAULT_CALLBACK_URL_PATH = 'patron/authorization/callback';

    /**
     * Tge callback url route
     */
    const DEFAULT_CALLBACK_ROUTE = self::DEFAULT_CALLBACK_URL_PATH;

    /**
     * @var string|null
     */
    private $callbackUrlPath;

    /**
     * @var array|null
     */
    private $providers = [];


    /*******************************************
     * PROVIDER OVERRIDES
     *******************************************/

    /**
     * Get an array provider override configurations
     *
     * @return array
     */
    public function getProviders(): array
    {
        return $this->providers;
    }

    /**
     * Set an array provider override configurations
     *
     * @param array $providers
     * @return static
     */
    public function setProviders(array $providers)
    {
        $this->providers = $providers;
        return $this;
    }

    /**
     * Get a provider override configuration by the provider handle
     *
     * @param string $handle
     * @return array
     */
    public function getProvider(string $handle): array
    {
        return $this->providers[$handle] ?? [];
    }


    /*******************************************
     * ENCRYPTION [DEPRECATED]
     *******************************************/

    /**
     * @param bool $value
     * @return $this
     *
     * @deprecated
     */
    public function setEncryptStorageData(bool $value)

    {
        return $this;
    }

    /*******************************************
     * TOKEN ENVIRONMENTS [DEPRECATED]
     *******************************************/

    /**
     * @param bool $value
     * @return $this
     *
     * @deprecated
     */
    public function setAutoPopulateTokenEnvironments(bool $value)

    {
        return $this;
    }

    /**
     * @param bool $value
     * @return $this
     *
     * @deprecated
     */
    public function setApplyProviderEnvironmentsToToken(bool $value)

    {
        return $this;
    }

    /*******************************************
     * ENVIRONMENTS [DEPRECATED]
     *******************************************/

    /**
     * @param string $environment
     * @return $this
     *
     * @deprecated
     */
    public function setEnvironment(string $environment)

    {
        return $this;
    }

    /**
     * @param array $environments
     * @return $this
     *
     * @deprecated
     */
    public function setEnvironments(array $environments)

    {
        return $this;
    }


    /**
     * @param array $environments
     * @return $this
     *
     * @deprecated
     */
    public function setDefaultEnvironments(array $environments)

    {
        return $this;
    }

    /*******************************************
     * CALLBACK
     *******************************************/

    /**
     * @return string
     */
    public function getCallbackUrl(): string
    {
        try {
            if ($this->callbackUrlPath === null) {
                return UrlHelper::siteActionUrl(self::DEFAULT_CALLBACK_URL_PATH);
            }

            return UrlHelper::siteUrl($this->callbackUrlPath);
        } catch (Exception $e) {
            if ($this->callbackUrlPath === null) {
                return UrlHelper::actionUrl(self::DEFAULT_CALLBACK_URL_PATH);
            }

            return UrlHelper::url($this->callbackUrlPath);
        }
    }

    /**
     * @param $callbackUrlPath
     * @return $this
     * @throws Exception
     */
    public function setCallbackUrlPath($callbackUrlPath)
    {
        $callbackUrlPath = trim(
            StringHelper::removeLeft(
                (string)$callbackUrlPath,
                UrlHelper::siteUrl()
            ),
            ' /'
        );

        $this->callbackUrlPath = empty($callbackUrlPath) ? null : $callbackUrlPath;

        return $this;
    }

    /**
     * @return string|null
     */
    public function getCallbackUrlPath()
    {
        return $this->callbackUrlPath;
    }

    /**
     * @return array|null
     */
    public function getCallbackUrlRule()
    {
        if ($path = $this->callbackUrlPath) {
            return [
                $path => self::DEFAULT_CALLBACK_ROUTE
            ];
        }
        return null;
    }


    /*******************************************
     * PROVIDER SETTINGS VIEW (not currently editable)
     *******************************************/

    /**
     * @return ViewInterface'

     */
    public function getProviderSettingsView(): ViewInterface
    {
        return new Template([
            'template' => 'patron/_cp/provider/_settings'
        ]);
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return array_merge(
            parent::rules(),
            [
                [
                    [
                        'callbackUrlPath'
                    ],
                    UriValidator::class
                ],
                [
                    [
                        'providers'
                    ],
                    'safe',
                    'on' => [
                        self::SCENARIO_DEFAULT
                    ]
                ]
            ]
        );
    }

    /**
     * @inheritdoc
     */
    public function attributes()
    {
        return array_merge(
            parent::attributes(),
            [
                'callbackUrlPath',
                'providers'
            ]
        );
    }

    /**
     * @inheritdocå
     */
    public function attributeLabels()
    {
        return array_merge(
            parent::attributeLabels(),
            [
                'callbackUrlPath' => Craft::t('patron', 'Callback Url Path'),
                'providers' => Craft::t('patron', 'Provider Overrides')
            ]
        );
    }
}


1			<?php
2
3			/**
4			* @copyright Copyright (c) Flipbox Digital Limited
5			* @license https://flipboxfactory.com/software/patron/license
6			* @link https://www.flipboxfactory.com/software/patron/
7			*/
8
9			namespace flipbox\patron\models;
10
11			use Craft;
12			use craft\base\Model;
13			use craft\helpers\StringHelper;
14			use craft\validators\UriValidator;
15			use flipbox\craft\ember\helpers\UrlHelper;
16			use flipbox\craft\ember\views\Template;
17			use flipbox\craft\ember\views\ViewInterface;
18			use yii\base\Exception;
19
20			/**
21			* @author Flipbox Factory <[email protected]>
22			* @since 1.0.0
23			*/
24			class Settings extends Model
25			{
26			/**
27			* The callback url path
28			*/
29			const DEFAULT_CALLBACK_URL_PATH = 'patron/authorization/callback';
30
31			/**
32			* Tge callback url route
33			*/
34			const DEFAULT_CALLBACK_ROUTE = self::DEFAULT_CALLBACK_URL_PATH;
35
36			/**
37			* @var string\|null
38			*/
39			private $callbackUrlPath;
40
41			/**
42			* @var array\|null
43			*/
44			private $providers = [];
45
46
47			/*******************************************
48			* PROVIDER OVERRIDES
49			*******************************************/
50
51			/**
52			* Get an array provider override configurations
53			*
54			* @return array
55			*/
56			public function getProviders(): array
57			{
58			return $this->providers;
59			}
60
61			/**
62			* Set an array provider override configurations
63			*
64			* @param array $providers
65			* @return static
66			*/
67			public function setProviders(array $providers)
68			{
69			$this->providers = $providers;
70			return $this;
71			}
72
73			/**
74			* Get a provider override configuration by the provider handle
75			*
76			* @param string $handle
77			* @return array
78			*/
79			public function getProvider(string $handle): array
80			{
81			return $this->providers[$handle] ?? [];
82			}
83
84
85			/*******************************************
86			* ENCRYPTION [DEPRECATED]
87			*******************************************/
88
89			/**
90			* @param bool $value
91			* @return $this
92			*
93			* @deprecated
94			*/
95			public function setEncryptStorageData(bool $value)
			0 ignored issues – show Unused Code introduced 2019-04-29 17:33 UTC by Report Bug Copy Issue Report The parameter `$value` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
96			{
97			return $this;
98			}
99
100			/*******************************************
101			* TOKEN ENVIRONMENTS [DEPRECATED]
102			*******************************************/
103
104			/**
105			* @param bool $value
106			* @return $this
107			*
108			* @deprecated
109			*/
110			public function setAutoPopulateTokenEnvironments(bool $value)
			0 ignored issues – show Unused Code introduced 2019-04-29 17:33 UTC by Report Bug Copy Issue Report The parameter `$value` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
111			{
112			return $this;
113			}
114
115			/**
116			* @param bool $value
117			* @return $this
118			*
119			* @deprecated
120			*/
121			public function setApplyProviderEnvironmentsToToken(bool $value)
			0 ignored issues – show Unused Code introduced 2019-04-29 17:33 UTC by Report Bug Copy Issue Report The parameter `$value` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
122			{
123			return $this;
124			}
125
126			/*******************************************
127			* ENVIRONMENTS [DEPRECATED]
128			*******************************************/
129
130			/**
131			* @param string $environment
132			* @return $this
133			*
134			* @deprecated
135			*/
136			public function setEnvironment(string $environment)
			0 ignored issues – show Unused Code introduced 2019-04-29 17:33 UTC by Report Bug Copy Issue Report The parameter `$environment` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
137			{
138			return $this;
139			}
140
141			/**
142			* @param array $environments
143			* @return $this
144			*
145			* @deprecated
146			*/
147			public function setEnvironments(array $environments)
			0 ignored issues – show Unused Code introduced 2019-04-29 17:33 UTC by Report Bug Copy Issue Report The parameter `$environments` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
148			{
149			return $this;
150			}
151
152
153			/**
154			* @param array $environments
155			* @return $this
156			*
157			* @deprecated
158			*/
159			public function setDefaultEnvironments(array $environments)
			0 ignored issues – show Unused Code introduced 2019-04-29 17:33 UTC by Report Bug Copy Issue Report The parameter `$environments` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
160			{
161			return $this;
162			}
163
164			/*******************************************
165			* CALLBACK
166			*******************************************/
167
168			/**
169			* @return string
170			*/
171			public function getCallbackUrl(): string
172			{
173			try {
174			if ($this->callbackUrlPath === null) {
175			return UrlHelper::siteActionUrl(self::DEFAULT_CALLBACK_URL_PATH);
176			}
177
178			return UrlHelper::siteUrl($this->callbackUrlPath);
179			} catch (Exception $e) {
180			if ($this->callbackUrlPath === null) {
181			return UrlHelper::actionUrl(self::DEFAULT_CALLBACK_URL_PATH);
182			}
183
184			return UrlHelper::url($this->callbackUrlPath);
185			}
186			}
187
188			/**
189			* @param $callbackUrlPath
190			* @return $this
191			* @throws Exception
192			*/
193			public function setCallbackUrlPath($callbackUrlPath)
194			{
195			$callbackUrlPath = trim(
196			StringHelper::removeLeft(
197			(string)$callbackUrlPath,
198			UrlHelper::siteUrl()
199			),
200			' /'
201			);
202
203			$this->callbackUrlPath = empty($callbackUrlPath) ? null : $callbackUrlPath;
204
205			return $this;
206			}
207
208			/**
209			* @return string\|null
210			*/
211			public function getCallbackUrlPath()
212			{
213			return $this->callbackUrlPath;
214			}
215
216			/**
217			* @return array\|null
218			*/
219			public function getCallbackUrlRule()
220			{
221			if ($path = $this->callbackUrlPath) {
222			return [
223			$path => self::DEFAULT_CALLBACK_ROUTE
224			];
225			}
226			return null;
227			}
228
229
230			/*******************************************
231			* PROVIDER SETTINGS VIEW (not currently editable)
232			*******************************************/
233
234			/**
235			* @return ViewInterface'
			0 ignored issues – show Documentation introduced 2019-05-02 19:35 UTC by Report Bug Copy Issue Report The doc-type `ViewInterface'` could not be parsed: Unknown type name "ViewInterface'" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
236			*/
237			public function getProviderSettingsView(): ViewInterface
238			{
239			return new Template([
240			'template' => 'patron/_cp/provider/_settings'
241			]);
242			}
243
244			/**
245			* @inheritdoc
246			*/
247			public function rules()
248			{
249			return array_merge(
250			parent::rules(),
251			[
252			[
253			[
254			'callbackUrlPath'
255			],
256			UriValidator::class
257			],
258			[
259			[
260			'providers'
261			],
262			'safe',
263			'on' => [
264			self::SCENARIO_DEFAULT
265			]
266			]
267			]
268			);
269			}
270
271			/**
272			* @inheritdoc
273			*/
274			public function attributes()
275			{
276			return array_merge(
277			parent::attributes(),
278			[
279			'callbackUrlPath',
280			'providers'
281			]
282			);
283			}
284
285			/**
286			* @inheritdocå
287			*/
288			public function attributeLabels()
289			{
290			return array_merge(
291			parent::attributeLabels(),
292			[
293			'callbackUrlPath' => Craft::t('patron', 'Callback Url Path'),
294			'providers' => Craft::t('patron', 'Provider Overrides')
295			]
296			);
297			}
298			}
299

flipboxfactory / patron

Push — develop ( 424357...36238a )

Settings::rules() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like