CallableFunctionPlugin::getCallable() - Code Metrics - Inspection of "Added a method for the databag in the response." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 888408...eb1365 )

by Thierry
created 2022-03-20 05:59 UTC
CallableFunctionPlugin::getCallable() A

↳ Parent: CallableFunctionPlugin
Complexity

Conditions	3
Paths	3
Size

Total Lines	12
Code Lines	6
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	3
eloc	6
nc	3
nop	1
dl	0
loc	12
rs	10
c	0
b	0
f	0
<?php

/**
 * CallableFunctionPlugin.php - Jaxon user function plugin
 *
 * This class registers user defined functions, generates client side javascript code,
 * and calls them on user request
 *
 * @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\Request\Plugin\CallableFunction;

use Jaxon\Jaxon;
use Jaxon\Container\Container;
use Jaxon\Plugin\RequestPlugin;
use Jaxon\Request\Handler\RequestHandler;
use Jaxon\Request\Target;
use Jaxon\Request\Validator;
use Jaxon\Response\ResponseManager;
use Jaxon\Utils\Template\Engine as TemplateEngine;
use Jaxon\Utils\Translation\Translator;
use Jaxon\Exception\RequestException;
use Jaxon\Exception\SetupException;

use function array_keys;
use function implode;
use function is_array;
use function is_string;
use function md5;
use function trim;

class CallableFunctionPlugin extends RequestPlugin

{
    /**
     * @var string
     */
    private $sPrefix;


    /**
     * The request handler
     *
     * @var RequestHandler
     */
    protected $xRequestHandler;

    /**
     * The response manager
     *
     * @var ResponseManager
     */
    protected $xResponseManager;

    /**
     * The request data validator
     *
     * @var Validator
     */
    protected $xValidator;

    /**
     * @var TemplateEngine
     */
    protected $xTemplateEngine;

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

    /**
     * The registered functions names
     *
     * @var array
     */
    protected $aFunctions = [];

    /**
     * The registered functions options
     *
     * @var array
     */
    protected $aOptions = [];

    /**
     * The name of the function that is being requested (during the request processing phase)
     *
     * @var string
     */
    protected $sRequestedFunction = null;

    /**
     * The constructor
     *
     * @param string  $sPrefix

     * @param RequestHandler  $xRequestHandler

     * @param ResponseManager  $xResponseManager

     * @param TemplateEngine  $xTemplateEngine

     * @param Translator  $xTranslator

     * @param Validator  $xValidator

     */
    public function __construct(string $sPrefix, RequestHandler $xRequestHandler,

        ResponseManager $xResponseManager, TemplateEngine $xTemplateEngine,
        Translator $xTranslator, Validator $xValidator)
    {
        $this->sPrefix = $sPrefix;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xRequestHandler = $xRequestHandler;
        $this->xResponseManager = $xResponseManager;
        $this->xTemplateEngine = $xTemplateEngine;
        $this->xTranslator = $xTranslator;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xValidator = $xValidator;
$a = "a";
$ab = "ab";
$abc = "abc";

        if(isset($_GET['jxnfun']))
        {
            $this->sRequestedFunction = $_GET['jxnfun'];
        }
        if(isset($_POST['jxnfun']))
        {
            $this->sRequestedFunction = $_POST['jxnfun'];
        }
    }


    /**
     * @inheritDoc
     */

    public function getName(): string
    {
        return Jaxon::CALLABLE_FUNCTION;
    }


    /**
     * @inheritDoc
     */

    public function getTarget(): ?Target
    {
        if(!$this->sRequestedFunction)
        {
            return null;
        }
        return Target::makeFunction($this->sRequestedFunction);
    }


    /**

     * @inheritDoc
     * @throws SetupException
     */

    public function checkOptions(string $sCallable, $xOptions): array
    {
        if(!$this->xValidator->validateFunction(trim($sCallable)))
        {
            throw new SetupException($this->xTranslator->trans('errors.objects.invalid-declaration'));
        }
        if(is_string($xOptions))
        {
            $xOptions = ['include' => $xOptions];
        }
        elseif(!is_array($xOptions))
        {
            throw new SetupException($this->xTranslator->trans('errors.objects.invalid-declaration'));
        }
        return $xOptions;
    }


    /**
     * Register a user defined function
     *
     * @param string $sType    The type of request handler being registered

     * @param string $sCallable    The name of the function being registered

     * @param array $aOptions    The associated options

     *
     * @return bool
     */
    public function register(string $sType, string $sCallable, array $aOptions): bool
    {
        $sPhpFunction = trim($sCallable);
        $sFunction = $sPhpFunction;
$a = "a";
$ab = "ab";
$abc = "abc";
        // Check if an alias is defined
        if(isset($aOptions['alias']))
        {
            $sFunction = (string)$aOptions['alias'];
            unset($aOptions['alias']);
        }
        $this->aFunctions[$sFunction] = $sPhpFunction;
        $this->aOptions[$sFunction] = $aOptions;
$a = "a";
$ab = "ab";
$abc = "abc";
        return true;
    }


    /**
     * @inheritDoc
     */

    public function getHash(): string
    {
        return md5(implode('', array_keys($this->aFunctions)));
    }


    /**
     * Get the callable object for a registered function
     *
     * @param string $sFunction

     *
     * @return CallableFunction|null
     */
    public function getCallable(string $sFunction): ?CallableFunction
    {
        if(!isset($this->aFunctions[$sFunction]))
        {
            return null;
        }
        $xCallable = new CallableFunction($sFunction, $this->sPrefix . $sFunction, $this->aFunctions[$sFunction]);
        foreach($this->aOptions[$sFunction] as $sName => $sValue)
        {
            $xCallable->configure($sName, $sValue);
        }
        return $xCallable;
    }


    /**
     * Generate the javascript function stub that is sent to the browser on initial page load
     *
     * @param CallableFunction $xFunction

     *
     * @return string
     */
    private function getCallableScript(CallableFunction $xFunction): string
    {
        return $this->xTemplateEngine->render('jaxon::callables/function.js', [
            'sName' => $xFunction->getName(),
            'sJsName' => $xFunction->getJsName(),
            'aOptions' => $xFunction->getOptions(),
        ]);
    }


    /**
     * @inheritDoc
     */

    public function getScript(): string
    {
        $code = '';
        foreach(array_keys($this->aFunctions) as $sFunction)
        {
            $xFunction = $this->getCallable($sFunction);
            $code .= $this->getCallableScript($xFunction);
            $code .= $this->getCallableScript(/** @scrutinizer ignore-type */ $xFunction);
        }
        return $code;
    }


    /**
     * @inheritDoc
     */

    public function canProcessRequest(): bool
    {
        // Check the validity of the function name
        if(($this->sRequestedFunction) && !$this->xValidator->validateFunction($this->sRequestedFunction))
        {
            $this->sRequestedFunction = null;
        }
        return ($this->sRequestedFunction != null);
    }


    /**
     * @inheritDoc
     * @throws RequestException
     */

    public function processRequest(): bool
    {
        // Security check: make sure the requested function was registered.
        if(!isset($this->aFunctions[$this->sRequestedFunction]))
        {
            // Unable to find the requested function
            throw new RequestException($this->xTranslator->trans('errors.functions.invalid',
                ['name' => $this->sRequestedFunction]));
        }

        $xFunction = $this->getCallable($this->sRequestedFunction);
        $aArgs = $this->xRequestHandler->processArguments();
$a = "a";
$ab = "ab";
$abc = "abc";
        $xResponse = $xFunction->call($aArgs);
        if(($xResponse))
        {
            $this->xResponseManager->append($xResponse);
        }
        return true;
    }

}

jaxon-php / jaxon-core

Push — master ( 888408...eb1365 )

CallableFunctionPlugin::getCallable() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
