nystudio107 / craft-autocomplete

src/base/Generator.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\base;

use Craft;
use nystudio107\autocomplete\Autocomplete;

/**

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

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

The tag in position 3 should be the @author tag

 */

Missing @license tag in class comment

Missing @link tag in class comment

Missing @category tag in class comment

abstract class Generator implements GeneratorInterface
{
    // Constants
    // =========================================================================

    /**

Missing short description in doc comment

     * @event Event The event that is triggered before generating autocomplete classes.
     *
     * ```php
     * use nystudio107\autocomplete\events\DefineGeneratorValuesEvent;
     * use nystudio107\autocomplete\generators\AutocompleteTwigExtensionGenerator;
     * use yii\base\Event;
     *
     * Event::on(AutocompleteTwigExtensionGenerator::class,
     *     AutocompleteTwigExtensionGenerator::EVENT_BEFORE_GENERATE,
     *     function(DefineGeneratorValuesEvent $event) {
     *         $event->values['myVariable'] = 'value';
     *     }
     * );
     * ```
     */
    public const EVENT_BEFORE_GENERATE = 'beforeGenerate';

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

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

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

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public static function getGeneratorStubsPath(): string
    {
        return Autocomplete::getInstance()->basePath . self::STUBS_DIR;
    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public static function generate()
    {
    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public static function regenerate()
    {
    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public static function delete()
    {
        $path = static::getGeneratedFilePath();
        if (is_file($path)) {
            @unlink($path);

It seems like you do not handle an error condition for unlink(). This can introduce security issues, and is generally not recommended.

        }
    }

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

    /**
     * Save the template to disk, with variable substitution
     *
     * @param array $vars key/value variables to be replaced in the stub

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return bool Whether the template was successfully saved

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected static function saveTemplate(array $vars): bool
    {
        $stub = file_get_contents(static::getStubFilePath());
        if ($stub) {
            $template = str_replace(array_keys($vars), array_values($vars), $stub);

            return !(file_put_contents(static::getGeneratedFilePath(), $template) === false);
        }

        return false;
    }

    /**
     * Don't regenerate the file if it already exists
     *
     * @return bool
     */
    protected static function shouldRegenerateFile(): bool
    {
        return !is_file(static::getGeneratedFilePath());
    }

    /**
     * Return a path to the generated autocomplete template file
     *
     * @return string
     */
    protected static function getGeneratedFilePath(): string
    {
        return Craft::$app->getPath()->getCompiledClassesPath() . DIRECTORY_SEPARATOR . static::getGeneratorName() . self::TEMPLATE_EXTENSION;
    }

    /**
     * Return a path to the autocomplete template stub
     *
     * @return string
     */
    protected static function getStubFilePath(): string
    {
        return static::getGeneratorStubsPath() . DIRECTORY_SEPARATOR . static::getGeneratorName() . self::STUBS_EXTENSION;
    }
}