Jaxon\Plugin\Code\CodeGenerator

Complexity

Total Complexity

24

Size/Duplication

Total Lines	287
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	renderCodes()	0	18	3
A	render()	0	4	1
A	getHash()	0	5	1
A	generatePluginCodes()	0	16	5
A	addCodeGenerator()	0	7	2
A	getJsScript()	0	3	1
A	getJs()	0	4	1
A	getCss()	0	4	1
A	generateCodes()	0	42	4
A	getScript()	0	20	4

<?php

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

Package name "jaxon-core" is not valid; consider "Jaxoncore" instead

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

Missing @category tag in file comment

PHP version not specified

namespace Jaxon\Plugin\Code;

use Jaxon\Di\Container;
use Jaxon\Plugin\Plugin;
use Jaxon\Utils\Http\UriException;
use Jaxon\Utils\Template\TemplateEngine;

use function array_reduce;
use function is_subclass_of;
use function ksort;
use function md5;
use function trim;

class CodeGenerator

Missing doc comment for class CodeGenerator

{
    /**
     * @var string
     */
    private $sVersion;

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

    /**
     * @var Container
     */
    private $di;

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

    /**
     * @var AssetManager
     */
    private $xAssetManager;

    /**
     * The classes that generate code
     *
     * @var array<string>
     */
    protected $aCodeGenerators = [];

    /**
     * @var string
     */
    protected $sJsOptions;

    /**
     * @var string
     */
    protected $sCss = '';

    /**
     * @var string
     */
    protected $sJs = '';

    /**
     * @var string
     */
    protected $sJsScript = '';

    /**
     * @var string
     */
    protected $sJsReadyScript = '';

    /**
     * @var string
     */
    protected $sJsInlineScript = '';

    /**
     * @var string
     */
    protected $bGenerated = false;

    /**
     * The constructor
     *
     * @param string $sVersion

Expected 9 spaces after parameter type; 1 found

Missing parameter comment

     * @param Container $di

Missing parameter comment

Expected 6 spaces after parameter type; 1 found

     * @param TemplateEngine $xTemplateEngine

Missing parameter comment

     */
    public function __construct(string $sVersion, Container $di, TemplateEngine $xTemplateEngine)

Expected 2 blank lines before function; 1 found

    {
        $this->sVersion = $sVersion;

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

        $this->di = $di;

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

        $this->xTemplateEngine = $xTemplateEngine;
    }

Expected 2 blank lines after function; 1 found

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

Expected 1 spaces after parameter name; 4 found

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

Expected 4 spaces after parameter type; 1 found

Expected 2 spaces after parameter name; 4 found

     *
     * @return void
     */
    public function addCodeGenerator(string $sClassName, int $nPriority)
    {
        while(isset($this->aCodeGenerators[$nPriority]))
        {
            $nPriority++;
        }
        $this->aCodeGenerators[$nPriority] = $sClassName;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Generate a hash for all the javascript code generated by the library
     *
     * @return string
     */
    public function getHash(): string
    {
        return md5(array_reduce($this->aCodeGenerators, function($sHash, $sClassName) {
            return $sHash . $this->di->g($sClassName)->getHash();
        }, $this->sVersion));
    }

Expected 2 blank lines after function; 1 found

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

Expected 1 spaces after parameter name; 4 found

     * @param array $aVars    The template variables

Expected 2 spaces after parameter type; 1 found

Expected 5 spaces after parameter name; 4 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Generate the Jaxon CSS and js codes for a given plugin
     *
     * @param string $sClassName

Missing parameter comment

     *
     * @return void
     */
    private function generatePluginCodes(string $sClassName)
    {
        $xGenerator = $this->di->g($sClassName);
        if(!is_subclass_of($xGenerator, Plugin::class) || $this->xAssetManager->shallIncludeAssets($xGenerator))
        {
            // HTML tags for CSS
            $this->sCss = trim($this->sCss) . "\n" . trim($xGenerator->getCss(), " \n");
            // HTML tags for js
            $this->sJs = trim($this->sJs) . "\n" . trim($xGenerator->getJs(), " \n");
        }
        // Javascript code
        $this->sJsScript = trim($this->sJsScript) . "\n\n" . trim($xGenerator->getScript(), " \n");
        if($xGenerator->readyEnabled())
        {
            $sScriptAttr = $xGenerator->readyInlined() ? 'sJsInlineScript' : 'sJsReadyScript';

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

            $this->$sScriptAttr = trim($this->$sScriptAttr) . "\n\n" . trim($xGenerator->getReadyScript(), " \n");
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * Render the generated CSS ans js codes
     *
     * @return void
     */
    private function renderCodes()
    {
        $this->sCss = trim($this->sCss, " \n");

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

        $this->sJs = trim($this->sJs, " \n");

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

        $this->sJsScript = trim($this->sJsScript, " \n");

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

        $this->sJsReadyScript = trim($this->sJsReadyScript, " \n");
        $this->sJsInlineScript = trim($this->sJsInlineScript, " \n");
        if(($this->sJsReadyScript))
        {
            $this->sJsReadyScript = $this->render('ready.js', ['sScript' => $this->sJsReadyScript . "\n"]);
        }
        if(($this->sJsInlineScript))
        {
            $this->sJsInlineScript = $this->render('ready.js', ['sScript' => $this->sJsInlineScript . "\n"]);
        }
        // Prepend Jaxon javascript files to HTML tags for Js
        $aJsFiles = $this->xAssetManager->getJsLibFiles();
        $this->sJs = trim($this->render('includes.js', ['aUrls' => $aJsFiles])) . "\n\n" . $this->sJs;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Generate the Jaxon CSS ans js codes
     *
     * @return void
     * @throws UriException
     */
    private function generateCodes()
    {
        if($this->bGenerated)
        {
            return;
        }

        // Sort the code generators by ascending priority
        ksort($this->aCodeGenerators);

        $this->xAssetManager = $this->di->getAssetManager();
        $this->sJsOptions = $this->xAssetManager->getJsOptions();

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

        foreach($this->aCodeGenerators as $sClassName)
        {
            $this->generatePluginCodes($sClassName);
        }
        $this->renderCodes();

        $sJsConfigVars = $this->render('config.js', $this->xAssetManager->getOptionVars());
        // These three parts are always rendered together
        $this->sJsScript = trim($sJsConfigVars) . "\n\n" .
            trim($this->sJsScript) . "\n\n" . trim($this->sJsReadyScript);
        // For js lib versions prior to 4.0, register the redirect command.
        $sJsLibVersion = $this->di->getJsLibVersion();
        if((int)$sJsLibVersion[0] < 4)
        {
            $this->sJsScript .= '

    jaxon.command.handler.register("rd", (command) => {
        const { data: sUrl, delay: nDelay } = command;
        if (nDelay <= 0) {
            window.location = sUrl;
            return true;
        }
        window.setTimeout(() => window.location = sUrl, nDelay * 1000);
        return true;
    });
';
        }

        // The codes are already generated.
        $this->bGenerated = true;

The property $bGenerated was declared of type string, but true is of type true. Maybe add a type cast?

    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the HTML tags to include Jaxon CSS code and files into the page
     *
     * @return string
     * @throws UriException
     */
    public function getCss(): string
    {
        $this->generateCodes();
        return $this->sCss;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the HTML tags to include Jaxon javascript files into the page
     *
     * @return string
     * @throws UriException
     */
    public function getJs(): string
    {
        $this->generateCodes();
        return $this->sJs;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the generated javascript code
     *
     * @return string
     */
    public function getJsScript(): string
    {
        return $this->sJsScript;
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 spaces after parameter name; 1 found

     * @param bool $bIncludeCss Also get the CSS files
     *
     * @return string
     * @throws UriException
     */
    public function getScript(bool $bIncludeJs, bool $bIncludeCss): string
    {
        $this->generateCodes();
        $sScript = '';
        if(($bIncludeCss))
        {
            $sScript .= $this->getCss() . "\n";
        }
        if(($bIncludeJs))
        {
            $sScript .= $this->getJs() . "\n";
        }

        if(!($sUrl = $this->xAssetManager->createJsFiles($this)))

Variable assignment found within a condition. Did you mean to do a comparison ?

        {
            return trim($sScript) . "\n\n" . $this->render('wrapper.js',
                ['sScript' => trim($this->sJsScript) . "\n\n" . trim($this->sJsInlineScript)]);
        }
        return trim($sScript) . "\n\n" . trim($this->render('include.js', ['sUrl' => $sUrl])) .
            "\n\n" . $this->render('wrapper.js', ['sScript' => $this->sJsInlineScript]);
    }

Expected 2 blank lines after function; 0 found

}