nystudio107\codefield\fields\Code

Complexity

Total Complexity

16

Size/Duplication

Total Lines	220
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getContentColumnType()	0	3	1
A	getContentGqlType()	0	8	1
A	rules()	0	15	1
B	normalizeValue()	0	37	7
A	getInputHtml()	0	32	4
A	getSettingsHtml()	0	9	1
A	displayName()	0	3	1

<?php
/**
 * Code Field plugin for Craft CMS
 *
 * Provides a Code Field that has a full-featured code editor with syntax highlighting & 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\codefield\fields;

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\base\Field;
use craft\base\PreviewableFieldInterface;
use craft\helpers\Html;
use craft\helpers\Json;
use craft\validators\ArrayValidator;
use GraphQL\Type\Definition\Type;
use nystudio107\codefield\gql\types\generators\CodeDataGenerator;
use nystudio107\codefield\models\CodeData;
use nystudio107\codefield\validators\JsonValidator;
use yii\db\Schema;

/**

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   CodeField

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

 * @since     4.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 Code extends Field implements PreviewableFieldInterface
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var string The theme to use for the Code Editor field.
     */
    public string $theme = 'auto';

    /**

Missing short description in doc comment

     * @var string The language to use for the Code Editor field.
     */
    public string $language = 'javascript';

    /**

Missing short description in doc comment

     * @var bool Whether the Code Editor field display as a single line
     */
    public bool $singleLineEditor = false;

    /**

Missing short description in doc comment

     * @var int The font size to use for the Code Editor field
     */
    public int $fontSize = 14;

    /**

Missing short description in doc comment

     * @var bool Whether line numbers should be displayed in the Code Editor field
     */
    public bool $lineNumbers = false;

    /**

Missing short description in doc comment

     * @var bool Whether code folding should be used in the Code Editor field
     */
    public bool $codeFolding = false;

    /**

Missing short description in doc comment

     * @var string The text that will be shown if the code field is empty.
     */
    public string $placeholder = '';

    /**

Missing short description in doc comment

     * @var bool Whether the language selector dropdown menu should be displayed.
     */
    public bool $showLanguageDropdown = true;

    /**

Missing short description in doc comment

     * @var array The languages that should be listed in the language selector dropdown menu.
     */
    public array $availableLanguages = [
        'css',
        'graphql',
        'html',
        'javascript',
        'json',
        'markdown',
        'mysql',
        'php',
        'shell',
        'twig',
        'typescript',
        'yaml',
    ];

    /**

Missing short description in doc comment

     * @var string JSON blob of Monaco [EditorOptions](https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.IEditorOptions.html) that will override the default settings
     */
    public string $monacoEditorOptions = '';

    // Static Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function displayName(): string
    {
        return Craft::t('codefield', 'Code');
    }

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

    /**

Missing short description in doc comment

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

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

     * @inheritdoc
     */

Missing @return tag in function comment

    public function normalizeValue($value, ElementInterface $element = null): mixed
    {
        if ($value instanceof CodeData) {
            return $value;
        }
        // Default config
        $config = [
            'value' => '',
            'language' => $this->language,
        ];
        // Handle incoming values potentially being JSON or an array
        if (!empty($value)) {
            // Handle JSON-encoded values coming in
            if (\is_string($value)) {
                $jsonValue = Json::decodeIfJson($value);
                // If this is still a string (meaning it's not valid JSON), treat it as the value
                if (\is_string($jsonValue)) {
                    $config['value'] = $jsonValue;
                } else {
                    $value = $jsonValue;
                }
            }
            if (\is_array($value)) {
                $config = array_merge($config, array_filter($value));
            }
        }
        // Create and validate the model
        $codeData = new CodeData($config);
        if (!$codeData->validate()) {
            Craft::error(
                Craft::t('codefield', 'CodeData failed validation: ')
                . print_r($codeData->getErrors(), true),

Are you sure print_r($codeData->getErrors(), true) of type string|true can be used in concatenation?

                __METHOD__
            );
        }

        return $codeData;
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getSettingsHtml(): ?string
    {
        $monacoLanguages = require(__DIR__ . '/MonacoLanguages.php');

"require" is a statement not a function; no parentheses are required

File is being conditionally included; use "include" instead

        // Render the settings template
        return Craft::$app->getView()->renderTemplate(
            'codefield/_components/fields/Code_settings',
            [
                'field' => $this,
                'monacoLanguages' => $monacoLanguages,
            ]
        );
    }

    /**

Missing short description in doc comment

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

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

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getInputHtml($value, ElementInterface $element = null): string
    {
        // Get our id and namespace
        $id = Html::id($this->handle);

It seems like $this->handle can also be of type null; however, parameter $id of craft\helpers\Html::id() does only seem to accept string, maybe add an additional type check?

        $namespacedId = Craft::$app->getView()->namespaceInputId($id);

        // Extract just the languages that have been selected for display
        $displayLanguages = [];
        if ($this->showLanguageDropdown) {
            $monacoLanguages = require(__DIR__ . '/MonacoLanguages.php');

"require" is a statement not a function; no parentheses are required

File is being conditionally included; use "include" instead

            $decomposedLanguages = array_column($monacoLanguages, 'label', 'value');
            $displayLanguages = array_intersect_key($decomposedLanguages, array_flip($this->availableLanguages));
            $displayLanguages = array_map(static function ($k, $v) {

The opening parenthesis of a multi-line function call should be the last content on the line.

                return ['value' => $k, 'label' => $v];
            }, array_keys($displayLanguages), array_values($displayLanguages));

For multi-line function calls, the closing parenthesis should be on a new line.

        }
        $monacoOptionsOverride = Json::decodeIfJson($this->monacoEditorOptions);
        if ($monacoOptionsOverride === null || is_string($monacoOptionsOverride)) {
            $monacoOptionsOverride = [];
        }
        // Render the input template
        return Craft::$app->getView()->renderTemplate(
            'codefield/_components/fields/Code_input',
            [
                'name' => $this->handle,
                'value' => $value,
                'field' => $this,
                'orientation' => $this->getOrientation($element),
                'id' => $id,
                'namespacedId' => $namespacedId,
                'displayLanguages' => $displayLanguages,
                'monacoOptionsOverride' => $monacoOptionsOverride,
            ]
        );
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getContentGqlType(): Type|array
    {
        $typeArray = CodeDataGenerator::generateTypes($this);

        return [
            'name' => $this->handle,
            'description' => 'Code Editor field',
            'type' => array_shift($typeArray),
        ];
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function rules(): array
    {
        $rules = parent::rules();
        return array_merge($rules, [

The opening parenthesis of a multi-line function call should be the last content on the line.

            ['theme', 'in', 'range' => ['auto', 'vs', 'vs-dark', 'hc-black']],
            ['theme', 'default', 'value' => 'auto'],
            ['language', 'string'],
            ['language', 'default', 'value' => 'javascript'],
            [['singleLineEditor', 'showLanguageDropdown', 'lineNumbers', 'codeFolding'], 'boolean'],
            ['placeholder', 'string'],
            ['placeholder', 'default', 'value' => ''],
            ['fontSize', 'integer'],
            ['fontSize', 'default', 'value' => 14],
            ['availableLanguages', ArrayValidator::class],
            ['monacoEditorOptions', JsonValidator::class],
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getContentColumnType(): string
    {
        return Schema::TYPE_TEXT;
    }
}