CallableObject::isProtectedMethod() - Code Metrics - Inspection of "Added tests for the 'excluded' option of callable..." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — main ( 18c043...2ebc4f )

by Thierry
created 2024-01-19 01:13 UTC
CallableObject::isProtectedMethod() A

↳ Parent: CallableObject
Complexity

Conditions	5
Paths	7
Size

Total Lines	8
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	4
c	0
b	0
f	0
dl	0
loc	8
rs	9.6111
cc	5
nc	7
nop	2
<?php

/**
 * CallableObject.php
 *
 * Jaxon callable object
 *
 * This class stores a reference to an object whose methods can be called from
 * the client via a 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

 * @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\Request\CallableClass;

use Jaxon\Di\Container;
use Jaxon\Exception\SetupException;
use Jaxon\Plugin\AnnotationReaderInterface;
use Jaxon\Request\Target;
use Jaxon\Response\ResponseInterface;
use ReflectionClass;
use ReflectionException;
use ReflectionMethod;
use ReflectionProperty;

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

class CallableObject

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


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

    /**
     * The user registered callable object
     *
     * @var mixed
     */
    private $xRegisteredObject = null;

    /**
     * The target of the Jaxon call
     *
     * @var Target
     */
    private $xTarget;

    /**
     * The options of this callable object
     *
     * @var CallableObjectOptions|null
     */
    private $xOptions = null;

    /**
     * @var int

     */
    private $nPropertiesFilter = ReflectionProperty::IS_PUBLIC | ReflectionProperty::IS_PROTECTED;

    /**
     * @var int

     */
    private $nMethodsFilter = ReflectionMethod::IS_PUBLIC;

    /**
     * @var array
     */
    private $aProtectedMethods;

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

     * @param AnnotationReaderInterface $xAnnotationReader

     * @param ReflectionClass $xReflectionClass    The reflection class

     * @param array $aOptions

     * @param array $aProtectedMethods

     */
    public function __construct(Container $di, AnnotationReaderInterface $xAnnotationReader,

        ReflectionClass $xReflectionClass, array $aOptions, array $aProtectedMethods)
    {
        $this->di = $di;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xReflectionClass = $xReflectionClass;
        $this->aProtectedMethods = array_fill_keys($aProtectedMethods, true);

        $aAnnotations = $xAnnotationReader->getAttributes($xReflectionClass->getName(),
$a = "a";
$ab = "ab";
$abc = "abc";
            $this->getPublicMethods(true), $this->getProperties());
        $this->xOptions = new CallableObjectOptions($aOptions, $aAnnotations);
    }


    /**
     * Get the public and protected attributes of the callable object
     *
     * @return array
     */
    private function getProperties(): array
    {
        return array_map(function($xProperty) {
            return $xProperty->getName();
        }, $this->xReflectionClass->getProperties($this->nPropertiesFilter));
    }


    /**
     * @param string $sMethodName

     * @param bool $bTakeAll

     *
     * @return bool
     */
    private function isProtectedMethod(string $sMethodName, bool $bTakeAll): bool
    {
        // Don't take magic __call, __construct, __destruct methods
        // Don't take protected methods
        return substr($sMethodName, 0, 2) === '__' ||
            isset($this->aProtectedMethods[$sMethodName]) ||
            (!$bTakeAll && $this->xOptions !== null &&
            $this->xOptions->isProtectedMethod($sMethodName));
    }


    /**
     * Get the public methods of the callable object
     *
     * @param bool $bTakeAll

     *
     * @return array
     */
    public function getPublicMethods(bool $bTakeAll): array
    {
        $aMethods = array_map(function($xMethod) {
            return $xMethod->getShortName();
        }, $this->xReflectionClass->getMethods($this->nMethodsFilter));

        return array_filter($aMethods, function($sMethodName) use($bTakeAll) {
            return !$this->isProtectedMethod($sMethodName, $bTakeAll);
        });
    }


    /**
     * @return bool
     */
    public function excluded(): bool
    {
        return $this->xOptions->excluded();
        return $this->xOptions->/** @scrutinizer ignore-call */ excluded();
    }


    /**
     * Get the name of the registered PHP class
     *
     * @return string
     */
    public function getClassName(): string
    {
        return $this->xReflectionClass->getName();
    }


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


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

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

     *
     * @return void
     */
    public function configure(string $sName, $xValue)
    {
        $this->xOptions->addOption($sName, $xValue);
    }


    /**
     * @return array
     */
    public function getClassDiOptions(): array
    {
        $aDiOptions = $this->xOptions->diOptions();
        return $aDiOptions['*'] ?? [];
    }


    /**
     * @param string $sMethodName

     *
     * @return array
     */
    public function getMethodDiOptions(string $sMethodName): array
    {
        $aDiOptions = $this->xOptions->diOptions();
        return $aDiOptions[$sMethodName] ?? [];
    }


    /**
     * Get the js options of the callable class
     *
     * @return array
     */
    public function getOptions(): array
    {
        return $this->xOptions->jsOptions();
    }


    /**
     * Return a list of methods of the callable object to export to javascript
     *
     * @return array
     */
    public function getCallableMethods(): 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;
        };

        return array_map(function($sMethodName) use($fConvertOption) {
            return [
                'name' => $sMethodName,
                'config' => array_map($fConvertOption, $this->xOptions->getMethodOptions($sMethodName)),
            ];
        }, $this->getPublicMethods(false));
    }


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


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

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


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

     * @param array $aArgs    The method arguments

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

     *
     * @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->xRegisteredObject, $aArgs);
    }


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

     *
     * @return void
     * @throws ReflectionException
     */
    private function callHookMethods(array $aHookMethods)
    {
        $sMethod = $this->xTarget->getMethodName();
        // The hooks defined at method level are merged with those defined at class level.
        $aMethods = array_merge($aHookMethods['*'] ?? [], $aHookMethods[$sMethod] ?? []);
        foreach($aMethods as $xKey => $xValue)
        {
            $sHookName = $xValue;
            $aHookArgs = [];
            if(is_string($xKey))
            {
                $sHookName = $xKey;
                $aHookArgs = is_array($xValue) ? $xValue : [$xValue];
            }
            $this->callMethod($sHookName, $aHookArgs, true);
        }
    }


    /**
     * Call the specified method of the registered callable object using the specified array of arguments
     *
     * @param Target $xTarget The target of the Jaxon call
     *
     * @return null|ResponseInterface
     * @throws ReflectionException
     * @throws SetupException
     */
    public function call(Target $xTarget): ?ResponseInterface
    {
        $this->xTarget = $xTarget;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xRegisteredObject = $this->di->getRegisteredObject($this, $xTarget);

        // Methods to call before processing the request
        $this->callHookMethods($this->xOptions->beforeMethods());

        // Call the request method
        $sMethod = $xTarget->getMethodName();
$a = "a";
$ab = "ab";
$abc = "abc";
        $xResponse = $this->callMethod($sMethod, $this->xTarget->getMethodArgs(), false);

        // Methods to call after processing the request
        $this->callHookMethods($this->xOptions->afterMethods());
        return $xResponse;
    }

}

jaxon-php / jaxon-core

Push — main ( 18c043...2ebc4f )

CallableObject::isProtectedMethod() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
