nystudio107 / craft-twigpack

src/variables/ManifestVariable.php

<?php
/**
 * Twigpack plugin for Craft CMS 3.x
 *
 * Twigpack is the conduit between Twig and webpack, with manifest.json &
 * webpack-dev-server HMR support
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 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\twigpack\variables;

use craft\helpers\Template;
use nystudio107\twigpack\Twigpack;
use Twig\Error\LoaderError;
use Twig\Markup;
use yii\web\NotFoundHttpException;

/**

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   Twigpack

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 ManifestVariable
{
    // Public Methods
    // =========================================================================

    /**
     * Returns the uglified loadCSS rel=preload Polyfill as per:
     * https://github.com/filamentgroup/loadCSS#how-to-use-loadcss-recommended-example
     *
     * @return Markup
     */
    public static function includeCssRelPreloadPolyfill(): Markup
    {
        return Template::raw(
            Twigpack::$plugin->manifest->getCssRelPreloadPolyfill()
        );
    }

    /**

Missing short description in doc comment

     * @param string $moduleName

Missing parameter comment

     * @param bool $async

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

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

Expected 2 spaces after parameter type; 1 found

     *
     * @return Markup
     * @throws NotFoundHttpException
     */
    public function includeCssModule(string $moduleName, bool $async = false, array $attributes = []): Markup
    {
        return Template::raw(
            Twigpack::$plugin->manifest->getCssModuleTags($moduleName, $async, null, $attributes)
        );
    }

    /**
     * Returns the CSS file in $path 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 Markup
     */
    public function includeInlineCssTags(string $path, array $attributes = []): Markup
    {
        return Template::raw(
            Twigpack::$plugin->manifest->getCssInlineTags($path, $attributes)
        );
    }

    /**
     * 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(
            Twigpack::$plugin->manifest->getCriticalCssTags($name, null, $attributes)
        );
    }

    /**

Missing short description in doc comment

     * @param string $moduleName

Missing parameter comment

     * @param bool $async

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

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

Expected 2 spaces after parameter type; 1 found

     *
     * @return Markup
     * @throws NotFoundHttpException
     */
    public function includeJsModule(string $moduleName, bool $async = false, array $attributes = []): Markup
    {
        return Template::raw(
            Twigpack::$plugin->manifest->getJsModuleTags($moduleName, $async, null, $attributes)
        );
    }

    /**
     * Return the URI to a module
     *
     * @param string $moduleName

Missing parameter comment

     * @param string $type

Missing parameter comment

     * @param null $config

Are you sure the doc-type for parameter $config is correct as it would always require null to be passed?

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return Markup
     * @throws NotFoundHttpException
     */
    public function getModuleUri(string $moduleName, string $type = 'modern', $config = null): Markup
    {
        return Template::raw(
            Twigpack::$plugin->manifest->getModule($moduleName, $type, $config)

It seems like nystudio107\twigpack\Twigpack::plugin->manifest->getModule($moduleName, $type, $config) can also be of type null; however, parameter $value of craft\helpers\Template::raw() does only seem to accept string, maybe add an additional type check?

        );
    }

    /**
     * Return the HASH value from a module
     *
     * @param string $moduleName

Missing parameter comment

     * @param string $type

Missing parameter comment

     * @param null $config

Are you sure the doc-type for parameter $config is correct as it would always require null to be passed?

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return Markup
     * @throws NotFoundHttpException
     */
    public function getModuleHash(string $moduleName, string $type = 'modern', $config = null): Markup
    {
        return Template::raw(
            Twigpack::$plugin->manifest->getModuleHash($moduleName, $type, $config)
        );
    }

    /**
     * Include the Safari 10.1 nomodule fix JavaScript
     *
     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag
     *
     * @return Markup
     */
    public function includeSafariNomoduleFix(array $attributes = []): Markup
    {
        return Template::raw(
            Twigpack::$plugin->manifest->getSafariNomoduleFix($attributes)
        );
    }

    /**
     * Returns the contents of a file from a URI path
     *
     * @param string $path

Missing parameter comment

     *
     * @return Markup
     */
    public function includeFile(string $path): Markup
    {
        return Template::raw(
            Twigpack::$plugin->manifest->getFile($path)
        );
    }

    /**
     * Returns the contents of a file from the $fileName in the manifest
     *
     * @param string $fileName

Missing parameter comment

     * @param string $type

Missing parameter comment

     * @param null $config

Are you sure the doc-type for parameter $config is correct as it would always require null to be passed?

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return Markup
     */
    public function includeFileFromManifest(string $fileName, string $type = 'legacy', $config = null): Markup
    {
        return Template::raw(
            Twigpack::$plugin->manifest->getFileFromManifest($fileName, $type, $config)
        );
    }
}