nystudio107 / craft-richvariables

src/controllers/DefaultController.php

<?php
/**
 * Rich Variables plugin for Craft CMS 3.x
 *
 * Allows you to easily use Craft Globals as variables in Rich Text fields
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2017 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\richvariables\controllers;

use aelvan\preparsefield\fields\PreparseFieldType as PreparseField;

The type aelvan\preparsefield\fields\PreparseFieldType was not found. Maybe you did not declare it correctly or list all dependencies?

use Craft;
use craft\base\Field;
use craft\ckeditor\Field as CKEditorField;

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

use craft\fields\Date as DateField;
use craft\fields\Dropdown as DropdownField;
use craft\fields\Number as NumberField;
use craft\fields\PlainText as PlainTextField;
use craft\helpers\Json;
use craft\redactor\Field as RedactorField;

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

use craft\web\Controller;
use nystudio107\richvariables\assetbundles\richvariables\RichVariablesAsset;
use nystudio107\richvariables\RichVariables;
use yii\base\InvalidConfigException;

/**

Missing short description in doc comment

 * @author    nystudio107

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

Content of the @author tag must be in the form "Display Name <username@example.com>"

The tag in position 1 should be the @package tag

 * @package   RichVariables

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 DefaultController extends Controller
{
    // Constants
    // =========================================================================

    const VALID_FIELD_CLASSES = [
        PlainTextField::class,
        NumberField::class,
        DateField::class,
        DropdownField::class,
        RedactorField::class,
        CKEditorField::class,
        PreparseField::class,
    ];

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

    /**

Missing short description in doc comment

     * @return mixed
     */
    public function actionIndex()
    {
        $result = [];
        $variablesList = [];

        // Get the global set to use
        $settings = RichVariables::$plugin->getSettings();
        $globalsSet = Craft::$app->getGlobals()->getSetByHandle($settings['globalSetHandle']);
        // Grab the first global set if they haven't specified one yet
        if (!$globalsSet) {
            $allGlobalsSetIds = Craft::$app->getGlobals()->getAllSetIds();
            if (!empty($allGlobalsSetIds)) {
                $globalsSet = Craft::$app->globals->getSetById($allGlobalsSetIds[0]);

The method getSetById() does not exist on null.

            }
        }
        if ($globalsSet) {
            // Get the field layout fields used for this global set
            $layout = $globalsSet->getFieldLayout();
            if ($layout) {
                $fieldLayoutFields = $layout->getFields();
                /** @var Field $field */

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

Missing short description in doc comment

                foreach ($fieldLayoutFields as $field) {
                    foreach (self::VALID_FIELD_CLASSES as $fieldClass) {
                        if ($field instanceof $fieldClass) {
                            // Add the field title and Reference Tag as per https://craftcms.com/docs/reference-tags
                            $thisVar = [
                                'title' => $field->name,
                                'text' => '{globalset:' . $globalsSet->attributes['id'] . ':' . $field->handle . '}',
                            ];
                            $variablesList[] = $thisVar;
                        }
                    }
                }
            }
        }

        // Get the URL to our menu icon from our resource bundle
        try {
            Craft::$app->getView()->registerAssetBundle(RichVariablesAsset::class);
        } catch (InvalidConfigException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
        $menuIconUrl = Craft::$app->assetManager->getPublishedUrl(

Are you sure Craft::app->assetManager->getPublishedUrl('@nystudio107/richvariables/web/assets/dist', true) of type false|mixed|string can be used in concatenation?

                '@nystudio107/richvariables/web/assets/dist',

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.

                true

The call to yii\web\AssetManager::getPublishedUrl() has too many arguments starting with true.

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.

            ) . '/img/RichVariables-menu-icon.svg';

This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 12.

        // Return everything to our JavaScript encoded as JSON
        $result['variablesList'] = $variablesList;
        $result['menuIconUrl'] = $menuIconUrl;
        $result['useIconForMenu'] = $settings['useIconForMenu'];

        return Json::encode($result);
    }
}