Jaxon\Plugin\Manager

Complexity

Total Complexity

31

Size/Duplication

Total Lines	323
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	14

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getRequestPlugins()	0	4	1
A	getResponsePlugins()	0	4	1
A	getPackage()	0	5	1
B	registerPlugin()	0	43	7
A	registerPackage()	0	27	1
A	registerCallable()	0	10	2
B	registerCallablesFromConfig()	0	22	7
A	_registerFromConfig()	0	19	2
A	registerFromConfig()	0	11	2
A	getResponsePlugin()	0	8	2
A	getRequestPlugin()	0	8	2
A	registerRequestPlugins()	0	8	1
A	registerResponsePlugins()	0	6	1

<?php

/**
 * Manager.php - Jaxon plugin manager
 *
 * Register Jaxon plugins, generate corresponding code, handle request
 * and redirect them to the right plugin.
 *
 * @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\Plugin;

use Jaxon\Jaxon;
use Jaxon\Plugin\Package;
use Jaxon\Plugin\Code\Generator as CodeGenerator;
use Jaxon\Request\Support\CallableRepository;
use Jaxon\Request\Plugin\CallableClass;
use Jaxon\Request\Plugin\CallableDir;
use Jaxon\Request\Plugin\CallableFunction;
use Jaxon\Request\Plugin\FileUpload;
use Jaxon\Response\Plugin\JQuery as JQueryPlugin;
use Jaxon\Utils\Config\Config;

use Closure;

class Manager

Missing doc comment for class Manager

{
    use \Jaxon\Features\Manager;
    use \Jaxon\Features\Config;
    use \Jaxon\Features\Event;
    use \Jaxon\Features\Translator;

    /**
     * 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 CodeGenerator     $xCodeGenerator

Missing parameter comment

Expected 1 spaces after parameter type; 5 found

     */
    public function __construct(CodeGenerator $xCodeGenerator)

Expected 2 blank lines before function; 1 found

    {
        $this->xCodeGenerator = $xCodeGenerator;
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Get the response plugins
     *
     * @return array
     */
    public function getResponsePlugins()
    {
        return $this->aResponsePlugins;
    }

Expected 2 blank lines after function; 1 found

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 11 found

     *
     * @return Package
     */
    public function getPackage($sClassName)
    {
        $sClassName = trim($sClassName, '\\ ');

Consider using a different name than the parameter $sClassName. This often makes code more readable.

        return jaxon()->di()->get($sClassName);
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 spaces after parameter type; 9 found

Expected 3 spaces after parameter name; 15 found

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 13 found

     *
     * @return void
     */
    public function registerPlugin(Plugin $xPlugin, $nPriority = 1000)
    {
        $bIsUsed = false;
        if($xPlugin instanceof Request)
        {
            // The name of a request plugin is used as key in the plugin table
            $this->aRequestPlugins[$xPlugin->getName()] = $xPlugin;
            $this->xCodeGenerator->addGenerator($xPlugin, $nPriority);
            $bIsUsed = true;
        }
        elseif($xPlugin instanceof Response)
        {
            // The name of a response plugin is used as key in the plugin table
            $this->aResponsePlugins[$xPlugin->getName()] = $xPlugin;
            $this->xCodeGenerator->addGenerator($xPlugin, $nPriority);
            $bIsUsed = true;
        }

        // This plugin implements the Message interface
        if($xPlugin instanceof \Jaxon\Contracts\Dialogs\Message)
        {
            jaxon()->dialog()->setMessage($xPlugin);
            $bIsUsed = true;
        }
        // This plugin implements the Question interface
        if($xPlugin instanceof \Jaxon\Contracts\Dialogs\Question)
        {
            jaxon()->dialog()->setQuestion($xPlugin);
            $bIsUsed = true;
        }
        // Register the plugin as an event listener
        if($xPlugin instanceof \Jaxon\Contracts\Event\Listener)
        {
            $this->addEventListener($xPlugin);
            $bIsUsed = true;
        }

        if(!$bIsUsed)
        {
            $sErrorMessage = $this->trans('errors.register.invalid', ['name' => get_class($xPlugin)]);
            throw new \Jaxon\Exception\Error($sErrorMessage);
        }
    }

Expected 2 blank lines after function; 1 found

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 11 found

     * @param array         $aOptions           The package options

Expected 2 spaces after parameter type; 9 found

Expected 3 spaces after parameter name; 11 found

     *
     * @return void
     */
    public function registerPackage($sClassName, array $aOptions)
    {
        $jaxon = jaxon();
        $di = $jaxon->di();

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

        $sClassName = trim($sClassName, '\\ ');

Consider using a different name than the parameter $sClassName. This often makes code more readable.

        $di->set($sClassName, function() use($di, $sClassName, $aOptions) {
            return $di->make($sClassName);
        });

        // Read and apply the package config.
        $aPackageConfig = $jaxon->config()->read($sClassName::getConfigFile());
        $xPackageConfig = $di->newConfig($aPackageConfig);
        $this->_registerFromConfig($xPackageConfig);
        // Register the view namespaces
        $di->getViewManager()->addNamespaces($xPackageConfig);

        // Set the package options
        $cSetter = function($_aOptions) {

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

            $this->aOptions = $_aOptions;

The property aOptions does not exist. Did you maybe forget to declare it?

        };
        $xPackage = $this->getPackage($sClassName);
        // Can now access protected attributes
        \call_user_func($cSetter->bindTo($xPackage, $xPackage), $aOptions);

        $this->xCodeGenerator->addGenerator($xPackage, 500);
    }

Expected 2 blank lines after function; 1 found

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

Expected 7 spaces after parameter type; 8 found

Expected 5 spaces after parameter name; 10 found

     * @param string        $sCallable      The callable entity being registered

Expected 7 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 6 found

     * @param array|string  $aOptions       The associated options

Expected 1 spaces after parameter type; 2 found

Expected 2 spaces after parameter name; 7 found

     *
     * @return mixed
     */
    public function registerCallable($sType, $sCallable, $aOptions = [])
    {
        if(!key_exists($sType, $this->aRequestPlugins))
        {
            throw new \Jaxon\Exception\Error($this->trans('errors.register.plugin', ['name' => $sType]));
        }

        $xPlugin = $this->aRequestPlugins[$sType];
        return $xPlugin->register($sType, $sCallable, $aOptions);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Register callable from a section of the config
     *
     * @param Config        $xAppConfig        The config options

Expected 1 spaces after parameter type; 8 found

Expected 4 spaces after parameter name; 8 found

     * @param string        $sSection          The config section name

Expected 1 spaces after parameter type; 8 found

Expected 6 spaces after parameter name; 10 found

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 5 found

     *
     * @return void
     */
    private function registerCallablesFromConfig(Config $xAppConfig, $sSection, $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
            }
        }
    }

Expected 2 blank lines after function; 1 found

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 8 found

     *
     * @return void
     */
    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 = jaxon()->di();

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

        $aContainerConfig = $xAppConfig->getOption('container', []);
        foreach($aContainerConfig as $sClassName => $xClosure)
        {
            $di->set($sClassName, $xClosure);
        }
    }

Expected 2 blank lines after function; 1 found

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 8 found

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 16 found

     *
     * @return \Jaxon\Plugin\Response
     */
    public function getResponsePlugin($sName)
    {
        if(array_key_exists($sName, $this->aResponsePlugins))
        {
            return $this->aResponsePlugins[$sName];
        }
        return null;
    }

Expected 2 blank lines after function; 1 found

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 16 found

     *
     * @return \Jaxon\Plugin\Request
     */
    public function getRequestPlugin($sName)
    {
        if(array_key_exists($sName, $this->aRequestPlugins))
        {
            return $this->aRequestPlugins[$sName];
        }
        return null;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Register the Jaxon request plugins
     *
     * @return void
     */
    public function registerRequestPlugins()
    {
        $di = jaxon()->di();
        $this->registerPlugin($di->get(CallableClass::class), 101);
        $this->registerPlugin($di->get(CallableDir::class), 102);
        $this->registerPlugin($di->get(CallableFunction::class), 103);
        $this->registerPlugin($di->get(FileUpload::class), 104);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Register the Jaxon response plugins
     *
     * @return void
     */
    public function registerResponsePlugins()
    {
        $di = jaxon()->di();
        // Register an instance of the JQuery plugin
        $this->registerPlugin($di->get(JQueryPlugin::class), 700);
    }

Expected 2 blank lines after function; 0 found

}