Jaxon\App\Traits\AjaxTrait

Complexity

Total Complexity

23

Size/Duplication

Total Lines	279
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	getJs()	0	3	1
A	getCss()	0	3	1
A	plugin()	0	3	1
A	script()	0	3	1
A	css()	0	3	1
A	js()	0	3	1
A	getScript()	0	3	1
A	package()	0	3	1
A	canProcessRequest()	0	3	1
A	hasOption()	0	3	1
A	cl()	0	5	2
A	getCharacterEncoding()	0	3	1
A	callback()	0	3	1
A	setOption()	0	3	1
A	request()	0	3	1
A	getContentType()	0	3	1
A	factory()	0	3	1
A	logger()	0	3	1
A	translator()	0	3	1
A	rq()	0	4	1
A	di()	0	3	1
A	getOption()	0	3	1

<?php

/**
 * Ajax.php
 *
 * The Jaxon library.
 *
 * @package jaxon-core

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

 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright 2022 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\App\Traits;

use Jaxon\App\Config\ConfigManager;
use Jaxon\App\I18n\Translator;
use Jaxon\Di\Container;
use Jaxon\Exception\SetupException;
use Jaxon\Plugin\Manager\PluginManager;
use Jaxon\Plugin\Package;
use Jaxon\Plugin\Request\CallableClass\CallableRegistry;
use Jaxon\Plugin\ResponsePlugin;
use Jaxon\Request\Factory\Factory;
use Jaxon\Request\Factory\RequestFactory;
use Jaxon\Request\Handler\CallbackManager;
use Jaxon\Response\Manager\ResponseManager;
use Jaxon\Utils\Http\UriException;
use Psr\Log\LoggerInterface;

use function trim;

trait AjaxTrait

Missing doc comment for trait AjaxTrait

{
    /**
     * @var Container
     */
    protected $xContainer = null;

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

    /**
     * @var ConfigManager
     */
    protected $xConfigManager;

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

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

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

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

    /**
     * @return Container
     */
    public function di(): ?Container

Expected 2 blank lines before function; 1 found

    {
        return $this->xContainer;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @return LoggerInterface
     */
    public function logger(): LoggerInterface
    {
        return $this->di()->getLogger();
    }

Expected 2 blank lines after function; 1 found

    /**
     * @return Translator
     */
    public function translator(): Translator
    {
        return $this->xTranslator;
    }

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->xConfigManager->setOption($sName, $sValue);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the value of a config option
     *
     * @param string $sName    The option name
     * @param mixed $xDefault    The default value, to be returned if the option is not defined

Expected 2 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     *
     * @return mixed
     */
    public function getOption(string $sName, $xDefault = null)
    {
        return $this->xConfigManager->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
     */
    public function hasOption(string $sName): bool
    {
        return $this->xConfigManager->hasOption($sName);
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Get the content type of the HTTP response
     *
     * @return string
     */
    public function getContentType(): string
    {
        return $this->xResponseManager->getContentType();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the factory for request and parameter factories
     *
     * @return Factory
     */
    public function factory(): Factory
    {
        return $this->di()->getFactory();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get an instance of a registered class
     *
     * @param string $sClassName The class name
     *
     * @return mixed
     * @throws SetupException
     */
    public function cl(string $sClassName)
    {
        $sClassName = trim($sClassName);

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

        $xCallableClass = $this->xCallableRegistry->getCallableObject($sClassName);
        return !$xCallableClass ? null : $xCallableClass->getRegisteredObject();

$xCallableClass is of type Jaxon\Plugin\Request\CallableClass\CallableObject, thus it always evaluated to true.

    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the request factory to a registered class
     *
     * @param string $sClassName The class name
     *
     * @return RequestFactory|null
     * @throws SetupException
     */
    public function rq(string $sClassName = ''): ?RequestFactory
    {
        $sClassName = trim($sClassName);
        return $this->factory()->request($sClassName);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the request factory to a registered class
     *
     * @param string $sClassName The class name
     *
     * @return RequestFactory|null
     * @throws SetupException
     */
    public function request(string $sClassName = ''): ?RequestFactory
    {
        return $this->rq($sClassName);
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Get the HTML tags to include Jaxon javascript files into the page.
     *
     * @return string  the javascript code
     */
    public function js(): string
    {
        return $this->di()->getCodeGenerator()->getJs();
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Get the HTML tags to include Jaxon CSS code and files into the page.
     *
     * @return string
     */
    public function css(): string
    {
        return $this->di()->getCodeGenerator()->getCss();
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 spaces after parameter name; 4 found

     * @param bool $bIncludeCss    Also get the css code

Expected 1 spaces after parameter name; 4 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Returns the js header and wrapper code to be printed into the page
     *
     * @param bool $bIncludeJs    Also get the js code

Expected 2 spaces after parameter name; 4 found

     * @param bool $bIncludeCss    Also get the css code

Expected 1 spaces after parameter name; 4 found

     *
     * @return string  the javascript code
     * @throws UriException
     */
    public function script(bool $bIncludeJs = false, bool $bIncludeCss = false): string
    {
        return $this->di()->getCodeGenerator()->getScript($bIncludeJs, $bIncludeCss);
    }

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->di()->getRequestHandler()->canProcessRequest();
    }

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|null
     */
    public function plugin(string $sName): ?ResponsePlugin
    {
        return $this->xPluginManager->getResponsePlugin($sName);
    }

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|null
     */
    public function package(string $sClassName): ?Package
    {
        return $this->di()->getPackageManager()->getPackage($sClassName);
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 0 found

}