Provider::rules() - Code Metrics - Inspection of "project config wip" - flipboxfactory/patron - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 55c38a...c1b735 )

by Nate

created 2019-04-29 17:20 UTC

Provider::rules() B

↳ Parent: Provider

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

How to fix Long Method

<?php

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

namespace flipbox\patron\records;

use Craft;
use craft\base\PluginInterface;
use craft\db\Query;
use craft\helpers\Json;
use craft\helpers\StringHelper;
use flipbox\craft\ember\helpers\ObjectHelper;
use flipbox\craft\ember\helpers\QueryHelper;
use flipbox\craft\ember\models\HandleRulesTrait;
use flipbox\craft\ember\records\ActiveRecordWithId;
use flipbox\craft\ember\records\StateAttributeTrait;
use flipbox\patron\events\RegisterProviderSettings;
use flipbox\patron\helpers\ProviderHelper;
use flipbox\patron\Patron;
use flipbox\patron\queries\ProviderActiveQuery;
use flipbox\patron\settings\BaseSettings;
use flipbox\patron\settings\SettingsInterface;
use flipbox\patron\validators\ProviderSettings as ProviderSettingsValidator;
use flipbox\patron\validators\ProviderValidator;
use yii\helpers\ArrayHelper;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 *
 * @property string $clientId
 * @property string $clientSecret
 * @property string $class
 * @property ProviderLock[] $locks
 * @property Token[] $tokens
 * @property SettingsInterface $settings
 */
class Provider extends ActiveRecordWithId
{
    use HandleRulesTrait,
        StateAttributeTrait;

    /**
     * The table alias
     */
    const TABLE_ALIAS = 'patron_providers';

    const CLIENT_ID_LENGTH = 100;
    const CLIENT_SECRET_LENGTH = 255;

    protected $getterPriorityAttributes = ['settings'];

    /**
     * @inheritdoc
     * @return ProviderActiveQuery
     * @throws \yii\base\InvalidConfigException
     */
    public static function find()
    {
        /** @noinspection PhpIncompatibleReturnTypeInspection */
        return Craft::createObject(ProviderActiveQuery::class, [get_called_class()]);
    }

    /**
     * @inheritdoc
     */
    protected static function findByCondition($condition)
    {
        if (!is_numeric($condition) && is_string($condition)) {
            $condition = ['handle' => $condition];
        }

        /** @noinspection PhpInternalEntityUsedInspection */
        return parent::findByCondition($condition);
    }

    /**
     * @return string|null
     */
    public function getIcon()
    {
        if ($this->class === null) {
            return null;
        }

        $icons = Patron::getInstance()->getCp()->getProviderIcons();

        return $icons[$this->class] ?? null;
    }

    /**
     * @return SettingsInterface
     * @throws \yii\base\InvalidConfigException
     */
    public function getSettings(): SettingsInterface
    {
        $settings = $this->getAttribute('settings');
        if (!$settings instanceof SettingsInterface) {
            $settings = Patron::getInstance()->providerSettings(
                $this->class,
                $this->getAttribute('settings')
            );

            $this->setAttribute('settings', $settings);
        }

        return $settings;
    }


    /**
     * @param $record
     * @param $row
     */
    public static function populateRecord($record, $row)
    {
        // Apply override settings
        if (null !== ($handle = $row['handle'] ?? null)) {
            $row = array_merge(
                $row,
                Patron::getInstance()->getSettings()->getProvider($handle)
            );
        }

        parent::populateRecord($record, $row);
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return array_merge(
            parent::rules(),
            $this->handleRules(),
            $this->stateRules(),
            [
                [
                    [
                        'clientId'
                    ],
                    'string',
                    'max' => static::CLIENT_ID_LENGTH
                ],
                [
                    [
                        'clientSecret'
                    ],
                    'string',
                    'max' => static::CLIENT_SECRET_LENGTH
                ],
                [
                    [
                        'class'
                    ],
                    ProviderValidator::class
                ],
                [
                    [
                        'settings'
                    ],
                    ProviderSettingsValidator::class
                ],
                [
                    [
                        'class',
                        'clientId'
                    ],
                    'required'
                ],
                [
                    [
                        'class',
                        'clientId',
                        'clientSecret',
                        'settings',
                    ],
                    'safe',
                    'on' => [
                        self::SCENARIO_DEFAULT
                    ]
                ]
            ]
        );
    }


    /*******************************************
     * RELATIONS
     *******************************************/

    /**
     * Get all of the associated tokens.
     *
     * @param array $config
     * @return \yii\db\ActiveQuery
     */
    public function getTokens(array $config = [])
    {
        $query = $this->hasMany(
            Token::class,
            ['providerId' => 'id']
        );

        if (!empty($config)) {
            QueryHelper::configure(
                $query,
                $config
            );
        }

        return $query;
    }

    /**
     * Get all of the associated tokens.
     *
     * @param array $config
     * @return \yii\db\ActiveQuery
     */
    public function getLocks(array $config = [])
    {
        $query = $this->hasMany(
            ProviderLock::class,
            ['providerId' => 'id']
        );

        if (!empty($config)) {
            QueryHelper::configure(
                $query,
                $config
            );
        }

        return $query;
    }

    /*******************************************
     * SAVE
     *******************************************/

    /**
     * @param PluginInterface $plugin
     * @param bool $runValidation
     * @param null $attributeNames
     * @return bool
     */
    public function saveAndLock(PluginInterface $plugin, $runValidation = true, $attributeNames = null): bool
    {
        if (!$this->save($runValidation, $attributeNames)) {
            return false;
        }

        return $this->addLock($plugin);
    }


    /*******************************************
     * LOCK
     *******************************************/

    /**
     * @param PluginInterface $plugin
     * @return bool
     */
    public function addLock(PluginInterface $plugin): bool
    {
        if (null === ($pluginId = $this->getPluginId($plugin))) {
            return false;
        }

        $record = ProviderLock::findOne([
            'providerId' => $this->getId(),
            'pluginId' => $pluginId
        ]);

        if (!empty($record)) {
            return true;
        }

        $record = new ProviderLock();

        $record->setAttributes([
            'providerId' => $this->getId(),
            'pluginId' => $pluginId
        ]);

        return (bool)$record->save();
    }

    /**
     * @param PluginInterface $plugin
     * @return bool
     * @throws \Throwable
     */
    public function removeLock(PluginInterface $plugin): bool
    {
        if (null === ($pluginId = $this->getPluginId($plugin))) {
            return false;
        }

        if (null === ($record = ProviderLock::findOne([
                'providerId' => $this->getId() ?: 0,
                'pluginId' => $pluginId
            ]))) {
            return true;
        }

        return (bool)$record->delete();
    }

    /**
     * @return bool
     */
    public function isLocked(): bool
    {
        return !empty($this->locks);
    }

    /**
     * @param PluginInterface $plugin
     * @return int|null
     */
    protected function getPluginId(PluginInterface $plugin)
    {
        $id = (new Query())
            ->select([
                'id',
            ])
            ->from(['{{%plugins}}'])
            ->where([
                'handle' => $plugin->getHandle()
            ])
            ->scalar();

        return $id ? (int)$id : null;
    }

    /**
     * @param PluginInterface $plugin
     * @return int|null
     */
    protected function getPluginName(PluginInterface $plugin)
    {
        $id = (new Query())
            ->select([
                'id',
            ])
            ->from(['{{%plugins}}'])
            ->where([
                'handle' => $plugin->getHandle()
            ])
            ->scalar();

        return $id ? (int)$id : null;
    }


    /*******************************************
     * DELETE
     *******************************************/

    /**
     * @param PluginInterface|null $plugin
     * @return bool|false|int
     * @throws \Throwable
     * @throws \yii\db\StaleObjectException
     */
    public function delete(PluginInterface $plugin = null)
    {
        return $this->canDelete($plugin) ? parent::delete() : false;
    }

    /**
     * @param PluginInterface|null $plugin
     * @return bool
     * @throws \craft\errors\InvalidPluginException
     */
    protected function canDelete(PluginInterface $plugin = null)
    {
        // If a plugin is locking this, prevent deletion
        $lockQuery = $this->getLocks();
        if (null !== $plugin) {
            $lockQuery->andWhere(
                ['<>', 'pluginId', $this->getPluginId($plugin)]
            );
        }

        $locks = $lockQuery->all();

        if (count($locks) > 0) {
            $handles = (new Query())
                ->select([
                    'handle',
                ])
                ->from(['{{%plugins}}'])
                ->where([
                    'id' => ArrayHelper::getColumn($locks, 'pluginId'),
                ])
                ->column();

            $names = [];
            foreach ($handles as $handle) {
                $plugin = Craft::$app->getPlugins()->getPluginInfo($handle);
                $names[] = $plugin['name'] ?? 'Unknown Plugin';
            }

            $this->addError(
                'locks',
                Craft::t(
                    'patron',
                    'The provider is locked by the following plugins: {plugins}',
                    [
                        'plugins' => StringHelper::toString($names, ', ')
                    ]
                )
            );
            return false;
        }

        return true;
    }

    /**
     * @return string
     * @throws \ReflectionException
     */
    public function getDisplayName(): string
    {
        if (empty($this->class)) {
            return 'Unknown';
        }

        return ProviderHelper::displayName(
            $this->class
        );
    }


    /*******************************************
     * PROJECT CONFIG
     *******************************************/

    /**
     * Return an array suitable for Craft's Project config
     */
    public function toProjectConfig(): array
    {
        return $this->toArray([
            'handle',
            'clientId',
            'clientSecret',
            'class',
            'scopes',
            'enabled'
        ]);
    }
}


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\records;
10
11			use Craft;
12			use craft\base\PluginInterface;
13			use craft\db\Query;
14			use craft\helpers\Json;
15			use craft\helpers\StringHelper;
16			use flipbox\craft\ember\helpers\ObjectHelper;
17			use flipbox\craft\ember\helpers\QueryHelper;
18			use flipbox\craft\ember\models\HandleRulesTrait;
19			use flipbox\craft\ember\records\ActiveRecordWithId;
20			use flipbox\craft\ember\records\StateAttributeTrait;
21			use flipbox\patron\events\RegisterProviderSettings;
22			use flipbox\patron\helpers\ProviderHelper;
23			use flipbox\patron\Patron;
24			use flipbox\patron\queries\ProviderActiveQuery;
25			use flipbox\patron\settings\BaseSettings;
26			use flipbox\patron\settings\SettingsInterface;
27			use flipbox\patron\validators\ProviderSettings as ProviderSettingsValidator;
28			use flipbox\patron\validators\ProviderValidator;
29			use yii\helpers\ArrayHelper;
30
31			/**
32			* @author Flipbox Factory <[email protected]>
33			* @since 1.0.0
34			*
35			* @property string $clientId
36			* @property string $clientSecret
37			* @property string $class
38			* @property ProviderLock[] $locks
39			* @property Token[] $tokens
40			* @property SettingsInterface $settings
41			*/
42			class Provider extends ActiveRecordWithId
43			{
44			use HandleRulesTrait,
45			StateAttributeTrait;
46
47			/**
48			* The table alias
49			*/
50			const TABLE_ALIAS = 'patron_providers';
51
52			const CLIENT_ID_LENGTH = 100;
53			const CLIENT_SECRET_LENGTH = 255;
54
55			protected $getterPriorityAttributes = ['settings'];
56
57			/**
58			* @inheritdoc
59			* @return ProviderActiveQuery
60			* @throws \yii\base\InvalidConfigException
61			*/
62			public static function find()
63			{
64			/** @noinspection PhpIncompatibleReturnTypeInspection */
65			return Craft::createObject(ProviderActiveQuery::class, [get_called_class()]);
66			}
67
68			/**
69			* @inheritdoc
70			*/
71			protected static function findByCondition($condition)
72			{
73			if (!is_numeric($condition) && is_string($condition)) {
74			$condition = ['handle' => $condition];
75			}
76
77			/** @noinspection PhpInternalEntityUsedInspection */
78			return parent::findByCondition($condition);
79			}
80
81			/**
82			* @return string\|null
83			*/
84			public function getIcon()
85			{
86			if ($this->class === null) {
87			return null;
88			}
89
90			$icons = Patron::getInstance()->getCp()->getProviderIcons();
91
92			return $icons[$this->class] ?? null;
93			}
94
95			/**
96			* @return SettingsInterface
97			* @throws \yii\base\InvalidConfigException
98			*/
99			public function getSettings(): SettingsInterface
100			{
101			$settings = $this->getAttribute('settings');
102			if (!$settings instanceof SettingsInterface) {
103			$settings = Patron::getInstance()->providerSettings(
104			$this->class,
105			$this->getAttribute('settings')
106			);
107
108			$this->setAttribute('settings', $settings);
109			}
110
111			return $settings;
112			}
113
114
115			/**
116			* @param $record
117			* @param $row
118			*/
119			public static function populateRecord($record, $row)
120			{
121			// Apply override settings
122			if (null !== ($handle = $row['handle'] ?? null)) {
123			$row = array_merge(
124			$row,
125			Patron::getInstance()->getSettings()->getProvider($handle)
126			);
127			}
128
129			parent::populateRecord($record, $row);
130			}
131
132			/**
133			* @inheritdoc
134			*/
135			public function rules()
136			{
137			return array_merge(
138			parent::rules(),
139			$this->handleRules(),
140			$this->stateRules(),
141			[
142			[
143			[
144			'clientId'
145			],
146			'string',
147			'max' => static::CLIENT_ID_LENGTH
148			],
149			[
150			[
151			'clientSecret'
152			],
153			'string',
154			'max' => static::CLIENT_SECRET_LENGTH
155			],
156			[
157			[
158			'class'
159			],
160			ProviderValidator::class
161			],
162			[
163			[
164			'settings'
165			],
166			ProviderSettingsValidator::class
167			],
168			[
169			[
170			'class',
171			'clientId'
172			],
173			'required'
174			],
175			[
176			[
177			'class',
178			'clientId',
179			'clientSecret',
180			'settings',
181			],
182			'safe',
183			'on' => [
184			self::SCENARIO_DEFAULT
185			]
186			]
187			]
188			);
189			}
190
191
192			/*******************************************
193			* RELATIONS
194			*******************************************/
195
196			/**
197			* Get all of the associated tokens.
198			*
199			* @param array $config
200			* @return \yii\db\ActiveQuery
201			*/
202			public function getTokens(array $config = [])
203			{
204			$query = $this->hasMany(
205			Token::class,
206			['providerId' => 'id']
207			);
208
209			if (!empty($config)) {
210			QueryHelper::configure(
211			$query,
212			$config
213			);
214			}
215
216			return $query;
217			}
218
219			/**
220			* Get all of the associated tokens.
221			*
222			* @param array $config
223			* @return \yii\db\ActiveQuery
224			*/
225			public function getLocks(array $config = [])
226			{
227			$query = $this->hasMany(
228			ProviderLock::class,
229			['providerId' => 'id']
230			);
231
232			if (!empty($config)) {
233			QueryHelper::configure(
234			$query,
235			$config
236			);
237			}
238
239			return $query;
240			}
241
242			/*******************************************
243			* SAVE
244			*******************************************/
245
246			/**
247			* @param PluginInterface $plugin
248			* @param bool $runValidation
249			* @param null $attributeNames
250			* @return bool
251			*/
252			public function saveAndLock(PluginInterface $plugin, $runValidation = true, $attributeNames = null): bool
253			{
254			if (!$this->save($runValidation, $attributeNames)) {
255			return false;
256			}
257
258			return $this->addLock($plugin);
259			}
260
261
262			/*******************************************
263			* LOCK
264			*******************************************/
265
266			/**
267			* @param PluginInterface $plugin
268			* @return bool
269			*/
270			public function addLock(PluginInterface $plugin): bool
271			{
272			if (null === ($pluginId = $this->getPluginId($plugin))) {
273			return false;
274			}
275
276			$record = ProviderLock::findOne([
277			'providerId' => $this->getId(),
278			'pluginId' => $pluginId
279			]);
280
281			if (!empty($record)) {
282			return true;
283			}
284
285			$record = new ProviderLock();
286
287			$record->setAttributes([
288			'providerId' => $this->getId(),
289			'pluginId' => $pluginId
290			]);
291
292			return (bool)$record->save();
293			}
294
295			/**
296			* @param PluginInterface $plugin
297			* @return bool
298			* @throws \Throwable
299			*/
300			public function removeLock(PluginInterface $plugin): bool
301			{
302			if (null === ($pluginId = $this->getPluginId($plugin))) {
303			return false;
304			}
305
306			if (null === ($record = ProviderLock::findOne([
307			'providerId' => $this->getId() ?: 0,
308			'pluginId' => $pluginId
309			]))) {
310			return true;
311			}
312
313			return (bool)$record->delete();
314			}
315
316			/**
317			* @return bool
318			*/
319			public function isLocked(): bool
320			{
321			return !empty($this->locks);
322			}
323
324			/**
325			* @param PluginInterface $plugin
326			* @return int\|null
327			*/
328			protected function getPluginId(PluginInterface $plugin)
329			{
330			$id = (new Query())
331			->select([
332			'id',
333			])
334			->from(['{{%plugins}}'])
335			->where([
336			'handle' => $plugin->getHandle()
337			])
338			->scalar();
339
340			return $id ? (int)$id : null;
341			}
342
343			/**
344			* @param PluginInterface $plugin
345			* @return int\|null
346			*/
347			protected function getPluginName(PluginInterface $plugin)
348			{
349			$id = (new Query())
350			->select([
351			'id',
352			])
353			->from(['{{%plugins}}'])
354			->where([
355			'handle' => $plugin->getHandle()
356			])
357			->scalar();
358
359			return $id ? (int)$id : null;
360			}
361
362
363			/*******************************************
364			* DELETE
365			*******************************************/
366
367			/**
368			* @param PluginInterface\|null $plugin
369			* @return bool\|false\|int
370			* @throws \Throwable
371			* @throws \yii\db\StaleObjectException
372			*/
373			public function delete(PluginInterface $plugin = null)
374			{
375			return $this->canDelete($plugin) ? parent::delete() : false;
376			}
377
378			/**
379			* @param PluginInterface\|null $plugin
380			* @return bool
381			* @throws \craft\errors\InvalidPluginException
382			*/
383			protected function canDelete(PluginInterface $plugin = null)
384			{
385			// If a plugin is locking this, prevent deletion
386			$lockQuery = $this->getLocks();
387			if (null !== $plugin) {
388			$lockQuery->andWhere(
389			['<>', 'pluginId', $this->getPluginId($plugin)]
390			);
391			}
392
393			$locks = $lockQuery->all();
394
395			if (count($locks) > 0) {
396			$handles = (new Query())
397			->select([
398			'handle',
399			])
400			->from(['{{%plugins}}'])
401			->where([
402			'id' => ArrayHelper::getColumn($locks, 'pluginId'),
403			])
404			->column();
405
406			$names = [];
407			foreach ($handles as $handle) {
408			$plugin = Craft::$app->getPlugins()->getPluginInfo($handle);
409			$names[] = $plugin['name'] ?? 'Unknown Plugin';
410			}
411
412			$this->addError(
413			'locks',
414			Craft::t(
415			'patron',
416			'The provider is locked by the following plugins: {plugins}',
417			[
418			'plugins' => StringHelper::toString($names, ', ')
419			]
420			)
421			);
422			return false;
423			}
424
425			return true;
426			}
427
428			/**
429			* @return string
430			* @throws \ReflectionException
431			*/
432			public function getDisplayName(): string
433			{
434			if (empty($this->class)) {
435			return 'Unknown';
436			}
437
438			return ProviderHelper::displayName(
439			$this->class
440			);
441			}
442
443
444			/*******************************************
445			* PROJECT CONFIG
446			*******************************************/
447
448			/**
449			* Return an array suitable for Craft's Project config
450			*/
451			public function toProjectConfig(): array
452			{
453			return $this->toArray([
454			'handle',
455			'clientId',
456			'clientSecret',
457			'class',
458			'scopes',
459			'enabled'
460			]);
461			}
462			}
463

flipboxfactory / patron

Push — develop ( 55c38a...c1b735 )

Provider::rules() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like