Jaxon\Plugin\Code\AssetManager

Complexity

Total Complexity

25

Size/Duplication

Total Lines	181
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getOptionVars()	0	22	4
A	__construct()	0	6	1
B	createJsFiles()	0	31	10
A	getJsOptions()	0	3	1
A	shallIncludeAssets()	0	8	2
A	getJsLibFiles()	0	14	3
A	shallCreateJsFiles()	0	12	4

<?php

Missing file doc comment

namespace Jaxon\Plugin\Code;

use Jaxon\Plugin\Plugin;
use Jaxon\Utils\Config\Config;
use Jaxon\Utils\File\Minifier;
use Jaxon\Utils\Http\UriDetector;
use Jaxon\Utils\Http\UriException;

use function rtrim;
use function is_file;
use function file_put_contents;

class AssetManager

Missing doc comment for class AssetManager

{
    /**
     * @var Config
     */
    protected $xConfig;

Expected 1 blank line(s) before first member var; 0 found

    /**
     * @var UriDetector
     */
    private $xUriDetector;

    /**
     * @var Minifier
     */
    private $xMinifier;

    /**
     * @var bool

Expected "boolean" but found "bool" for @var tag in member variable comment

     */
    protected $bIncludeAllAssets;

    /**
     * Default library URL
     *
     * @var string
     */
    const JS_LIB_URL = 'https://cdn.jsdelivr.net/gh/jaxon-php/jaxon-js@3.3/dist';

    /**
     * The constructor
     *
     * @param Config $xConfig

Missing parameter comment

Expected 6 spaces after parameter type; 1 found

     * @param UriDetector $xUriDetector

Missing parameter comment

     * @param Minifier $xMinifier

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     */
    public function __construct(Config $xConfig, UriDetector $xUriDetector, Minifier $xMinifier)

Expected 2 blank lines before function; 1 found

    {
        $this->xConfig = $xConfig;

Equals sign not aligned with surrounding assignments; expected 11 spaces but found 1 space

        $this->xUriDetector = $xUriDetector;

Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

        $this->xMinifier = $xMinifier;

Equals sign not aligned with surrounding assignments; expected 9 spaces but found 1 space

        $this->bIncludeAllAssets = $xConfig->getOption('assets.include.all', true);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get js options
     *
     * @return string
     */
    public function getJsOptions(): string
    {
        return $this->xConfig->getOption('js.app.options', '');
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check if the assets of this plugin shall be included in Jaxon generated code.
     *
     * @param Plugin $xPlugin

Missing parameter comment

     *
     * @return bool
     */
    public function shallIncludeAssets(Plugin $xPlugin): bool
    {
        if($this->bIncludeAllAssets)
        {
            return true;
        }
        $sPluginOptionName = 'assets.include.' . $xPlugin->getName();
        return $this->xConfig->getOption($sPluginOptionName, true);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the HTML tags to include Jaxon javascript files into the page
     *
     * @return array
     */
    public function getJsLibFiles(): array
    {
        $sJsExtension = $this->xConfig->getOption('js.app.minify') ? '.min.js' : '.js';
        // The URI for the javascript library files
        $sJsLibUri = rtrim($this->xConfig->getOption('js.lib.uri', self::JS_LIB_URL), '/') . '/';
        // Add component files to the javascript file array;
        $aJsFiles = [$sJsLibUri . 'jaxon.core' . $sJsExtension];
        if($this->xConfig->getOption('core.debug.on'))
        {
            $sLanguage = $this->xConfig->getOption('core.language');
            $aJsFiles[] = $sJsLibUri . 'jaxon.debug' . $sJsExtension;
            $aJsFiles[] = $sJsLibUri . 'lang/jaxon.' . $sLanguage . $sJsExtension;
        }
        return $aJsFiles;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the mappings between previous and current config options
     *
     * @return array
     * @throws UriException
     */
    public function getOptionVars(): array
    {
        if(!$this->xConfig->hasOption('core.request.uri'))
        {
            $this->xConfig->setOption('core.request.uri', $this->xUriDetector->detect($_SERVER));
        }
        return [
            'sResponseType'         => 'JSON',
            'sVersion'              => $this->xConfig->getOption('core.version'),
            'sLanguage'             => $this->xConfig->getOption('core.language'),
            'bLanguage'             => $this->xConfig->hasOption('core.language'),
            'sRequestURI'           => $this->xConfig->getOption('core.request.uri'),
            'sDefaultMode'          => $this->xConfig->getOption('core.request.mode'),
            'sDefaultMethod'        => $this->xConfig->getOption('core.request.method'),
            'sCsrfMetaName'         => $this->xConfig->getOption('core.request.csrf_meta'),
            'bDebug'                => $this->xConfig->getOption('core.debug.on'),
            'bVerboseDebug'         => $this->xConfig->getOption('core.debug.verbose'),
            'sDebugOutputID'        => $this->xConfig->getOption('core.debug.output_id'),
            'nResponseQueueSize'    => $this->xConfig->getOption('js.lib.queue_size'),
            'sStatusMessages'       => $this->xConfig->getOption('js.lib.show_status') ? 'true' : 'false',
            'sWaitCursor'           => $this->xConfig->getOption('js.lib.show_cursor') ? 'true' : 'false',
            'sDefer'                => $this->xConfig->getOption('js.app.options', ''),
        ];
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the javascript file name
     *
     * @return bool
     */
    public function shallCreateJsFiles(): bool
    {
        // Check config options
        // - The js.app.export option must be set to true
        // - The js.app.uri and js.app.dir options must be set to non null values
        if(!$this->xConfig->getOption('js.app.export', false) ||
            !$this->xConfig->getOption('js.app.uri', false) ||
            !$this->xConfig->getOption('js.app.dir', false))
        {
            return false;
        }
        return true;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Write javascript files and return the corresponding URI
     *
     * @param string $sHash

Missing parameter comment

     * @param string $sJsCode

Missing parameter comment

     *
     * @return string
     */
    public function createJsFiles(string $sHash, string $sJsCode): string
    {
        // Check dir access
        $sJsFileName = $this->xConfig->getOption('js.app.file', $sHash);
        $sJsDirectory = rtrim($this->xConfig->getOption('js.app.dir'), '/') . '/';

It seems like $this->xConfig->getOption('js.app.dir') can also be of type null; however, parameter $string of rtrim() does only seem to accept string, maybe add an additional type check?

        // - The js.app.dir must be writable
        if(!$sJsFileName || !is_dir($sJsDirectory) || !is_writable($sJsDirectory))
        {
            return '';
        }

        $sOutFile = $sJsFileName . '.js';
        $sMinFile = $sJsFileName . '.min.js';
        if(!is_file($sJsDirectory . $sOutFile))
        {
            if(!file_put_contents($sJsDirectory . $sOutFile, $sJsCode))
            {
                return '';
            }
        }
        if(($this->xConfig->getOption('js.app.minify')) && !is_file($sJsDirectory . $sMinFile))
        {
            if(!$this->xMinifier->minify($sJsDirectory . $sOutFile, $sJsDirectory . $sMinFile))
            {
                return '';
            }
        }

        $sJsAppUri = rtrim($this->xConfig->getOption('js.app.uri'), '/') . '/';

Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space

        $sJsExtension = $this->xConfig->getOption('js.app.minify') ? '.min.js' : '.js';
        return $sJsAppUri . $sJsFileName . $sJsExtension;
    }

Expected 2 blank lines after function; 0 found

}