AssetManager::createJsFiles() - Code Metrics - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

AssetManager::createJsFiles() B
last analyzed 2025-01-08 16:45 UTC

↳ Parent: AssetManager
Complexity

Conditions	11
Paths	6
Size

Total Lines	33
Code Lines	16
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	16
c	1
b	0
f	0
dl	0
loc	33
rs	7.3166
cc	11
nc	6
nop	1
How to fix Complexity

<?php

namespace Jaxon\Plugin\Code;

use Jaxon\App\Config\ConfigManager;
use Jaxon\Plugin\AbstractPlugin;
use Jaxon\Request\Handler\ParameterReader;
use Jaxon\Utils\Http\UriException;

use function file_put_contents;
use function is_dir;
use function is_file;
use function is_writable;
use function rtrim;

class AssetManager
{
    /**
     * @var ConfigManager
     */
    protected $xConfigManager;

    /**
     * @var ParameterReader
     */
    private $xParameterReader;

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

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

    /**
     * The constructor
     *
     * @param ConfigManager $xConfigManager
     * @param ParameterReader $xParameterReader
     * @param MinifierInterface $xMinifier
     */
    public function __construct(ConfigManager $xConfigManager, ParameterReader $xParameterReader, MinifierInterface $xMinifier)
    {
        $this->xConfigManager = $xConfigManager;
        $this->xParameterReader = $xParameterReader;
        $this->xMinifier = $xMinifier;
    }

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

    /**
     * Check if the assets of this plugin shall be included in Jaxon generated code.
     *
     * @param AbstractPlugin $xPlugin
     *
     * @return bool
     */
    public function shallIncludeAssets(AbstractPlugin $xPlugin): bool
    {
        $sPluginOptionName = 'assets.include.' . $xPlugin->getName();
        if($this->xConfigManager->hasOption($sPluginOptionName))
        {
            return $this->xConfigManager->getOption($sPluginOptionName);

        }
        return $this->xConfigManager->getOption('assets.include.all', true);
    }

    /**
     * Get the HTML tags to include Jaxon javascript files into the page
     *
     * @return array
     */
    public function getJsLibFiles(): array
    {
        $sJsExtension = $this->xConfigManager->getOption('js.app.minify') ? '.min.js' : '.js';
        // The URI for the javascript library files
        $sJsLibUri = $this->xConfigManager->getOption('js.lib.uri', self::JS_LIB_URL);
        $sJsLibUri = rtrim($sJsLibUri, '/');

        // Add component files to the javascript file array;
        $aJsFiles = [
            $this->xConfigManager->getOption('js.lib.jq', "$sJsLibUri/libs/chibi/chibi$sJsExtension"),
            "$sJsLibUri/jaxon.core$sJsExtension",
        ];
        if($this->xConfigManager->getOption('core.debug.on'))
        {
            $sLanguage = $this->xConfigManager->getOption('core.language');
            $aJsFiles[] = "$sJsLibUri/jaxon.debug$sJsExtension";
            $aJsFiles[] = "$sJsLibUri/lang/jaxon.$sLanguage$sJsExtension";
        }

        return $aJsFiles;
    }

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

    /**
     * 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->xConfigManager->getOption('js.app.export', false) ||
            !$this->xConfigManager->getOption('js.app.uri') ||
            !$this->xConfigManager->getOption('js.app.dir'))
        {
            return false;
        }
        return true;
    }

    /**
     * Write javascript files and return the corresponding URI
     *
     * @param CodeGenerator $codeGenerator
     *
     * @return string
     */
    public function createJsFiles(CodeGenerator $xCodeGenerator): string
    {
        if(!$this->shallCreateJsFiles())
        {
            return '';
        }

        // Check dir access
        $sJsFileName = $this->xConfigManager->getOption('js.app.file') ?: $xCodeGenerator->getHash();
        $sJsDirectory = rtrim($this->xConfigManager->getOption('js.app.dir'), '\/') . DIRECTORY_SEPARATOR;
        $sJsDirectory = rtrim(/** @scrutinizer ignore-type */ $this->xConfigManager->getOption('js.app.dir'), '\/') . DIRECTORY_SEPARATOR;
        // - The js.app.dir must be writable
        if(!$sJsFileName || !is_dir($sJsDirectory) || !is_writable($sJsDirectory))
        {
            return '';
        }

        $sJsFilePath = $sJsDirectory . $sJsFileName . '.js';
        $sJsMinFilePath = $sJsDirectory . $sJsFileName . '.min.js';
        $sJsFileUri = rtrim($this->xConfigManager->getOption('js.app.uri'), '/') . "/$sJsFileName";
        if(!is_file($sJsFilePath) && !@file_put_contents($sJsFilePath, $xCodeGenerator->getJsScript()))
        {
            return '';
        }
        if(!$this->xConfigManager->getOption('js.app.minify', false))
        {
            return $sJsFileUri . '.js';
        }
        if(!is_file($sJsMinFilePath) && !$this->xMinifier->minify($sJsFilePath, $sJsMinFilePath))
        {
            // If the file cannot be minified, return the plain js file.
            return $sJsFileUri . '.js';
        }
        return $sJsFileUri . '.min.js';
    }
}

jaxon-php / jaxon-core

AssetManager::createJsFiles() B last analyzed 2025-01-08 16:45 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

AssetManager::createJsFiles() B
last analyzed 2025-01-08 16:45 UTC
