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/
 * @copyright Copyright (c) 2018 nystudio107
 */

namespace nystudio107\twigpack\services;

use nystudio107\twigpack\Twigpack;
use nystudio107\twigpack\helpers\Manifest as ManifestHelper;

use craft\base\Component;

use yii\web\NotFoundHttpException;

/** @noinspection MissingPropertyAnnotationsInspection */

/**
 * @author    nystudio107
 * @package   Twigpack
 * @since     1.0.0
 */
class Manifest extends Component
{
    // Public Methods
    // =========================================================================

    /**
     * Return the HTML tags to include the CSS
     *
     * @param string $moduleName
     * @param bool $async
     * @param null|array $config
     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag
     *
     * @return string
     * @throws NotFoundHttpException
     */
    public function getCssModuleTags(string $moduleName, bool $async = false, $config = null, array $attributes = []): string
    {
        $settings = Twigpack::$plugin->getSettings();
        $config = $config ?? $settings->getAttributes();

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

    /**
     * Returns the CSS file in $path wrapped in <style></style> tags
     *
     * @param $path
     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag
     *
     * @return string
     */
    public function getCssInlineTags(string $path, array $attributes = []): string
    {
        return ManifestHelper::getCssInlineTags($path, $attributes);
    }

    /**
     * @param array $config
     * @param null|string $name
     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag
     *
     * @return string
     * @throws \Twig\Error\LoaderError
     */
    public function getCriticalCssTags($name = null, $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
     * @param bool       $async
     * @param null|array $config
     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag
     *
     * @return null|string
     * @throws NotFoundHttpException
     */
    public function getJsModuleTags(string $moduleName, bool $async = false, $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
     * @param string $type
     * @param null   $config

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

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

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

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

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

     *
     * @return null|string
     * @throws NotFoundHttpException
     */
    public function getModuleHash(string $moduleName, string $type = 'modern', $config = null)
    {
        $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
     *
     * @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
     * @param string $type
     * @param null   $config

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

     *
     * @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
     */
    public function invalidateCaches()
    {
        ManifestHelper::invalidateCaches();
    }
}