Jaxon\Jaxon

Complexity

Total Complexity

50

Size/Duplication

Total Lines	638
Duplicated Lines	0 %

Importance

Changes	26
Bugs	1	Features	0

39 Methods

Rating	Name	Duplication	Size	Complexity
A	plugin()	0	3	1
A	getVersion()	0	3	1
A	di()	0	3	1
A	session()	0	3	1
A	getJs()	0	3	1
A	package()	0	3	1
A	app()	0	3	1
A	callback()	0	3	1
A	canProcessRequest()	0	3	1
A	registerPackage()	0	3	1
A	getInstance()	0	9	2
A	config()	0	3	1
A	register()	0	3	1
A	getResponse()	0	7	2
A	getScript()	0	3	1
A	trans()	0	3	1
A	getDefaultOptions()	0	33	1
A	template()	0	3	1
A	newResponse()	0	3	1
A	request()	0	3	1
A	__construct()	0	4	1
A	hasOption()	0	3	1
A	readConfig()	0	25	5
A	instance()	0	4	2
A	registerPlugin()	0	3	1
A	printScript()	0	3	1
A	view()	0	3	1
A	newConfig()	0	3	1
A	factory()	0	3	1
A	dialog()	0	3	1
A	processRequest()	0	19	4
A	getOption()	0	3	1
A	loadConfig()	0	12	2
A	setOption()	0	3	1
A	getCss()	0	3	1
A	initInstance()	0	13	1
A	logger()	0	3	1
A	upload()	0	3	1
A	getCharacterEncoding()	0	3	1

<?php

/**
 * Jaxon.php - Jaxon class
 *
 * The Jaxon class uses a modular plug-in system to facilitate the processing
 * of special Ajax requests made by a PHP page.
 * It generates Javascript that the page must include in order to make requests.
 * It handles the output of response commands (see <Jaxon\Response\Response>).
 * Many flags and settings can be adjusted to effect the behavior of the Jaxon class
 * as well as the client-side javascript.
 *
 * @package jaxon-core

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

 * @author Jared White

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author J. Max Wilson

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Joseph Woolley

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Steffen Konerow

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson

@copyright tag must contain a year and the name of the copyright holder

 * @copyright Copyright (c) 2008-2010 by Joseph Woolley, Steffen Konerow, Jared White  & J. Max Wilson

@copyright tag must contain a year and the name of the copyright holder

 * @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
 */

PHP version not specified

Missing @category tag in file comment

namespace Jaxon;

use Jaxon\App\App;
use Jaxon\Container\Container;
use Jaxon\Contracts\Session;
use Jaxon\Exception\RequestException;
use Jaxon\Exception\SetupException;
use Jaxon\Plugin\Code\Generator as CodeGenerator;
use Jaxon\Plugin\Manager as PluginManager;
use Jaxon\Plugin\Package;
use Jaxon\Plugin\Response as ResponsePlugin;
use Jaxon\Request\Factory\Factory;
use Jaxon\Request\Factory\RequestFactory;
use Jaxon\Request\Handler\Callback;
use Jaxon\Request\Handler\Handler as RequestHandler;
use Jaxon\Request\Support\CallableRegistry;
use Jaxon\Request\Upload\Plugin as UploadPlugin;
use Jaxon\Response\Manager as ResponseManager;
use Jaxon\Response\AbstractResponse;
use Jaxon\Response\Response;
use Jaxon\Ui\Dialogs\Dialog;
use Jaxon\Ui\View\Renderer;
use Jaxon\Utils\Config\Config;
use Jaxon\Utils\Config\Exception\DataDepth;
use Jaxon\Utils\Config\Exception\FileAccess;
use Jaxon\Utils\Config\Exception\FileContent;
use Jaxon\Utils\Config\Exception\FileExtension;
use Jaxon\Utils\Config\Exception\YamlExtension;
use Jaxon\Utils\Config\Reader as ConfigReader;
use Jaxon\Utils\Template\Engine as TemplateEngine;
use Jaxon\Utils\Translation\Translator;
use Jaxon\Utils\Http\UriException;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use function headers_sent;

class Jaxon implements LoggerAwareInterface

Missing doc comment for class Jaxon

{
    use LoggerAwareTrait;

    /**
     * Package version number
     *
     * @const string
     */
    const VERSION = 'Jaxon 4.0.0-dev';

    /*
     * Request plugins
     */

Empty line required after block comment

    const CALLABLE_CLASS = 'CallableClass';

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

    const CALLABLE_DIR = 'CallableDir';

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

    const CALLABLE_FUNCTION = 'CallableFunction';

    /**
     * A static instance on this class
     *
     * @var Jaxon
     */
    private static $xInstance = null;

    /**
     * The DI container
     *
     * @var Container
     */
    private static $xContainer = null;

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

    /**
     * @var Translator
     */
    protected $xTranslator;

    /**
     * @var ConfigReader
     */
    protected $xConfigReader;

    /**
     * @var PluginManager
     */
    protected $xPluginManager;

    /**
     * @var CodeGenerator
     */
    protected $xCodeGenerator;

    /**
     * @var CallableRegistry
     */
    protected $xCallableRegistry;

    /**
     * @var RequestHandler
     */
    protected $xRequestHandler;

    /**
     * @var ResponseManager
     */
    protected $xResponseManager;

    /**
     * @return void
     */
    private static function initInstance()

Expected 2 blank lines before function; 1 found

    {
        // Save the Jaxon instance in the DI
        self::$xContainer->val(Jaxon::class, self::$xInstance);

As per coding style, self should be used for accessing local static members.

        // Set the attributes from the container
        self::$xInstance->xConfig = self::$xContainer->g(Config::class);

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

        self::$xInstance->xTranslator = self::$xContainer->g(Translator::class);

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

        self::$xInstance->xConfigReader = self::$xContainer->g(ConfigReader::class);

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

        self::$xInstance->xPluginManager = self::$xContainer->g(PluginManager::class);

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

        self::$xInstance->xCodeGenerator = self::$xContainer->g(CodeGenerator::class);

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

        self::$xInstance->xCallableRegistry = self::$xContainer->g(CallableRegistry::class);
        self::$xInstance->xRequestHandler = self::$xContainer->g(RequestHandler::class);

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

        self::$xInstance->xResponseManager = self::$xContainer->g(ResponseManager::class);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the static instance
     *
     * @return Jaxon
     */
    public static function getInstance(): ?Jaxon
    {
        if(self::$xInstance === null)
        {
            self::$xContainer = new Container(self::getDefaultOptions());
            self::$xInstance = new Jaxon();
            self::initInstance();
        }
        return self::$xInstance;
    }

Expected 2 blank lines after function; 1 found

    /**
     * The constructor
     */
    private function __construct()
    {
        // Set the default logger
        $this->setLogger(new NullLogger());
    }

Expected 2 blank lines after function; 1 found

    /**
     * The current Jaxon version
     *
     * @return string
     */
    public function getVersion(): string
    {
        return self::VERSION;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the default options of all components of the library
     *
     * @return array<string,string|bool|integer>
     */
    private static function getDefaultOptions(): array
    {
        // The default configuration settings.
        return [
            'core.version'                      => self::VERSION,
            'core.language'                     => 'en',
            'core.encoding'                     => 'utf-8',
            'core.decode_utf8'                  => false,
            'core.prefix.function'              => 'jaxon_',
            'core.prefix.class'                 => 'Jaxon',
            // 'core.request.uri'               => '',
            'core.request.mode'                 => 'asynchronous',
            'core.request.method'               => 'POST', // W3C: Method is case sensitive
            'core.response.send'                => true,
            'core.response.merge.ap'            => true,
            'core.response.merge.js'            => true,
            'core.debug.on'                     => false,
            'core.debug.verbose'                => false,
            'core.process.exit'                 => true,
            'core.process.clean'                => false,
            'core.process.timeout'              => 6000,
            'core.error.handle'                 => false,
            'core.error.log_file'               => '',
            'core.jquery.no_conflict'           => false,
            'core.upload.enabled'               => true,
            'js.lib.output_id'                  => 0,
            'js.lib.queue_size'                 => 0,
            'js.lib.load_timeout'               => 2000,
            'js.lib.show_status'                => false,
            'js.lib.show_cursor'                => true,
            'js.app.dir'                        => '',
            'js.app.minify'                     => true,
            'js.app.options'                    => '',
        ];
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the DI container
     *
     * @return Container
     */
    public function di(): ?Container
    {
        return self::$xContainer;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the logger
     *
     * @return LoggerInterface
     */
    public function logger(): LoggerInterface
    {
        return $this->logger;

The expression return $this->logger could return the type null which is incompatible with the type-hinted return Psr\Log\LoggerInterface. Consider adding an additional type-check to rule them out.

    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the library config
     *
     * @return Config
     */
    public function config(): Config
    {
        return $this->xConfig;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Read a config file
     *
     * @param string $sConfigFile

Missing parameter comment

     *
     * @return array
     * @throws SetupException
     */
    public function readConfig(string $sConfigFile): array
    {
        try
        {
            return $this->xConfigReader->read($sConfigFile);
        }
        catch(YamlExtension $e)
        {
            $sMessage = $this->xTranslator->trans('errors.yaml.install');
            throw new SetupException($sMessage);
        }
        catch(FileExtension $e)
        {
            $sMessage = $this->xTranslator->trans('errors.file.extension', ['path' => $sConfigFile]);
            throw new SetupException($sMessage);
        }
        catch(FileAccess $e)
        {
            $sMessage = $this->xTranslator->trans('errors.file.access', ['path' => $sConfigFile]);
            throw new SetupException($sMessage);
        }
        catch(FileContent $e)
        {
            $sMessage = $this->xTranslator->trans('errors.file.content', ['path' => $sConfigFile]);
            throw new SetupException($sMessage);
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * Load a config file
     *
     * @param string $sConfigFile

Missing parameter comment

     * @param string $sConfigSection

Missing parameter comment

     *
     * @return void
     * @throws SetupException
     */
    public function loadConfig(string $sConfigFile, string $sConfigSection = '')
    {
        $aConfigOptions = $this->readConfig($sConfigFile);
        try
        {
            // Set up the lib config options.
            $this->xConfig->setOptions($aConfigOptions, $sConfigSection);
        }
        catch(DataDepth $e)
        {
            $sMessage = $this->xTranslator->trans('errors.data.depth', ['key' => $e->sPrefix, 'depth' => $e->nDepth]);
            throw new SetupException($sMessage);
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set the value of a config option
     *
     * @param string $sName    The option name

Expected 2 spaces after parameter name; 4 found

     * @param mixed $sValue    The option value

Expected 2 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     *
     * @return void
     */
    public function setOption(string $sName, $sValue)
    {
        $this->xConfig->setOption($sName, $sValue);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the value of a config option
     *
     * @param string $sName    The option name

Expected 5 spaces after parameter type; 1 found

     * @param mixed|null $xDefault    The default value, to be returned if the option is not defined

Expected 1 spaces after parameter name; 4 found

     *
     * @return mixed        The option value, or null if the option is unknown
     */
    public function getOption(string $sName, $xDefault = null)
    {
        return $this->xConfig->getOption($sName, $xDefault);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check the presence of a config option
     *
     * @param string $sName    The option name

Expected 1 spaces after parameter name; 4 found

     *
     * @return bool        True if the option exists, and false if not
     */
    public function hasOption(string $sName): bool
    {
        return $this->xConfig->hasOption($sName);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Create a new the config set
     *
     * @return Config            The config manager
     * @throws SetupException
     */
    public function newConfig(): Config
    {
        return $this->di()->newConfig();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the configured character encoding
     *
     * @return string
     */
    public function getCharacterEncoding(): string
    {
        return trim($this->xConfig->getOption('core.encoding'));

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

    }

Expected 2 blank lines after function; 1 found

    /**
     * Get a translated string
     *
     * @param string $sText    The key of the translated string

Expected 9 spaces after parameter name; 4 found

     * @param array $aPlaceHolders    The placeholders of the translated string

Expected 2 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     * @param string $sLanguage    The language of the translated string

Expected 5 spaces after parameter name; 4 found

     *
     * @return string
     */
    public function trans(string $sText, array $aPlaceHolders = [], string $sLanguage = ''): string
    {
        return $this->xTranslator->trans($sText, $aPlaceHolders, $sLanguage);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the Global Response object
     *
     * @return AbstractResponse
     */
    public function getResponse(): AbstractResponse
    {
        if(($xResponse = $this->xResponseManager->getResponse()))

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

        {
            return $xResponse;
        }
        return $this->di()->getResponse();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Create a new Jaxon response object
     *
     * @return Response
     */
    public function newResponse(): Response
    {
        return $this->di()->newResponse();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Register a plugin
     *
     * Below is a table for priorities and their description:
     * - 0 to 999: Plugins that are part of or extensions to the jaxon core
     * - 1000 to 8999: User created plugins, typically, these plugins don't care about order
     * - 9000 to 9999: Plugins that generally need to be last or near the end of the plugin list
     *
     * @param string $sClassName    The plugin class

Expected 2 spaces after parameter type; 1 found

Expected 2 spaces after parameter name; 4 found

     * @param string $sPluginName    The plugin name

Expected 2 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     * @param integer $nPriority    The plugin priority, used to order the plugins

Expected 3 spaces after parameter name; 4 found

     *
     * @return void
     * @throws SetupException
     */
    public function registerPlugin(string $sClassName, string $sPluginName, int $nPriority = 1000)
    {
        $this->xPluginManager->registerPlugin($sClassName, $sPluginName, $nPriority);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Register a package
     *
     * @param string $sClassName    The package class

Expected 1 spaces after parameter name; 4 found

     * @param array $aOptions    The package options

Expected 3 spaces after parameter name; 4 found

Expected 2 spaces after parameter type; 1 found

     *
     * @return void
     * @throws SetupException
     */
    public function registerPackage(string $sClassName, array $aOptions = [])
    {
        $this->xPluginManager->registerPackage($sClassName, $aOptions);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Register request handlers, including functions, callable classes and directories.
     *
     * @param string $sType    The type of request handler being registered

Expected 7 spaces after parameter type; 1 found

     *        Options include:

Parameter comment not aligned correctly; expected 25 spaces but found 8

     *        - Jaxon::CALLABLE_FUNCTION: a function declared at global scope

Parameter comment not aligned correctly; expected 25 spaces but found 8

     *        - Jaxon::CALLABLE_CLASS: a class who's methods are to be registered

Parameter comment not aligned correctly; expected 25 spaces but found 8

     *        - Jaxon::CALLABLE_DIR: a directory containing classes to be registered

Parameter comment not aligned correctly; expected 25 spaces but found 8

     * @param string $sName

Expected 7 spaces after parameter type; 1 found

Missing parameter comment

     *        When registering a function, this is the name of the function
     *        When registering a callable class, this is the class name
     *        When registering a callable directory, this is the full path to the directory
     * @param array|string $xOptions    The related options

Expected 1 spaces after parameter name; 4 found

     *
     * @return void
     * @throws SetupException
     */
    public function register(string $sType, string $sName, $xOptions = [])
    {
        $this->xPluginManager->registerCallable($sType, $sName, $xOptions);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get an instance of a registered class
     *
     * @param string $sClassName    The class name

Expected 1 spaces after parameter name; 4 found

     *
     * @return null|object
     */
    public function instance(string $sClassName)
    {
        $xCallable = $this->xCallableRegistry->getCallableObject($sClassName);
        return ($xCallable) ? $xCallable->getRegisteredObject() : null;

$xCallable is of type Jaxon\Request\Support\CallableObject, thus it always evaluated to true.

    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the factory
     *
     * @return Factory
     */
    public function factory(): Factory
    {
        return $this->di()->g(Factory::class);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get a request to a registered class
     *
     * @param string $sClassName    The class name

Expected 1 spaces after parameter name; 4 found

     *
     * @return RequestFactory|null
     */
    public function request(string $sClassName): ?RequestFactory
    {
        return $this->factory()->request($sClassName);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Returns the Jaxon Javascript header and wrapper code to be printed into the page
     *
     * The javascript code returned by this function is dependent on the plugins
     * that are included and the functions and classes that are registered.
     *
     * @param bool $bIncludeJs    Also get the JS files

Expected 2 spaces after parameter name; 4 found

     * @param bool $bIncludeCss    Also get the CSS files

Expected 1 spaces after parameter name; 4 found

     *
     * @return string
     * @throws UriException
     */
    public function getScript(bool $bIncludeJs = false, bool $bIncludeCss = false): string
    {
        return $this->xCodeGenerator->getScript($bIncludeJs, $bIncludeCss);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Print the jaxon Javascript header and wrapper code into your page
     *
     * The javascript code returned by this function is dependent on the plugins
     * that are included and the functions and classes that are registered.
     *
     * @param bool $bIncludeJs    Also print the JS files

Expected 2 spaces after parameter name; 4 found

     * @param bool $bIncludeCss    Also print the CSS files

Expected 1 spaces after parameter name; 4 found

     *
     * @return void
     * @throws UriException
     */
    public function printScript(bool $bIncludeJs = false, bool $bIncludeCss = false)
    {
        print $this->getScript($bIncludeJs, $bIncludeCss);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Return the javascript header code and file includes
     *
     * @return string
     */
    public function getJs(): string
    {
        return $this->xCodeGenerator->getJs();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Return the CSS header code and file includes
     *
     * @return string
     */
    public function getCss(): string
    {
        return $this->xCodeGenerator->getCss();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Determine if a call is a jaxon request or a page load request
     *
     * @return bool
     */
    public function canProcessRequest(): bool
    {
        return $this->xRequestHandler->canProcessRequest();
    }

Expected 2 blank lines after function; 1 found

    /**
     * If this is a jaxon request, call the requested PHP function, build the response and send it back to the browser
     *
     * This is the main server side engine for Jaxon.
     * It handles all the incoming requests, including the firing of events and handling of the response.
     * If your RequestURI is the same as your web page, then this function should be called before ANY
     * headers or HTML is output from your script.
     *
     * This function may exit after the request is processed, if the 'core.process.exit' option is set to true.
     *
     * @return void
     *
     * @throws RequestException
     * @see <Jaxon\Jaxon->canProcessRequest>
     */
    public function processRequest()
    {
        // Check to see if headers have already been sent out, in which case we can't do our job
        if(headers_sent($filename, $linenumber))
        {
            echo $this->xTranslator->trans('errors.output.already-sent', [
                'location' => $filename . ':' . $linenumber
            ]), "\n", $this->xTranslator->trans('errors.output.advice');
            exit();

Using exit here is not recommended.

        }

        $this->xRequestHandler->processRequest();

        if(($this->xConfig->getOption('core.response.send')))
        {
            $this->xResponseManager->sendOutput();
            if(($this->xConfig->getOption('core.process.exit')))
            {
                exit();

Using exit here is not recommended.

            }
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get a registered response plugin
     *
     * @param string $sName    The name of the plugin

Expected 1 spaces after parameter name; 4 found

     *
     * @return ResponsePlugin
     */
    public function plugin(string $sName): ResponsePlugin
    {
        return $this->xPluginManager->getResponsePlugin($sName);

The expression return $this->xPluginManager->getResponsePlugin($sName) could return the type null which is incompatible with the type-hinted return Jaxon\Plugin\Response. Consider adding an additional type-check to rule them out.

    }

Expected 2 blank lines after function; 1 found

    /**
     * Get a package instance
     *
     * @param string $sClassName    The package class name

Expected 1 spaces after parameter name; 4 found

     *
     * @return Package
     */
    public function package(string $sClassName): Package
    {
        return $this->xPluginManager->getPackage($sClassName);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the upload plugin
     *
     * @return UploadPlugin|null
     */
    public function upload(): ?UploadPlugin
    {
        return $this->di()->getUploadPlugin();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the request callback manager
     *
     * @return Callback
     */
    public function callback(): Callback
    {
        return $this->xRequestHandler->getCallbackManager();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the dialog wrapper
     *
     * @return Dialog
     */
    public function dialog(): Dialog
    {
        return $this->di()->getDialog();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the template engine
     *
     * @return TemplateEngine
     */
    public function template(): TemplateEngine
    {
        return $this->di()->getTemplateEngine();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the App instance
     *
     * @return App
     */
    public function app(): App
    {
        return $this->di()->getApp();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the view renderer
     *
     * @return Renderer
     */
    public function view(): Renderer
    {
        return $this->di()->getViewRenderer();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the session manager
     *
     * @return Session
     */
    public function session(): Session
    {
        return $this->di()->getSessionManager();
    }

Expected 2 blank lines after function; 0 found

}