nystudio107 / craft-autocomplete

src/Autocomplete.php

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

The tag in position 1 should be the @copyright tag

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

@copyright tag must contain a year and the name of the copyright holder

 * @copyright Copyright (c) PutYourLightsOn

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

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

Content of the @author tag must be in the form "Display Name <username@example.com>"

The tag in position 1 should be the @package tag

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Autocomplete

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

The tag in position 3 should be the @author tag

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

Missing @link tag in class comment

Missing @license tag in class comment

Missing @category tag in class comment

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

    public const ID = 'craft-autocomplete';

    /**

Missing short description in doc comment

     * @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;
     *     }
     * );
     * ```
     */
    public const EVENT_REGISTER_AUTOCOMPLETE_GENERATORS = 'registerAutocompleteGenerators';

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

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

    private $allAutocompleteGenerators;

Private member variable "allAutocompleteGenerators" must be prefixed with an underscore

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

    /**

Missing short description in doc comment

Parameter $id should have a doc-comment as per coding-style.

Parameter $parent should have a doc-comment as per coding-style.

Parameter $config should have a doc-comment as per coding-style.

     * @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

Missing parameter comment

     */

Missing @return tag in function comment

    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
     */

Missing @return tag in function comment

    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(CraftWebApp::class, CraftWebApp::EVENT_INIT, [$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
     */

Missing @return tag in function comment

    public function generateAutocompleteClasses()
    {
        if (Craft::$app->getIsInstalled()) {
            $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
     */

Missing @return tag in function comment

    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
     */

Missing @return tag in function comment

    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) {

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.

            return $this->allAutocompleteGenerators;
        }

        $event = new RegisterComponentTypesEvent([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'types' => self::DEFAULT_AUTOCOMPLETE_GENERATORS,
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $this->trigger(self::EVENT_REGISTER_AUTOCOMPLETE_GENERATORS, $event);
        $this->allAutocompleteGenerators = $event->types;

The property allAutocompleteGenerators is declared read-only in nystudio107\autocomplete\Autocomplete.

        return $this->allAutocompleteGenerators;
    }
}