PluginManager - 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

PluginManager A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	345
Duplicated Lines	0 %

Importance

Changes

Metric	Value
eloc	85
dl	0
loc	345
rs	9.76
c	0
b	0
f	0
wmc	33

13 Methods

Rating	Name	Size	Complexity
A	registerCallable()	10	3
A	_registerFromConfig()	17	2
B	registerCallablesFromConfig()	18	7
A	registerPlugins()	11	1
A	__construct()	6	1
A	registerFromConfig()	9	2
A	getRequestPlugin()	7	2
B	registerPlugin()	40	7
A	registerPackage()	22	2
A	getResponsePlugin()	12	3
A	readPackageConfig()	7	1
A	getPackage()	3	1
A	getRequestPlugins()	3	1

<?php

/**
 * ResponseManager.php - Jaxon plugin manager
 *
 * Register Jaxon plugins, generate corresponding code, handle request
 * and redirect them to the right plugin.
 *
 * @package jaxon-core

 * @author Jared White

 * @author J. Max Wilson

 * @author Joseph Woolley

 * @author Steffen Konerow

 * @author Thierry Feuzeu <[email protected]>
 * @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson

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

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

use Jaxon\Jaxon;
use Jaxon\Plugin\Code\CodeGenerator;
use Jaxon\Plugin\RequestPlugin;
use Jaxon\Plugin\ResponsePlugin;
use Jaxon\Request\Plugin\CallableClass\ClassPlugin;
use Jaxon\Request\Plugin\CallableClass\DirPlugin;
use Jaxon\Request\Plugin\CallableFunction\FunctionPlugin;
use Jaxon\Response\Plugin\DataBag\DataBagPlugin;
use Jaxon\Response\Plugin\JQuery\JQueryPlugin;
use Jaxon\Response\Response;
use Jaxon\Utils\Config\Config;
use Jaxon\Utils\Translation\Translator;
use Jaxon\Contracts\Dialogs\Message;
use Jaxon\Contracts\Dialogs\Question;
use Jaxon\Exception\SetupException;

use function is_array;
use function is_integer;
use function is_string;
use function is_subclass_of;
use function trim;

class PluginManager

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


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

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

    /**
     * Request plugins, indexed by name
     *
     * @var array
     */
    private $aRequestPlugins = [];

    /**
     * Response plugins, indexed by name
     *
     * @var array
     */
    private $aResponsePlugins = [];

    /**
     * The code generator
     *
     * @var CodeGenerator
     */
    private $xCodeGenerator;

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

     * @param Config $xConfig

     * @param Translator $xTranslator

     * @param CodeGenerator $xCodeGenerator

     */
    public function __construct(Jaxon $jaxon, Config $xConfig, Translator $xTranslator, CodeGenerator $xCodeGenerator)

    {
        $this->jaxon = $jaxon;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xConfig = $xConfig;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xTranslator = $xTranslator;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xCodeGenerator = $xCodeGenerator;
    }


    /**
     * Get the request plugins
     *
     * @return array
     */
    public function getRequestPlugins(): array
    {
        return $this->aRequestPlugins;
    }


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

     *
     * @return Package|null
     */
    public function getPackage(string $sClassName): ?Package
    {
        return $this->jaxon->di()->get(trim($sClassName, '\\ '));
    }


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

     * @param string $sPluginName    The plugin name

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

     *
     * @return void
     * @throws SetupException
     */
    public function registerPlugin(string $sClassName, string $sPluginName, int $nPriority = 1000)
    {
        $bIsUsed = false;
        if(is_subclass_of($sClassName, RequestPlugin::class))
        {
            $this->aRequestPlugins[$sPluginName] = $sClassName;
            $this->xCodeGenerator->addGenerator($sClassName, $nPriority);
            $bIsUsed = true;
        }
        elseif(is_subclass_of($sClassName, ResponsePlugin::class))
        {
            $this->aResponsePlugins[$sPluginName] = $sClassName;
            $this->xCodeGenerator->addGenerator($sClassName, $nPriority);
            $bIsUsed = true;
        }

        // This plugin implements the Message interface
        if(is_subclass_of($sClassName, Message::class))
        {
            $this->jaxon->dialog()->setMessage($sClassName);
            $bIsUsed = true;
        }
        // This plugin implements the Question interface
        if(is_subclass_of($sClassName, Question::class))
        {
            $this->jaxon->dialog()->setQuestion($sClassName);
            $bIsUsed = true;
        }

        if(!$bIsUsed)
        {
            // The class is invalid.
            $sMessage = $this->xTranslator->trans('errors.register.invalid', ['name' => $sClassName]);
            throw new SetupException($sMessage);
        }

        // Register the plugin in the DI container, if necessary
        if(!$this->jaxon->di()->has($sClassName))
        {
            $this->jaxon->di()->auto($sClassName);
        }
    }


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

     *
     * @return Config
     * @throws SetupException
     */
    private function readPackageConfig(string $sClassName): Config
    {
        $sConfigFile = $sClassName::getConfigFile();
$a = "a";
$ab = "ab";
$abc = "abc";
        $aPackageConfig = $this->jaxon->readConfig($sConfigFile);
        // Add the package name to the config
        $aPackageConfig['package'] = $sClassName;
        return $this->jaxon->di()->newConfig($aPackageConfig);
    }


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

     * @param array $aAppOptions    The package options defined in the app section of the config file

     *
     * @return void
     * @throws SetupException
     */
    public function registerPackage(string $sClassName, array $aAppOptions)
    {
        $sClassName = trim($sClassName, '\\ ');
        if(!is_subclass_of($sClassName, Package::class))
        {
            $sMessage = $this->xTranslator->trans('errors.register.invalid', ['name' => $sClassName]);
            throw new SetupException($sMessage);
        }
        $di = $this->jaxon->di();
$a = "a";
$ab = "ab";
$abc = "abc";
        $xAppConfig = $di->registerPackage($sClassName, $aAppOptions);

        // Read the package config.
        $xPackageConfig = $this->readPackageConfig($sClassName);

        // Register the declarations in the package config.
        $this->_registerFromConfig($xPackageConfig);

        // Register the view namespaces
        $di->getViewManager()->addNamespaces($xPackageConfig, $xAppConfig);

        // Register the package as a code generator.
        $this->xCodeGenerator->addGenerator($sClassName, 500);
    }


    /**
     * Register a function or callable class
     *
     * Call the request plugin with the $sType defined as name.
     *
     * @param string $sType    The type of request handler being registered

     * @param string $sCallable    The callable entity being registered

     * @param array|string $xOptions    The associated options

     *
     * @return void
     * @throws SetupException
     */
    public function registerCallable(string $sType, string $sCallable, $xOptions = [])
    {
        if(isset($this->aRequestPlugins[$sType]) &&
            ($xPlugin = $this->jaxon->di()->g($this->aRequestPlugins[$sType])))

        {
            $xPlugin->register($sType, $sCallable, $xPlugin->checkOptions($sCallable, $xOptions));
            return;
        }
        throw new SetupException($this->xTranslator->trans('errors.register.plugin',
            ['name' => $sType, 'callable' => $sCallable]));
    }


    /**
     * Register callables from a section of the config
     *
     * @param Config $xAppConfig    The config options
     * @param string $sSection    The config section name

     * @param string $sCallableType    The type of callable to register

     *
     * @return void
     * @throws SetupException
     */
    private function registerCallablesFromConfig(Config $xAppConfig, string $sSection, string $sCallableType)
    {
        $aConfig = $xAppConfig->getOption($sSection, []);
        foreach($aConfig as $xKey => $xValue)
        {
            if(is_integer($xKey) && is_string($xValue))
            {
                // Register a function without options
                $this->registerCallable($sCallableType, $xValue);
            }
            elseif(is_string($xKey) && (is_array($xValue) || is_string($xValue)))
            {
                // Register a function with options
                $this->registerCallable($sCallableType, $xKey, $xValue);
            }
            else
            {
                continue;
                // Todo: throw an exception
            }
        }
    }


    /**
     * Read and set Jaxon options from a JSON config file
     *
     * @param Config $xAppConfig    The config options

     *
     * @return void
     * @throws SetupException
     */
    private function _registerFromConfig(Config $xAppConfig)
    {
        // Register functions
        $this->registerCallablesFromConfig($xAppConfig, 'functions', Jaxon::CALLABLE_FUNCTION);

        // Register classes
        $this->registerCallablesFromConfig($xAppConfig, 'classes', Jaxon::CALLABLE_CLASS);

        // Register directories
        $this->registerCallablesFromConfig($xAppConfig, 'directories', Jaxon::CALLABLE_DIR);

        // Register classes in DI container
        $di = $this->jaxon->di();
$a = "a";
$ab = "ab";
$abc = "abc";
        $aContainerConfig = $xAppConfig->getOption('container', []);
        foreach($aContainerConfig as $sClassName => $xClosure)
        {
            $di->set($sClassName, $xClosure);
        }
    }


    /**
     * Read and set Jaxon options from a JSON config file
     *
     * @param Config $xAppConfig    The config options

     *
     * @return void
     * @throws SetupException
     */
    public function registerFromConfig(Config $xAppConfig)
    {
        $this->_registerFromConfig($xAppConfig);

        // Register packages
        $aPackageConfig = $xAppConfig->getOption('packages', []);
        foreach($aPackageConfig as $sClassName => $aOptions)
        {
            $this->registerPackage($sClassName, $aOptions);
        }
    }


    /**
     * Find the specified response plugin by name and return a reference to it if one exists
     *
     * @param string $sName    The name of the plugin

     * @param Response|null $xResponse    The response to attach the plugin to

     *
     * @return ResponsePlugin|null
     */
    public function getResponsePlugin(string $sName, ?Response $xResponse = null): ?ResponsePlugin
    {
        if(!isset($this->aResponsePlugins[$sName]))
        {
            return null;
        }
        $xPlugin = $this->jaxon->di()->g($this->aResponsePlugins[$sName]);
        if(($xResponse))
        {
            $xPlugin->setResponse($xResponse);
        }
        return $xPlugin;
    }


    /**
     * Find the specified request plugin by name and return a reference to it if one exists
     *
     * @param string $sName    The name of the plugin

     *
     * @return RequestPlugin|null
     */
    public function getRequestPlugin(string $sName): ?RequestPlugin
    {
        if(!isset($this->aRequestPlugins[$sName]))
        {
            return null;
        }
        return $this->jaxon->di()->g($this->aRequestPlugins[$sName]);
    }


    /**
     * Register the Jaxon request plugins
     *
     * @return void
     * @throws SetupException
     */
    public function registerPlugins()
    {
        // Request plugins
        $this->registerPlugin(ClassPlugin::class, Jaxon::CALLABLE_CLASS, 101);
        $this->registerPlugin(FunctionPlugin::class, Jaxon::CALLABLE_FUNCTION, 102);
        $this->registerPlugin(DirPlugin::class, Jaxon::CALLABLE_DIR, 103);

        // Register the JQuery response plugin
        $this->registerPlugin(JQueryPlugin::class, 'jquery', 700);
        // Register the DataBag response plugin
        $this->registerPlugin(DataBagPlugin::class, 'bags', 700);
    }

}


1			<?php
2
3			/**
4			* ResponseManager.php - Jaxon plugin manager
5			*
6			* Register Jaxon plugins, generate corresponding code, handle request
7			* and redirect them to the right plugin.
8			*
9			* @package jaxon-core
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Package name "jaxon-core" is not valid; consider "Jaxoncore" instead Loading history...
10			* @author Jared White
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history...
11			* @author J. Max Wilson
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history...
12			* @author Joseph Woolley
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history...
13			* @author Steffen Konerow
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history...
14			* @author Thierry Feuzeu <[email protected]>
15			* @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
16			* @copyright Copyright (c) 2008-2010 by Joseph Woolley, Steffen Konerow, Jared White & J. Max Wilson
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
17			* @copyright 2016 Thierry Feuzeu <[email protected]>
18			* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
19			* @link https://github.com/jaxon-php/jaxon-core
20			*/
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history...
21
22			namespace Jaxon\Plugin;
23
24			use Jaxon\Jaxon;
25			use Jaxon\Plugin\Code\CodeGenerator;
26			use Jaxon\Plugin\RequestPlugin;
27			use Jaxon\Plugin\ResponsePlugin;
28			use Jaxon\Request\Plugin\CallableClass\ClassPlugin;
29			use Jaxon\Request\Plugin\CallableClass\DirPlugin;
30			use Jaxon\Request\Plugin\CallableFunction\FunctionPlugin;
31			use Jaxon\Response\Plugin\DataBag\DataBagPlugin;
32			use Jaxon\Response\Plugin\JQuery\JQueryPlugin;

jaxon-php / jaxon-core

Push — master ( 7c83a0...cd350b )

PluginManager A

Complexity

Size/Duplication

Importance

13 Methods

Duplication Side-by-Side

Filter issues like