nystudio107 / craft-autocomplete

src/generators/AutocompleteTwigExtensionGenerator.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\generators;

use Craft;
use craft\base\Element;
use craft\web\twig\GlobalsExtension;
use nystudio107\autocomplete\base\Generator;
use nystudio107\autocomplete\events\DefineGeneratorValuesEvent;
use yii\base\Event;

/**

Missing short description in doc comment

 * @author    nystudio107

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

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

 * @package   autocomplete

Package name "autocomplete" is not valid; consider "Autocomplete" instead

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

 */

Missing @link tag in class comment

Missing @license tag in class comment

Missing @category tag in class comment

class AutocompleteTwigExtensionGenerator extends Generator
{
    // Constants
    // =========================================================================

    public const ELEMENT_ROUTE_EXCLUDES = [
        'matrixblock',
        'globalset',
    ];

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

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public static function getGeneratorName(): string
    {
        return 'AutocompleteTwigExtension';
    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public static function generate()
    {
        if (self::shouldRegenerateFile()) {
            static::generateInternal();
        }
    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public static function regenerate()
    {
        self::generateInternal();
    }

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

    /**
     * Core function that generates the autocomplete class
     */

Missing @return tag in function comment

    protected static function generateInternal()
    {
        $values = [];
        // Iterate through the globals in the Twig context
        /* @noinspection PhpInternalEntityUsedInspection */
        $globals = Craft::$app->view->getTwig()->getGlobals();
        foreach ($globals as $key => $value) {
            $type = gettype($value);
            switch ($type) {
                case 'object':

Line indented incorrectly; expected 12 spaces, found 16

                    $values[$key] = 'new \\' . get_class($value) . '()';
                    break;

                case 'boolean':

Line indented incorrectly; expected 12 spaces, found 16

                    $values[$key] = $value ? 'true' : 'false';
                    break;

                case 'integer':

Line indented incorrectly; expected 12 spaces, found 16

                case 'double':

Line indented incorrectly; expected 12 spaces, found 16

                    $values[$key] = $value;
                    break;

                case 'string':

Line indented incorrectly; expected 12 spaces, found 16

                    $values[$key] = "'" . addslashes($value) . "'";
                    break;

                case 'array':

Line indented incorrectly; expected 12 spaces, found 16

                    $values[$key] = '[]';
                    break;

                case 'NULL':

Line indented incorrectly; expected 12 spaces, found 16

                    $values[$key] = 'null';
                    break;
            }
        }

        // Mix in element route variables, and override values that should be used for autocompletion
        $values = array_merge(
            $values,
            static::elementRouteVariables(),
            static::globalVariables(),
            static::overrideValues()
        );

        // Allow plugins to modify the values
        $event = new DefineGeneratorValuesEvent([

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

            'values' => $values,
        ]);

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

        Event::trigger(self::class, self::EVENT_BEFORE_GENERATE, $event);
        $values = $event->values;

        // Format the line output for each value
        foreach ($values as $key => $value) {
            $values[$key] = "            '" . $key . "' => " . $value . ",";
        }

        // Save the template with variable substitution
        self::saveTemplate([

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

            '{{ globals }}' => implode(PHP_EOL, $values),
        ]);

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

    }

    /**
     * Add in the element types that could be injected as route variables
     *
     * @return array
     */
    protected static function elementRouteVariables(): array
    {
        $routeVariables = [];
        $elementTypes = Craft::$app->elements->getAllElementTypes();

The method getAllElementTypes() does not exist on null.

        foreach ($elementTypes as $elementType) {
            /* @var Element $elementType */
            $key = $elementType::refHandle();
            if (!empty($key) && !in_array($key, static::ELEMENT_ROUTE_EXCLUDES, true)) {
                $routeVariables[$key] = 'new \\' . $elementType . '()';
            }
        }

        return $routeVariables;
    }

    /**
     * Add in the global variables manually, because Craft conditionally loads the GlobalsExtension as of
     * Craft CMS 3.7.8 only for frontend routes
     *
     * @return array
     */
    protected static function globalVariables(): array
    {
        $globalVariables = [];
        // See if the GlobalsExtension class is available (Craft CMS 3.7.8 or later) and use it
        if (class_exists(GlobalsExtension::class)) {
            $globalsExtension = new GlobalsExtension();
            foreach ($globalsExtension->getGlobals() as $key => $value) {
                $globalVariables[$key] = 'new \\' . get_class($value) . '()';
            }

            return $globalVariables;
        }
        // Fall back and get the globals ourselves
        foreach (Craft::$app->getGlobals()->getAllSets() as $globalSet) {
            $globalVariables[$globalSet->handle] = 'new \\' . get_class($globalSet) . '()';
        }

        return $globalVariables;
    }

    /**
     * Override certain values that we always want hard-coded
     *
     * @return array
     */
    protected static function overrideValues(): array
    {
        return [
            // Swap in our variable in place of the `craft` variable
            'craft' => 'new \nystudio107\autocomplete\variables\AutocompleteVariable()',
            // Set the current user to a new user, so it is never `null`
            'currentUser' => 'new \craft\elements\User()',
            // Set the nonce to a blank string, as it changes on every request
            'nonce' => "''",
        ];
    }
}