jaxon-php / jaxon-mono

jaxon-core/src/Plugin/Request/CallableClass/CallableClassPlugin.php

Switch Indentation +222 added lines, -222 removed lines

@@ -46,17 +46,17 @@ 
 
 class CallableClassPlugin extends AbstractRequestPlugin
 {
-    /**
+/**
      * @var array<CallableObject>
      */
-    private array $aCallableObjects = [];
+private array $aCallableObjects = [];
 
-    /**
+/**
      * @var array<string>
      */
-    private array $aCallableParams = [];
+private array $aCallableParams = [];
 
-    /**
+/**
      * The class constructor
      *
      * @param string $sPrefix
@@ -67,162 +67,162 @@ 
      * @param TemplateEngine $xTemplateEngine
      * @param Validator $xValidator
      */
-    public function __construct(private string $sPrefix,
-        private LoggerInterface $xLogger, private ComponentContainer $cdi,
-        private ComponentRegistry $xRegistry, private Translator $xTranslator,
-        private TemplateEngine $xTemplateEngine, private Validator $xValidator)
-    {}
+public function __construct(private string $sPrefix,
+private LoggerInterface $xLogger, private ComponentContainer $cdi,
+private ComponentRegistry $xRegistry, private Translator $xTranslator,
+private TemplateEngine $xTemplateEngine, private Validator $xValidator)
+{}
 
-    /**
+/**
      * @inheritDoc
      */
-    public function getName(): string
-    {
-        return Jaxon::CALLABLE_CLASS;
-    }
+public function getName(): string
+{
+return Jaxon::CALLABLE_CLASS;
+}
 
-    /**
+/**
      * @inheritDoc
      * @throws SetupException
      */
-    public function checkOptions(string $sCallable, $xOptions): array
-    {
-        if(!$this->xValidator->validateClass(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;
-    }
-
-    /**
+public function checkOptions(string $sCallable, $xOptions): array
+{
+if(!$this->xValidator->validateClass(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;
+}
+
+/**
      * @inheritDoc
      */
-    public function register(string $sType, string $sCallable, array $aOptions): bool
-    {
-        $sClassName = trim($sCallable);
-        $this->xRegistry->registerComponent($sClassName, $aOptions);
-        return true;
-    }
-
-    /**
+public function register(string $sType, string $sCallable, array $aOptions): bool
+{
+$sClassName = trim($sCallable);
+$this->xRegistry->registerComponent($sClassName, $aOptions);
+return true;
+}
+
+/**
      * @inheritDoc
      * @throws SetupException
      */
-    public function getCallable(string $sCallable): CallableObject|null
-    {
-        return $this->cdi->makeCallableObject($sCallable);
-    }
+public function getCallable(string $sCallable): CallableObject|null
+{
+return $this->cdi->makeCallableObject($sCallable);
+}
 
-    /**
+/**
      * @inheritDoc
      */
-    public function getHash(): string
-    {
-        $this->xRegistry->registerAllComponents();
-        return md5($this->xRegistry->getHash());
-    }
+public function getHash(): string
+{
+$this->xRegistry->registerAllComponents();
+return md5($this->xRegistry->getHash());
+}
 
-    /**
+/**
      * Add a callable object to the script generator
      *
      * @param CallableObject $xCallableObject
      *
      * @return void
      */
-    private function addCallable(CallableObject $xCallableObject): void
-    {
-        $aCallableMethods = $xCallableObject->getCallableMethods();
-        if($xCallableObject->excluded() || count($aCallableMethods) === 0)
-        {
-            return;
-        }
-
-        $aCallableObject = &$this->aCallableObjects;
-        $sJsName = $xCallableObject->getJsName();
-        foreach(explode('.', $sJsName) as $sName)
-        {
-            if(!isset($aCallableObject['children'][$sName]))
-            {
-                $aCallableObject['children'][$sName] = [];
-            }
-            $aCallableObject = &$aCallableObject['children'][$sName];
-        }
-
-        $sJsParam = $xCallableObject->getJsParam();
-
-        $aCallableObject['methods'] = $aCallableMethods;
-        $aCallableObject['param'] = $sJsParam;
-
-        // Add the js param to the list, if it is not already in.
-        if(isset($this->aCallableParams[$sJsParam]))
-        {
-            $aCallableObject['index'] = $this->aCallableParams[$sJsParam];
-            return;
-        }
-
-        $nIndex = count($this->aCallableParams);
-        $this->aCallableParams[$sJsParam] = $nIndex;
-        $aCallableObject['index'] = $nIndex;
-    }
-
-    /**
+private function addCallable(CallableObject $xCallableObject): void
+{
+$aCallableMethods = $xCallableObject->getCallableMethods();
+if($xCallableObject->excluded() || count($aCallableMethods) === 0)
+{
+return;
+}
+
+$aCallableObject = &$this->aCallableObjects;
+$sJsName = $xCallableObject->getJsName();
+foreach(explode('.', $sJsName) as $sName)
+{
+if(!isset($aCallableObject['children'][$sName]))
+{
+    $aCallableObject['children'][$sName] = [];
+}
+$aCallableObject = &$aCallableObject['children'][$sName];
+}
+
+$sJsParam = $xCallableObject->getJsParam();
+
+$aCallableObject['methods'] = $aCallableMethods;
+$aCallableObject['param'] = $sJsParam;
+
+// Add the js param to the list, if it is not already in.
+if(isset($this->aCallableParams[$sJsParam]))
+{
+$aCallableObject['index'] = $this->aCallableParams[$sJsParam];
+return;
+}
+
+$nIndex = count($this->aCallableParams);
+$this->aCallableParams[$sJsParam] = $nIndex;
+$aCallableObject['index'] = $nIndex;
+}
+
+/**
      * @param string $sIndent
      * @param array $aTemplateVars
      *
      * @return string
      */
-    private function renderMethod(string $sIndent, array $aTemplateVars): string
-    {
-        $aOptions = [];
-        foreach($aTemplateVars['aMethod']['options'] as $sKey => $sValue)
-        {
-            $aOptions[] = "$sKey: $sValue";
-        }
-        $aTemplateVars['sArguments'] = count($aOptions) === 0 ? 'args' :
-            'args, { ' . implode(', ', $aOptions) . ' }';
-
-        return $sIndent . trim($this->xTemplateEngine
-            ->render('jaxon::callables/method.js', $aTemplateVars));
-    }
-
-    /**
+private function renderMethod(string $sIndent, array $aTemplateVars): string
+{
+$aOptions = [];
+foreach($aTemplateVars['aMethod']['options'] as $sKey => $sValue)
+{
+$aOptions[] = "$sKey: $sValue";
+}
+$aTemplateVars['sArguments'] = count($aOptions) === 0 ? 'args' :
+'args, { ' . implode(', ', $aOptions) . ' }';
+
+return $sIndent . trim($this->xTemplateEngine
+->render('jaxon::callables/method.js', $aTemplateVars));
+}
+
+/**
      * @param string $sJsClass
      * @param array $aCallable
      * @param int $nIndent
      *
      * @return string
      */
-    private function renderCallable(string $sJsClass, array $aCallable, int $nIndent): string
-    {
-        $nIndent += 2; // Indentation.
-        $sIndent = str_repeat(' ', $nIndent);
-
-        $fMethodCallback = fn($aMethod) => $this->renderMethod($sIndent, [
-            'aMethod' => $aMethod,
-            'nIndex' => $aCallable['index'] ?? 0,
-        ]);
-        $aMethods = !isset($aCallable['methods']) ? [] :
-            array_map($fMethodCallback, $aCallable['methods']);
-
-        $aChildren = [];
-        foreach($aCallable['children'] ?? [] as $sName => $aChild)
-        {
-            $aChildren[] = $this->renderChild("$sName:", "$sJsClass.$sName",
-                $aChild, $nIndent) . ',';
-        }
-
-        return implode("\n", array_merge($aMethods, $aChildren));
-    }
-
-    /**
+private function renderCallable(string $sJsClass, array $aCallable, int $nIndent): string
+{
+$nIndent += 2; // Indentation.
+$sIndent = str_repeat(' ', $nIndent);
+
+$fMethodCallback = fn($aMethod) => $this->renderMethod($sIndent, [
+'aMethod' => $aMethod,
+'nIndex' => $aCallable['index'] ?? 0,
+]);
+$aMethods = !isset($aCallable['methods']) ? [] :
+array_map($fMethodCallback, $aCallable['methods']);
+
+$aChildren = [];
+foreach($aCallable['children'] ?? [] as $sName => $aChild)
+{
+$aChildren[] = $this->renderChild("$sName:", "$sJsClass.$sName",
+    $aChild, $nIndent) . ',';
+}
+
+return implode("\n", array_merge($aMethods, $aChildren));
+}
+
+/**
      * @param string $sJsVar
      * @param string $sJsClass
      * @param array $aCallable
@@ -230,70 +230,70 @@ 
      *
      * @return string
      */
-    private function renderChild(string $sJsVar, string $sJsClass,
-        array $aCallable, int $nIndent = 0): string
-    {
-        $sIndent = str_repeat(' ', $nIndent);
-        $sScript = $this->renderCallable($sJsClass, $aCallable, $nIndent);
+private function renderChild(string $sJsVar, string $sJsClass,
+array $aCallable, int $nIndent = 0): string
+{
+$sIndent = str_repeat(' ', $nIndent);
+$sScript = $this->renderCallable($sJsClass, $aCallable, $nIndent);
 
-        return <<<CODE
+return <<<CODE
 $sIndent$sJsVar {
 $sScript
 $sIndent}
 CODE;
-    }
+}
 
-    /**
+/**
      * Generate client side javascript code for the registered callable objects
      *
      * @return string
      * @throws SetupException
      */
-    public function getScript(): string
-    {
-        $this->xRegistry->registerAllComponents();
-
-        $this->aCallableParams = [];
-        $this->aCallableObjects = ['children' => []];
-        foreach($this->cdi->getCallableObjects() as $xCallableObject)
-        {
-            $this->addCallable($xCallableObject);
-        }
-
-        $aScripts = [
-            $this->xTemplateEngine ->render('jaxon::callables/objects.js', [
-                'aCallableParams' => $this->aCallableParams,
-            ])
-        ];
-        foreach($this->aCallableObjects['children'] as $sJsClass => $aCallable)
-        {
-            $aScripts[] = $this->renderChild("{$this->sPrefix}$sJsClass =",
-                $sJsClass, $aCallable) . ';';
-        }
-        return implode("\n", $aScripts) . "\n";
-    }
-
-    /**
+public function getScript(): string
+{
+$this->xRegistry->registerAllComponents();
+
+$this->aCallableParams = [];
+$this->aCallableObjects = ['children' => []];
+foreach($this->cdi->getCallableObjects() as $xCallableObject)
+{
+$this->addCallable($xCallableObject);
+}
+
+$aScripts = [
+$this->xTemplateEngine ->render('jaxon::callables/objects.js', [
+    'aCallableParams' => $this->aCallableParams,
+])
+];
+foreach($this->aCallableObjects['children'] as $sJsClass => $aCallable)
+{
+$aScripts[] = $this->renderChild("{$this->sPrefix}$sJsClass =",
+    $sJsClass, $aCallable) . ';';
+}
+return implode("\n", $aScripts) . "\n";
+}
+
+/**
      * @inheritDoc
      */
-    public static function canProcessRequest(ServerRequestInterface $xRequest): bool
-    {
-        $aCall = $xRequest->getAttribute('jxncall');
-        return $aCall !== null && ($aCall['type'] ?? '') === 'class' &&
-            isset($aCall['name']) && isset($aCall['method']) &&
-            is_string($aCall['name']) && is_string($aCall['method']);
-    }
-
-    /**
+public static function canProcessRequest(ServerRequestInterface $xRequest): bool
+{
+$aCall = $xRequest->getAttribute('jxncall');
+return $aCall !== null && ($aCall['type'] ?? '') === 'class' &&
+isset($aCall['name']) && isset($aCall['method']) &&
+is_string($aCall['name']) && is_string($aCall['method']);
+}
+
+/**
      * @inheritDoc
      */
-    public function setTarget(ServerRequestInterface $xRequest): Target
-    {
-        $this->xTarget = Target::makeClass($xRequest->getAttribute('jxncall'));
-        return $this->xTarget;
-    }
+public function setTarget(ServerRequestInterface $xRequest): Target
+{
+$this->xTarget = Target::makeClass($xRequest->getAttribute('jxncall'));
+return $this->xTarget;
+}
 
-    /**
+/**
      * @param string $sExceptionMessage
      * @param string $sErrorCode
      * @param array $aErrorParams
@@ -301,53 +301,53 @@ 
      * @throws RequestException
      * @return void
      */
-    private function throwException(string $sExceptionMessage,
-        string $sErrorCode, array $aErrorParams = []): void
-    {
-        $sMessage = $this->xTranslator->trans($sErrorCode, $aErrorParams) .
-            (!$sExceptionMessage ? '' : "\n$sExceptionMessage");
-        $this->xLogger->error($sMessage);
-        throw new RequestException($sMessage);
-    }
-
-    /**
+private function throwException(string $sExceptionMessage,
+string $sErrorCode, array $aErrorParams = []): void
+{
+$sMessage = $this->xTranslator->trans($sErrorCode, $aErrorParams) .
+(!$sExceptionMessage ? '' : "\n$sExceptionMessage");
+$this->xLogger->error($sMessage);
+throw new RequestException($sMessage);
+}
+
+/**
      * @inheritDoc
      * @throws RequestException
      */
-    public function processRequest(): void
-    {
-        $sClassName = $this->xTarget->getClassName();
-        $sMethodName = $this->xTarget->getMethodName();
-        // Will be used to print a translated error message.
-        $aErrorParams = ['class' => $sClassName, 'method' => $sMethodName];
-
-        if(!$this->xValidator->validateJsObject($sClassName) ||
-            !$this->xValidator->validateMethod($sMethodName))
-        {
-            // Unable to find the requested object or method
-            $this->throwException('', 'errors.objects.invalid', $aErrorParams);
-        }
-
-        // Call the requested method
-        try
-        {
-            $sError = 'errors.objects.find';
-            /** @var CallableObject */
-            $xCallableObject = $this->getCallable($sClassName);
-
-            if($xCallableObject->excluded($sMethodName))
-            {
-                // Unable to find the requested class or method
-                $this->throwException('', 'errors.objects.excluded', $aErrorParams);
-            }
-
-            $sError = 'errors.objects.call';
-            $xCallableObject->call($this->xTarget);
-        }
-        catch(ReflectionException|SetupException $e)
-        {
-            // Unable to execute the requested class or method
-            $this->throwException($e->getMessage(), $sError, $aErrorParams);
-        }
-    }
+public function processRequest(): void
+{
+$sClassName = $this->xTarget->getClassName();
+$sMethodName = $this->xTarget->getMethodName();
+// Will be used to print a translated error message.
+$aErrorParams = ['class' => $sClassName, 'method' => $sMethodName];
+
+if(!$this->xValidator->validateJsObject($sClassName) ||
+!$this->xValidator->validateMethod($sMethodName))
+{
+// Unable to find the requested object or method
+$this->throwException('', 'errors.objects.invalid', $aErrorParams);
+}
+
+// Call the requested method
+try
+{
+$sError = 'errors.objects.find';
+/** @var CallableObject */
+$xCallableObject = $this->getCallable($sClassName);
+
+if($xCallableObject->excluded($sMethodName))
+{
+    // Unable to find the requested class or method
+    $this->throwException('', 'errors.objects.excluded', $aErrorParams);
+}
+
+$sError = 'errors.objects.call';
+$xCallableObject->call($this->xTarget);
+}
+catch(ReflectionException|SetupException $e)
+{
+// Unable to execute the requested class or method
+$this->throwException($e->getMessage(), $sError, $aErrorParams);
+}
+}
 }