AutocompleteInterface.php

<?php
/**
 * CodeEditor for Craft CMS
 *
 * Provides a code editor field with Twig & Craft API autocomplete
 *
 * @link      https://nystudio107.com
 * @copyright Copyright (c) 2022 nystudio107
 */

namespace nystudio107\codeeditor\base;

use nystudio107\codeeditor\models\CompleteItem;

/**
 * @author    nystudio107
 * @package   CodeEditor
 * @since     1.0.0
 */
interface AutocompleteInterface
{
    // Constants
    // =========================================================================

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

    /**
     * Generate the complete items
     */
    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
     * @param string $path The . delimited path in the autocomplete array to the item; if omitted, will be set to the $item->label
     */
    public function addCompleteItem(CompleteItem $item, string $path = ''): void;

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