nystudio107 / craft-twigfield

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

class CraftApiAutocomplete extends ObjectParserAutocomplete
{
    // Constants
    // =========================================================================

    const ELEMENT_ROUTE_EXCLUDES = [
        'matrixblock',
        'globalset'
    ];

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

    /**

Missing short description in doc comment

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

    /**

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

     * @var array A key-value array of the Twig global variables to parse. If left empty, it will
     * default to the current Twig context global variables
     */
    public $twigGlobals = [];

    /**

Missing short description in doc comment

     * @var array A key-value array of the Element Route variables (the injected `entry`, etc.
     * variable). If left empty, it will default to the current Element Route variables
     */
    public $elementRouteGlobals = [];

    /**

Missing short description in doc comment

     * @var array A key-value array of additional global variables to parse for completions
     */
    public $additionalGlobals = [];

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

    /**

Missing short description in doc comment

     * @inerhitDoc
     */

Missing @return tag in function comment

    public function init(): void
    {
        if (empty($this->twigGlobals)) {
            $this->twigGlobals = Craft::$app->view->getTwig()->getGlobals();
        }
        if (empty($this->elementRouteGlobals)) {
            $this->elementRouteGlobals = $this->getElementRouteGlobals();
        }
    }

    /**

Missing short description in doc comment

     * @inerhitDoc
     */

Missing @return tag in function comment

    public function generateCompleteItems(): void
    {
        // Gather up all of the globals to parse
        $globals = array_merge(
            $this->twigGlobals,
            $this->elementRouteGlobals,
            $this->additionalGlobals,
            $this->overrideValues()
        );
        foreach ($globals as $key => $value) {
            if (!in_array($key, parent::EXCLUDED_PROPERTY_NAMES, true)) {
                $type = gettype($value);
                switch ($type) {
                    case 'object':

Line indented incorrectly; expected 16 spaces, found 20

                        $this->parseObject($key, $value, 0);
                        break;

                    case 'array':

Line indented incorrectly; expected 16 spaces, found 20

                    case 'boolean':

Line indented incorrectly; expected 16 spaces, found 20

                    case 'double':

Line indented incorrectly; expected 16 spaces, found 20

                    case 'integer':

Line indented incorrectly; expected 16 spaces, found 20

                    case 'string':

Line indented incorrectly; expected 16 spaces, found 20

                        $kind = CompleteItemKind::VariableKind;
                        $path = $key;
                        $normalizedKey = preg_replace("/[^A-Za-z]/", '', $key);
                        if (ctype_upper($normalizedKey)) {

Line indented incorrectly; expected 20 spaces, found 24

                            $kind = CompleteItemKind::ConstantKind;
                        }

Line indented incorrectly; expected 20 spaces, found 24

                        // If this is an array, JSON-encode the keys. In the future, we could recursively parse the array
                        // To allow for nested values
                        if (is_array($value)) {

Line indented incorrectly; expected 20 spaces, found 24

                            $value = json_encode(array_keys($value));
                        }

Line indented incorrectly; expected 20 spaces, found 24

                        CompleteItem::create()
                            ->detail((string)$value)
                            ->kind($kind)
                            ->label((string)$key)
                            ->insertText((string)$key)
                            ->add($this, $path);
                        break;
                }
            }
        }
    }

    // Protected Methods
    // =========================================================================

    /**
     * Add in the element types that could be injected as route variables
     *
     * @return array
     */
    protected function getElementRouteGlobals(): array
    {
        $routeVariables = [];
        $elementTypes = Craft::$app->elements->getAllElementTypes();

The method getAllElementTypes() does not exist on null.

        foreach ($elementTypes as $elementType) {
            /* @var Element $elementType */
            $key = $elementType::refHandle();
            if (!empty($key) && !in_array($key, self::ELEMENT_ROUTE_EXCLUDES)) {
                $routeVariables[$key] = new $elementType();
            }
        }

        return $routeVariables;
    }

    /**
     * Override certain values that we always want hard-coded
     *
     * @return array
     */
    protected function overrideValues(): array
    {
        return [
            // Set the nonce to a blank string, as it changes on every request
            'nonce' => '',
        ];
    }
}