nystudio107 / craft-twigfield

src/autocompletes/EnvironmentVariableAutocomplete.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\autocompletes;

use craft\web\twig\variables\Cp;
use nystudio107\twigfield\base\Autocomplete;
use nystudio107\twigfield\models\CompleteItem;
use nystudio107\twigfield\types\AutocompleteTypes;
use nystudio107\twigfield\types\CompleteItemKind;

/**

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

class EnvironmentVariableAutocomplete extends Autocomplete
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var string The name of the autocomplete
     */
    public $name = 'EnvironmentVariableAutocomplete';

    /**

Missing short description in doc comment

     * @var string The type of the autocomplete
     */
    public $type = AutocompleteTypes::GeneralAutocomplete;

    /**

Missing short description in doc comment

     * @var string Whether the autocomplete should be parsed with . -delimited nested sub-properties
     */
    public $hasSubProperties = false;

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

    /**

Missing short description in doc comment

     * @inerhitDoc
     */

Missing @return tag in function comment

    public function generateCompleteItems(): void
    {
        $cp = new Cp();
        $suggestions = $cp->getEnvSuggestions(true);
        foreach ($suggestions as $suggestion) {
            foreach ($suggestion['data'] as $item) {
                $name = $item['name'];
                $prefix = $name[0];
                $trimmedName = ltrim($name, $prefix);
                CompleteItem::create()
                    ->label($name)
                    ->insertText($trimmedName)
                    ->filterText($trimmedName)
                    ->detail($item['hint'])
                    ->kind(CompleteItemKind::ConstantKind)
                    ->sortText('~' . $name)
                    ->add($this);
            }
        }
    }
}