nystudio107 / craft-twigfield

src/autocompletes/SectionShorthandFieldsAutocomplete.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;
use craft\base\ElementInterface;

The type craft\base\ElementInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\elements\Entry;
use nystudio107\twigfield\base\ObjectParserAutocomplete;
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.13

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 SectionShorthandFieldsAutocomplete extends ObjectParserAutocomplete
{
    // Constants
    // =========================================================================

    public const OPTIONS_DATA_KEY = 'SectionShorthandFields';

    /**

Missing short description in doc comment

     * @array properties that are defined only using the `@property` docblock annotation
     */
    public const MAGIC_GETTER_PROPERTIES = [
        Entry::class => [
            'typeId' => "the entry type’s ID",
            'authorId' => "the entry author’s ID",
            'type' => "the entry type",
            'section' => "the entry’s section",
            'author' => "the entry’s author",
        ]
    ];

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

    /**

Missing short description in doc comment

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

    /**

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 = true;

    /**

Missing short description in doc comment

     * @inheritdoc
     */
    public $parseBehaviors = false;

    /**

Missing short description in doc comment

     * @inheritdoc
     */
    public $parseMethods = false;

    /**

Missing short description in doc comment

     * @inheritdoc
     */
    public $customPropertySortPrefix = '';

    /**

Missing short description in doc comment

     * @inheritdoc
     */
    public $propertySortPrefix = '';

    /**

Missing short description in doc comment

     * @inheritdoc
     */
    public $methodSortPrefix = '';

    /**

Missing short description in doc comment

     * @var ?int The section id. A sectionId of 0 denotes we don't know what this section is, so use
     * a generic `Entry` and don't generate any complete items for custom fields
     */
    public $sectionId = null;

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

    /**

Missing short description in doc comment

     * @inerhitDoc
     */

Missing @return tag in function comment

    public function init(): void
    {
        $this->sectionId = $this->twigfieldOptions[self::OPTIONS_DATA_KEY] ?? null;
    }

    /**
     * Core function that generates the autocomplete array
     */

Missing @return tag in function comment

    public function generateCompleteItems(): void
    {
        if ($this->sectionId !== null) {
            // A sectionId of 0 denotes we don't know what this section is, so use
            // a generic `Entry` and don't generate any complete items for custom fields
            if ($this->sectionId === 0) {
                $element = new Entry();
                $this->parseObject('', $element, 0);
                $this->addMagicGetterProperties($element);

                return;
            }
            // Find the entry types used in the passed in sectionId
            $sections = Craft::$app->getSections();
            $section = $sections->getSectionById($this->sectionId);
            if ($section) {
                $entryTypes = $section->getEntryTypes();
                foreach ($entryTypes as $entryType) {
                    // Add the native fields in
                    if ($entryType->elementType) {
                        $element = new $entryType->elementType;
                        /* @var ElementInterface $element */
                        $this->parseObject('', $element, 0);
                        $this->addMagicGetterProperties($element);
                    }
                    // Add the custom fields in
                    if (version_compare(Craft::$app->getVersion(), '4.0', '>=')) {
                        $customFields = $entryType->getCustomFields();
                    } else {
                        $customFields = $entryType->getFields();
                    }
                    foreach ($customFields as $customField) {
                        $name = $customField->handle;
                        $docs = $customField->instructions ?? '';
                        if ($name) {
                            CompleteItem::create()
                                ->insertText($name)
                                ->label($name)
                                ->detail(Craft::t('twigfield', 'Custom Field Shorthand'))
                                ->documentation($docs)
                                ->kind(CompleteItemKind::FieldKind)
                                ->add($this);
                        }
                    }
                }
            }
        }
    }

    /**
     * Add in magic getter properties that are defined only in the `@property` docblock annotation
     *
     * @param ElementInterface $element

Missing parameter comment

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

     */
    protected function addMagicGetterProperties(ElementInterface $element): void
    {
        foreach (self::MAGIC_GETTER_PROPERTIES as $key => $value) {
            if ($key === $element::class) {
                foreach ($value as $name => $docs) {
                    CompleteItem::create()
                        ->insertText($name)
                        ->label($name)
                        ->detail(Craft::t('twigfield', 'Custom Field Shorthand'))
                        ->documentation($docs)
                        ->kind(CompleteItemKind::FieldKind)
                        ->add($this);
                }
            }
        }
    }
}