Jaxon\Plugin\Request\CallableClass\CallableObject

Complexity

Total Complexity

36

Size/Duplication

Total Lines	319
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	hasMethod()	0	3	1
A	getCallableMethods()	0	17	4
A	getOptions()	0	3	1
A	setOptions()	0	3	1
A	callMethod()	0	5	1
A	excluded()	0	3	1
B	configure()	0	35	10
A	getJsName()	0	3	1
A	__construct()	0	4	1
A	setHookMethods()	0	11	4
A	getRegisteredObject()	0	3	1
A	getPublicMethods()	0	11	3
A	call()	0	9	1
A	callHookMethods()	0	21	6

<?php

/**
 * CallableObject.php - Jaxon callable object
 *
 * This class stores a reference to an object whose methods can be called from
 * the client via an Jaxon request
 *
 * The Jaxon plugin manager will call <CallableObject->getClientScript> so that
 * stub functions can be generated and sent to the browser.
 *
 * @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\Request\CallableClass;

use Jaxon\Di\Container;
use Jaxon\Response\ResponseInterface;

use ReflectionClass;
use ReflectionException;
use ReflectionMethod;

use function array_filter;
use function array_map;
use function array_merge;
use function in_array;
use function is_array;
use function is_string;
use function json_encode;
use function str_replace;
use function substr;

class CallableObject

Missing doc comment for class CallableObject

{
    /**
     * The DI container
     *
     * @var Container
     */
    protected $di;

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

    /**
     * The reflection class of the user registered callable object
     *
     * @var ReflectionClass
     */
    private $xReflectionClass;

    /**
     * A list of methods of the user registered callable object the library must not export to javascript
     *
     * @var array
     */
    private $aProtectedMethods = [];

    /**
     * A list of methods to call before processing the request
     *
     * @var array
     */
    private $aBeforeMethods = [];

    /**
     * A list of methods to call after processing the request
     *
     * @var array
     */
    private $aAfterMethods = [];

    /**
     * The callable object options
     *
     * @var array
     */
    private $aOptions = [];

    /**
     * The character to use as separator in javascript class names
     *
     * @var string
     */
    private $sSeparator = '.';

    /**
     * Check if the js code for this object must be generated
     *
     * @var bool

Expected "boolean" but found "bool" for @var tag in member variable comment

     */
    private $bExcluded = false;

    /**
     * The class constructor
     *
     * @param Container  $di

Missing parameter comment

Expected 7 spaces after parameter type; 2 found

     * @param ReflectionClass $xReflectionClass    The reflection class

Expected 1 spaces after parameter name; 4 found

     *
     */
    public function __construct(Container $di, ReflectionClass $xReflectionClass)

Expected 2 blank lines before function; 1 found

    {
        $this->di = $di;

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

        $this->xReflectionClass = $xReflectionClass;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get callable object options
     *
     * @return array
     */
    public function getOptions(): array
    {
        return $this->aOptions;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check if the js code for this object must be generated
     *
     * @return bool
     */
    public function excluded(): bool
    {
        return $this->bExcluded;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set callable object options
     *
     * @param array  $aOptions

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     *
     * @return void
     */
    public function setOptions(array $aOptions)
    {
        $this->aOptions = $aOptions;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the name of the corresponding javascript class
     *
     * @return string
     */
    public function getJsName(): string
    {
        return str_replace('\\', $this->sSeparator, $this->xReflectionClass->getName());
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set hook methods
     *
     * @param array $aHookMethods    The array of hook methods

Expected 8 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     * @param string|array $xValue    The value of the configuration option

Expected 7 spaces after parameter name; 4 found

     *
     * @return void
     */
    private function setHookMethods(array &$aHookMethods, $xValue)
    {
        foreach($xValue as $sCalledMethod => $xMethodToCall)
        {
            if(is_array($xMethodToCall))
            {
                $aHookMethods[$sCalledMethod] = $xMethodToCall;
            }
            elseif(is_string($xMethodToCall))
            {
                $aHookMethods[$sCalledMethod] = [$xMethodToCall];
            }
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set configuration options / call options for each method
     *
     * @param string $sName    The name of the configuration option

Expected 7 spaces after parameter type; 1 found

Expected 2 spaces after parameter name; 4 found

     * @param string|array $xValue    The value of the configuration option

Expected 1 spaces after parameter name; 4 found

     *
     * @return void
     */
    public function configure(string $sName, $xValue)
    {
        switch($sName)
        {
        // Set the separator
        case 'separator':
            if($xValue === '_' || $xValue === '.')
            {
                $this->sSeparator = $xValue;
            }
            break;
        // Set the protected methods
        case 'protected':
            if(is_array($xValue))
            {
                $this->aProtectedMethods = array_merge($this->aProtectedMethods, $xValue);
            }
            elseif(is_string($xValue))

The condition is_string($xValue) is always true.

            {
                $this->aProtectedMethods[] = $xValue;
            }
            break;
        // Set the methods to call before processing the request
        case '__before':
            $this->setHookMethods($this->aBeforeMethods, $xValue);
            break;
        // Set the methods to call after processing the request
        case '__after':
            $this->setHookMethods($this->aAfterMethods, $xValue);
            break;
        case 'excluded':
            $this->bExcluded = (bool)$xValue;
            break;
        default:
            break;
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * Return a list of methods of the callable object
     *
     * @param array $aProtectedMethods    The protected methods

Expected 1 spaces after parameter name; 4 found

     *
     * @return array
     */
    public function getPublicMethods(array $aProtectedMethods = []): array
    {
        $aMethods = array_map(function($xMethod) {
            return $xMethod->getShortName();
        }, $this->xReflectionClass->getMethods(ReflectionMethod::IS_PUBLIC));
        return array_filter($aMethods, function($sMethodName) use($aProtectedMethods) {
            // Don't take magic __call, __construct, __destruct methods
            // Don't take protected methods
            return !(substr($sMethodName, 0, 2) === '__' ||
                in_array($sMethodName, $aProtectedMethods) ||
                in_array($sMethodName, $this->aProtectedMethods));
        });
    }

Expected 2 blank lines after function; 1 found

    /**
     * Return a list of methods of the callable object to export to javascript
     *
     * @param array $aProtectedMethods    The protected methods

Expected 1 spaces after parameter name; 4 found

     *
     * @return array
     */
    public function getCallableMethods(array $aProtectedMethods): array
    {
        // Convert an option to a string to be displayed in the js script template.
        $fConvertOption = function($xOption) {
            return is_array($xOption) ? json_encode($xOption) : $xOption;
        };
        $aCommonConfig = isset($this->aOptions['*']) ? array_map($fConvertOption, $this->aOptions['*']) : [];

        return array_map(function($sMethodName) use($fConvertOption, $aCommonConfig) {
            // Specific options for this method
            $aMethodConfig = isset($this->aOptions[$sMethodName]) ?

Expected 1 space after "?"; newline found

                array_map($fConvertOption, $this->aOptions[$sMethodName]) : [];
            return [
                'name' => $sMethodName,
                'config' => array_merge($aCommonConfig, $aMethodConfig),
            ];
        }, $this->getPublicMethods($aProtectedMethods));
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the registered callable object
     *
     * @return null|object
     */
    public function getRegisteredObject()
    {
        return $this->di->g($this->xReflectionClass->getName());
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check if the specified method name is one of the methods of the registered callable object
     *
     * @param string $sMethod    The name of the method to check

Expected 1 spaces after parameter name; 4 found

     *
     * @return bool
     */
    public function hasMethod(string $sMethod): bool
    {
        return $this->xReflectionClass->hasMethod($sMethod);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Call the specified method of the registered callable object using the specified array of arguments
     *
     * @param string $sMethod    The method name

Expected 5 spaces after parameter name; 4 found

     * @param array $aArgs    The method arguments

Expected 2 spaces after parameter type; 1 found

Expected 7 spaces after parameter name; 4 found

     * @param bool $bAccessible    If false, only calls to public method are allowed

Expected 3 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     *
     * @return mixed
     * @throws ReflectionException
     */
    private function callMethod(string $sMethod, array $aArgs, bool $bAccessible)
    {
        $reflectionMethod = $this->xReflectionClass->getMethod($sMethod);
        $reflectionMethod->setAccessible($bAccessible); // Make it possible to call protected methods
        return $reflectionMethod->invokeArgs($this->getRegisteredObject(), $aArgs);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Call the specified method of the registered callable object using the specified array of arguments
     *
     * @param array $aClassMethods    The method config options

Expected 2 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     * @param string $sMethod    The method called by the request

Expected 7 spaces after parameter name; 4 found

     *
     * @return void
     * @throws ReflectionException
     */
    private function callHookMethods(array $aClassMethods, string $sMethod)
    {
        $aMethods = [];
        if(isset($aClassMethods[$sMethod]))
        {
            $aMethods = $aClassMethods[$sMethod];
        }
        elseif(isset($aClassMethods['*']))
        {
            $aMethods = $aClassMethods['*'];
        }
        foreach($aMethods as $xKey => $xValue)
        {
            $sMethodName = $xValue;
            $aMethodArgs = [];
            if(is_string($xKey))
            {
                $sMethodName = $xKey;
                $aMethodArgs = is_array($xValue) ? $xValue : [$xValue];
            }
            $this->callMethod($sMethodName, $aMethodArgs, true);
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * Call the specified method of the registered callable object using the specified array of arguments
     *
     * @param string $sMethod    The name of the method to call

Expected 1 spaces after parameter name; 4 found

     * @param array $aArgs    The arguments to pass to the method

Expected 2 spaces after parameter type; 1 found

Expected 3 spaces after parameter name; 4 found

     *
     * @return null|ResponseInterface
     * @throws ReflectionException
     */
    public function call(string $sMethod, array $aArgs): ?ResponseInterface
    {
        // Methods to call before processing the request
        $this->callHookMethods($this->aBeforeMethods, $sMethod);
        // Call the request method
        $xResponse = $this->callMethod($sMethod, $aArgs, false);
        // Methods to call after processing the request
        $this->callHookMethods($this->aAfterMethods, $sMethod);
        return $xResponse;
    }

Expected 2 blank lines after function; 0 found

}