nystudio107\autocomplete\generators\AutocompleteVariableGenerator

Complexity

Total Complexity

20

Size/Duplication

Total Lines	134
Duplicated Lines	0 %

Importance

Changes	16
Bugs	0	Features	2

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getGeneratorName()	0	3	1
A	regenerate()	0	3	1
A	generate()	0	4	2
C	generateInternal()	0	90	16

<?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\web\twig\variables\CraftVariable;
use nystudio107\autocomplete\base\Generator;
use nystudio107\autocomplete\events\DefineGeneratorValuesEvent;
use ReflectionClass;
use ReflectionMethod;
use ReflectionNamedType;
use ReflectionProperty;
use Throwable;
use yii\base\Event;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

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

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

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

The tag in position 3 should be the @author tag

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

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class AutocompleteVariableGenerator extends Generator
{
    // Constants
    // =========================================================================

    public const BEHAVIOR_PROPERTY_EXCLUDES = [
        'owner',
    ];

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

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

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

    /**

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()
    {
        static::generateInternal();
    }

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

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

Missing @return tag in function comment

    protected static function generateInternal()
    {
        $properties = [];
        $methods = [];
        /* @noinspection PhpInternalEntityUsedInspection */
        $globals = Craft::$app->view->getTwig()->getGlobals();
        /* @var CraftVariable $craftVariable */
        if (isset($globals['craft'])) {
            $craftVariable = $globals['craft'];
            // Handle the components
            foreach ($craftVariable->getComponents() as $key => $value) {
                try {
                    $properties[$key] = get_class($craftVariable->get($key));
                } catch (Throwable $e) {
                    // That's okay
                }
            }
            // Handle the behaviors
            foreach ($craftVariable->getBehaviors() as $behavior) {
                try {
                    $reflect = new ReflectionClass($behavior);
                    // Properties
                    foreach ($reflect->getProperties(ReflectionProperty::IS_PUBLIC) as $reflectProp) {
                        // Property name
                        $reflectPropName = $reflectProp->getName();
                        // Ensure the property exists only for this class and not any parent class
                        if (property_exists(get_parent_class($behavior), $reflectPropName)) {
                            continue;
                        }
                        // Do it this way because getType() reflection method is >= PHP 7.4
                        $reflectPropType = gettype($behavior->$reflectPropName);
                        switch ($reflectPropType) {
                            case 'object':

Line indented incorrectly; expected 24 spaces, found 28

                                $properties[$reflectPropName] = get_class($behavior->$reflectPropName);
                                break;
                            default:

Line indented incorrectly; expected 24 spaces, found 28

                                $properties[$reflectPropName] = $reflectPropType;
                                break;
                        }
                    }
                    // Methods
                    foreach ($reflect->getMethods(ReflectionMethod::IS_PUBLIC) as $reflectMethod) {
                        // Method name
                        $reflectMethodName = $reflectMethod->getName();
                        // Ensure the method exists only for this class and not any parent class
                        if (method_exists(get_parent_class($behavior), $reflectMethodName)) {
                            continue;
                        }
                        // Method return type
                        $methodReturn = '';
                        $reflectMethodReturnType = $reflectMethod->getReturnType();
                        if ($reflectMethodReturnType instanceof ReflectionNamedType) {
                            $methodReturn = ': ' . $reflectMethodReturnType->getName();
                        }
                        // Method parameters
                        $methodParams = [];
                        foreach ($reflectMethod->getParameters() as $methodParam) {
                            $paramType = '';
                            $methodParamType = $methodParam->getType();
                            if ($methodParamType) {
                                $paramType = $methodParamType . ' ';
                            }
                            $methodParams[] = $paramType . '$' . $methodParam->getName();
                        }
                        $methods[$reflectMethodName] = '(' . implode(', ', $methodParams) . ')' . $methodReturn;
                    }
                } catch (\ReflectionException $e) {

Consider adding a comment why this CATCH block is empty.

                }
            }
        }

        // 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' => $properties,
        ]);

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

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

        // Format the line output for each property
        foreach ($properties as $key => $value) {
            $properties[$key] = ' * @property \\' . $value . ' $' . $key;
        }
        // Format the line output for each method
        foreach ($methods as $key => $value) {
            $methods[$key] = ' * @method ' . $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.

            '{{ properties }}' => implode(PHP_EOL, array_merge($properties, $methods)),
        ]);

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

    }
}