nystudio107 / craft-twigpack

src/services/Manifest.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\services;

use craft\base\Component;
use nystudio107\twigpack\helpers\Manifest as ManifestHelper;
use nystudio107\twigpack\Twigpack;
use Twig\Error\LoaderError;
use yii\web\NotFoundHttpException;

/** @noinspection MissingPropertyAnnotationsInspection */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

/**

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 Manifest extends Component
{
    // Public Methods
    // =========================================================================

    /**
     * Return the HTML tags to include the CSS
     *
     * @param string $moduleName

Missing parameter comment

Expected 5 spaces after parameter type; 1 found

     * @param bool $async

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

     * @param null|array $config

Missing parameter comment

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

Expected 6 spaces after parameter type; 1 found

     *
     * @return string
     * @throws NotFoundHttpException
     */
    public function getCssModuleTags(string $moduleName, bool $async = false, $config = null, array $attributes = []): string
    {
        $settings = Twigpack::$plugin->getSettings();

The method getSettings() does not exist on null.

        $config = $config ?? $settings->getAttributes();

        return ManifestHelper::getCssModuleTags($config, $moduleName, $async, $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 string
     */
    public function getCssInlineTags(string $path, array $attributes = []): string
    {
        return ManifestHelper::getCssInlineTags($path, $attributes);
    }

    /**

Missing short description in doc comment

     * @param array $config

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

Doc comment for parameter $config does not match actual variable name $name

     * @param null|string $name

Missing parameter comment

Doc comment for parameter $name does not match actual variable name $config

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

Expected 7 spaces after parameter type; 1 found

     *
     * @return string
     * @throws LoaderError
     */
    public function getCriticalCssTags(?string $name = null, ?array $config = null, array $attributes = []): string
    {
        $settings = Twigpack::$plugin->getSettings();
        $config = $config ?? $settings->getAttributes();

        return ManifestHelper::getCriticalCssTags($config, $name, $attributes);
    }

    /**
     * Returns the uglified loadCSS rel=preload Polyfill as per:
     * https://github.com/filamentgroup/loadCSS#how-to-use-loadcss-recommended-example
     *
     * @return string
     */
    public function getCssRelPreloadPolyfill(): string
    {
        return ManifestHelper::getCssRelPreloadPolyfill();

The function nystudio107\twigpack\helpers\Manifest::getCssRelPreloadPolyfill() has been deprecated: in 1.2.0

    }

    /**
     * Return the HTML tags to include the JavaScript module
     *
     * @param string $moduleName

Missing parameter comment

Expected 5 spaces after parameter type; 1 found

     * @param bool $async

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

     * @param null|array $config

Missing parameter comment

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

Expected 6 spaces after parameter type; 1 found

     *
     * @return null|string
     * @throws NotFoundHttpException
     */
    public function getJsModuleTags(string $moduleName, bool $async = false, ?array $config = null, array $attributes = [])
    {
        $settings = Twigpack::$plugin->getSettings();
        $config = $config ?? $settings->getAttributes();

        return ManifestHelper::getJsModuleTags($config, $moduleName, $async, $attributes);
    }

    /**
     * Return the Safari 10.1 nomodule JavaScript fix
     *
     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag
     *
     * @return string
     */
    public function getSafariNomoduleFix(array $attributes = []): string
    {
        return ManifestHelper::getSafariNomoduleFix($attributes);
    }

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

Missing parameter comment

     * @param string $type

Missing parameter comment

     * @param ?array $config

Missing parameter comment

     *
     * @return null|string
     * @throws NotFoundHttpException
     */
    public function getModule(string $moduleName, string $type = 'modern', $config = null): ?string
    {
        $settings = Twigpack::$plugin->getSettings();
        $config = $config ?? $settings->getAttributes();

        return ManifestHelper::getModule($config, $moduleName, $type);
    }

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

Missing parameter comment

     * @param string $type

Missing parameter comment

     * @param ?array $config

Missing parameter comment

     *
     * @return null|string
     * @throws NotFoundHttpException
     */
    public function getModuleHash(string $moduleName, string $type = 'modern', $config = null): ?string
    {
        $settings = Twigpack::$plugin->getSettings();
        $config = $config ?? $settings->getAttributes();

        return ManifestHelper::getModuleHash($config, $moduleName, $type);
    }

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

Missing parameter comment

     *
     * @return string
     */
    public function getFile(string $path): string
    {
        return ManifestHelper::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 ?array $config

Missing parameter comment

     *
     * @return string
     */
    public function getFileFromManifest(string $fileName, string $type = 'legacy', $config = null): string
    {
        $settings = Twigpack::$plugin->getSettings();
        $config = $config ?? $settings->getAttributes();

        return ManifestHelper::getFileFromManifest($config, $fileName, $type);
    }

    /**
     * Invalidate the manifest cache
     */

Missing @return tag in function comment

    public function invalidateCaches()
    {
        ManifestHelper::invalidateCaches();
    }
}