nystudio107 / craft-twigfield

src/controllers/AutocompleteController.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\controllers;

use craft\helpers\Json;
use craft\web\Controller;
use nystudio107\twigfield\Twigfield;
use yii\web\Response;

/**

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

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 AutocompleteController extends Controller
{
    /**

Missing short description in doc comment

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

     * @inheritDoc
     */

Missing @return tag in function comment

    public function beforeAction($action): bool
    {
        if (Twigfield::$settings->allowFrontendAccess) {
            $this->allowAnonymous = 1;
        }

        return parent::beforeAction($action);
    }

    /**
     * Return all of the autocomplete items in JSON format
     *
     * @param string $fieldType

Missing parameter comment

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

     * @param string $twigfieldOptions

Missing parameter comment

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

     * @return Response

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

     */
    public function actionIndex(string $fieldType = Twigfield::DEFAULT_FIELD_TYPE, string $twigfieldOptions = ''): Response
    {
        $options = [];
        $parsedJson = Json::decodeIfJson($twigfieldOptions);
        if (is_array($parsedJson)) {
            $options = $parsedJson;
        }
        $result = Twigfield::getInstance()->autocomplete->generateAutocompletes($fieldType, $options);

        return $this->asJson($result);
    }
}