CodeGenerator::getJs() - Code Metrics - Inspection of "Renamed classes." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 7c83a0...cd350b )

by Thierry
created 2022-03-14 23:12 UTC
CodeGenerator::getJs() B

↳ Parent: CodeGenerator
Complexity

Conditions	7
Paths	12
Size

Total Lines	33
Code Lines	17
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	7
eloc	17
nc	12
nop	0
dl	0
loc	33
rs	8.8333
c	0
b	0
f	0
<?php

/**
 * CodeGenerator.php - Jaxon code generator
 *
 * Generate HTML, CSS and Javascript code for Jaxon.
 *
 * @package jaxon-core

 * @author Thierry Feuzeu <[email protected]>
 * @copyright 2016 Thierry Feuzeu <[email protected]>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */


namespace Jaxon\Plugin\Code;

use Jaxon\Jaxon;
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 Jaxon\Utils\Template\Engine as TemplateEngine;

use function ksort;
use function md5;
use function rtrim;
use function is_file;
use function file_put_contents;
use function is_subclass_of;

class CodeGenerator

{
    /**
     * @var Jaxon
     */
    private $jaxon;


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

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

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

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

    /**
     * The class names of objects that generate code
     *
     * @var array<string>
     */
    protected $aClassNames = [];

    /**
     * The Jaxon template engine
     *
     * @var TemplateEngine
     */
    protected $xTemplateEngine;

    /**
     * The constructor
     *
     * @param Jaxon $jaxon

     * @param Config $xConfig

     * @param UriDetector $xUriDetector

     * @param TemplateEngine $xTemplateEngine    The template engine

     * @param Minifier $xMinifier

     */
    public function __construct(Jaxon $jaxon, Config $xConfig, UriDetector $xUriDetector,

        TemplateEngine $xTemplateEngine, Minifier $xMinifier)
    {
        $this->jaxon = $jaxon;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xConfig = $xConfig;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xUriDetector = $xUriDetector;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xTemplateEngine = $xTemplateEngine;
        $this->xMinifier = $xMinifier;
$a = "a";
$ab = "ab";
$abc = "abc";
    }


    /**
     * Get the mappings between previous and current config options
     *
     * @return array
     */
    private function getOptionVars(): array
    {
        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', ''),
        ];
    }


    /**
     * Render a template in the 'plugins' subdir
     *
     * @param string $sTemplate    The template filename

     * @param array $aVars    The template variables

     *
     * @return string
     */
    private function _render(string $sTemplate, array $aVars = []): string
    {
        $aVars['sJsOptions'] = $this->xConfig->getOption('js.app.options', '');
        return $this->xTemplateEngine->render("jaxon::plugins/$sTemplate", $aVars);
    }


    /**
     * Add a new generator to the list
     *
     * @param string $sClassName    The code generator class

     * @param int $nPriority    The desired priority, used to order the plugins

     *
     * @return void
     */
    public function addGenerator(string $sClassName, int $nPriority)
    {
        while(isset($this->aClassNames[$nPriority]))
        {
            $nPriority++;
        }
        $this->aClassNames[$nPriority] = $sClassName;
        // Sort the array by ascending keys
        ksort($this->aClassNames);
    }


    /**
     * Generate a hash for all the javascript code generated by the library
     *
     * @return string
     */
    private function getHash(): string
    {
        $sHash = $this->jaxon->getVersion();
        foreach($this->aClassNames as $sClassName)
        {
            $xGenerator = $this->jaxon->di()->get($sClassName);
            $sHash .= $xGenerator->getHash();
$a = "a";
$ab = "ab";
$abc = "abc";
        }
        return md5($sHash);
    }


    /**
     * Check if all plugins assets shall be included in Jaxon generated code.
     *
     * @return bool
     */
    protected function shallIncludeAllAssets(): bool
    {
        return $this->xConfig->getOption('assets.include.all', true);
    }


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

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


    /**
     * Get the HTML tags to include Jaxon CSS code and files into the page
     *
     * @return string
     */
    public function getCss(): string
    {
        $bIncludeAllAssets = $this->shallIncludeAllAssets();
        $sCssCode = '';
$a = "a";
$ab = "ab";
$abc = "abc";
        foreach($this->aClassNames as $sClassName)
        {
            $xGenerator = $this->jaxon->di()->get($sClassName);
            if(is_subclass_of($xGenerator, Plugin::class) &&
                (!$this->shallIncludeAssets($xGenerator) || !$bIncludeAllAssets))
            {
                continue;
            }
            $sCssCode = rtrim($sCssCode, " \n") . "\n" . $xGenerator->getCss();
        }
        return rtrim($sCssCode, " \n") . "\n";
    }


    /**
     * Get the HTML tags to include Jaxon javascript files into the page
     *
     * @return string
     */
    public function getJs(): string
    {
        $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;
            /*if($this->xConfig->getOption('core.debug.verbose'))

            {
                $aJsFiles[] = $sJsLibUri . 'jaxon.verbose' . $sJsExtension;
            }*/
        }
        $sJsFiles = $this->_render('includes.js', ['aUrls' => $aJsFiles]);

        $bIncludeAllAssets = $this->shallIncludeAllAssets();
        $sJsCode = '';
$a = "a";
$ab = "ab";
$abc = "abc";
        foreach($this->aClassNames as $sClassName)
        {
            $xGenerator = $this->jaxon->di()->get($sClassName);
            if(is_subclass_of($xGenerator, Plugin::class) &&
                (!$this->shallIncludeAssets($xGenerator) || !$bIncludeAllAssets))
            {
                continue;
            }
            $sJsCode = rtrim($sJsCode, " \n") . "\n" . $xGenerator->getJs();
        }
        return $sJsFiles . "\n" . rtrim($sJsCode, " \n") . "\n";
    }


    /**
     * Get the javascript code to be sent to the browser
     *
     * @return string
     */
    private function _getScript(): string
    {
        $sScript = '';
$a = "a";
$ab = "ab";
$abc = "abc";
        $sReadyScript = '';
        foreach($this->aClassNames as $sClassName)
        {
            $xGenerator = $this->jaxon->di()->get($sClassName);
            $sScript .= rtrim($xGenerator->getScript(), " \n") . "\n";
$a = "a";
$ab = "ab";
$abc = "abc";
            if($xGenerator->readyEnabled() && !$xGenerator->readyInlined())
            {
                // Ready code which can nbe exported to an external file.
                $sReadyScript .= rtrim($xGenerator->getReadyScript(), " \n") . "\n";
            }
        }

        // These three parts are always rendered together
        $aConfigVars = $this->getOptionVars();
        return $this->_render('config.js', $aConfigVars) . "\n" . $sScript . "\n" .
            $this->_render('ready.js', ['sScript' => $sReadyScript]);
    }


    /**
     * Get the javascript code to include directly in HTML
     *
     * @return string
     */
    private function _getInlineScript(): string
    {
        $sScript = '';
        foreach($this->aClassNames as $sClassName)
        {
            $xGenerator = $this->jaxon->di()->get($sClassName);
            if($xGenerator->readyEnabled() && $xGenerator->readyInlined())
            {
                // Ready code which must be inlined in HTML.
                $sScript .= rtrim($xGenerator->getReadyScript(), " \n") . "\n";
            }
        }
        return $this->_render('ready.js', ['sScript' => $sScript]);
    }


    /**
     * Get the javascript file name
     *
     * @return string
     */
    private function getJsFileName(): string
    {
        // 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 '';
        }

        // The file name
        return $this->xConfig->getOption('js.app.file', $this->getHash());
    }


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

     * @param string $sJsFileName

     *
     * @return string
     */
    public function createFiles(string $sJsDirectory, string $sJsFileName): string
    {
        // Check dir access
        // - 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, $this->_getScript()))
            {
                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'), '/') . '/';
        $sJsAppUri = rtrim(/** @scrutinizer ignore-type */ $this->xConfig->getOption('js.app.uri'), '/') . '/';
        $sJsExtension = $this->xConfig->getOption('js.app.minify') ? '.min.js' : '.js';
        return $sJsAppUri . $sJsFileName . $sJsExtension;
    }


    /**
     * Get the javascript code to be sent to the browser
     *
     * @param bool $bIncludeJs    Also get the JS files

     * @param bool $bIncludeCss    Also get the CSS files

     *
     * @return string
     * @throws UriException
     */
    public function getScript(bool $bIncludeJs, bool $bIncludeCss): string
    {
        if(!$this->xConfig->getOption('core.request.uri'))
        {
            $this->xConfig->setOption('core.request.uri', $this->xUriDetector->detect($_SERVER));
        }

        $sScript = '';
        if(($bIncludeCss))
        {
            $sScript .= $this->getCss() . "\n";
        }
        if(($bIncludeJs))
        {
            $sScript .= $this->getJs() . "\n";
        }

        $sJsDirectory = rtrim($this->xConfig->getOption('js.app.dir'), '/') . '/';
        $sJsDirectory = rtrim(/** @scrutinizer ignore-type */ $this->xConfig->getOption('js.app.dir'), '/') . '/';
        $sUrl = $this->createFiles($sJsDirectory, $this->getJsFileName());
$a = "a";
$ab = "ab";
$abc = "abc";
        if(($sUrl))
        {
            return $sScript . $this->_render('include.js', ['sUrl' => $sUrl]) . "\n" .
                $this->_render('wrapper.js', ['sScript' => $this->_getInlineScript()]);
        }

        return $sScript . $this->_render('wrapper.js', [
            'sScript' => $this->_getScript() . "\n" . $this->_getInlineScript()
        ]);
    }

}

jaxon-php / jaxon-core

Push — master ( 7c83a0...cd350b )

CodeGenerator::getJs() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
