Autocomplete::generateAutocompleteClasses() - Code Metrics - Inspection of "refactor: Add `allow-plugins` so CI can work" - nystudio107/craft-autocomplete - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 91aa12...b99bc4 )

by Andrew

created 2022-07-23 14:26 UTC

Autocomplete::generateAutocompleteClasses() A

↳ Parent: Autocomplete

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	0
dl	0
loc	8
rs	10
c	0
b	0
f	0

<?php
/**
 * Autocomplete plugin for Craft CMS 3.x
 *
 * Provides Twig template IDE autocomplete of Craft CMS & plugin variables
 *
 * @link      https://nystudio107.com

 * @link      https://putyourlightson.com
 * @copyright Copyright (c) 2021 nystudio107

 * @copyright Copyright (c) 2021 PutYourLightsOn

 */


namespace nystudio107\autocomplete;

use Craft;
use craft\console\Application as CraftConsoleApp;
use craft\events\RegisterComponentTypesEvent;
use craft\services\Globals;
use craft\services\Plugins;
use craft\web\Application as CraftWebApp;
use nystudio107\autocomplete\base\Generator;
use nystudio107\autocomplete\console\controllers\AutocompleteController;
use nystudio107\autocomplete\generators\AutocompleteTwigExtensionGenerator;
use nystudio107\autocomplete\generators\AutocompleteVariableGenerator;
use yii\base\Application as YiiApp;
use yii\base\BootstrapInterface;
use yii\base\Event;
use yii\base\Module;

/**
 * Class Autocomplete
 *
 * @author    nystudio107

 * @package   Autocomplete

 * @since     1.0.0

 *
 * @property-read string[] $allAutocompleteGenerators
 */

class Autocomplete extends Module implements BootstrapInterface
{
    // Constants
    // =========================================================================

    const ID = 'craft-autocomplete';

    /**

     * @event RegisterComponentTypesEvent The event that is triggered when registering
     *        Autocomplete Generator types
     *
     * Autocomplete Generator types must implement [[GeneratorInterface]]. [[Generator]]
     * provides a base implementation.
     *
     * ```php
     * use nystudio107\autocomplete\Autocomplete;
     * use craft\events\RegisterComponentTypesEvent;
     * use yii\base\Event;
     *
     * Event::on(Autocomplete::class,
     *     Autocomplete::EVENT_REGISTER_AUTOCOMPLETE_GENERATORS,
     *     function(RegisterComponentTypesEvent $event) {
     *         $event->types[] = MyAutocompleteGenerator::class;
     *     }
     * );
     * ```
     */
    const EVENT_REGISTER_AUTOCOMPLETE_GENERATORS = 'registerAutocompleteGenerators';

    const DEFAULT_AUTOCOMPLETE_GENERATORS = [
        AutocompleteVariableGenerator::class,
        AutocompleteTwigExtensionGenerator::class,
    ];

    // Private Properties
    // =========================================================================

    private $allAutocompleteGenerators;


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

    /**

     * @inerhitdoc
     */
    public function __construct($id = self::ID, $parent = null, $config = [])
    {
        /**
         * Explicitly set the $id parameter, as earlier versions of Yii2 look for a
         * default parameter, and depend on $id being explicitly set:
         * https://github.com/yiisoft/yii2/blob/f3d1534125c9c3dfe8fa65c28a4be5baa822e721/framework/di/Container.php#L436-L448
         */
        parent::__construct($id, $parent, $config);
    }

    /**
     * Bootstraps the extension
     *
     * @param YiiApp $app

     */

    public function bootstrap($app)
    {
        // Set the currently requested instance of this module class,
        // so we can later access it with `Autocomplete::getInstance()`
        static::setInstance($this);

        // Make sure it's Craft
        if (!($app instanceof CraftWebApp || $app instanceof CraftConsoleApp)) {
            return;
        }
        // Make sure we're in devMode
        if (!Craft::$app->config->general->devMode) {
            return;
        }

        // Register our event handlers
        $this->registerEventHandlers();

        // Add our console controller
        if (Craft::$app->request->isConsoleRequest) {
            Craft::$app->controllerMap['autocomplete'] = AutocompleteController::class;
        }
    }

    /**
     * Registers our event handlers
     */

    public function registerEventHandlers()
    {
        Event::on(Plugins::class, Plugins::EVENT_AFTER_INSTALL_PLUGIN, [$this, 'regenerateAutocompleteClasses']);
        Event::on(Plugins::class, Plugins::EVENT_AFTER_UNINSTALL_PLUGIN, [$this, 'deleteAutocompleteClasses']);
        Event::on(Globals::class, Globals::EVENT_AFTER_SAVE_GLOBAL_SET, [$this, 'deleteAutocompleteClasses']);
        Event::on(Plugins::class, Plugins::EVENT_AFTER_LOAD_PLUGINS, [$this, 'generateAutocompleteClasses']);
        Craft::info('Event Handlers installed', __METHOD__);
    }

    /**
     * Call each of the autocomplete generator classes to tell them to generate their classes if they don't exist already
     */

    public function generateAutocompleteClasses()
    {
        $autocompleteGenerators = $this->getAllAutocompleteGenerators();
        foreach ($autocompleteGenerators as $generatorClass) {
            /* @var Generator $generatorClass */
            $generatorClass::generate();
        }
        Craft::info('Autocomplete classes generated', __METHOD__);
    }

    /**
     * Call each of the autocomplete generator classes to tell them to regenerate their classes from scratch
     */

    public function regenerateAutocompleteClasses()
    {
        $autocompleteGenerators = $this->getAllAutocompleteGenerators();
        foreach ($autocompleteGenerators as $generatorClass) {
            /* @var Generator $generatorClass */
            $generatorClass::regenerate();
        }
        Craft::info('Autocomplete classes regenerated', __METHOD__);
    }

    /**
     * Call each of the autocomplete generator classes to tell them to delete their classes
     */

    public function deleteAutocompleteClasses()
    {
        $autocompleteGenerators = $this->getAllAutocompleteGenerators();
        foreach ($autocompleteGenerators as $generatorClass) {
            /* @var Generator $generatorClass */
            $generatorClass::delete();
        }
        Craft::info('Autocomplete classes deleted', __METHOD__);
    }

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

    /**
     * Returns all available autocomplete generator classes.
     *
     * @return string[] The available autocomplete generator classes
     */
    public function getAllAutocompleteGenerators(): array
    {
        if ($this->allAutocompleteGenerators) {

            return $this->allAutocompleteGenerators;
        }

        $event = new RegisterComponentTypesEvent([

            'types' => self::DEFAULT_AUTOCOMPLETE_GENERATORS
        ]);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
        $this->trigger(self::EVENT_REGISTER_AUTOCOMPLETE_GENERATORS, $event);
        $this->allAutocompleteGenerators = $event->types;


        return $this->allAutocompleteGenerators;
    }
}


1			<?php
2			/**
3			* Autocomplete plugin for Craft CMS 3.x
4			*
5			* Provides Twig template IDE autocomplete of Craft CMS & plugin variables
6			*
7			* @link https://nystudio107.com
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @copyright tag Loading history...
8			* @link https://putyourlightson.com
9			* @copyright Copyright (c) 2021 nystudio107
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
10			* @copyright Copyright (c) 2021 PutYourLightsOn
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
11			*/
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history...
12
13			namespace nystudio107\autocomplete;
14
15			use Craft;
16			use craft\console\Application as CraftConsoleApp;
17			use craft\events\RegisterComponentTypesEvent;
18			use craft\services\Globals;
19			use craft\services\Plugins;
20			use craft\web\Application as CraftWebApp;
21			use nystudio107\autocomplete\base\Generator;
22			use nystudio107\autocomplete\console\controllers\AutocompleteController;
23			use nystudio107\autocomplete\generators\AutocompleteTwigExtensionGenerator;
24			use nystudio107\autocomplete\generators\AutocompleteVariableGenerator;
25			use yii\base\Application as YiiApp;
26			use yii\base\BootstrapInterface;
27			use yii\base\Event;
28			use yii\base\Module;
29
30			/**
31			* Class Autocomplete
32			*
33			* @author nystudio107
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 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 2021-08-07 15:51 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @package tag Loading history... Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Tag value for @author tag indented incorrectly; expected 2 spaces but found 4 Loading history...
34			* @package Autocomplete
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Tag value for @package tag indented incorrectly; expected 1 spaces but found 3 Loading history...
35			* @since 1.0.0
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Tag value for @since tag indented incorrectly; expected 3 spaces but found 5 Loading history... Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report The tag in position 3 should be the @author tag Loading history...
36			*
37			* @property-read string[] $allAutocompleteGenerators
38			*/
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history... Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history...
39			class Autocomplete extends Module implements BootstrapInterface
40			{
41			// Constants
42			// =========================================================================
43
44			const ID = 'craft-autocomplete';
45
46			/**
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
47			* @event RegisterComponentTypesEvent The event that is triggered when registering
48			* Autocomplete Generator types
49			*
50			* Autocomplete Generator types must implement [[GeneratorInterface]]. [[Generator]]
51			* provides a base implementation.
52			*
53			* ```php
54			* use nystudio107\autocomplete\Autocomplete;
55			* use craft\events\RegisterComponentTypesEvent;
56			* use yii\base\Event;
57			*
58			* Event::on(Autocomplete::class,
59			* Autocomplete::EVENT_REGISTER_AUTOCOMPLETE_GENERATORS,
60			* function(RegisterComponentTypesEvent $event) {
61			* $event->types[] = MyAutocompleteGenerator::class;
62			* }
63			* );
64			* ```
65			*/
66			const EVENT_REGISTER_AUTOCOMPLETE_GENERATORS = 'registerAutocompleteGenerators';
67
68			const DEFAULT_AUTOCOMPLETE_GENERATORS = [
69			AutocompleteVariableGenerator::class,
70			AutocompleteTwigExtensionGenerator::class,
71			];
72
73			// Private Properties
74			// =========================================================================
75
76			private $allAutocompleteGenerators;
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Private member variable "allAutocompleteGenerators" must be prefixed with an underscore Loading history...
77
78			// Public Methods
79			// =========================================================================
80
81			/**
			0 ignored issues – show Coding Style introduced 2022-07-23 14:34 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2022-07-23 14:34 UTC by Report Bug Copy Issue Report Parameter `$id` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2022-07-23 14:34 UTC by Report Bug Copy Issue Report Parameter `$parent` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2022-07-23 14:34 UTC by Report Bug Copy Issue Report Parameter `$config` should have a doc-comment as per coding-style. Loading history...
82			* @inerhitdoc
83			*/
84			public function __construct($id = self::ID, $parent = null, $config = [])
85			{
86			/**
87			* Explicitly set the $id parameter, as earlier versions of Yii2 look for a
88			* default parameter, and depend on $id being explicitly set:
89			* https://github.com/yiisoft/yii2/blob/f3d1534125c9c3dfe8fa65c28a4be5baa822e721/framework/di/Container.php#L436-L448
90			*/
91			parent::__construct($id, $parent, $config);
92			}
93
94			/**
95			* Bootstraps the extension
96			*
97			* @param YiiApp $app
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
98			*/
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
99			public function bootstrap($app)
100			{
101			// Set the currently requested instance of this module class,
102			// so we can later access it with `Autocomplete::getInstance()`
103			static::setInstance($this);
104
105			// Make sure it's Craft
106			if (!($app instanceof CraftWebApp \|\| $app instanceof CraftConsoleApp)) {
107			return;
108			}
109			// Make sure we're in devMode
110			if (!Craft::$app->config->general->devMode) {
111			return;
112			}
113
114			// Register our event handlers
115			$this->registerEventHandlers();
116
117			// Add our console controller
118			if (Craft::$app->request->isConsoleRequest) {
119			Craft::$app->controllerMap['autocomplete'] = AutocompleteController::class;
120			}
121			}
122
123			/**
124			* Registers our event handlers
125			*/
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
126			public function registerEventHandlers()
127			{
128			Event::on(Plugins::class, Plugins::EVENT_AFTER_INSTALL_PLUGIN, [$this, 'regenerateAutocompleteClasses']);
129			Event::on(Plugins::class, Plugins::EVENT_AFTER_UNINSTALL_PLUGIN, [$this, 'deleteAutocompleteClasses']);
130			Event::on(Globals::class, Globals::EVENT_AFTER_SAVE_GLOBAL_SET, [$this, 'deleteAutocompleteClasses']);
131			Event::on(Plugins::class, Plugins::EVENT_AFTER_LOAD_PLUGINS, [$this, 'generateAutocompleteClasses']);
132			Craft::info('Event Handlers installed', __METHOD__);
133			}
134
135			/**
136			* Call each of the autocomplete generator classes to tell them to generate their classes if they don't exist already
137			*/
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
138			public function generateAutocompleteClasses()
139			{
140			$autocompleteGenerators = $this->getAllAutocompleteGenerators();
141			foreach ($autocompleteGenerators as $generatorClass) {
142			/* @var Generator $generatorClass */
143			$generatorClass::generate();
144			}
145			Craft::info('Autocomplete classes generated', __METHOD__);
146			}
147
148			/**
149			* Call each of the autocomplete generator classes to tell them to regenerate their classes from scratch
150			*/
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
151			public function regenerateAutocompleteClasses()
152			{
153			$autocompleteGenerators = $this->getAllAutocompleteGenerators();
154			foreach ($autocompleteGenerators as $generatorClass) {
155			/* @var Generator $generatorClass */
156			$generatorClass::regenerate();
157			}
158			Craft::info('Autocomplete classes regenerated', __METHOD__);
159			}
160
161			/**
162			* Call each of the autocomplete generator classes to tell them to delete their classes
163			*/
			0 ignored issues – show Coding Style introduced 2021-09-22 21:57 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
164			public function deleteAutocompleteClasses()
165			{
166			$autocompleteGenerators = $this->getAllAutocompleteGenerators();
167			foreach ($autocompleteGenerators as $generatorClass) {
168			/* @var Generator $generatorClass */
169			$generatorClass::delete();
170			}
171			Craft::info('Autocomplete classes deleted', __METHOD__);
172			}
173
174			// Protected Methods
175			// =========================================================================
176
177			/**
178			* Returns all available autocomplete generator classes.
179			*
180			* @return string[] The available autocomplete generator classes
181			*/
182			public function getAllAutocompleteGenerators(): array
183			{
184			if ($this->allAutocompleteGenerators) {
			0 ignored issues – show Bug Best Practice introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report The expression `$this->allAutocompleteGenerators` of type `string[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
185			return $this->allAutocompleteGenerators;
186			}
187
188			$event = new RegisterComponentTypesEvent([
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 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...
189			'types' => self::DEFAULT_AUTOCOMPLETE_GENERATORS
190			]);
			0 ignored issues – show Coding Style introduced 2021-08-07 15:51 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...
191			$this->trigger(self::EVENT_REGISTER_AUTOCOMPLETE_GENERATORS, $event);
192			$this->allAutocompleteGenerators = $event->types;
			0 ignored issues – show Bug introduced 2021-08-07 15:51 UTC by Report Bug Copy Issue Report The property `allAutocompleteGenerators` is declared read-only in `nystudio107\autocomplete\Autocomplete`. Loading history...
193
194			return $this->allAutocompleteGenerators;
195			}
196			}
197

nystudio107 / craft-autocomplete

Push — develop ( 91aa12...b99bc4 )

Autocomplete::generateAutocompleteClasses() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like