nystudio107 / craft-templatecomments

src/models/Settings.php

<?php
/**
 * Template Comments plugin for Craft CMS
 *
 * Adds a HTML comment to demarcate each Twig template that is included or extended.
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c)  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\templatecomments\models;

use craft\base\Model;
use craft\validators\ArrayValidator;

/**

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   TemplateComments

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 comments should be generated for site templates
     */
    public bool $siteTemplateComments = true;

    /**

Missing short description in doc comment

     * @var bool Whether comments should be generated for Control Panel templates
     */
    public bool $cpTemplateComments = false;

    /**

Missing short description in doc comment

     * @var bool Whether to generate comments only when `devMode` is on
     */
    public bool $onlyCommentsInDevMode = true;

    /**

Missing short description in doc comment

     * @var array Don't add comments to template blocks that contain these strings (case-insensitive)
     */
    public array $excludeBlocksThatContain = [
        'css',
        'js',
        'javascript',
    ];

    /**

Missing short description in doc comment

     * @var bool Whether or not to show comments for templates that are include'd
     */
    public bool $templateCommentsEnabled = true;

    /**

Missing short description in doc comment

     * @var bool Whether or not to show comments for `{% block %}`s
     */
    public bool $blockCommentsEnabled = true;

    /**

Missing short description in doc comment

     * @var array Template file suffixes that Template Comments should be enabled for
     */
    public array $allowedTemplateSuffixes = [
        '',
        'twig',
        'htm',
        'html',
    ];

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

Missing short description in doc comment

     * @inerhitdoc
     */

Missing @return tag in function comment

    public function rules(): array
    {
        return [
            [
                [
                    'siteTemplateComments',
                    'cpTemplateComments',
                    'onlyCommentsInDevMode',
                    'templateCommentsEnabled',
                    'blockCommentsEnabled',
                ],
                'boolean',
            ],
            [
                [
                    'excludeBlocksThatContain',
                    'allowedTemplateSuffixes',
                ],
                ArrayValidator::class,
            ],
        ];
    }
}