nystudio107 / craft-vite

src/models/Settings.php

<?php
/**
 * Vite plugin for Craft CMS
 *
 * Allows the use of the Vite.js next generation frontend tooling with Craft CMS
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

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

use craft\base\Model;

/**

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   Vite

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 Should the dev server be used for?
     */
    public bool $useDevServer = false;

    /**

Missing short description in doc comment

     * @var string File system path (or URL) to the Vite-built manifest.json
     */
    public string $manifestPath = '';

    /**

Missing short description in doc comment

     * @var string The public URL to the dev server (what appears in `<script src="">` tags
     */
    public string $devServerPublic = '';

    /**

Missing short description in doc comment

     * @var string The public URL to use when not using the dev server
     */
    public string $serverPublic = '';

    /**

Missing short description in doc comment

     * @var string|array The JavaScript entry from the manifest.json to inject on Twig error pages
     *              This can be a string or an array of strings
     */
    public string|array $errorEntry = '';

    /**

Missing short description in doc comment

     * @var string String to be appended to the cache key
     */
    public string $cacheKeySuffix = '';

    /**

Missing short description in doc comment

     * @var string The internal URL to the dev server, when accessed from the environment in which PHP is executing
     *              This can be the same as `$devServerPublic`, but may be different in containerized or VM setups.
     *              ONLY used if $checkDevServer = true
     */
    public string $devServerInternal = '';

    /**

Missing short description in doc comment

     * @var bool Should we check for the presence of the dev server by pinging $devServerInternal to make sure it's running?
     */
    public bool $checkDevServer = false;

    /**

Missing short description in doc comment

     * @var bool Whether the react-refresh-shim should be included
     */
    public bool $includeReactRefreshShim = false;

    /**

Missing short description in doc comment

     * @var bool Whether the modulepreload-polyfill shim should be included
     */
    public bool $includeModulePreloadShim = true;

    /**

Missing short description in doc comment

     * @var string File system path (or URL) to where the Critical CSS files are stored
     */
    public string $criticalPath = '';

    /**

Missing short description in doc comment

     * @var string the suffix added to the name of the currently rendering template for the critical css file name
     */
    public string $criticalSuffix = '_critical.min.css';

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function rules(): array
    {
        return [
            [
                [
                    'useDevServer',
                    'checkDevServer',
                    'includeReactRefreshShim',
                    'includeModulePreloadShim',
                ],
                'boolean',
            ],
            [
                [
                    'manifestPath',
                    'devServerPublic',
                    'serverPublic',
                    'cacheKeySuffix',
                    'devServerInternal',
                ],
                'string',
            ],
            [
                [
                    'errorEntry',
                ],
                'string',
            ],
        ];
    }
}