ManifestVariable::includeFileFromManifest() - Code Metrics - Inspection of "Updated README.md" - nystudio107/craft-webperf - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v1 ( 887199...d7f64b )

by Andrew

created 2019-01-02 04:48 UTC

ManifestVariable::includeFileFromManifest() A

↳ Parent: ManifestVariable

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	2
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	3

<?php


namespace nystudio107\webperf\variables;

use nystudio107\webperf\assetbundles\webperf\WebperfAsset;
use nystudio107\webperf\helpers\Manifest as ManifestHelper;

use Craft;
filter:
    dependency_paths: ["lib/*"]
use craft\helpers\Template;
filter:
    dependency_paths: ["lib/*"]

class ManifestVariable

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

    protected static $config = [
        // If `devMode` is on, use webpack-dev-server to all for HMR (hot module reloading)
        'useDevServer' => false,
        // Manifest names
        'manifest'     => [
            'legacy' => 'manifest.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 WebperfAsset();
        $baseAssetsUrl = Craft::$app->assetManager->getPublishedUrl(
            $bundle->sourcePath,
            true
        );
        self::$config['server']['manifestPath'] = Craft::getAlias($bundle->sourcePath);
        self::$config['server']['publicPath'] = $baseAssetsUrl;
        $useDevServer = getenv('NYS_PLUGIN_DEVSERVER');
        if ($useDevServer !== false) {
            self::$config['useDevServer'] = (bool)$useDevServer;
        }
    }

    /**

     * @param string     $moduleName

     * @param bool       $async

     * @param null|array $config

     *
     * @return \Twig_Markup
     * @throws \yii\web\NotFoundHttpException
     */
    public function includeCssModule(string $moduleName, bool $async = false, $config = null): \Twig_Markup
    public function includeCssModule(string $moduleName, bool $async = false, /** @scrutinizer ignore-unused */ $config = null): \Twig_Markup
    {
        return Template::raw(
            ManifestHelper::getCssModuleTags(self::$config, $moduleName, $async)
        );
    }

    /**
     * Returns the CSS file in $path wrapped in <style></style> tags
     *
     * @param string $path

     *
     * @return \Twig_Markup
     */
    public function includeInlineCssTags(string $path): \Twig_Markup
    {
        return Template::raw(
            ManifestHelper::getCssInlineTags($path)
        );
    }

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

    /**

     * @param string     $moduleName

     * @param bool       $async

     * @param null|array $config

     *
     * @return null|\Twig_Markup
     * @throws \yii\web\NotFoundHttpException
     */
    public function includeJsModule(string $moduleName, bool $async = false, $config = null)
    public function includeJsModule(string $moduleName, bool $async = false, /** @scrutinizer ignore-unused */ $config = null)
    {
        return Template::raw(
            ManifestHelper::getJsModuleTags(self::$config, $moduleName, $async)
        );
    }

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

     * @param string $type

     * @param null   $config

     *
     * @return null|\Twig_Markup
     * @throws \yii\web\NotFoundHttpException
     */
    public function getModuleUri(string $moduleName, string $type = 'modern', $config = null)
    public function getModuleUri(string $moduleName, string $type = 'modern', /** @scrutinizer ignore-unused */ $config = null)
    {
        return Template::raw(
            ManifestHelper::getModule(self::$config, $moduleName, $type)
        );
    }

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

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

     *
     * @return \Twig_Markup
     */
    public function includeFile(string $path): \Twig_Markup
    {
        return Template::raw(
            ManifestHelper::getFile($path)
        );
    }

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

     * @param string $type

     * @param null   $config

     *
     * @return \Twig_Markup
     */
    public function includeFileFromManifest(string $fileName, string $type = 'legacy', $config = null): \Twig_Markup
    {
        return Template::raw(
            ManifestHelper::getFileFromManifest($config, $fileName, $type)
            ManifestHelper::getFileFromManifest(/** @scrutinizer ignore-type */ $config, $fileName, $type)
        );
    }
}


nystudio107 / craft-webperf

Push — v1 ( 887199...d7f64b )

ManifestVariable::includeFileFromManifest() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like