RichVariables::installSiteEventListeners() - Code Metrics - nystudio107/craft-richvariables - Measure and Improve Code Quality continuously with Scrutinizer

RichVariables::installSiteEventListeners() A
last analyzed 2022-01-24 20:14 UTC

↳ Parent: RichVariables

Complexity

Conditions	1
Paths	1

Size

Total Lines	15
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	10
c	1
b	0
f	0
dl	0
loc	15
rs	9.9332
cc	1
nc	1
nop	0

<?php
/**
 * Rich Variables plugin for Craft CMS 3.x
 *
 * Allows you to easily use Craft Globals as variables in Rich Text fields
 *
 * @link      https://nystudio107.com

 * @copyright Copyright (c) 2017 nystudio107

 */


namespace nystudio107\richvariables;

use Composer\Semver\Comparator;
use Craft;
use craft\base\Plugin;
use craft\events\PluginEvent;
use craft\events\RegisterUrlRulesEvent;
use craft\helpers\UrlHelper;
use craft\redactor\events\RegisterPluginPathsEvent;
filter:
    dependency_paths: ["lib/*"]
use craft\redactor\Field as RichText;
filter:
    dependency_paths: ["lib/*"]
use craft\services\Plugins;
use craft\web\twig\variables\CraftVariable;
use craft\web\UrlManager;
use Exception;
use nystudio107\pluginvite\services\VitePluginService;
use nystudio107\richvariables\assetbundles\richvariables\RichVariablesAsset;
use nystudio107\richvariables\models\Settings;
use nystudio107\richvariables\variables\RichVariablesVariable;
use Twig\Error\LoaderError;
use yii\base\Event;
use yii\base\InvalidConfigException;

/**
 * Class RichVariables
 *
 * @author    nystudio107

 * @package   RichVariables

 * @since     1.0.0

 *
 * @property VitePluginService $vite
 */

class RichVariables extends Plugin
{
    // Static Properties
    // =========================================================================

    /**

     * @var RichVariables
     */
    public static $plugin;

    // Static Methods
    // =========================================================================
    /**

     * @var string
     */
    public $schemaVersion = '1.0.0';

    // Public Properties
    // =========================================================================
    /**

     * @var bool
     */
    public $hasCpSection = false;
    /**

     * @var bool
     */
    public $hasCpSettings = true;

    /**

     * @inheritdoc
     */
    public function __construct($id, $parent = null, array $config = [])
    {
        $config['components'] = [
            // Register the vite service
            'vite' => [
                'class' => VitePluginService::class,
                'assetClass' => RichVariablesAsset::class,
                'useDevServer' => true,
                'devServerPublic' => 'http://localhost:3001',
                'serverPublic' => 'http://localhost:8000',
                'errorEntry' => 'src/js/app.ts',
                'devServerInternal' => 'http://craft-richvariables-buildchain:3001',
                'checkDevServer' => true,
            ],
        ];

        parent::__construct($id, $parent, $config);
    }


    // Public Methods
    // =========================================================================

    /**

     * @inheritdoc
     */

    public function init()
    {
        parent::init();
        self::$plugin = $this;

        // Add in our event listeners that are needed for every request
        $this->installEventListeners();
        // We're loaded!
        Craft::info(
            Craft::t(
                'rich-variables',
                '{name} plugin loaded',
                ['name' => $this->name]
            ),
            __METHOD__
        );
    }

    // Protected Methods
    // =========================================================================

    /**
     * Install our event listeners
     */

    protected function installEventListeners()
    {
        Event::on(
            CraftVariable::class,
            CraftVariable::EVENT_INIT,
            function (Event $event) {
                /** @var CraftVariable $variable */

                $variable = $event->sender;
                $variable->set('richVariables', [

                    'class' => RichVariablesVariable::class,
                    'viteService' => $this->vite,
                ]);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
            }
        );
        // Handler: Plugins::EVENT_AFTER_INSTALL_PLUGIN
        Event::on(
            Plugins::class,
            Plugins::EVENT_AFTER_INSTALL_PLUGIN,
            function (PluginEvent $event) {
                if ($event->plugin === $this) {
                    $request = Craft::$app->getRequest();
                    if ($request->isCpRequest) {
                        Craft::$app->getResponse()->redirect(UrlHelper::cpUrl('rich-variables/welcome'))->send();
                    }
                }
            }
        );
        $request = Craft::$app->getRequest();
        // Install only for non-console site requests
        if ($request->getIsSiteRequest() && !$request->getIsConsoleRequest()) {
            $this->installSiteEventListeners();
        }
        // Install only for non-console Control Panel requests
        if ($request->getIsCpRequest() && !$request->getIsConsoleRequest()) {
            $this->installCpEventListeners();
        }
    }

    /**
     * Install site event listeners for site requests only
     */

    protected function installSiteEventListeners()
    {
        // Handler: UrlManager::EVENT_REGISTER_SITE_URL_RULES
        Event::on(
            UrlManager::class,
            UrlManager::EVENT_REGISTER_SITE_URL_RULES,
            function (RegisterUrlRulesEvent $event) {
                Craft::debug(
                    'UrlManager::EVENT_REGISTER_SITE_URL_RULES',
                    __METHOD__
                );
                // Register our Control Panel routes
                $event->rules = array_merge(
                    $event->rules,
                    $this->customFrontendRoutes()
                );
            }
        );
    }

    /**
     * Return the custom frontend routes
     *
     * @return array
     */
    protected function customFrontendRoutes(): array
    {
        return [
        ];
    }

    /**
     * Install site event listeners for Control Panel requests only
     */

    protected function installCpEventListeners()
    {
        // Handler: Plugins::EVENT_AFTER_LOAD_PLUGINS
        Event::on(
            Plugins::class,
            Plugins::EVENT_AFTER_LOAD_PLUGINS,
            function () {
                $this->installRedactorPlugin();
            }
        );
    }

    /**
     * Install our Redactor plugin
     */

    protected function installRedactorPlugin()
    {
        // Make sure the Redactor plugin is installed
        $redactor = Craft::$app->getPlugins()->getPlugin('redactor');
        if ($redactor) {
            // Event handler: RichText::EVENT_REGISTER_PLUGIN_PATHS
            Event::on(
                RichText::class,
                RichText::EVENT_REGISTER_PLUGIN_PATHS,
                function (RegisterPluginPathsEvent $event) {
                    /** @var Plugin $redactor */

                    $redactor = Craft::$app->getPlugins()->getPlugin('redactor');
                    $versionDir = 'v1/';
                    if (Comparator::greaterThanOrEqualTo($redactor->version, '2.0.0')) {
                        $versionDir = 'v2/';
                    }
                    // Add the path to our Redactor plugin
                    $src = Craft::getAlias('@nystudio107/richvariables/redactor/plugins/' . $versionDir);
                    $event->paths[] = $src;
                }
            );
            // Register our asset bundle
            try {
                Craft::$app->getView()->registerAssetBundle(RichVariablesAsset::class);
            } catch (InvalidConfigException $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }
    }

    /**

     * @inheritdoc
     */

    protected function createSettingsModel()
    {
        return new Settings();
    }

    /**

     * @inheritdoc
     */

    protected function settingsHtml(): string
    {
        // Get all of the globals sets
        $globalsHandles = [];
        $allGlobalsSets = Craft::$app->getGlobals()->getAllSets();
        foreach ($allGlobalsSets as $globalsSet) {
            $globalsHandles[$globalsSet->handle] = $globalsSet->name;
        }

        // Render our settings template
        try {
            return Craft::$app->view->renderTemplate(
                'rich-variables/settings',
                [
                    'settings' => $this->getSettings(),
                    'globalsSets' => $globalsHandles,
                ]
            );
        } catch (LoaderError $e) {
            Craft::error($e->getMessage(), __METHOD__);
        } catch (Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        return '';
    }
}


1			<?php
2			/**
3			* Rich Variables plugin for Craft CMS 3.x
4			*
5			* Allows you to easily use Craft Globals as variables in Rich Text fields
6			*
7			* @link https://nystudio107.com
			0 ignored issues – show Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @copyright tag Loading history...
8			* @copyright Copyright (c) 2017 nystudio107
			0 ignored issues – show Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
9			*/
			0 ignored issues – show Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history...
10
11			namespace nystudio107\richvariables;
12
13			use Composer\Semver\Comparator;
14			use Craft;
15			use craft\base\Plugin;
16			use craft\events\PluginEvent;
17			use craft\events\RegisterUrlRulesEvent;
18			use craft\helpers\UrlHelper;
19			use craft\redactor\events\RegisterPluginPathsEvent;
			0 ignored issues – show Bug introduced 2018-03-07 13:20 UTC by Report Bug Copy Issue Report The type `craft\redactor\events\RegisterPluginPathsEvent` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
20			use craft\redactor\Field as RichText;
			0 ignored issues – show Bug introduced 2018-03-07 13:20 UTC by Report Bug Copy Issue Report The type `craft\redactor\Field` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
21			use craft\services\Plugins;
22			use craft\web\twig\variables\CraftVariable;
23			use craft\web\UrlManager;
24			use Exception;
25			use nystudio107\pluginvite\services\VitePluginService;
26			use nystudio107\richvariables\assetbundles\richvariables\RichVariablesAsset;
27			use nystudio107\richvariables\models\Settings;
28			use nystudio107\richvariables\variables\RichVariablesVariable;
29			use Twig\Error\LoaderError;
30			use yii\base\Event;
31			use yii\base\InvalidConfigException;
32
33			/**
34			* Class RichVariables
35			*
36			* @author nystudio107
			0 ignored issues – show Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @package tag Loading history... Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history... Coding Style introduced 2019-04-20 03:19 UTC by Report Bug Copy Issue Report Tag value for @author tag indented incorrectly; expected 2 spaces but found 4 Loading history...
37			* @package RichVariables
			0 ignored issues – show Coding Style introduced 2019-04-20 03:19 UTC by Report Bug Copy Issue Report Tag value for @package tag indented incorrectly; expected 1 spaces but found 3 Loading history...
38			* @since 1.0.0
			0 ignored issues – show Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report The tag in position 3 should be the @author tag Loading history... Coding Style introduced 2019-04-20 03:19 UTC by Report Bug Copy Issue Report Tag value for @since tag indented incorrectly; expected 3 spaces but found 5 Loading history...
39			*
40			* @property VitePluginService $vite
41			*/
			0 ignored issues – show Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
42			class RichVariables extends Plugin
43			{
44			// Static Properties
45			// =========================================================================
46
47			/**
			0 ignored issues – show Coding Style introduced 2018-10-04 18:36 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
48			* @var RichVariables
49			*/
50			public static $plugin;
51
52			// Static Methods
53			// =========================================================================
54			/**
			0 ignored issues – show Coding Style introduced 2018-10-04 18:36 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
55			* @var string
56			*/
57			public $schemaVersion = '1.0.0';
58
59			// Public Properties
60			// =========================================================================
61			/**
			0 ignored issues – show Coding Style introduced 2018-10-04 18:36 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
62			* @var bool
63			*/
64			public $hasCpSection = false;
65			/**
			0 ignored issues – show Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
66			* @var bool
67			*/
68			public $hasCpSettings = true;
69
70			/**
			0 ignored issues – show Coding Style introduced 2021-03-28 19:57 UTC by Report Bug Copy Issue Report Parameter `$id` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2021-03-28 19:57 UTC by Report Bug Copy Issue Report Parameter `$config` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2021-03-28 19:57 UTC by Report Bug Copy Issue Report Parameter `$parent` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
71			* @inheritdoc
72			*/
73			public function __construct($id, $parent = null, array $config = [])
74			{
75			$config['components'] = [
76			// Register the vite service
77			'vite' => [
78			'class' => VitePluginService::class,
79			'assetClass' => RichVariablesAsset::class,
80			'useDevServer' => true,
81			'devServerPublic' => 'http://localhost:3001',
82			'serverPublic' => 'http://localhost:8000',
83			'errorEntry' => 'src/js/app.ts',
84			'devServerInternal' => 'http://craft-richvariables-buildchain:3001',
85			'checkDevServer' => true,
86			],
87			];
88
89			parent::__construct($id, $parent, $config);
90			}
91
92
93			// Public Methods
94			// =========================================================================
95
96			/**
			0 ignored issues – show Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
97			* @inheritdoc
98			*/
			0 ignored issues – show Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
99			public function init()
100			{
101			parent::init();
102			self::$plugin = $this;
103
104			// Add in our event listeners that are needed for every request
105			$this->installEventListeners();
106			// We're loaded!
107			Craft::info(
108			Craft::t(
109			'rich-variables',
110			'{name} plugin loaded',
111			['name' => $this->name]
112			),
113			__METHOD__
114			);
115			}
116
117			// Protected Methods
118			// =========================================================================
119
120			/**
121			* Install our event listeners
122			*/
			0 ignored issues – show Coding Style introduced 2018-08-24 00:45 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
123			protected function installEventListeners()
124			{
125			Event::on(
126			CraftVariable::class,
127			CraftVariable::EVENT_INIT,
128			function (Event $event) {
129			/** @var CraftVariable $variable */
			0 ignored issues – show Coding Style introduced 2018-10-04 18:36 UTC by Report Bug Copy Issue Report The open comment tag must be the only content on the line Loading history... Coding Style introduced 2021-03-28 19:57 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2018-10-04 18:36 UTC by Report Bug Copy Issue Report The close comment tag must be the only content on the line Loading history...
130			$variable = $event->sender;
131			$variable->set('richVariables', [
			0 ignored issues – show Coding Style introduced 2021-03-03 03:40 UTC by Report Bug Copy Issue Report The opening parenthesis of a multi-line function call should be the last content on the line. Loading history...
132			'class' => RichVariablesVariable::class,
133			'viteService' => $this->vite,
134			]);
			0 ignored issues – show Coding Style introduced 2021-03-03 03:40 UTC by Report Bug Copy Issue Report For multi-line function calls, the closing parenthesis should be on a new line. If a function call spawns multiple lines, the coding standard suggests to move the closing parenthesis to a new line: someFunctionCall( $firstArgument, $secondArgument, $thirdArgument ); // Closing parenthesis on a new line. Loading history...
135			}
136			);
137			// Handler: Plugins::EVENT_AFTER_INSTALL_PLUGIN
138			Event::on(
139			Plugins::class,
140			Plugins::EVENT_AFTER_INSTALL_PLUGIN,
141			function (PluginEvent $event) {
142			if ($event->plugin === $this) {
143			$request = Craft::$app->getRequest();
144			if ($request->isCpRequest) {
145			Craft::$app->getResponse()->redirect(UrlHelper::cpUrl('rich-variables/welcome'))->send();
146			}
147			}
148			}
149			);
150			$request = Craft::$app->getRequest();
151			// Install only for non-console site requests
152			if ($request->getIsSiteRequest() && !$request->getIsConsoleRequest()) {
153			$this->installSiteEventListeners();
154			}
155			// Install only for non-console Control Panel requests
156			if ($request->getIsCpRequest() && !$request->getIsConsoleRequest()) {
157			$this->installCpEventListeners();
158			}
159			}
160
161			/**
162			* Install site event listeners for site requests only
163			*/
			0 ignored issues – show Coding Style introduced 2018-08-24 00:45 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
164			protected function installSiteEventListeners()
165			{
166			// Handler: UrlManager::EVENT_REGISTER_SITE_URL_RULES
167			Event::on(
168			UrlManager::class,
169			UrlManager::EVENT_REGISTER_SITE_URL_RULES,
170			function (RegisterUrlRulesEvent $event) {
171			Craft::debug(
172			'UrlManager::EVENT_REGISTER_SITE_URL_RULES',
173			__METHOD__
174			);
175			// Register our Control Panel routes
176			$event->rules = array_merge(
177			$event->rules,
178			$this->customFrontendRoutes()
179			);
180			}
181			);
182			}
183
184			/**
185			* Return the custom frontend routes
186			*
187			* @return array
188			*/
189			protected function customFrontendRoutes(): array
190			{
191			return [
192			];
193			}
194
195			/**
196			* Install site event listeners for Control Panel requests only
197			*/
			0 ignored issues – show Coding Style introduced 2018-08-24 00:45 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
198			protected function installCpEventListeners()
199			{
200			// Handler: Plugins::EVENT_AFTER_LOAD_PLUGINS
201			Event::on(
202			Plugins::class,
203			Plugins::EVENT_AFTER_LOAD_PLUGINS,
204			function () {
205			$this->installRedactorPlugin();
206			}
207			);
208			}
209
210			/**
211			* Install our Redactor plugin
212			*/
			0 ignored issues – show Coding Style introduced 2018-08-24 00:45 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
213			protected function installRedactorPlugin()
214			{
215			// Make sure the Redactor plugin is installed
216			$redactor = Craft::$app->getPlugins()->getPlugin('redactor');
217			if ($redactor) {
218			// Event handler: RichText::EVENT_REGISTER_PLUGIN_PATHS
219			Event::on(
220			RichText::class,
221			RichText::EVENT_REGISTER_PLUGIN_PATHS,
222			function (RegisterPluginPathsEvent $event) {
223			/** @var Plugin $redactor */
			0 ignored issues – show Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report The open comment tag must be the only content on the line Loading history... Coding Style introduced 2021-03-28 19:57 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report The close comment tag must be the only content on the line Loading history...
224			$redactor = Craft::$app->getPlugins()->getPlugin('redactor');
225			$versionDir = 'v1/';
226			if (Comparator::greaterThanOrEqualTo($redactor->version, '2.0.0')) {
227			$versionDir = 'v2/';
228			}
229			// Add the path to our Redactor plugin
230			$src = Craft::getAlias('@nystudio107/richvariables/redactor/plugins/' . $versionDir);
231			$event->paths[] = $src;
232			}
233			);
234			// Register our asset bundle
235			try {
236			Craft::$app->getView()->registerAssetBundle(RichVariablesAsset::class);
237			} catch (InvalidConfigException $e) {
238			Craft::error($e->getMessage(), __METHOD__);
239			}
240			}
241			}
242
243			/**
			0 ignored issues – show Coding Style introduced 2021-03-28 19:57 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
244			* @inheritdoc
245			*/
			0 ignored issues – show Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
246			protected function createSettingsModel()
247			{
248			return new Settings();
249			}
250
251			/**
			0 ignored issues – show Coding Style introduced 2021-03-28 19:57 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
252			* @inheritdoc
253			*/
			0 ignored issues – show Coding Style introduced 2018-08-23 22:23 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
254			protected function settingsHtml(): string
255			{
256			// Get all of the globals sets
257			$globalsHandles = [];
258			$allGlobalsSets = Craft::$app->getGlobals()->getAllSets();
259			foreach ($allGlobalsSets as $globalsSet) {
260			$globalsHandles[$globalsSet->handle] = $globalsSet->name;
261			}
262
263			// Render our settings template
264			try {
265			return Craft::$app->view->renderTemplate(
266			'rich-variables/settings',
267			[
268			'settings' => $this->getSettings(),
269			'globalsSets' => $globalsHandles,
270			]
271			);
272			} catch (LoaderError $e) {
273			Craft::error($e->getMessage(), __METHOD__);
274			} catch (Exception $e) {
275			Craft::error($e->getMessage(), __METHOD__);
276			}
277
278			return '';
279			}
280			}
281

nystudio107 / craft-richvariables

RichVariables::installSiteEventListeners() A last analyzed 2022-01-24 20:14 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

RichVariables::installSiteEventListeners() A
last analyzed 2022-01-24 20:14 UTC