nystudio107 / craft-autocomplete

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

/**

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

interface GeneratorInterface
{
    // Constants
    // =========================================================================

    public const TEMPLATE_EXTENSION = '.php';
    public const STUBS_EXTENSION = '.php.stub';
    public const STUBS_DIR = DIRECTORY_SEPARATOR . 'stubs';

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

    /**
     * Return the name of the generator
     *
     * @return string
     */
    public static function getGeneratorName(): string;

    /**
     * Return a file system path to the generator stubs directory
     *
     * @return string
     */
    public static function getGeneratorStubsPath(): string;

    /**
     * Generate the autocomplete class if it doesn't exist already
     */

Missing @return tag in function comment

    public static function generate();

    /**
     * Regenerate the autocomplete classes from scratch
     */

Missing @return tag in function comment

    public static function regenerate();

    /**
     * Delete the autocomplete classes
     */

Missing @return tag in function comment

    public static function delete();
}