nystudio107\transcoder\variables\ManifestVariable

Complexity

Total Complexity

6

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	includeJsModule()	0	4	1
A	includeCssRelPreloadPolyfill()	0	4	1
A	__construct()	0	5	1
A	includeSafariNomoduleFix()	0	4	1
A	getModuleUri()	0	4	1
A	includeCssModule()	0	4	1

<?php

Missing file doc comment

namespace nystudio107\transcoder\variables;

use nystudio107\transcoder\helpers\Manifest as ManifestHelper;
use nystudio107\transcoder\assetbundles\transcoder\TranscoderAsset;

use Craft;
use craft\helpers\Template;

class ManifestVariable

Missing doc comment for class ManifestVariable

{
    // Protected Static Properties
    // =========================================================================

    protected static $config = [
        // If `devMode` is on, use webpack-dev-server to all for HMR (hot module reloading)
        'useDevServer' => true,
        // Manifest names
        'manifest'     => [
            'legacy' => 'manifest-legacy.json',
            'modern' => 'manifest.json',
        ],
        // Public server config
        'server'       => [
            'manifestPath' => '/',
            'publicPath' => '/',
        ],
        // webpack-dev-server config
        'devServer'    => [
            'manifestPath' => 'http://127.0.0.1:8080',
            'publicPath' => '/',
        ],
    ];

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

    /**
     * ManifestVariable constructor.
     */
    public function __construct()
    {
        ManifestHelper::invalidateCaches();
        $bundle = new TranscoderAsset();
        self::$config['server']['manifestPath'] = Craft::getAlias($bundle->sourcePath);
    }

    /**

Missing short description in doc comment

     * @param string     $moduleName

Missing parameter comment

     * @param bool       $async

Missing parameter comment

     * @param null|array $config

Missing parameter comment

     *
     * @return null|\Twig_Markup
     * @throws \yii\web\NotFoundHttpException
     */
    public function includeCssModule(string $moduleName, bool $async = false, $config = null)

The parameter $config is not used and could be removed.

    {
        return Template::raw(
            ManifestHelper::getCssModuleTags(self::$config, $moduleName, $async)
        );
    }


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

    /**

Missing short description in doc comment

     * @param string     $moduleName

Missing parameter comment

     * @param bool       $async

Missing parameter comment

     * @param null|array $config

Missing parameter comment

     *
     * @return null|\Twig_Markup
     * @throws \yii\web\NotFoundHttpException
     */
    public function includeJsModule(string $moduleName, bool $async = false, $config = null)

The parameter $config is not used and could be removed.

    {
        return Template::raw(
            ManifestHelper::getJsModuleTags(self::$config, $moduleName, $async)
        );
    }

    /**
     * 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

     *
     * @return null|\Twig_Markup
     * @throws \yii\web\NotFoundHttpException
     */
    public function getModuleUri(string $moduleName, string $type = 'modern', $config = null)

The parameter $config is not used and could be removed.

    {
        return Template::raw(
            ManifestHelper::getModule(self::$config, $moduleName, $type)
        );
    }

    /**
     * Include the Safari 10.1 nomodule fix JavaScript
     *
     * @return \Twig_Markup
     */
    public function includeSafariNomoduleFix()
    {
        return Template::raw(
            ManifestHelper::getSafariNomoduleFix()
        );
    }
}