nystudio107\instantanalytics\variables\ManifestVariable

Complexity

Total Complexity

4

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	registerCssModules()	0	3	1
A	includeJsModule()	0	4	1
A	includeCssModule()	0	4	1
A	registerJsModules()	0	3	1

<?php

Missing file doc comment

namespace nystudio107\instantanalytics\variables;

use nystudio107\instantanalytics\helpers\Manifest as ManifestHelper;

use craft\helpers\Template;

use yii\base\InvalidConfigException;
use yii\web\NotFoundHttpException;

use Twig\Markup;

class ManifestVariable

Missing doc comment for class ManifestVariable

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

    /**
     * Get the passed in JS modules from the manifest, and register them in the current Craft view
     *
     * @param array $modules

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @throws InvalidConfigException

Tag @throws cannot be grouped with parameter tags in a doc comment

     * @throws NotFoundHttpException

Tag @throws cannot be grouped with parameter tags in a doc comment

     */

Missing @return tag in function comment

    public function registerJsModules(array $modules)
    {
        ManifestHelper::registerJsModules($modules);
    }

    /**
     * Get the passed in CS modules from the manifest, and register them in the current Craft view
     *
     * @param array $modules

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @throws InvalidConfigException

Tag @throws cannot be grouped with parameter tags in a doc comment

     * @throws NotFoundHttpException

Tag @throws cannot be grouped with parameter tags in a doc comment

     */

Missing @return tag in function comment

    public function registerCssModules(array $modules)
    {
        ManifestHelper::registerCssModules($modules);
    }

    /**
     * Get the passed in JS module from the manifest, then output a `<script src="">` tag for it in the HTML
     *
     * @param string     $moduleName

Missing parameter comment

     * @param bool       $async

Missing parameter comment

     * @param null|array $config

Missing parameter comment

Superfluous parameter comment

     *
     * @return null|Markup
     * @throws NotFoundHttpException
     */
    public function includeJsModule(string $moduleName, bool $async = false)
    {
        return Template::raw(
            ManifestHelper::includeJsModule($moduleName, $async) ?? ''
        );
    }

    /**
     * Get the passed in CS module from the manifest, then output a `<link>` tag for it in the HTML
     *
     * @param string     $moduleName

Missing parameter comment

     * @param bool       $async

Missing parameter comment

     * @param null|array $config

Missing parameter comment

Superfluous parameter comment

     *
     * @return Markup
     * @throws NotFoundHttpException
     */
    public function includeCssModule(string $moduleName, bool $async = false): Markup
    {
        return Template::raw(
            ManifestHelper::includeCssModule($moduleName, $async) ?? ''
        );
    }
}