nystudio107 / craft-twigfield

src/base/AutocompleteInterface.php

<?php
/**
 * Twigfield for Craft CMS
 *
 * Provides a twig editor field with Twig & Craft API autocomplete
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2022 nystudio107

@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\twigfield\base;

use nystudio107\twigfield\models\CompleteItem;

/**

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   twigfield

Package name "twigfield" is not valid; consider "Twigfield" 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 AutocompleteInterface
{
    // Constants
    // =========================================================================

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

    /**
     * Generate the complete items
     */

Missing @return tag in function comment

    public function generateCompleteItems(): void;

    /**
     * Add a complete item to the $path, which is a . separated namespace for the item
     * that indicates where in the associative array the item should appear.
     *
     * @param CompleteItem $item

Missing parameter comment

     * @param string $path The . delimited path in the autocomplete array to the item; if omitted, will be set to the $item->label

Expected 7 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

    public function addCompleteItem(CompleteItem $item, string $path = ''): void;

    /**
     * Get the array of complete items
     *
     * @return array
     */
    public function getCompleteItems(): array;
}