Jaxon\Request\Plugin\CallableClass

Complexity

Total Complexity

41

Size/Duplication

Total Lines	296
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	14

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	22	5
A	getName()	0	4	1
A	getTarget()	0	8	3
A	register()	0	25	5
A	generateHash()	0	18	3
A	getNamespacesScript()	0	25	4
B	getCallableScript()	0	31	6
A	getScript()	0	22	3
A	canProcessRequest()	0	11	6
A	processRequest()	0	26	5

<?php

/**
 * CallableClass.php - Jaxon callable class plugin
 *
 * This class registers user defined callable classes, generates client side javascript code,
 * and calls their methods on user request
 *
 * @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\Request\Plugin;

use Jaxon\Jaxon;
use Jaxon\CallableClass as UserCallableClass;
use Jaxon\Plugin\Request as RequestPlugin;
use Jaxon\Request\Support\CallableObject;
use Jaxon\Request\Support\CallableRegistry;
use Jaxon\Request\Support\CallableRepository;
use Jaxon\Request\Target;

class CallableClass extends RequestPlugin

Missing doc comment for class CallableClass

{
    use \Jaxon\Features\Config;
    use \Jaxon\Features\Template;
    use \Jaxon\Features\Validator;
    use \Jaxon\Features\Translator;

    /**
     * The callable registrar
     *
     * @var CallableRegistry
     */
    protected $xRegistry;

    /**
     * The callable repository
     *
     * @var CallableRepository
     */
    protected $xRepository;

    /**
     * The value of the class parameter of the incoming Jaxon request
     *
     * @var string
     */
    protected $sRequestedClass = '';

    /**
     * The value of the method parameter of the incoming Jaxon request
     *
     * @var string
     */
    protected $sRequestedMethod = '';

    /**
     * The class constructor
     *
     * @param CallableRegistry      $xRegistry      The callable class registry

Expected 3 spaces after parameter type; 6 found

Expected 3 spaces after parameter name; 6 found

     * @param CallableRepository    $xRepository    The callable object repository

Expected 1 spaces after parameter type; 4 found

Expected 1 spaces after parameter name; 4 found

     */
    public function __construct(CallableRegistry $xRegistry, CallableRepository $xRepository)
    {
        $this->xRegistry = $xRegistry;

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

        $this->xRepository = $xRepository;

        if(!empty($_GET['jxncls']))
        {
            $this->sRequestedClass = trim($_GET['jxncls']);
        }
        if(!empty($_GET['jxnmthd']))
        {
            $this->sRequestedMethod = trim($_GET['jxnmthd']);
        }
        if(!empty($_POST['jxncls']))
        {
            $this->sRequestedClass = trim($_POST['jxncls']);
        }
        if(!empty($_POST['jxnmthd']))
        {
            $this->sRequestedMethod = trim($_POST['jxnmthd']);
        }
    }

    /**
     * Return the name of this plugin
     *
     * @return string
     */
    public function getName()
    {
        return Jaxon::CALLABLE_CLASS;
    }

    /**
     * Return the target class and method
     *
     * @return Target|null
     */
    public function getTarget()
    {
        if(!$this->sRequestedClass || !$this->sRequestedMethod)
        {
            return null;
        }
        return Target::makeClass($this->sRequestedClass, $this->sRequestedMethod);
    }

    /**
     * Register a callable class
     *
     * @param string        $sType          The type of request handler being registered

Expected 7 spaces after parameter type; 8 found

Expected 6 spaces after parameter name; 10 found

     * @param string        $sClassName     The name of the class being registered

Expected 7 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 5 found

     * @param array|string  $aOptions       The associated options

Expected 1 spaces after parameter type; 2 found

Expected 3 spaces after parameter name; 7 found

     *
     * @return boolean
     */
    public function register($sType, $sClassName, $aOptions)
    {
        $sType = trim($sType);

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

        if($sType != $this->getName())
        {
            return false;
        }

        if(!is_string($sClassName))
        {
            throw new \Jaxon\Exception\Error($this->trans('errors.objects.invalid-declaration'));
        }
        if(is_string($aOptions))
        {
            $aOptions = ['include' => $aOptions];

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

        }
        if(!is_array($aOptions))
        {
            throw new \Jaxon\Exception\Error($this->trans('errors.objects.invalid-declaration'));
        }

        $this->xRepository->addClass(trim($sClassName), $aOptions);

        return true;
    }

    /**
     * Generate a hash for the registered callable objects
     *
     * @return string
     */
    public function generateHash()
    {
        $this->xRegistry->createCallableObjects();
        $aNamespaces = $this->xRepository->getNamespaces();

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

        $aCallableObjects = $this->xRepository->getCallableObjects();
        $sHash = '';

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

        foreach($aNamespaces as $sNamespace => $aOptions)
        {
            $sHash .= $sNamespace . $aOptions['separator'];
        }
        foreach($aCallableObjects as $sClassName => $xCallableObject)
        {
            $sHash .= $sClassName . implode('|', $xCallableObject->getMethods());
        }

        return md5($sHash);
    }

    /**
     * Generate client side javascript code for namespaces
     *
     * @return string
     */
    private function getNamespacesScript()
    {
        $sCode = '';

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

        $sPrefix = $this->getOption('core.prefix.class');

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

        $aJsClasses = [];

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

        $aNamespaces = array_keys($this->xRepository->getNamespaces());
        foreach($aNamespaces as $sNamespace)
        {
            $offset = 0;

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

            $sJsNamespace = str_replace('\\', '.', $sNamespace);

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

            $sJsNamespace .= '.Null'; // This is a sentinel. The last token is not processed in the while loop.
            while(($dotPosition = strpos($sJsNamespace, '.', $offset)) !== false)

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

            {
                $sJsClass = substr($sJsNamespace, 0, $dotPosition);
                // Generate code for this object
                if(!key_exists($sJsClass, $aJsClasses))
                {
                    $sCode .= "$sPrefix$sJsClass = {};\n";

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

                    $aJsClasses[$sJsClass] = $sJsClass;
                }
                $offset = $dotPosition + 1;
            }
        }
        return $sCode;
    }

    /**
     * Generate client side javascript code for a callable class
     *
     * @param string            $sClassName         The class name

Expected 9 spaces after parameter type; 12 found

Expected 8 spaces after parameter name; 9 found

     * @param CallableObject    $xCallableObject    The corresponding callable object

Expected 1 spaces after parameter type; 4 found

Expected 3 spaces after parameter name; 4 found

     * @param array             $aProtectedMethods  The protected methods

Expected 10 spaces after parameter type; 13 found

Expected 1 spaces after parameter name; 2 found

     *
     * @return string
     */
    private function getCallableScript($sClassName, CallableObject $xCallableObject, array $aProtectedMethods)
    {
        $aCallableOptions = $this->xRepository->getCallableOptions();
        $aConfig = $aCallableOptions[$sClassName];

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

        $aCommonConfig = key_exists('*', $aConfig) ? $aConfig['*'] : [];

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

        $_aProtectedMethods = is_subclass_of($sClassName, UserCallableClass::class) ? $aProtectedMethods : [];
        $aMethods = [];

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

        foreach($xCallableObject->getMethods() as $sMethodName)
        {
            // Don't export methods of the CallableClass class
            if(in_array($sMethodName, $_aProtectedMethods))
            {
                continue;
            }
            // Specific options for this method
            $aMethodConfig = key_exists($sMethodName, $aConfig) ?

Expected 1 space after "?"; newline found

                array_merge($aCommonConfig, $aConfig[$sMethodName]) : $aCommonConfig;
            $aMethods[] = [

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

                'name' => $sMethodName,
                'config' => $aMethodConfig,
            ];
        }

        $sPrefix = $this->getOption('core.prefix.class');
        return $this->render('jaxon::support/object.js', [
            'sPrefix' => $sPrefix,
            'sClass' => $xCallableObject->getJsName(),
            'aMethods' => $aMethods,
        ]);
    }

    /**
     * Generate client side javascript code for the registered callable objects
     *
     * @return string
     */
    public function getScript()
    {
        $this->xRegistry->createCallableObjects();

        // The methods of the \Jaxon\CallableClass class must not be exported
        $xCallableClass = new \ReflectionClass(UserCallableClass::class);

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

        $aProtectedMethods = [];
        foreach($xCallableClass->getMethods(\ReflectionMethod::IS_PUBLIC) as $xMethod)
        {
            $aProtectedMethods[] = $xMethod->getName();
        }

        $sCode = $this->getNamespacesScript();

        $aCallableObjects = $this->xRepository->getCallableObjects();
        foreach($aCallableObjects as $sClassName => $xCallableObject)
        {
            $sCode .= $this->getCallableScript($sClassName, $xCallableObject, $aProtectedMethods);
        }

        return $sCode;
    }

    /**
     * Check if this plugin can process the incoming Jaxon request
     *
     * @return boolean
     */
    public function canProcessRequest()
    {
        // Check the validity of the class name
        if(($this->sRequestedClass !== null && !$this->validateClass($this->sRequestedClass)) ||
            ($this->sRequestedMethod !== null && !$this->validateMethod($this->sRequestedMethod)))
        {
            $this->sRequestedClass = null;

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

            $this->sRequestedMethod = null;
        }
        return ($this->sRequestedClass !== null && $this->sRequestedMethod !== null);
    }

    /**
     * Process the incoming Jaxon request
     *
     * @return boolean
     */
    public function processRequest()
    {
        if(!$this->canProcessRequest())
        {
            return false;
        }

        // Find the requested method
        $xCallableObject = $this->xRegistry->getCallableObject($this->sRequestedClass);
        if(!$xCallableObject || !$xCallableObject->hasMethod($this->sRequestedMethod))
        {
            // Unable to find the requested object or method
            throw new \Jaxon\Exception\Error($this->trans('errors.objects.invalid',
                ['class' => $this->sRequestedClass, 'method' => $this->sRequestedMethod]));
        }

        // Call the requested method
        $di = jaxon()->di();

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

        $aArgs = $di->getRequestHandler()->processArguments();

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

        $xResponse = $xCallableObject->call($this->sRequestedMethod, $aArgs);
        if(($xResponse))
        {
            $di->getResponseManager()->append($xResponse);
        }
        return true;
    }
}