nystudio107 / craft-twigfield

src/models/CompleteItem.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\models;

use craft\base\Model;
use craft\validators\ArrayValidator;
use nystudio107\twigfield\base\AutocompleteInterface;
use nystudio107\twigfield\types\CompleteItemKind;

/**
 * Based on: https://microsoft.github.io/monaco-editor/api/interfaces/monaco.languages.CompletionItem.html
 *
 * @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

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.11

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 CompleteItem extends Model
{
    // Public Static Methods
    // =========================================================================

    /**
     * Factory method for complete item objects
     *
     * @return CompleteItem
     */
    public static function create(): CompleteItem
    {
        return new CompleteItem();
    }

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

    /**

Missing short description in doc comment

     * @var array An optional array of additional text edits that are applied when selecting this completion.
     * Edits must not overlap with the main edit nor with themselves.
     * ref: https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.ISingleEditOperation.html
     */
    public $additionalTextEdits;

    /**

Missing short description in doc comment

     * @var array A command that should be run upon acceptance of this item.
     * ref: https://microsoft.github.io/monaco-editor/api/interfaces/monaco.languages.Command.html
     */
    public $command;

    /**

Missing short description in doc comment

     * @var array An optional set of characters that when pressed while this completion is active will accept
     * it first and then type that character. Note that all commit characters should have `length=1` and that
     * superfluous characters will be ignored.
     */
    public $commitCharacters;

    /**

Missing short description in doc comment

     * @var string A human-readable string with additional information about this item, like type or symbol information.
     */
    public $detail;

    /**

Missing short description in doc comment

     * @var string A human-readable string that represents a doc-comment.
     * Can contain Markdown
     */
    public $documentation;

    /**

Missing short description in doc comment

     * @var string A string that should be used when filtering a set of completion items.
     * When falsy the `label` is used.
     */
    public $filterText;

    /**

Missing short description in doc comment

     * @var string A string or snippet that should be inserted in a document when selecting this completion.
     */
    public $insertText = '';

    /**

Missing short description in doc comment

     * @var int Additional rules (as bitmask) that should be applied when inserting this completion.
     */
    public $insertTextRules;

    /**

Missing short description in doc comment

     * @var int The kind of this completion item. Based on the kind an icon is chosen by the editor.
     */
    public $kind = CompleteItemKind::PropertyKind;

    /**

Missing short description in doc comment

     * @var string The label of this completion item. By default this is also the text that is inserted
     * when selecting this completion.
     */
    public $label;

    /**

Missing short description in doc comment

     * @var bool Select this item when showing. Note that only one completion item can be selected and that
     * the editor decides which item that is. The rule is that the first item of those that match best is selected.
     */
    public $preselect;

    /**

Missing short description in doc comment

     * @var array A range of text that should be replaced by this completion item.
     */
    public $range;

    /**

Missing short description in doc comment

     * @var string A string that should be used when comparing this item with other items. When falsy
     * the `label` is used.
     */
    public $sortText;

    /**

Missing short description in doc comment

     * @var array A modifier to the kind which affect how the item is rendered, e.g. Deprecated is rendered
     * with a strikeout
     */
    public $tags;

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

    /**
     * An optional array of additional text edits that are applied when selecting this completion.
     * Edits must not overlap with the main edit nor with themselves.
     * ref: https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.ISingleEditOperation.html
     * @param $value array

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function additionalTextEdits($value): self
    {
        $this->additionalTextEdits = $value;
        return $this;
    }

    /**
     * A command that should be run upon acceptance of this item.
     * ref: https://microsoft.github.io/monaco-editor/api/interfaces/monaco.languages.Command.html
     * @param $value array

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function command($value): self
    {
        $this->command = $value;
        return $this;
    }

    /**
     * An optional set of characters that when pressed while this completion is active will accept
     * it first and then type that character. Note that all commit characters should have `length=1` and that
     * superfluous characters will be ignored.
     * @param $value array

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function commitCharacters($value): self
    {
        $this->commitCharacters = $value;
        return $this;
    }

    /**
     * A human-readable string with additional information about this item, like type or symbol information.
     * @param $value string

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function detail($value): self
    {
        $this->detail = $value;
        return $this;
    }

    /**
     * A human-readable string that represents a doc-comment.
     * Can contain Markdown
     * @param $value string

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function documentation($value): self
    {
        $this->documentation = $value;
        return $this;
    }

    /**
     * A string that should be used when filtering a set of completion items.
     * When falsy the `label` is used.
     * @param $value string

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function filterText($value): self
    {
        $this->filterText = $value;
        return $this;
    }

    /**
     * A string or snippet that should be inserted in a document when selecting this completion.
     * @param $value string

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function insertText($value): self
    {
        $this->insertText = $value;
        return $this;
    }

    /**
     * Additional rules (as bitmask) that should be applied when inserting this completion.
     * @param $value int

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function insertTextRules($value): self
    {
        $this->insertTextRules = $value;
        return $this;
    }

    /**
     * The kind of this completion item. Based on the kind an icon is chosen by the editor.
     * @param $value int

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function kind($value): self
    {
        $this->kind = $value;
        return $this;
    }

    /**
     * The label of this completion item. By default this is also the text that is inserted
     * when selecting this completion.
     * @param $value string

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function label($value): self
    {
        $this->label = $value;
        return $this;
    }

    /**
     * Select this item when showing. Note that only one completion item can be selected and that
     * the editor decides which item that is. The rule is that the first item of those that match best is selected.
     * @param $value bool

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function preselect($value): self
    {
        $this->preselect = $value;
        return $this;
    }

    /**
     * A range of text that should be replaced by this completion item.
     * @param $value array

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function range($value): self
    {
        $this->range = $value;
        return $this;
    }

    /**
     * A string that should be used when comparing this item with other items. When falsy
     * the `label` is used.
     * @param $value string

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function sortText($value): self
    {
        $this->sortText = $value;
        return $this;
    }

    /**
     * A modifier to the kind which affect how the item is rendered, e.g. Deprecated is rendered
     * with a strikeout
     * @param $value array

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function tags($value): self
    {
        $this->tags = $value;
        return $this;
    }

    /**
     * Add the completion item to the passed in AutocompleteInterface static class
     *
     * @param AutocompleteInterface $autocomplete

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

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

Expected 16 spaces after parameter type; 1 found

Expected 9 spaces after parameter name; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return void

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function add($autocomplete, string $path = ''): void
    {
        $autocomplete->addCompleteItem($this, $path);
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function defineRules(): array
    {
        return [

            [
                [
                    'detail',
                    'documentation',
                    'filterText',
                    'insertText',
                    'label',
                    'sortText',
                    'tags',
                ],
                'string'
            ],
            [
                [
                    'additionalTextEdits',
                    'command',
                    'commitCharacters',
                    'range',
                ],
                ArrayValidator::class
            ],
            ['insertTextRules', 'integer', 'min' => 0, 'max' => 4],
            ['kind', 'integer', 'min' => 0, 'max' => 27],
            ['preselect', 'boolean'],
            [
                [
                    'insertText',
                    'kind',
                ],
                'required'
            ],
        ];
    }
}