nystudio107 / craft-twigfield

src/base/Autocomplete.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 Craft;
use craft\base\Model;
use craft\helpers\ArrayHelper;
use nystudio107\twigfield\models\CompleteItem;
use nystudio107\twigfield\Twigfield;
use nystudio107\twigfield\types\AutocompleteTypes;

/**

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.12

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

abstract class Autocomplete extends Model implements AutocompleteInterface
{
    // Constants
    // =========================================================================

    const COMPLETION_KEY = '__completions';

    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @var string The field type passed down from the template to the autocomplete
     */
    public $fieldType = TwigField::DEFAULT_FIELD_TYPE;

    /**

Missing short description in doc comment

     * @var array The twigfield options object passed down from the template to the autocomplete
     */
    public $twigfieldOptions = [];

    // Protected Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var array The accumulated complete items
     */
    protected $completeItems = [];

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

    /**

Missing short description in doc comment

     * @inerhitDoc
     */

Missing @return tag in function comment

    public function generateCompleteItems(): void
    {
    }

    /**

Parameter $item should have a doc-comment as per coding-style.

Parameter $path should have a doc-comment as per coding-style.

Missing short description in doc comment

     * @inerhitDoc
     */

Missing @return tag in function comment

    public function addCompleteItem(CompleteItem $item, string $path = ''): void
    {
        if (!$item->validate()) {
            Craft::debug(print_r($item->getErrors(), true), __METHOD__);

It seems like print_r($item->getErrors(), true) can also be of type true; however, parameter $message of yii\BaseYii::debug() does only seem to accept array|string, maybe add an additional type check?

            return;
        }
        if (empty($path)) {
            $path = $item->label;
        }
        ArrayHelper::setValue($this->completeItems, $path, [

The opening parenthesis of a multi-line function call should be the last content on the line.

            self::COMPLETION_KEY => array_filter($item->toArray(), static function ($v) {

The opening parenthesis of a multi-line function call should be the last content on the line.

                return !is_null($v);
            })

For multi-line function calls, the closing parenthesis should be on a new line.

        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**

Missing short description in doc comment

     * @inerhitDoc
     */

Missing @return tag in function comment

    public function getCompleteItems(): array
    {
        return $this->completeItems;
    }
}