Patron::getCpNavItem() - Code Metrics - Inspection of "Allow additional provider information" - flipboxfactory/patron - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( c340f4...8cafaa )

by Nate

created 2019-05-02 19:31 UTC

Patron::getCpNavItem() A

↳ Parent: Patron

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	18
ccs	0
cts	4
cp	0
rs	9.6666
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;

use Craft;
use craft\base\Plugin;
use craft\events\RegisterUrlRulesEvent;
use craft\helpers\ArrayHelper;
use craft\helpers\Json;
use craft\helpers\UrlHelper;
use craft\services\ProjectConfig;
use craft\web\twig\variables\CraftVariable;
use craft\web\UrlManager;
use flipbox\craft\ember\helpers\ObjectHelper;
use flipbox\craft\ember\helpers\QueryHelper;
use flipbox\craft\ember\modules\LoggerTrait;
use flipbox\patron\events\handlers\ProjectConfigHandler;
use flipbox\patron\events\RegisterProviderSettings;
use flipbox\patron\models\Settings as SettingsModel;
use flipbox\patron\queries\ProviderQuery;
use flipbox\patron\queries\TokenQuery;
use flipbox\patron\records\Provider;
use flipbox\patron\records\Token;
use flipbox\patron\settings\BaseSettings;
use flipbox\patron\settings\SettingsInterface;
use yii\base\Event;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 *
 * @method SettingsModel getSettings()
 *
 * @property services\Session $session
 */
class Patron extends Plugin
{
    use LoggerTrait;

    /**
     * @var string
     */
    public static $category = 'patron';

    /**
     * The before persist token event name
     */
    const EVENT_BEFORE_PERSIST_TOKEN = 'beforePersistToken';

    /**
     *  The after persist token event name
     */
    const EVENT_AFTER_PERSIST_TOKEN = 'afterPersistToken';

    /**
     * @return string
     */
    protected static function getLogFileName(): string
    {
        return 'patron';
    }

    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();

        // Components
        $this->setComponents([
            'session' => services\Session::class
        ]);

        // Modules
        $this->setModules([
            'cp' => cp\Cp::class
        ]);


        // Project config
        $this->registerProjectConfigEvents();


        // Template variables
        Event::on(
            CraftVariable::class,
            CraftVariable::EVENT_INIT,
            function (Event $event) {
                /** @var CraftVariable $variable */
                $variable = $event->sender;
                $variable->set('patron', self::getInstance());
            }
        );

        // CP routes
        Event::on(
            UrlManager::class,
            UrlManager::EVENT_REGISTER_CP_URL_RULES,
            [self::class, 'onRegisterCpUrlRules']
        );

        // Register our site routes
        Event::on(
            UrlManager::class,
            UrlManager::EVENT_REGISTER_SITE_URL_RULES,
            function (RegisterUrlRulesEvent $event) {
                if ($callbackUrlRule = $this->getSettings()->getCallbackUrlRule()) {
                    $event->rules = array_merge(
                        $event->rules,
                        $callbackUrlRule
                    );
                }
            }
        );
    }

    /**
     * Register project config events, if we're able to
     */
    protected function registerProjectConfigEvents()
    {
        if (!version_compare(Craft::$app->getVersion(), '3.1', '>=')) {
            return;
        }

        // Project Config
        Craft::$app->projectConfig
            ->onAdd(
                'patronProviders.{uid}',
                [
                    ProjectConfigHandler::class,
                    'handleChangedProvider'
                ]
            )
            ->onUpdate(
                'patronProviders.{uid}',
                [ProjectConfigHandler::class,
                    'handleChangedProvider'
                ]
            )
            ->onRemove(
                'patronProviders.{uid}',
                [ProjectConfigHandler::class,
                    'handleDeletedProvider'
                ]
            )
            ->onAdd(
                'patronTokens.{uid}',
                [ProjectConfigHandler::class,
                    'handleChangedToken'
                ]
            )
            ->onUpdate(
                'patronTokens.{uid}',
                [ProjectConfigHandler::class,
                    'handleChangedToken'
                ]
            )
            ->onRemove(
                'patronTokens.{uid}',
                [ProjectConfigHandler::class,
                    'handleDeletedToken'
                ]
            );

        Event::on(
            ProjectConfig::class,
            ProjectConfig::EVENT_REBUILD,
            [
                events\handlers\ProjectConfigHandler::class,
                'rebuild'
            ]
        );

        Event::on(
            Provider::class,
            Provider::EVENT_AFTER_INSERT,
            [
                events\ManageProviderProjectConfig::class,
                'save'
            ]
        );

        Event::on(
            Provider::class,
            Provider::EVENT_AFTER_UPDATE,
            [
                events\ManageProviderProjectConfig::class,
                'save'
            ]
        );

        Event::on(
            Provider::class,
            Provider::EVENT_AFTER_DELETE,
            [
                events\ManageProviderProjectConfig::class,
                'delete'
            ]
        );

        Event::on(
            Token::class,
            Token::EVENT_AFTER_INSERT,
            [
                events\ManageTokenProjectConfig::class,
                'save'
            ]
        );

        Event::on(
            Token::class,
            Token::EVENT_AFTER_UPDATE,
            [
                events\ManageTokenProjectConfig::class,
                'save'
            ]
        );

        Event::on(
            Token::class,
            Token::EVENT_AFTER_DELETE,
            [
                events\ManageTokenProjectConfig::class,
                'delete'
            ]
        );
    }


    /*******************************************
     * NAV
     *******************************************/

    /**
     * @inheritdoc
     */
    public function getCpNavItem()
    {
        return array_merge(
            parent::getCpNavItem(),
            [
                'subnav' => [
                    'patron.providers' => [
                        'label' => Craft::t('patron', 'Providers'),
                        'url' => 'patron/providers',
                    ],
                    'patron.settings' => [
                        'label' => Craft::t('patron', 'Settings'),
                        'url' => 'patron/settings',
                    ]
                ]
            ]
        );
    }


    /*******************************************
     * SETTINGS
     *******************************************/

    /**
     * @inheritdoc
     * @return SettingsModel
     */
    public function createSettingsModel()
    {
        return new SettingsModel();
    }

    /**
     * @inheritdoc
     * @throws \yii\base\ExitException
     */
    public function getSettingsResponse()
    {
        Craft::$app->getResponse()->redirect(
            UrlHelper::cpUrl('patron/settings')
        );

        Craft::$app->end();
    }

    /*******************************************
     * QUERIES
     *******************************************/

    /**
     * @param array $config
     * @return ProviderQuery
     */
    public function getProviders(array $config = []): ProviderQuery
    {
        $query = new ProviderQuery();

        QueryHelper::configure(
            $query,
            $config
        );

        return $query;
    }

    /**
     * @param array $config
     * @return TokenQuery
     */
    public function getTokens(array $config = []): TokenQuery
    {
        $query = new TokenQuery();

        QueryHelper::configure(
            $query,
            $config
        );

        return $query;
    }


    /*******************************************
     * SERVICES
     *******************************************/

    /**
     * @noinspection PhpDocMissingThrowsInspection
     * @return services\Session
     */
    public function getSession(): services\Session
    {
        /** @noinspection PhpUnhandledExceptionInspection */
        /** @noinspection PhpIncompatibleReturnTypeInspection */
        return $this->get('session');
    }


    /*******************************************
     * MODULES
     *******************************************/

    /**
     * @noinspection PhpDocMissingThrowsInspection
     * @return cp\Cp
     */
    public function getCp(): cp\Cp
    {
        /** @noinspection PhpUnhandledExceptionInspection */
        /** @noinspection PhpIncompatibleReturnTypeInspection */
        return $this->getModule('cp');
    }


    /*******************************************
     * PROVIDER SETTINGS
     *******************************************/

    /**
     * @param string|null $class
     * @param array $settings
     * @return SettingsInterface
     * @throws \yii\base\InvalidConfigException
     */
    public function providerSettings(string $class = null, $settings = []): SettingsInterface
    {
        if (null === $class) {
            return new BaseSettings();
        }

        $event = new RegisterProviderSettings();

        RegisterProviderSettings::trigger(
            $class,
            RegisterProviderSettings::REGISTER_SETTINGS,
            $event
        );

        if (is_string($settings)) {
            $settings = Json::decodeIfJson($settings);
        }

        if (!is_array($settings)) {
            $settings = ArrayHelper::toArray($settings, []);
        }

        $settings['class'] = $event->class;

        /** @noinspection PhpIncompatibleReturnTypeInspection */
        return ObjectHelper::create($settings, SettingsInterface::class);
    }


    /*******************************************
     * EVENTS
     *******************************************/

    /**
     * @param RegisterUrlRulesEvent $event
     */
    public static function onRegisterCpUrlRules(RegisterUrlRulesEvent $event)
    {
        $event->rules = array_merge(
            $event->rules,
            [
                // SETTINGS
                'patron/settings' => 'patron/cp/view/settings/index',

                // BASE
                'patron' =>
                    'patron/cp/view/general/index',

                // PROVIDERS
                'patron/providers' =>
                    'patron/cp/view/providers/default/index',

                'patron/providers/new' =>
                    'patron/cp/view/providers/default/upsert',

                'patron/providers/<identifier:\d+>' =>
                    'patron/cp/view/providers/default/upsert',

                // TOKENS
                'patron/providers/<provider:\d+>/tokens' =>
                    'patron/cp/view/providers/tokens/index',

                'patron/providers/<provider:\d+>/tokens/<identifier:\d+>' =>
                    'patron/cp/view/providers/tokens/upsert',
            ]
        );
    }

    /*******************************************
     * TRANSLATE
     *******************************************/

    /**
     * Translates a message to the specified language.
     *
     * This is a shortcut method of [[\Craft::t()]].
     *     *
     * @param string $message the message to be translated.
     * @param array $params the parameters that will be used to replace the corresponding placeholders in the message.
     * @param string $language the language code (e.g. `en-US`, `en`). If this is null, the current
     * [[\yii\base\Application::language|application language]] will be used.
     * @return string the translated message.
     */
    public static function t($message, $params = [], $language = null)
    {
        return Craft::t(self::$category, $message, $params, $language);
    }
}


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;
10
11		use Craft;
12		use craft\base\Plugin;
13		use craft\events\RegisterUrlRulesEvent;
14		use craft\helpers\ArrayHelper;
15		use craft\helpers\Json;
16		use craft\helpers\UrlHelper;
17		use craft\services\ProjectConfig;
18		use craft\web\twig\variables\CraftVariable;
19		use craft\web\UrlManager;
20		use flipbox\craft\ember\helpers\ObjectHelper;
21		use flipbox\craft\ember\helpers\QueryHelper;
22		use flipbox\craft\ember\modules\LoggerTrait;
23		use flipbox\patron\events\handlers\ProjectConfigHandler;
24		use flipbox\patron\events\RegisterProviderSettings;
25		use flipbox\patron\models\Settings as SettingsModel;
26		use flipbox\patron\queries\ProviderQuery;
27		use flipbox\patron\queries\TokenQuery;
28		use flipbox\patron\records\Provider;
29		use flipbox\patron\records\Token;
30		use flipbox\patron\settings\BaseSettings;
31		use flipbox\patron\settings\SettingsInterface;
32		use yii\base\Event;
33
34		/**
35		* @author Flipbox Factory <[email protected]>
36		* @since 1.0.0
37		*
38		* @method SettingsModel getSettings()
39		*
40		* @property services\Session $session
41		*/
42		class Patron extends Plugin
43		{
44		use LoggerTrait;
45
46		/**
47		* @var string
48		*/
49		public static $category = 'patron';
50
51		/**
52		* The before persist token event name
53		*/
54		const EVENT_BEFORE_PERSIST_TOKEN = 'beforePersistToken';
55
56		/**
57		* The after persist token event name
58		*/
59		const EVENT_AFTER_PERSIST_TOKEN = 'afterPersistToken';
60
61		/**
62		* @return string
63		*/
64		protected static function getLogFileName(): string
65		{
66		return 'patron';
67	3	}
68
69	3	/**
70		* @inheritdoc
71		*/
72	3	public function init()
73	3	{
74		parent::init();
75
76		// Components
77	3	$this->setComponents([
78	3	'session' => services\Session::class
79		]);
80
81		// Modules
82		$this->setModules([
83	3	'cp' => cp\Cp::class
84		]);
85
86
87	3	// Project config
88	3	$this->registerProjectConfigEvents();
89	3
90	1
91		// Template variables
92		Event::on(
93		CraftVariable::class,
94	3	CraftVariable::EVENT_INIT,
95		function (Event $event) {
96		/** @var CraftVariable $variable */
97		$variable = $event->sender;
98	3	$variable->set('patron', self::getInstance());
99	3	}
100	3	);
101	3
102		// CP routes
103		Event::on(
104		UrlManager::class,
105	3	UrlManager::EVENT_REGISTER_CP_URL_RULES,
106	3	[self::class, 'onRegisterCpUrlRules']
107	3	);
108	1
109		// Register our site routes
110		Event::on(
111		UrlManager::class,
112		UrlManager::EVENT_REGISTER_SITE_URL_RULES,
113		function (RegisterUrlRulesEvent $event) {
114		if ($callbackUrlRule = $this->getSettings()->getCallbackUrlRule()) {
115	3	$event->rules = array_merge(
116		$event->rules,
117	3	$callbackUrlRule
118		);
119		}
120		}
121		);
122	3	}
123
124	3	/**
125		* Register project config events, if we're able to
126		*/
127		protected function registerProjectConfigEvents()
128		{
129	3	if (!version_compare(Craft::$app->getVersion(), '3.1', '>=')) {
130	3	return;
131	3	}
132
133	3	// Project Config
134		Craft::$app->projectConfig
135		->onAdd(
136		'patronProviders.{uid}',
137	3	[
138	3	ProjectConfigHandler::class,
139	3	'handleChangedProvider'
140		]
141		)
142		->onUpdate(
143	3	'patronProviders.{uid}',
144	3	[ProjectConfigHandler::class,
145	3	'handleChangedProvider'
146		]
147		)
148		->onRemove(
149	3	'patronProviders.{uid}',
150	3	[ProjectConfigHandler::class,
151	3	'handleDeletedProvider'
152		]
153		)
154		->onAdd(
155	3	'patronTokens.{uid}',
156	3	[ProjectConfigHandler::class,
157	3	'handleChangedToken'
158		]
159		)
160		->onUpdate(
161	3	'patronTokens.{uid}',
162	3	[ProjectConfigHandler::class,
163	3	'handleChangedToken'
164		]
165		)
166		->onRemove(
167		'patronTokens.{uid}',
168	3	[ProjectConfigHandler::class,
169	3	'handleDeletedToken'
170	3	]
171		);
172	3
173		Event::on(
174		ProjectConfig::class,
175		ProjectConfig::EVENT_REBUILD,
176		[
177	3	events\handlers\ProjectConfigHandler::class,
178	3	'rebuild'
179	3	]
180		);
181	3
182		Event::on(
183		Provider::class,
184		Provider::EVENT_AFTER_INSERT,
185		[
186	3	events\ManageProviderProjectConfig::class,
187	3	'save'
188	3	]
189		);
190	3
191		Event::on(
192		Provider::class,
193		Provider::EVENT_AFTER_UPDATE,
194		[
195	3	events\ManageProviderProjectConfig::class,
196	3	'save'
197	3	]
198		);
199	3
200		Event::on(
201		Provider::class,
202		Provider::EVENT_AFTER_DELETE,
203		[
204	3	events\ManageProviderProjectConfig::class,
205	3	'delete'
206	3	]
207		);
208	3
209		Event::on(
210		Token::class,
211		Token::EVENT_AFTER_INSERT,
212		[
213	3	events\ManageTokenProjectConfig::class,
214	3	'save'
215	3	]
216		);
217	3
218		Event::on(
219		Token::class,
220		Token::EVENT_AFTER_UPDATE,
221		[
222	3	events\ManageTokenProjectConfig::class,
223	3	'save'
224	3	]
225		);
226	3
227		Event::on(
228		Token::class,
229		Token::EVENT_AFTER_DELETE,
230	3	[
231		events\ManageTokenProjectConfig::class,
232		'delete'
233		]
234		);
235		}
236
237
238		/*******************************************
239		* NAV
240		*******************************************/
241
242		/**
243		* @inheritdoc
244		*/
245		public function getCpNavItem()
246		{
247		return array_merge(
248		parent::getCpNavItem(),
249		[
250		'subnav' => [
251		'patron.providers' => [
252		'label' => Craft::t('patron', 'Providers'),
253		'url' => 'patron/providers',
254		],
255		'patron.settings' => [
256		'label' => Craft::t('patron', 'Settings'),
257		'url' => 'patron/settings',
258		]
259		]
260		]
261		);
262		}
263
264
265		/*******************************************
266		* SETTINGS
267		*******************************************/
268
269		/**
270		* @inheritdoc
271		* @return SettingsModel
272		*/
273		public function createSettingsModel()
274		{
275		return new SettingsModel();
276		}
277
278		/**
279		* @inheritdoc
280		* @throws \yii\base\ExitException
281		*/
282		public function getSettingsResponse()
283		{
284		Craft::$app->getResponse()->redirect(
285		UrlHelper::cpUrl('patron/settings')
286		);
287
288		Craft::$app->end();
289		}
290
291		/*******************************************
292		* QUERIES
293		*******************************************/
294
295		/**
296		* @param array $config
297		* @return ProviderQuery
298		*/
299		public function getProviders(array $config = []): ProviderQuery
300		{
301		$query = new ProviderQuery();
302
303		QueryHelper::configure(
304		$query,
305		$config
306		);
307
308		return $query;
309		}
310
311		/**
312		* @param array $config
313		* @return TokenQuery
314		*/
315		public function getTokens(array $config = []): TokenQuery
316		{
317		$query = new TokenQuery();
318
319		QueryHelper::configure(
320		$query,
321		$config
322		);
323
324		return $query;
325		}
326
327
328		/*******************************************
329		* SERVICES
330		*******************************************/
331	3
332		/**
333		* @noinspection PhpDocMissingThrowsInspection
334		* @return services\Session
335	3	*/
336		public function getSession(): services\Session
337		{
338		/** @noinspection PhpUnhandledExceptionInspection */
339		/** @noinspection PhpIncompatibleReturnTypeInspection */
340		return $this->get('session');
341		}
342
343
344		/*******************************************
345		* MODULES
346		*******************************************/
347
348		/**
349		* @noinspection PhpDocMissingThrowsInspection
350		* @return cp\Cp
351		*/
352		public function getCp(): cp\Cp
353		{
354		/** @noinspection PhpUnhandledExceptionInspection */
355		/** @noinspection PhpIncompatibleReturnTypeInspection */
356		return $this->getModule('cp');
357		}
358
359
360		/*******************************************
361		* PROVIDER SETTINGS
362		*******************************************/
363
364		/**
365		* @param string\|null $class
366		* @param array $settings
367		* @return SettingsInterface
368		* @throws \yii\base\InvalidConfigException
369		*/
370		public function providerSettings(string $class = null, $settings = []): SettingsInterface
371		{
372		if (null === $class) {
373		return new BaseSettings();
374		}
375
376		$event = new RegisterProviderSettings();
377
378		RegisterProviderSettings::trigger(
379		$class,
380		RegisterProviderSettings::REGISTER_SETTINGS,
381		$event
382		);
383
384		if (is_string($settings)) {
385		$settings = Json::decodeIfJson($settings);
386		}
387
388		if (!is_array($settings)) {
389		$settings = ArrayHelper::toArray($settings, []);
390		}
391
392		$settings['class'] = $event->class;
393
394		/** @noinspection PhpIncompatibleReturnTypeInspection */
395		return ObjectHelper::create($settings, SettingsInterface::class);
396		}
397
398
399		/*******************************************
400		* EVENTS
401		*******************************************/
402
403		/**
404		* @param RegisterUrlRulesEvent $event
405		*/
406		public static function onRegisterCpUrlRules(RegisterUrlRulesEvent $event)
407		{
408		$event->rules = array_merge(
409		$event->rules,
410		[
411		// SETTINGS
412		'patron/settings' => 'patron/cp/view/settings/index',
413
414		// BASE
415		'patron' =>
416		'patron/cp/view/general/index',
417
418		// PROVIDERS
419		'patron/providers' =>
420		'patron/cp/view/providers/default/index',
421
422		'patron/providers/new' =>
423		'patron/cp/view/providers/default/upsert',
424
425		'patron/providers/<identifier:\d+>' =>
426		'patron/cp/view/providers/default/upsert',
427
428		// TOKENS
429		'patron/providers/<provider:\d+>/tokens' =>
430		'patron/cp/view/providers/tokens/index',
431
432		'patron/providers/<provider:\d+>/tokens/<identifier:\d+>' =>
433		'patron/cp/view/providers/tokens/upsert',
434		]
435		);
436		}
437
438		/*******************************************
439		* TRANSLATE
440		*******************************************/
441
442		/**
443		* Translates a message to the specified language.
444		*
445		* This is a shortcut method of [[\Craft::t()]].
446		* *
447		* @param string $message the message to be translated.
448		* @param array $params the parameters that will be used to replace the corresponding placeholders in the message.
449		* @param string $language the language code (e.g. `en-US`, `en`). If this is null, the current
450		* [[\yii\base\Application::language\|application language]] will be used.
451		* @return string the translated message.
452		*/
453		public static function t($message, $params = [], $language = null)
454		{
455		return Craft::t(self::$category, $message, $params, $language);
456		}
457		}
458

flipboxfactory / patron

Push — develop ( c340f4...8cafaa )

Patron::getCpNavItem() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like