nystudio107 / craft-code-editor

src/models/Settings.php

<?php
/**
 * CodeEditor for Craft CMS
 *
 * Provides a code 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\codeeditor\models;

use craft\base\Model;
use craft\validators\ArrayValidator;
use nystudio107\codeeditor\autocompletes\CraftApiAutocomplete;
use nystudio107\codeeditor\autocompletes\SectionShorthandFieldsAutocomplete;
use nystudio107\codeeditor\autocompletes\TwigLanguageAutocomplete;

/**

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   CodeEditor

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 Settings extends Model
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var bool Whether to allow anonymous access be allowed to the codeeditor/autocomplete/index endpoint
     */
    public $allowFrontendAccess = false;

    /**

Missing short description in doc comment

     * @var bool Whether to allow frontend templates access to the `codeeditor/codeEditor.twig` Twig template
     */
    public $allowTemplateAccess = true;

    /**

Missing short description in doc comment

     * @var string[] The default autocompletes to use for the default `CodeEditor` field type
     */
    public $defaultCodeEditorAutocompletes = [
        CraftApiAutocomplete::class,
        TwigLanguageAutocomplete::class,
        SectionShorthandFieldsAutocomplete::class,
    ];

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function defineRules(): array
    {
        return [
            [['allowFrontendAccess', 'allowTemplateAccess'], 'boolean'],
            ['defaultCodeFieldAutocompletes', ArrayValidator::class],
        ];
    }
}