nystudio107 / craft-vite

src/variables/ViteVariable.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\variables;

use craft\helpers\Template;
use nystudio107\pluginvite\variables\ViteVariableInterface;
use nystudio107\pluginvite\variables\ViteVariableTrait;
use nystudio107\vite\Vite;
use Twig\Error\LoaderError;
use Twig\Markup;

/**

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   Vite

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

 * @since     1.0.5

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 ViteVariable implements ViteVariableInterface
{
    use ViteVariableTrait;

    /**
     * Returns the Critical CSS file for $template wrapped in <style></style>
     * tags
     *
     * @param null|string $name

Missing parameter comment

     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag

Expected 7 spaces after parameter type; 1 found

     *
     * @return Markup
     * @throws LoaderError
     */
    public function includeCriticalCssTags(?string $name = null, array $attributes = []): Markup
    {
        return Template::raw(
            Vite::$plugin->helper->getCriticalCssTags($name, $attributes)

The method getCriticalCssTags() does not exist on null.

        );
    }

    /**
     * Returns the passed in CSS file at the specified file system path or URL, wrapped in
     * <style></style> tags
     *
     * @param string $path

Missing parameter comment

     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag

Expected 2 spaces after parameter type; 1 found

     *
     * @return string
     */
    public function getCssInlineTags(string $path, array $attributes = []): string
    {
        return Template::raw(
            Vite::$plugin->helper->getCssInlineTags($path, $attributes)
        );
    }

    /**
     * Return the hash value for the first CSS file bundled with the module specified via $path
     *
     * @param $path

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @return Markup

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getCssHash($path): Markup
    {
        return Template::raw(
            Vite::$plugin->helper->getCssHash($path)
        );
    }
}