jaxon-php / jaxon-mono

jaxon-core/src/Di/Traits/ComponentTrait.php

Switch Indentation +59 added lines, -59 removed lines

@@ -241,83 +241,83 @@
                 $this->aComponentPublicMethods['node'],
             $xReflectionClass->isSubclassOf(FuncComponent::class) =>
                 $this->aComponentPublicMethods['func'],
-            default => [[], []],
-        };
+default => [[], []],
+};
 
-        return [$aMethods, ...$aBaseMethods];
-    }
+return [$aMethods, ...$aBaseMethods];
+}
 
-    /**
+/**
      * @param ReflectionClass $xReflectionClass
      * @param array $aMethods
      * @param array $aOptions
      *
      * @return Metadata|null
      */
-    private function getComponentMetadata(ReflectionClass $xReflectionClass,
-        array $aMethods, array $aOptions): Metadata|null
-    {
-        /** @var Config|null */
-        $xPackageConfig = $aOptions['config'] ?? null;
-        if($xPackageConfig === null || (bool)($aOptions['excluded'] ?? false))
-        {
-            return null;
-        }
-        $sMetadataFormat = $xPackageConfig->getOption('metadata.format');
-        if(!in_array($sMetadataFormat, ['attributes', 'annotations']))
-        {
-            return null;
-        }
+private function getComponentMetadata(ReflectionClass $xReflectionClass,
+array $aMethods, array $aOptions): Metadata|null
+{
+/** @var Config|null */
+$xPackageConfig = $aOptions['config'] ?? null;
+if($xPackageConfig === null || (bool)($aOptions['excluded'] ?? false))
+{
+return null;
+}
+$sMetadataFormat = $xPackageConfig->getOption('metadata.format');
+if(!in_array($sMetadataFormat, ['attributes', 'annotations']))
+{
+return null;
+}
 
-        // Try to get the class metadata from the cache.
-        $di = $this->cn();
-        $xMetadata = null;
-        $xMetadataCache = null;
-        $xConfig = $di->config();
-        if($xConfig->getAppOption('metadata.cache.enabled', false))
-        {
-            if(!$di->h('jaxon_metadata_cache_dir'))
-            {
-                $sCacheDir = $xConfig->getAppOption('metadata.cache.dir');
-                $di->val('jaxon_metadata_cache_dir', $sCacheDir);
-            }
-            $xMetadataCache = $di->getMetadataCache();
-            $xMetadata = $xMetadataCache->read($xReflectionClass->getName());
-            if($xMetadata !== null)
-            {
-                return $xMetadata;
-            }
-        }
+// Try to get the class metadata from the cache.
+$di = $this->cn();
+$xMetadata = null;
+$xMetadataCache = null;
+$xConfig = $di->config();
+if($xConfig->getAppOption('metadata.cache.enabled', false))
+{
+if(!$di->h('jaxon_metadata_cache_dir'))
+{
+    $sCacheDir = $xConfig->getAppOption('metadata.cache.dir');
+    $di->val('jaxon_metadata_cache_dir', $sCacheDir);
+}
+$xMetadataCache = $di->getMetadataCache();
+$xMetadata = $xMetadataCache->read($xReflectionClass->getName());
+if($xMetadata !== null)
+{
+    return $xMetadata;
+}
+}
 
-        $aProperties = array_map(fn($xProperty) => $xProperty->getName(),
-            $xReflectionClass->getProperties(ReflectionProperty::IS_PUBLIC |
-                ReflectionProperty::IS_PROTECTED));
+$aProperties = array_map(fn($xProperty) => $xProperty->getName(),
+$xReflectionClass->getProperties(ReflectionProperty::IS_PUBLIC |
+    ReflectionProperty::IS_PROTECTED));
 
-        $xMetadataReader = $di->getMetadataReader($sMetadataFormat);
-        $xInput = new InputData($xReflectionClass, $aMethods, $aProperties);
-        $xMetadata = $xMetadataReader->getAttributes($xInput);
+$xMetadataReader = $di->getMetadataReader($sMetadataFormat);
+$xInput = new InputData($xReflectionClass, $aMethods, $aProperties);
+$xMetadata = $xMetadataReader->getAttributes($xInput);
 
-        // Try to save the metadata in the cache
-        if($xMetadataCache !== null)
-        {
-            $xMetadataCache->save($xReflectionClass->getName(), $xMetadata);
-        }
+// Try to save the metadata in the cache
+if($xMetadataCache !== null)
+{
+$xMetadataCache->save($xReflectionClass->getName(), $xMetadata);
+}
 
-        return $xMetadata;
-    }
+return $xMetadata;
+}
 
-    /**
+/**
      * @param ReflectionClass $xReflectionClass
      * @param array $aOptions
      *
      * @return ComponentOptions
      */
-    public function getComponentOptions(ReflectionClass $xReflectionClass,
-        array $aOptions): ComponentOptions
-    {
-        $aMethods = $this->getPublicMethods($xReflectionClass);
-        $xMetadata = $this->getComponentMetadata($xReflectionClass, $aMethods[0], $aOptions);
+public function getComponentOptions(ReflectionClass $xReflectionClass,
+array $aOptions): ComponentOptions
+{
+$aMethods = $this->getPublicMethods($xReflectionClass);
+$xMetadata = $this->getComponentMetadata($xReflectionClass, $aMethods[0], $aOptions);
 
-        return new ComponentOptions($aMethods, $aOptions, $xMetadata);
-    }
+return new ComponentOptions($aMethods, $aOptions, $xMetadata);
+}
 }

jaxon-core/src/Di/Traits/PluginTrait.php

Switch Indentation +139 added lines, -139 removed lines

@@ -35,154 +35,154 @@ 
 
 trait PluginTrait
 {
-    /**
+/**
      * Register the values into the container
      *
      * @return void
      */
-    private function registerPlugins(): void
-    {
-        // Plugin manager
-        $this->set(PluginManager::class, function($di) {
-            $xPluginManager = new PluginManager($di->g(Container::class),
-                $di->g(CodeGenerator::class), $di->g(Translator::class));
-            // Register the Jaxon request and response plugins
-            $xPluginManager->registerPlugins();
-            return $xPluginManager;
-        });
-        // Package manager
-        $this->set(PackageManager::class, function($di) {
-            return new PackageManager($di->g(Container::class), $di->g(Translator::class),
-                $di->g(PluginManager::class), $di->g(ConfigManager::class),
-                $di->g(CodeGenerator::class), $di->g(ViewRenderer::class),
-                $di->g(CallbackManager::class), $di->g(ComponentRegistry::class));
-        });
-        // Code Generation
-        $this->set(MinifierInterface::class, function() {
-            return new class extends FileMinifier implements MinifierInterface
-            {};
-        });
-        $this->set(AssetManager::class, function($di) {
-            return new AssetManager($di->g(ConfigManager::class),
-                $di->g(MinifierInterface::class));
-        });
-        $this->set(CodeGenerator::class, function($di) {
-            return new CodeGenerator(Jaxon::VERSION, $di->g(Container::class),
-                $di->g(TemplateEngine::class));
-        });
-        $this->set(ConfigScriptGenerator::class, function($di) {
-            return new ConfigScriptGenerator($di->g(ParameterReader::class),
-                $di->g(TemplateEngine::class), $di->g(ConfigManager::class));
-        });
-        $this->set(ReadyScriptGenerator::class, function($di) {
-            return new ReadyScriptGenerator();
-        });
-
-        // Script response plugin
-        $this->set(ScriptPlugin::class, function($di) {
-            return new ScriptPlugin($di->g(CallFactory::class));
-        });
-        // Databag response plugin
-        $this->set(DatabagPlugin::class, function($di) {
-            return new DatabagPlugin($di->g(Container::class));
-        });
-        // Dialog response plugin
-        $this->set(DialogPlugin::class, function($di) {
-            return new DialogPlugin($di->g(DialogCommand::class));
-        });
-        // Paginator response plugin
-        $this->set(PaginatorPlugin::class, function($di) {
-            return new PaginatorPlugin($di->g(RendererInterface::class));
-        });
-    }
-
-    /**
+private function registerPlugins(): void
+{
+// Plugin manager
+$this->set(PluginManager::class, function($di) {
+$xPluginManager = new PluginManager($di->g(Container::class),
+    $di->g(CodeGenerator::class), $di->g(Translator::class));
+// Register the Jaxon request and response plugins
+$xPluginManager->registerPlugins();
+return $xPluginManager;
+});
+// Package manager
+$this->set(PackageManager::class, function($di) {
+return new PackageManager($di->g(Container::class), $di->g(Translator::class),
+    $di->g(PluginManager::class), $di->g(ConfigManager::class),
+    $di->g(CodeGenerator::class), $di->g(ViewRenderer::class),
+    $di->g(CallbackManager::class), $di->g(ComponentRegistry::class));
+});
+// Code Generation
+$this->set(MinifierInterface::class, function() {
+return new class extends FileMinifier implements MinifierInterface
+{};
+});
+$this->set(AssetManager::class, function($di) {
+return new AssetManager($di->g(ConfigManager::class),
+    $di->g(MinifierInterface::class));
+});
+$this->set(CodeGenerator::class, function($di) {
+return new CodeGenerator(Jaxon::VERSION, $di->g(Container::class),
+    $di->g(TemplateEngine::class));
+});
+$this->set(ConfigScriptGenerator::class, function($di) {
+return new ConfigScriptGenerator($di->g(ParameterReader::class),
+    $di->g(TemplateEngine::class), $di->g(ConfigManager::class));
+});
+$this->set(ReadyScriptGenerator::class, function($di) {
+return new ReadyScriptGenerator();
+});
+
+// Script response plugin
+$this->set(ScriptPlugin::class, function($di) {
+return new ScriptPlugin($di->g(CallFactory::class));
+});
+// Databag response plugin
+$this->set(DatabagPlugin::class, function($di) {
+return new DatabagPlugin($di->g(Container::class));
+});
+// Dialog response plugin
+$this->set(DialogPlugin::class, function($di) {
+return new DialogPlugin($di->g(DialogCommand::class));
+});
+// Paginator response plugin
+$this->set(PaginatorPlugin::class, function($di) {
+return new PaginatorPlugin($di->g(RendererInterface::class));
+});
+}
+
+/**
      * Get the plugin manager
      *
      * @return PluginManager
      */
-    public function getPluginManager(): PluginManager
-    {
-        return $this->g(PluginManager::class);
-    }
+public function getPluginManager(): PluginManager
+{
+return $this->g(PluginManager::class);
+}
 
-    /**
+/**
      * Get the package manager
      *
      * @return PackageManager
      */
-    public function getPackageManager(): PackageManager
-    {
-        return $this->g(PackageManager::class);
-    }
+public function getPackageManager(): PackageManager
+{
+return $this->g(PackageManager::class);
+}
 
-    /**
+/**
      * Get the code generator
      *
      * @return CodeGenerator
      */
-    public function getCodeGenerator(): CodeGenerator
-    {
-        return $this->g(CodeGenerator::class);
-    }
+public function getCodeGenerator(): CodeGenerator
+{
+return $this->g(CodeGenerator::class);
+}
 
-    /**
+/**
      * Get the asset manager
      *
      * @return AssetManager
      */
-    public function getAssetManager(): AssetManager
-    {
-        return $this->g(AssetManager::class);
-    }
+public function getAssetManager(): AssetManager
+{
+return $this->g(AssetManager::class);
+}
 
-    /**
+/**
      * Get the jQuery plugin
      *
      * @return ScriptPlugin
      */
-    public function getScriptPlugin(): ScriptPlugin
-    {
-        return $this->g(ScriptPlugin::class);
-    }
+public function getScriptPlugin(): ScriptPlugin
+{
+return $this->g(ScriptPlugin::class);
+}
 
-    /**
+/**
      * Get the dialog plugin
      *
      * @return DialogPlugin
      */
-    public function getDialogPlugin(): DialogPlugin
-    {
-        return $this->g(DialogPlugin::class);
-    }
+public function getDialogPlugin(): DialogPlugin
+{
+return $this->g(DialogPlugin::class);
+}
 
-    /**
+/**
      * @param class-string $sClassName    The package class name
      *
      * @return string
      */
-    private function getPackageConfigKey(string $sClassName): string
-    {
-        return $sClassName . '_PackageConfig';
-    }
+private function getPackageConfigKey(string $sClassName): string
+{
+return $sClassName . '_PackageConfig';
+}
 
-    /**
+/**
      * @param class-string $sClassName    The package class name
      * @param-closure-this AbstractPackage $cSetter
      *
      * @return void
      */
-    private function extendPackage(string $sClassName, Closure $cSetter): void
-    {
-        // Initialize the package instance.
-        $this->xLibContainer->extend($sClassName, function($xPackage) use($cSetter) {
-            // Allow the setter to access protected attributes.
-            call_user_func($cSetter->bindTo($xPackage, $xPackage));
-            return $xPackage;
-        });
-    }
-
-    /**
+private function extendPackage(string $sClassName, Closure $cSetter): void
+{
+// Initialize the package instance.
+$this->xLibContainer->extend($sClassName, function($xPackage) use($cSetter) {
+// Allow the setter to access protected attributes.
+call_user_func($cSetter->bindTo($xPackage, $xPackage));
+return $xPackage;
+});
+}
+
+/**
      * Register a package
      *
      * @param class-string $sClassName    The package class name
@@ -191,45 +191,45 @@ 
      * @return void
      * @throws SetupException
      */
-    public function registerPackage(string $sClassName, array $aUserOptions): void
-    {
-        // Register the user class, but only if the user didn't already.
-        if(!$this->h($sClassName))
-        {
-            $this->set($sClassName, fn() => $this->make($sClassName));
-        }
-
-        // Save the package config in the container.
-        $sConfigKey = $this->getPackageConfigKey($sClassName);
-        $this->set($sConfigKey, function($di) use($aUserOptions) {
-            $xOptionsProvider = $aUserOptions['provider'] ?? null;
-            // The user can provide a callable that returns the package options.
-            if(is_callable($xOptionsProvider))
-            {
-                $aUserOptions = $xOptionsProvider($aUserOptions);
-            }
-            return $di->g(ConfigManager::class)->newConfig($aUserOptions);
-        });
-
-        // Initialize the package instance.
-        $di = $this;
-        $this->extendPackage($sClassName, function() use($di, $sConfigKey) {
-            // $this here refers to the AbstractPackage instance.
-            $this->xPkgConfig = $di->g($sConfigKey);
-            $this->xRenderer = $di->g(ViewRenderer::class);
-            $this->init();
-        });
-    }
-
-    /**
+public function registerPackage(string $sClassName, array $aUserOptions): void
+{
+// Register the user class, but only if the user didn't already.
+if(!$this->h($sClassName))
+{
+$this->set($sClassName, fn() => $this->make($sClassName));
+}
+
+// Save the package config in the container.
+$sConfigKey = $this->getPackageConfigKey($sClassName);
+$this->set($sConfigKey, function($di) use($aUserOptions) {
+$xOptionsProvider = $aUserOptions['provider'] ?? null;
+// The user can provide a callable that returns the package options.
+if(is_callable($xOptionsProvider))
+{
+    $aUserOptions = $xOptionsProvider($aUserOptions);
+}
+return $di->g(ConfigManager::class)->newConfig($aUserOptions);
+});
+
+// Initialize the package instance.
+$di = $this;
+$this->extendPackage($sClassName, function() use($di, $sConfigKey) {
+// $this here refers to the AbstractPackage instance.
+$this->xPkgConfig = $di->g($sConfigKey);
+$this->xRenderer = $di->g(ViewRenderer::class);
+$this->init();
+});
+}
+
+/**
      * Get the config of a package
      *
      * @param class-string $sClassName    The package class name
      *
      * @return Config
      */
-    public function getPackageConfig(string $sClassName): Config
-    {
-        return $this->g($this->getPackageConfigKey($sClassName));
-    }
+public function getPackageConfig(string $sClassName): Config
+{
+return $this->g($this->getPackageConfigKey($sClassName));
+}
 }

jaxon-core/src/Di/ComponentContainer.php

Switch Indentation +204 added lines, -204 removed lines

@@ -39,73 +39,73 @@ 
 
 class ComponentContainer
 {
-    use Traits\DiAutoTrait;
-    use Traits\ComponentTrait;
+use Traits\DiAutoTrait;
+use Traits\ComponentTrait;
 
-    /**
+/**
      * The Dependency Injection Container for registered classes
      *
      * @var PimpleContainer
      */
-    private $xContainer;
+private $xContainer;
 
-    /**
+/**
      * This will be set only when getting the object targetted by the ajax request.
      *
      * @var Target|null
      */
-    private $xTarget = null;
+private $xTarget = null;
 
-    /**
+/**
      * The class constructor
      *
      * @param Container $di
      */
-    public function __construct(private Container $di)
-    {
-        $this->xContainer = new PimpleContainer();
-        $this->val(ComponentContainer::class, $this);
-
-        // Register the call factory for registered functions
-        $this->set($this->getRequestFactoryKey(JxnCall::class), fn() =>
-            new JxnCall($this->di->g(ConfigManager::class)
-                ->getOption('core.prefix.function', '')));
-
-        // Register the pagination component, but do not export to js.
-        $this->saveComponent(Pagination::class, [
-            'excluded' => true,
-            'separator' => '.',
-            // The namespace has the same name as the Component class.
-            'namespace' => Component::class,
-        ]);
-
-        $this->setComponentPublicMethods('node', NodeComponent::class, ['item', 'html']);
-        $this->setComponentPublicMethods('func', FuncComponent::class, ['paginator']);
-    }
+public function __construct(private Container $di)
+{
+$this->xContainer = new PimpleContainer();
+$this->val(ComponentContainer::class, $this);
+
+// Register the call factory for registered functions
+$this->set($this->getRequestFactoryKey(JxnCall::class), fn() =>
+new JxnCall($this->di->g(ConfigManager::class)
+    ->getOption('core.prefix.function', '')));
+
+// Register the pagination component, but do not export to js.
+$this->saveComponent(Pagination::class, [
+'excluded' => true,
+'separator' => '.',
+// The namespace has the same name as the Component class.
+'namespace' => Component::class,
+]);
+
+$this->setComponentPublicMethods('node', NodeComponent::class, ['item', 'html']);
+$this->setComponentPublicMethods('func', FuncComponent::class, ['paginator']);
+}
 
-    /**
+/**
      * The container for parameters
      *
      * @return Container
      */
-    protected function cn(): Container
-    {
-        return $this->di;
-    }
+protected function cn(): Container
+{
+return $this->di;
+}
 
-    /**
+/**
      * Check if a class is defined in the container
      *
      * @param class-string $sClass    The full class name
      *
      * @return bool
      */
-    public function has(string $sClass): bool
-    {
-        return $this->xContainer->offsetExists($sClass);
-    }
+public function has(string $sClass): bool
+{
+return $this->xContainer->offsetExists($sClass);
+}
 
-    /**
+/**
      * Save a closure in the container
      *
      * @param class-string $sClass    The full class name
@@ -113,12 +113,12 @@ 
      *
      * @return void
      */
-    public function set(string $sClass, Closure $xClosure)
-    {
-        $this->xContainer->offsetSet($sClass, fn() => $xClosure($this));
-    }
+public function set(string $sClass, Closure $xClosure)
+{
+$this->xContainer->offsetSet($sClass, fn() => $xClosure($this));
+}
 
-    /**
+/**
      * Save a value in the container
      *
      * @param string|class-string $sKey    The key
@@ -126,12 +126,12 @@ 
      *
      * @return void
      */
-    public function val(string $sKey, $xValue)
-    {
-       $this->xContainer->offsetSet($sKey, $xValue);
-    }
+public function val(string $sKey, $xValue)
+{
+$this->xContainer->offsetSet($sKey, $xValue);
+}
 
-    /**
+/**
      * Get a class instance
      *
      * @template T
@@ -139,12 +139,12 @@ 
      *
      * @return T
      */
-    public function get(string $sClass)
-    {
-        return $this->xContainer->offsetGet($sClass);
-    }
+public function get(string $sClass)
+{
+return $this->xContainer->offsetGet($sClass);
+}
 
-    /**
+/**
      * Get a component when one of its method needs to be called
      *
      * @template T
@@ -153,17 +153,17 @@ 
      *
      * @return T|null
      */
-    public function getTargetComponent(string $sClassName, Target $xTarget): mixed
-    {
-        // Set the target only when getting the object targetted by the ajax request.
-        $this->xTarget = $xTarget;
-        $xComponent = $this->get($sClassName);
-        $this->xTarget = null;
+public function getTargetComponent(string $sClassName, Target $xTarget): mixed
+{
+// Set the target only when getting the object targetted by the ajax request.
+$this->xTarget = $xTarget;
+$xComponent = $this->get($sClassName);
+$this->xTarget = null;
 
-        return $xComponent;
-    }
+return $xComponent;
+}
 
-    /**
+/**
      * Register a component and its options
      *
      * @param class-string $sClassName    The class name
@@ -171,40 +171,40 @@ 
      *
      * @return void
      */
-    public function saveComponent(string $sClassName, array $aOptions): void
-    {
-        try
-        {
-            // Make sure the registered class exists
-            if(isset($aOptions['include']))
-            {
-                require_once $aOptions['include'];
-            }
-            $xReflectionClass = new ReflectionClass($sClassName);
-            // Check if the class is registrable
-            if(!$xReflectionClass->isInstantiable())
-            {
-                return;
-            }
-
-            $this->_saveClassOptions($sClassName, $aOptions);
-
-            $sClassKey = $this->getReflectionClassKey($sClassName);
-            $this->val($sClassKey, $xReflectionClass);
-            // Register the user class, but only if the user didn't already.
-            if(!$this->has($sClassName))
-            {
-                $this->set($sClassName, fn() => $this->make($this->get($sClassKey)));
-            }
-        }
-        catch(ReflectionException $e)
-        {
-            throw new SetupException($this->cn()->g(Translator::class)
-                ->trans('errors.class.invalid', ['name' => $sClassName]));
-        }
-    }
+public function saveComponent(string $sClassName, array $aOptions): void
+{
+try
+{
+// Make sure the registered class exists
+if(isset($aOptions['include']))
+{
+    require_once $aOptions['include'];
+}
+$xReflectionClass = new ReflectionClass($sClassName);
+// Check if the class is registrable
+if(!$xReflectionClass->isInstantiable())
+{
+    return;
+}
+
+$this->_saveClassOptions($sClassName, $aOptions);
 
-    /**
+$sClassKey = $this->getReflectionClassKey($sClassName);
+$this->val($sClassKey, $xReflectionClass);
+// Register the user class, but only if the user didn't already.
+if(!$this->has($sClassName))
+{
+    $this->set($sClassName, fn() => $this->make($this->get($sClassKey)));
+}
+}
+catch(ReflectionException $e)
+{
+throw new SetupException($this->cn()->g(Translator::class)
+    ->trans('errors.class.invalid', ['name' => $sClassName]));
+}
+}
+
+/**
      * Register a component
      *
      * @param string $sComponentId The component name
@@ -212,74 +212,74 @@ 
      * @return string
      * @throws SetupException
      */
-    private function _registerComponent(string $sComponentId): string
-    {
-        // Replace all separators ('.' or '_') with antislashes, and trim the class name.
-        $sClassName = trim(str_replace(['.', '_'], '\\', $sComponentId), '\\');
-
-        $sComponentObject = $this->getCallableObjectKey($sClassName);
-        // Prevent duplication. It's important not to use the class name here.
-        if($this->has($sComponentObject))
-        {
-            return $sClassName;
-        }
-
-        // Register the helper class
-        $this->set($this->getCallableHelperKey($sClassName), function() use($sClassName) {
-            $xFactory = $this->di->getCallFactory();
-            return new ComponentHelper($this, $xFactory->rq($sClassName),
-                $xFactory, $this->di->getViewRenderer(),
-                $this->di->getLogger(), $this->di->getSessionManager(),
-                $this->di->getStash(), $this->di->getUploadHandler());
-        });
-
-        $this->discoverComponent($sClassName);
-
-        // Register the callable object
-        $this->set($sComponentObject, function() use($sComponentId, $sClassName) {
-            $aOptions = $this->_getClassOptions($sComponentId);
-            $xReflectionClass = $this->get($this->getReflectionClassKey($sClassName));
-            $xOptions = $this->getComponentOptions($xReflectionClass, $aOptions);
-            return new CallableObject($this, $this->di, $xReflectionClass, $xOptions);
-        });
-
-        // Initialize the user class instance
-        $this->xContainer->extend($sClassName, function($xClassInstance) use($sClassName) {
-            if($xClassInstance instanceof AbstractComponent)
-            {
-                $xHelper = $this->get($this->getCallableHelperKey($sClassName));
-                $xHelper->xTarget = $this->xTarget;
-
-                // Call the protected "initComponent()" method of the Component class.
-                $cSetter = function($di, $xHelper) {
-                    $this->initComponent($di, $xHelper);  // "$this" here refers to the Component class.
-                };
-                $cSetter = $cSetter->bindTo($xClassInstance, $xClassInstance);
-                call_user_func($cSetter, $this->di, $xHelper);
-            }
-
-            // Run the callbacks for class initialisation
-            $this->di->g(CallbackManager::class)->onInit($xClassInstance);
-
-            // Set attributes from the DI container.
-            // The class level DI options are set on any component.
-            // The method level DI options are set only on the targetted component.
-            /** @var CallableObject */
-            $xCallableObject = $this->get($this->getCallableObjectKey($sClassName));
-            $xCallableObject->setDiClassAttributes($xClassInstance);
-            if($this->xTarget !== null)
-            {
-                $sMethodName = $this->xTarget->getMethodName();
-                $xCallableObject->setDiMethodAttributes($xClassInstance, $sMethodName);
-            }
-
-            return $xClassInstance;
-        });
-
-        return $sClassName;
-    }
+private function _registerComponent(string $sComponentId): string
+{
+// Replace all separators ('.' or '_') with antislashes, and trim the class name.
+$sClassName = trim(str_replace(['.', '_'], '\\', $sComponentId), '\\');
+
+$sComponentObject = $this->getCallableObjectKey($sClassName);
+// Prevent duplication. It's important not to use the class name here.
+if($this->has($sComponentObject))
+{
+return $sClassName;
+}
+
+// Register the helper class
+$this->set($this->getCallableHelperKey($sClassName), function() use($sClassName) {
+$xFactory = $this->di->getCallFactory();
+return new ComponentHelper($this, $xFactory->rq($sClassName),
+    $xFactory, $this->di->getViewRenderer(),
+    $this->di->getLogger(), $this->di->getSessionManager(),
+    $this->di->getStash(), $this->di->getUploadHandler());
+});
+
+$this->discoverComponent($sClassName);
+
+// Register the callable object
+$this->set($sComponentObject, function() use($sComponentId, $sClassName) {
+$aOptions = $this->_getClassOptions($sComponentId);
+$xReflectionClass = $this->get($this->getReflectionClassKey($sClassName));
+$xOptions = $this->getComponentOptions($xReflectionClass, $aOptions);
+return new CallableObject($this, $this->di, $xReflectionClass, $xOptions);
+});
+
+// Initialize the user class instance
+$this->xContainer->extend($sClassName, function($xClassInstance) use($sClassName) {
+if($xClassInstance instanceof AbstractComponent)
+{
+    $xHelper = $this->get($this->getCallableHelperKey($sClassName));
+    $xHelper->xTarget = $this->xTarget;
+
+    // Call the protected "initComponent()" method of the Component class.
+    $cSetter = function($di, $xHelper) {
+        $this->initComponent($di, $xHelper);  // "$this" here refers to the Component class.
+    };
+    $cSetter = $cSetter->bindTo($xClassInstance, $xClassInstance);
+    call_user_func($cSetter, $this->di, $xHelper);
+}
+
+// Run the callbacks for class initialisation
+$this->di->g(CallbackManager::class)->onInit($xClassInstance);
+
+// Set attributes from the DI container.
+// The class level DI options are set on any component.
+// The method level DI options are set only on the targetted component.
+/** @var CallableObject */
+$xCallableObject = $this->get($this->getCallableObjectKey($sClassName));
+$xCallableObject->setDiClassAttributes($xClassInstance);
+if($this->xTarget !== null)
+{
+    $sMethodName = $this->xTarget->getMethodName();
+    $xCallableObject->setDiMethodAttributes($xClassInstance, $sMethodName);
+}
+
+return $xClassInstance;
+});
 
-    /**
+return $sClassName;
+}
+
+/**
      * Get the callable object for a given class
      * The callable object is registered if it is not already in the DI.
      *
@@ -288,13 +288,13 @@ 
      * @return CallableObject|null
      * @throws SetupException
      */
-    public function makeCallableObject(string $sComponentId): ?CallableObject
-    {
-        $sClassName = $this->_registerComponent($sComponentId);
-        return $this->get($this->getCallableObjectKey($sClassName));
-    }
+public function makeCallableObject(string $sComponentId): ?CallableObject
+{
+$sClassName = $this->_registerComponent($sComponentId);
+return $this->get($this->getCallableObjectKey($sClassName));
+}
 
-    /**
+/**
      * Get an instance of a component by name
      *
      * @template T
@@ -303,53 +303,53 @@ 
      * @return T|null
      * @throws SetupException
      */
-    public function makeComponent(string $sClassName): mixed
-    {
-        $sComponentId = str_replace('\\', '.', $sClassName);
-        $sClassName = $this->_registerComponent($sComponentId);
-        return $this->get($sClassName);
-    }
+public function makeComponent(string $sClassName): mixed
+{
+$sComponentId = str_replace('\\', '.', $sClassName);
+$sClassName = $this->_registerComponent($sComponentId);
+return $this->get($sClassName);
+}
 
-    /**
+/**
      * Get a factory for a call to a registered function.
      *
      * @return JxnCall
      */
-    public function getFunctionRequestFactory(): JxnCall
-    {
-        return $this->get($this->getRequestFactoryKey(JxnCall::class));
-    }
+public function getFunctionRequestFactory(): JxnCall
+{
+return $this->get($this->getRequestFactoryKey(JxnCall::class));
+}
 
-    /**
+/**
      * Get a factory for a call to a registered component.
      *
      * @param class-string $sClassName
      *
      * @return JxnCall|null
      */
-    public function getComponentRequestFactory(string $sClassName): ?JxnCall
+public function getComponentRequestFactory(string $sClassName): ?JxnCall
+{
+$sClassName = trim($sClassName, " \t");
+if($sClassName === '')
+{
+return null;
+}
+
+$sFactoryKey = $this->getRequestFactoryKey($sClassName);
+if(!$this->has($sFactoryKey))
+{
+$this->xContainer->offsetSet($sFactoryKey, function() use($sClassName) {
+    $sComponentId = str_replace('\\', '.', $sClassName);
+    if(!($xCallable = $this->makeCallableObject($sComponentId)))
     {
-        $sClassName = trim($sClassName, " \t");
-        if($sClassName === '')
-        {
-            return null;
-        }
-
-        $sFactoryKey = $this->getRequestFactoryKey($sClassName);
-        if(!$this->has($sFactoryKey))
-        {
-            $this->xContainer->offsetSet($sFactoryKey, function() use($sClassName) {
-                $sComponentId = str_replace('\\', '.', $sClassName);
-                if(!($xCallable = $this->makeCallableObject($sComponentId)))
-                {
-                    return null;
-                }
-
-                $xConfigManager = $this->di->g(ConfigManager::class);
-                $sPrefix = $xConfigManager->getOption('core.prefix.class', '');
-                return new JxnClassCall($sPrefix . $xCallable->getJsName());
-            });
-        }
-        return $this->get($sFactoryKey);
+        return null;
     }
+
+    $xConfigManager = $this->di->g(ConfigManager::class);
+    $sPrefix = $xConfigManager->getOption('core.prefix.class', '');
+    return new JxnClassCall($sPrefix . $xCallable->getJsName());
+});
+}
+return $this->get($sFactoryKey);
+}
 }

jaxon-core/src/Di/Container.php

Switch Indentation +149 added lines, -149 removed lines

@@ -32,145 +32,145 @@ 
 
 class Container
 {
-    use Traits\AppTrait;
-    use Traits\PsrTrait;
-    use Traits\RequestTrait;
-    use Traits\ResponseTrait;
-    use Traits\PluginTrait;
-    use Traits\CallableTrait;
-    use Traits\ViewTrait;
-    use Traits\UtilTrait;
-    use Traits\MetadataTrait;
-    use Traits\DiAutoTrait;
+use Traits\AppTrait;
+use Traits\PsrTrait;
+use Traits\RequestTrait;
+use Traits\ResponseTrait;
+use Traits\PluginTrait;
+use Traits\CallableTrait;
+use Traits\ViewTrait;
+use Traits\UtilTrait;
+use Traits\MetadataTrait;
+use Traits\DiAutoTrait;
 
-    /**
+/**
      * The library Dependency Injection Container
      *
      * @var PimpleContainer
      */
-    private $xLibContainer;
+private $xLibContainer;
 
-    /**
+/**
      * The application or framework Dependency Injection Container
      *
      * @var ContainerInterface
      */
-    private $xAppContainer = null;
+private $xAppContainer = null;
 
-    /**
+/**
      * The class constructor
      */
-    public function __construct()
-    {
-        $this->xLibContainer = new PimpleContainer();
+public function __construct()
+{
+$this->xLibContainer = new PimpleContainer();
 
-        $this->val(Container::class, $this);
+$this->val(Container::class, $this);
 
-        // Register the null logger by default
-        $this->setLogger(new NullLogger());
+// Register the null logger by default
+$this->setLogger(new NullLogger());
 
-        // Template directory
-        $sTemplateDir = realpath(__DIR__ . '/../../templates');
-        $this->val('jaxon.core.dir.template', $sTemplateDir);
+// Template directory
+$sTemplateDir = realpath(__DIR__ . '/../../templates');
+$this->val('jaxon.core.dir.template', $sTemplateDir);
 
-        // Translation directory
-        $sTranslationDir = realpath(__DIR__ . '/../../translations');
-        $this->val('jaxon.core.dir.translation', $sTranslationDir);
+// Translation directory
+$sTranslationDir = realpath(__DIR__ . '/../../translations');
+$this->val('jaxon.core.dir.translation', $sTranslationDir);
 
-        $this->registerAll();
-        $this->setEventHandlers();
-    }
+$this->registerAll();
+$this->setEventHandlers();
+}
 
-    /**
+/**
      * The container for parameters
      *
      * @return Container
      */
-    protected function cn(): Container
-    {
-        return $this;
-    }
+protected function cn(): Container
+{
+return $this;
+}
 
-    /**
+/**
      * Register the values into the container
      *
      * @return void
      */
-    private function registerAll()
-    {
-        $this->registerApp();
-        $this->registerPsr();
-        $this->registerRequests();
-        $this->registerResponses();
-        $this->registerPlugins();
-        $this->registerCallables();
-        $this->registerViews();
-        $this->registerUtils();
-        $this->registerMetadataReader();
-    }
+private function registerAll()
+{
+$this->registerApp();
+$this->registerPsr();
+$this->registerRequests();
+$this->registerResponses();
+$this->registerPlugins();
+$this->registerCallables();
+$this->registerViews();
+$this->registerUtils();
+$this->registerMetadataReader();
+}
 
-    /**
+/**
      * Set the logger
      *
      * @param LoggerInterface|Closure $xLogger
      *
      * @return void
      */
-    public function setLogger(LoggerInterface|Closure $xLogger)
-    {
-        is_a($xLogger, LoggerInterface::class) ?
-            $this->val(LoggerInterface::class, $xLogger) :
-            $this->set(LoggerInterface::class, $xLogger);
-    }
+public function setLogger(LoggerInterface|Closure $xLogger)
+{
+is_a($xLogger, LoggerInterface::class) ?
+$this->val(LoggerInterface::class, $xLogger) :
+$this->set(LoggerInterface::class, $xLogger);
+}
 
-    /**
+/**
      * Get the logger
      *
      * @return LoggerInterface
      */
-    public function getLogger(): LoggerInterface
-    {
-        return $this->get(LoggerInterface::class);
-    }
+public function getLogger(): LoggerInterface
+{
+return $this->get(LoggerInterface::class);
+}
 
-    /**
+/**
      * Set the container provided by the integrated framework
      *
      * @param ContainerInterface $xContainer    The container implementation
      *
      * @return void
      */
-    public function setContainer(ContainerInterface $xContainer)
-    {
-        $this->xAppContainer = $xContainer;
-    }
+public function setContainer(ContainerInterface $xContainer)
+{
+$this->xAppContainer = $xContainer;
+}
 
-    /**
+/**
      * Check if a class is defined in the container
      *
      * @param string $sClass    The full class name
      *
      * @return bool
      */
-    public function h(string $sClass): bool
-    {
-        return $this->xLibContainer->offsetExists($sClass);
-    }
+public function h(string $sClass): bool
+{
+return $this->xLibContainer->offsetExists($sClass);
+}
 
-    /**
+/**
      * Check if a class is defined in the container
      *
      * @param string $sClass    The full class name
      *
      * @return bool
      */
-    public function has(string $sClass): bool
-    {
-        return $this->xAppContainer != null && $this->xAppContainer->has($sClass) ?
-            true : $this->xLibContainer->offsetExists($sClass);
-    }
+public function has(string $sClass): bool
+{
+return $this->xAppContainer != null && $this->xAppContainer->has($sClass) ?
+true : $this->xLibContainer->offsetExists($sClass);
+}
 
-    /**
+/**
      * Get a class instance
      *
      * @template T
@@ -178,12 +178,12 @@ 
      *
      * @return T
      */
-    public function g(string $sClass): mixed
-    {
-        return $this->xLibContainer->offsetGet($sClass);
-    }
+public function g(string $sClass): mixed
+{
+return $this->xLibContainer->offsetGet($sClass);
+}
 
-    /**
+/**
      * Get a class instance
      *
      * @template T
@@ -192,24 +192,24 @@ 
      * @return T
      * @throws SetupException
      */
-    public function get(string $sClass): mixed
-    {
-        try
-        {
-            return $this->xAppContainer != null && $this->xAppContainer->has($sClass) ?
-                $this->xAppContainer->get($sClass) : $this->xLibContainer->offsetGet($sClass);
-        }
-        catch(Throwable $e)
-        {
-            $xLogger = $this->g(LoggerInterface::class);
-            $xTranslator = $this->g(Translator::class);
-            $sMessage = $e->getMessage() . ': ' . $xTranslator->trans('errors.class.container', ['name' => $sClass]);
-            $xLogger->error($e->getMessage(), ['message' => $sMessage]);
-            throw new SetupException($sMessage);
-        }
-    }
+public function get(string $sClass): mixed
+{
+try
+{
+return $this->xAppContainer != null && $this->xAppContainer->has($sClass) ?
+    $this->xAppContainer->get($sClass) : $this->xLibContainer->offsetGet($sClass);
+}
+catch(Throwable $e)
+{
+$xLogger = $this->g(LoggerInterface::class);
+$xTranslator = $this->g(Translator::class);
+$sMessage = $e->getMessage() . ': ' . $xTranslator->trans('errors.class.container', ['name' => $sClass]);
+$xLogger->error($e->getMessage(), ['message' => $sMessage]);
+throw new SetupException($sMessage);
+}
+}
 
-    /**
+/**
      * Save a closure in the container
      *
      * @param string|class-string $sClass    The full class name
@@ -218,15 +218,15 @@ 
      *
      * @return void
      */
-    public function set(string $sClass, Closure $xClosure, bool $bIsSingleton = true)
-    {
-        // Wrap the user closure into a new closure, so it can take this container as a parameter.
-        $xClosure = fn() => $xClosure($this);
-        $this->xLibContainer->offsetSet($sClass, $bIsSingleton ?
-            $xClosure : $this->xLibContainer->factory($xClosure));
-    }
+public function set(string $sClass, Closure $xClosure, bool $bIsSingleton = true)
+{
+// Wrap the user closure into a new closure, so it can take this container as a parameter.
+$xClosure = fn() => $xClosure($this);
+$this->xLibContainer->offsetSet($sClass, $bIsSingleton ?
+$xClosure : $this->xLibContainer->factory($xClosure));
+}
 
-    /**
+/**
      * Save a value in the container
      *
      * @param string|class-string $sKey    The key
@@ -234,12 +234,12 @@ 
      *
      * @return void
      */
-    public function val(string $sKey, $xValue)
-    {
-       $this->xLibContainer->offsetSet($sKey, $xValue);
-    }
+public function val(string $sKey, $xValue)
+{
+$this->xLibContainer->offsetSet($sKey, $xValue);
+}
 
-    /**
+/**
      * Set an alias in the container
      *
      * @param string|class-string $sAlias    The alias name
@@ -247,60 +247,60 @@ 
      *
      * @return void
      */
-    public function alias(string $sAlias, string $sClass)
-    {
-        $this->set($sAlias, function($di) use ($sClass) {
-            return $di->get($sClass);
-        });
-    }
+public function alias(string $sAlias, string $sClass)
+{
+$this->set($sAlias, function($di) use ($sClass) {
+return $di->get($sClass);
+});
+}
 
-    /**
+/**
      * @param ReflectionClass $xClass
      * @param ReflectionParameter $xParameter
      *
      * @return mixed
      * @throws SetupException
      */
-    public function getParameter(ReflectionClass $xClass, ReflectionParameter $xParameter)
-    {
-        $xType = $xParameter->getType();
-        // Check the parameter class first.
-        if($xType instanceof ReflectionNamedType)
-        {
-            // Check the class + the name
-            if($this->has($xType->getName() . ' $' . $xParameter->getName()))
-            {
-                return $this->get($xType->getName() . ' $' . $xParameter->getName());
-            }
-            // Check the class only
-            if($this->has($xType->getName()))
-            {
-                return $this->get($xType->getName());
-            }
-        }
-        // Check the name only
-        return $this->get('$' . $xParameter->getName());
-    }
+public function getParameter(ReflectionClass $xClass, ReflectionParameter $xParameter)
+{
+$xType = $xParameter->getType();
+// Check the parameter class first.
+if($xType instanceof ReflectionNamedType)
+{
+// Check the class + the name
+if($this->has($xType->getName() . ' $' . $xParameter->getName()))
+{
+    return $this->get($xType->getName() . ' $' . $xParameter->getName());
+}
+// Check the class only
+if($this->has($xType->getName()))
+{
+    return $this->get($xType->getName());
+}
+}
+// Check the name only
+return $this->get('$' . $xParameter->getName());
+}
 
-    /**
+/**
      * Get the session manager
      *
      * @return SessionInterface|null
      */
-    public function getSessionManager(): ?SessionInterface
-    {
-        return $this->h(SessionInterface::class) ? $this->g(SessionInterface::class) : null;
-    }
+public function getSessionManager(): ?SessionInterface
+{
+return $this->h(SessionInterface::class) ? $this->g(SessionInterface::class) : null;
+}
 
-    /**
+/**
      * Set the session manager
      *
      * @param Closure $xClosure    A closure to create the session manager instance
      *
      * @return void
      */
-    public function setSessionManager(Closure $xClosure)
-    {
-        $this->set(SessionInterface::class, $xClosure);
-    }
+public function setSessionManager(Closure $xClosure)
+{
+$this->set(SessionInterface::class, $xClosure);
+}
 }

jaxon-core/src/App/Pagination/Page.php

Switch Indentation +12 added lines, -12 removed lines

@@ -13,25 +13,25 @@
 
 class Page
 {
-    /**
+/**
      * @var string
      */
-    public $sType;
+public $sType;
 
-    /**
+/**
      * @var string
      */
-    public $sText;
+public $sText;
 
-    /**
+/**
      * @var int
      */
-    public $nNumber;
+public $nNumber;
 
-    public function __construct(string $sType, string $sText, int $nNumber)
-    {
-        $this->sType = $sType;
-        $this->sText = $sText;
-        $this->nNumber = $nNumber;
-    }
+public function __construct(string $sType, string $sText, int $nNumber)
+{
+$this->sType = $sType;
+$this->sText = $sText;
+$this->nNumber = $nNumber;
+}
 }
\ No newline at end of file

jaxon-core/src/App/Ajax/Jaxon.php

Switch Indentation +65 added lines, -65 removed lines

@@ -32,110 +32,110 @@
 
 final class Jaxon
 {
-    use Traits\ConfigTrait;
-    use Traits\ServicesTrait;
-    use Traits\PluginTrait;
-    use Traits\RequestTrait;
-    use Traits\ResponseTrait;
-    use Traits\SendResponseTrait;
-
-    /**
+use Traits\ConfigTrait;
+use Traits\ServicesTrait;
+use Traits\PluginTrait;
+use Traits\RequestTrait;
+use Traits\ResponseTrait;
+use Traits\SendResponseTrait;
+
+/**
      * @var Jaxon|null
      */
-    private static $xInstance = null;
+private static $xInstance = null;
 
-    /**
+/**
      * The constructor
      *
      * @param Container $xContainer
      * @param ComponentContainer $xComponentContainer
      */
-    private function __construct(Container $xContainer, ComponentContainer $xComponentContainer)
-    {
-        $this->xContainer = $xContainer;
-        $this->xComponentContainer = $xComponentContainer;
-    }
+private function __construct(Container $xContainer, ComponentContainer $xComponentContainer)
+{
+$this->xContainer = $xContainer;
+$this->xComponentContainer = $xComponentContainer;
+}
 
-    /**
+/**
      * @return Jaxon
      */
-    private static function createInstance(): Jaxon
-    {
-        $xContainer = new Container();
-        $xComponentContainer = new ComponentContainer($xContainer);
-        self::$xInstance = new Jaxon($xContainer, $xComponentContainer);
+private static function createInstance(): Jaxon
+{
+$xContainer = new Container();
+$xComponentContainer = new ComponentContainer($xContainer);
+self::$xInstance = new Jaxon($xContainer, $xComponentContainer);
 
-        // Save the Jaxon and container instances
-        $xContainer->val(Jaxon::class, self::$xInstance);
-        $xContainer->val(ComponentContainer::class, $xComponentContainer);
+// Save the Jaxon and container instances
+$xContainer->val(Jaxon::class, self::$xInstance);
+$xContainer->val(ComponentContainer::class, $xComponentContainer);
 
-        // Make the helpers functions available in the global namespace.
-        self::$xInstance->getCallbackManager()->boot(function() {
-            self::$xInstance->config()->globals();
-        });
+// Make the helpers functions available in the global namespace.
+self::$xInstance->getCallbackManager()->boot(function() {
+self::$xInstance->config()->globals();
+});
 
-        return self::$xInstance;
-    }
+return self::$xInstance;
+}
 
-    /**
+/**
      * @return Jaxon
      */
-    public static function getInstance(): Jaxon
-    {
-        return self::$xInstance ?: self::$xInstance = self::createInstance();
-    }
+public static function getInstance(): Jaxon
+{
+return self::$xInstance ?: self::$xInstance = self::createInstance();
+}
 
-    /**
+/**
      * @return string
      */
-    public function getVersion(): string
-    {
-        return \Jaxon\Jaxon::VERSION;
-    }
+public function getVersion(): string
+{
+return \Jaxon\Jaxon::VERSION;
+}
 
-    /**
+/**
      * @return ConfigManager
      */
-    public function config(): ConfigManager
-    {
-        return $this->di()->g(ConfigManager::class);
-    }
+public function config(): ConfigManager
+{
+return $this->di()->g(ConfigManager::class);
+}
 
-    /**
+/**
      * Set the ajax endpoint URI
      *
      * @param string $sUri    The ajax endpoint URI
      *
      * @return void
      */
-    public function setUri(string $sUri): void
-    {
-        $this->config()->setOption('core.request.uri', $sUri);
-    }
+public function setUri(string $sUri): void
+{
+$this->config()->setOption('core.request.uri', $sUri);
+}
 
-    /**
+/**
      * @return AppInterface
      */
-    public function app(): AppInterface
-    {
-        return $this->xContainer->getApp();
-    }
+public function app(): AppInterface
+{
+return $this->xContainer->getApp();
+}
 
-    /**
+/**
      * Get the callback manager
      *
      * @return CallbackManager
      */
-    public function callback(): CallbackManager
-    {
-        return $this->getCallbackManager();
-    }
+public function callback(): CallbackManager
+{
+return $this->getCallbackManager();
+}
 
-    /**
+/**
      * @return void
      */
-    public function reset(): void
-    {
-        self::$xInstance = null;
-    }
+public function reset(): void
+{
+self::$xInstance = null;
+}
 }

jaxon-core/src/App/Ajax/Traits/PluginTrait.php

Switch Indentation +72 added lines, -72 removed lines

@@ -28,27 +28,27 @@ 
 
 trait PluginTrait
 {
-    /**
+/**
      * @return PluginManager
      */
-    abstract public function getPluginManager(): PluginManager;
+abstract public function getPluginManager(): PluginManager;
 
-    /**
+/**
      * @return PackageManager
      */
-    abstract public function getPackageManager(): PackageManager;
+abstract public function getPackageManager(): PackageManager;
 
-    /**
+/**
      * @return CodeGenerator
      */
-    abstract public function getCodeGenerator(): CodeGenerator;
+abstract public function getCodeGenerator(): CodeGenerator;
 
-    /**
+/**
      * @return Bootstrap
      */
-    abstract protected function getBootstrap(): Bootstrap;
+abstract protected function getBootstrap(): Bootstrap;
 
-    /**
+/**
      * Register request handlers, including functions, callable classes and directories.
      *
      * @param string $sType    The type of request handler being registered
@@ -65,14 +65,14 @@ 
      * @return void
      * @throws SetupException
      */
-    public function register(string $sType, string $sName, $xOptions = []): void
-    {
-        // We need the library to have been bootstrapped.
-        $this->getBootstrap()->onBoot();
-        $this->getPluginManager()->registerCallable($sType, $sName, $xOptions);
-    }
-
-    /**
+public function register(string $sType, string $sName, $xOptions = []): void
+{
+// We need the library to have been bootstrapped.
+$this->getBootstrap()->onBoot();
+$this->getPluginManager()->registerCallable($sType, $sName, $xOptions);
+}
+
+/**
      * Register a plugin
      *
      * Below is a table for priorities and their description:
@@ -87,14 +87,14 @@ 
      * @return void
      * @throws SetupException
      */
-    public function registerPlugin(string $sClassName, string $sPluginName, int $nPriority = 1000)
-    {
-        // We need the library to have been bootstrapped.
-        $this->getBootstrap()->onBoot();
-        $this->getPluginManager()->registerPlugin($sClassName, $sPluginName, $nPriority);
-    }
-
-    /**
+public function registerPlugin(string $sClassName, string $sPluginName, int $nPriority = 1000)
+{
+// We need the library to have been bootstrapped.
+$this->getBootstrap()->onBoot();
+$this->getPluginManager()->registerPlugin($sClassName, $sPluginName, $nPriority);
+}
+
+/**
      * Register a package
      *
      * @param string $sClassName    The package class
@@ -103,14 +103,14 @@ 
      * @return void
      * @throws SetupException
      */
-    public function registerPackage(string $sClassName, array $xPkgOptions = [])
-    {
-        // We need the library to have been bootstrapped.
-        $this->getBootstrap()->onBoot();
-        $this->getPackageManager()->registerPackage($sClassName, $xPkgOptions);
-    }
-
-    /**
+public function registerPackage(string $sClassName, array $xPkgOptions = [])
+{
+// We need the library to have been bootstrapped.
+$this->getBootstrap()->onBoot();
+$this->getPackageManager()->registerPackage($sClassName, $xPkgOptions);
+}
+
+/**
      * Find a response plugin by name or class name
      *
      * @template R of ResponsePluginInterface
@@ -118,12 +118,12 @@ 
      *
      * @return ($sName is class-string ? R : ResponsePluginInterface)|null
      */
-    public function plugin(string $sName): ResponsePluginInterface|null
-    {
-        return $this->getPluginManager()->getResponsePlugin($sName);
-    }
+public function plugin(string $sName): ResponsePluginInterface|null
+{
+return $this->getPluginManager()->getResponsePlugin($sName);
+}
 
-    /**
+/**
      * Get a package instance
      *
      * @template P of AbstractPackage
@@ -131,52 +131,52 @@ 
      *
      * @return P|null
      */
-    public function package(string $sClassName): ?AbstractPackage
-    {
-        return $this->getPackageManager()->getPackage($sClassName);
-    }
+public function package(string $sClassName): ?AbstractPackage
+{
+return $this->getPackageManager()->getPackage($sClassName);
+}
 
-    /**
+/**
      * Get the HTML tags to include Jaxon javascript files into the page.
      *
      * @return string
      */
-    public function getJs(): string
-    {
-        return $this->getCodeGenerator()->getJs();
-    }
+public function getJs(): string
+{
+return $this->getCodeGenerator()->getJs();
+}
 
-    /**
+/**
      * Get the HTML tags to include Jaxon javascript files into the page.
      *
      * @return string  the javascript code
      */
-    public function js(): string
-    {
-        return $this->getCodeGenerator()->getJs();
-    }
+public function js(): string
+{
+return $this->getCodeGenerator()->getJs();
+}
 
-    /**
+/**
      * Get the HTML tags to include Jaxon CSS code and files into the page.
      *
      * @return string
      */
-    public function getCss(): string
-    {
-        return $this->getCodeGenerator()->getCss();
-    }
+public function getCss(): string
+{
+return $this->getCodeGenerator()->getCss();
+}
 
-    /**
+/**
      * Get the HTML tags to include Jaxon CSS code and files into the page.
      *
      * @return string
      */
-    public function css(): string
-    {
-        return $this->getCodeGenerator()->getCss();
-    }
+public function css(): string
+{
+return $this->getCodeGenerator()->getCss();
+}
 
-    /**
+/**
      * Returns the js header and wrapper code to be printed into the page
      *
      * The javascript code returned by this function depends on the plugins
@@ -188,12 +188,12 @@ 
      * @return string
      * @throws UriException
      */
-    public function getScript(bool $bIncludeJs = false, bool $bIncludeCss = false): string
-    {
-        return $this->getCodeGenerator()->getScript($bIncludeJs, $bIncludeCss);
-    }
+public function getScript(bool $bIncludeJs = false, bool $bIncludeCss = false): string
+{
+return $this->getCodeGenerator()->getScript($bIncludeJs, $bIncludeCss);
+}
 
-    /**
+/**
      * Returns the js header and wrapper code to be printed into the page
      *
      * @param bool $bIncludeJs    Also get the js code
@@ -202,8 +202,8 @@ 
      * @return string  the javascript code
      * @throws UriException
      */
-    public function script(bool $bIncludeJs = false, bool $bIncludeCss = false): string
-    {
-        return $this->getCodeGenerator()->getScript($bIncludeJs, $bIncludeCss);
-    }
+public function script(bool $bIncludeJs = false, bool $bIncludeCss = false): string
+{
+return $this->getCodeGenerator()->getScript($bIncludeJs, $bIncludeCss);
+}
 }

jaxon-core/src/App/View/Store.php

Switch Indentation +55 added lines, -55 removed lines

@@ -9,35 +9,35 @@ 
 
 class Store implements JsonSerializable, Stringable
 {
-    /**
+/**
      * The view renderer
      *
      * @var ViewInterface|null
      */
-    protected $xRenderer = null;
+protected $xRenderer = null;
 
-    /**
+/**
      * The view namespace
      *
      * @var string
      */
-    protected $sNamespace;
+protected $sNamespace;
 
-    /**
+/**
      * The view name
      *
      * @var string
      */
-    protected $sViewName;
+protected $sViewName;
 
-    /**
+/**
      * The view data
      *
      * @var array
      */
-    protected $aViewData = [];
+protected $aViewData = [];
 
-    /**
+/**
      * Make a piece of data available for the rendered view
      *
      * @param string $sName    The data name
@@ -45,26 +45,26 @@ 
      *
      * @return Store
      */
-    public function with(string $sName, $xValue): Store
-    {
-        $this->aViewData[$sName] = $xValue;
-        return $this;
-    }
+public function with(string $sName, $xValue): Store
+{
+$this->aViewData[$sName] = $xValue;
+return $this;
+}
 
-    /**
+/**
      * Set the data to be rendered
      *
      * @param array $aViewData    The view data
      *
      * @return Store
      */
-    public function setData(array $aViewData): Store
-    {
-        $this->aViewData = array_merge($this->aViewData, $aViewData);
-        return $this;
-    }
+public function setData(array $aViewData): Store
+{
+$this->aViewData = array_merge($this->aViewData, $aViewData);
+return $this;
+}
 
-    /**
+/**
      * Set the view to be rendered, with optional data
      *
      * @param ViewInterface $xRenderer    The view renderer
@@ -74,65 +74,65 @@ 
      *
      * @return Store
      */
-    public function setView(ViewInterface $xRenderer,
-        string $sNamespace, string $sViewName, array $aViewData = []): Store
-    {
-        $this->xRenderer = $xRenderer;
-        $this->sNamespace = trim($sNamespace);
-        $this->sViewName = trim($sViewName);
-        $this->aViewData = array_merge($this->aViewData, $aViewData);
-        return $this;
-    }
+public function setView(ViewInterface $xRenderer,
+string $sNamespace, string $sViewName, array $aViewData = []): Store
+{
+$this->xRenderer = $xRenderer;
+$this->sNamespace = trim($sNamespace);
+$this->sViewName = trim($sViewName);
+$this->aViewData = array_merge($this->aViewData, $aViewData);
+return $this;
+}
 
-    /**
+/**
      * Get the view namespace
      *
      * @return string        The view namespace
      */
-    public function getNamespace(): string
-    {
-        return $this->sNamespace;
-    }
+public function getNamespace(): string
+{
+return $this->sNamespace;
+}
 
-    /**
+/**
      * Get the view name
      *
      * @return string        The view name
      */
-    public function getViewName(): string
-    {
-        return $this->sViewName;
-    }
+public function getViewName(): string
+{
+return $this->sViewName;
+}
 
-    /**
+/**
      * Get the view data
      *
      * @return array         The view data
      */
-    public function getViewData(): array
-    {
-        return $this->aViewData;
-    }
+public function getViewData(): array
+{
+return $this->aViewData;
+}
 
-    /**
+/**
      * Render a view using third party view system
      *
      * @return string        The string representation of the view
      */
-    public function __toString(): string
-    {
-        return !$this->xRenderer ? '' : $this->xRenderer->render($this);
-    }
+public function __toString(): string
+{
+return !$this->xRenderer ? '' : $this->xRenderer->render($this);
+}
 
-    /**
+/**
      * Convert this object to string for json.
      *
      * This is a method of the JsonSerializable interface.
      *
      * @return string
      */
-    public function jsonSerialize(): string
-    {
-        return $this->__toString();
-    }
+public function jsonSerialize(): string
+{
+return $this->__toString();
+}
 }

jaxon-core/src/App/View/ViewRenderer.php

Switch Indentation +151 added lines, -151 removed lines

@@ -13,58 +13,58 @@ 
 
 class ViewRenderer
 {
-    /**
+/**
      * @var Container
      */
-    protected $di;
+protected $di;
 
-    /**
+/**
      * The view data store
      *
      * @var Store|null
      */
-    protected $xStore = null;
+protected $xStore = null;
 
-    /**
+/**
      * The view data store
      *
      * @var Store
      */
-    protected $xEmptyStore = null;
+protected $xEmptyStore = null;
 
-    /**
+/**
      * The view namespaces
      *
      * @var array
      */
-    protected $aNamespaces = [];
+protected $aNamespaces = [];
 
-    /**
+/**
      * The default namespace
      *
      * @var string
      */
-    protected $sDefaultNamespace = 'jaxon';
+protected $sDefaultNamespace = 'jaxon';
 
-    /**
+/**
      * The view global data
      *
      * @var array
      */
-    protected $aViewData = [];
+protected $aViewData = [];
 
-    /**
+/**
      * The class constructor
      *
      * @param Container $di
      */
-    public function __construct(Container $di)
-    {
-        $this->di = $di;
-        $this->xEmptyStore = new Store();
-    }
+public function __construct(Container $di)
+{
+$this->di = $di;
+$this->xEmptyStore = new Store();
+}
 
-    /**
+/**
      * Add a view namespace, and set the corresponding renderer.
      *
      * @param string $sNamespace    The namespace name
@@ -74,59 +74,59 @@ 
      *
      * @return void
      */
-    public function addNamespace(string $sNamespace, string $sDirectory,
-        string $sExtension, string $sRenderer): void
-    {
-        $aNamespace = [
-            'directory' => $sDirectory,
-            'extension' => $sExtension,
-            'renderer' => $sRenderer,
-        ];
-        $this->aNamespaces[$sNamespace] = $aNamespace;
-    }
+public function addNamespace(string $sNamespace, string $sDirectory,
+string $sExtension, string $sRenderer): void
+{
+$aNamespace = [
+'directory' => $sDirectory,
+'extension' => $sExtension,
+'renderer' => $sRenderer,
+];
+$this->aNamespaces[$sNamespace] = $aNamespace;
+}
 
-    /**
+/**
      * Set the view namespaces.
      *
      * @param Config $xAppConfig    The config options provided in the library
      *
      * @return void
      */
-    public function addNamespaces(Config $xAppConfig): void
-    {
-        if(empty($aNamespaces = $xAppConfig->getOptionNames('views')))
-        {
-            return;
-        }
+public function addNamespaces(Config $xAppConfig): void
+{
+if(empty($aNamespaces = $xAppConfig->getOptionNames('views')))
+{
+return;
+}
 
-        $sPackage = $xAppConfig->getOption('package', '');
-        foreach($aNamespaces as $sNamespace => $sOption)
-        {
-            // Save the namespace
-            $aNamespace = $xAppConfig->getOption($sOption);
-            $aNamespace['package'] = $sPackage;
-            if(!isset($aNamespace['renderer']))
-            {
-                $aNamespace['renderer'] = 'jaxon'; // 'jaxon' is the default renderer.
-            }
-            $this->aNamespaces[$sNamespace] = $aNamespace;
-        }
-    }
+$sPackage = $xAppConfig->getOption('package', '');
+foreach($aNamespaces as $sNamespace => $sOption)
+{
+// Save the namespace
+$aNamespace = $xAppConfig->getOption($sOption);
+$aNamespace['package'] = $sPackage;
+if(!isset($aNamespace['renderer']))
+{
+    $aNamespace['renderer'] = 'jaxon'; // 'jaxon' is the default renderer.
+}
+$this->aNamespaces[$sNamespace] = $aNamespace;
+}
+}
 
-    /**
+/**
      * Get the view renderer
      *
      * @param string $sId    The unique identifier of the view renderer
      *
      * @return ViewInterface
      */
-    public function getRenderer(string $sId): ViewInterface
-    {
-        // Return the view renderer with the given id
-        return $this->di->g("jaxon.app.view.$sId");
-    }
+public function getRenderer(string $sId): ViewInterface
+{
+// Return the view renderer with the given id
+return $this->di->g("jaxon.app.view.$sId");
+}
 
-    /**
+/**
      * Add a view renderer with an id
      *
      * @param string $sId    The unique identifier of the view renderer
@@ -134,25 +134,25 @@ 
      *
      * @return void
      */
-    public function addRenderer(string $sId, Closure $xClosure): void
-    {
-        // Return the initialized view renderer
-        $this->di->set("jaxon.app.view.$sId", function($di) use($sId, $xClosure) {
-            // Get the defined renderer
-            $xRenderer = $xClosure($di);
-            // Init the renderer with the template namespaces
-            $aNamespaces = array_filter($this->aNamespaces, function($aOptions) use($sId) {
-                return $aOptions['renderer'] === $sId;
-            });
-            foreach($aNamespaces as $sName => $aOptions)
-            {
-                $xRenderer->addNamespace($sName, $aOptions['directory'], $aOptions['extension']);
-            }
-            return $xRenderer;
-        });
-    }
+public function addRenderer(string $sId, Closure $xClosure): void
+{
+// Return the initialized view renderer
+$this->di->set("jaxon.app.view.$sId", function($di) use($sId, $xClosure) {
+// Get the defined renderer
+$xRenderer = $xClosure($di);
+// Init the renderer with the template namespaces
+$aNamespaces = array_filter($this->aNamespaces, function($aOptions) use($sId) {
+    return $aOptions['renderer'] === $sId;
+});
+foreach($aNamespaces as $sName => $aOptions)
+{
+    $xRenderer->addNamespace($sName, $aOptions['directory'], $aOptions['extension']);
+}
+return $xRenderer;
+});
+}
 
-    /**
+/**
      * Add a view renderer with an id
      *
      * @param string $sId    The unique identifier of the view renderer
@@ -161,55 +161,55 @@ 
      *
      * @return void
      */
-    public function setDefaultRenderer(string $sId, string $sExtension, Closure $xClosure): void
-    {
-        $this->setDefaultNamespace($sId);
-        $this->addNamespace($sId, '', $sExtension, $sId);
-        $this->addRenderer($sId, $xClosure);
-    }
+public function setDefaultRenderer(string $sId, string $sExtension, Closure $xClosure): void
+{
+$this->setDefaultNamespace($sId);
+$this->addNamespace($sId, '', $sExtension, $sId);
+$this->addRenderer($sId, $xClosure);
+}
 
-    /**
+/**
      * Get the view renderer for a given namespace
      *
      * @param string $sNamespace    The namespace name
      *
      * @return ViewInterface|null
      */
-    public function getNamespaceRenderer(string $sNamespace): ?ViewInterface
-    {
-        if(!isset($this->aNamespaces[$sNamespace]))
-        {
-            return null;
-        }
-        // Return the view renderer with the configured id
-        return $this->getRenderer($this->aNamespaces[$sNamespace]['renderer']);
-    }
+public function getNamespaceRenderer(string $sNamespace): ?ViewInterface
+{
+if(!isset($this->aNamespaces[$sNamespace]))
+{
+return null;
+}
+// Return the view renderer with the configured id
+return $this->getRenderer($this->aNamespaces[$sNamespace]['renderer']);
+}
 
-    /**
+/**
      * Set the default namespace
      *
      * @param string $sDefaultNamespace
      */
-    public function setDefaultNamespace(string $sDefaultNamespace): void
-    {
-        $this->sDefaultNamespace = $sDefaultNamespace;
-    }
+public function setDefaultNamespace(string $sDefaultNamespace): void
+{
+$this->sDefaultNamespace = $sDefaultNamespace;
+}
 
-    /**
+/**
      * Get the current store or create a new store
      *
      * @return Store
      */
-    protected function store(): Store
-    {
-        if(!$this->xStore)
-        {
-            $this->xStore = new Store();
-        }
-        return $this->xStore;
-    }
+protected function store(): Store
+{
+if(!$this->xStore)
+{
+$this->xStore = new Store();
+}
+return $this->xStore;
+}
 
-    /**
+/**
      * Make a piece of data available for the rendered view
      *
      * @param string $sName    The data name
@@ -217,13 +217,13 @@ 
      *
      * @return ViewRenderer
      */
-    public function set(string $sName, $xValue): ViewRenderer
-    {
-        $this->store()->with($sName, $xValue);
-        return $this;
-    }
+public function set(string $sName, $xValue): ViewRenderer
+{
+$this->store()->with($sName, $xValue);
+return $this;
+}
 
-    /**
+/**
      * Make a piece of data available for all views
      *
      * @param string $sName    The data name
@@ -231,29 +231,29 @@ 
      *
      * @return ViewRenderer
      */
-    public function share(string $sName, $xValue): ViewRenderer
-    {
-        $this->aViewData[$sName] = $xValue;
-        return $this;
-    }
+public function share(string $sName, $xValue): ViewRenderer
+{
+$this->aViewData[$sName] = $xValue;
+return $this;
+}
 
-    /**
+/**
      * Make an array of data available for all views
      *
      * @param array $aValues    The data values
      *
      * @return ViewRenderer
      */
-    public function shareValues(array $aValues): ViewRenderer
-    {
-        foreach($aValues as $sName => $xValue)
-        {
-            $this->share($sName, $xValue);
-        }
-        return $this;
-    }
+public function shareValues(array $aValues): ViewRenderer
+{
+foreach($aValues as $sName => $xValue)
+{
+$this->share($sName, $xValue);
+}
+return $this;
+}
 
-    /**
+/**
      * Render a view using a store
      *
      * The store returned by this function will later be used with the make() method to render the view.
@@ -263,32 +263,32 @@ 
      *
      * @return Store   A store populated with the view data
      */
-    public function render(string $sViewName, array $aViewData = []): Store
-    {
-        $xStore = $this->store();
-        // Get the default view namespace
-        $sNamespace = $this->sDefaultNamespace;
-        // Get the namespace from the view name
-        $nSeparatorPosition = strrpos($sViewName, '::');
-        if($nSeparatorPosition !== false)
-        {
-            $sNamespace = substr($sViewName, 0, $nSeparatorPosition);
-            $sViewName = substr($sViewName, $nSeparatorPosition + 2);
-        }
+public function render(string $sViewName, array $aViewData = []): Store
+{
+$xStore = $this->store();
+// Get the default view namespace
+$sNamespace = $this->sDefaultNamespace;
+// Get the namespace from the view name
+$nSeparatorPosition = strrpos($sViewName, '::');
+if($nSeparatorPosition !== false)
+{
+$sNamespace = substr($sViewName, 0, $nSeparatorPosition);
+$sViewName = substr($sViewName, $nSeparatorPosition + 2);
+}
 
-        $xRenderer = $this->getNamespaceRenderer($sNamespace);
-        if(!$xRenderer)
-        {
-            // Cannot render a view if there's no renderer corresponding to the namespace.
-            return $this->xEmptyStore;
-        }
+$xRenderer = $this->getNamespaceRenderer($sNamespace);
+if(!$xRenderer)
+{
+// Cannot render a view if there's no renderer corresponding to the namespace.
+return $this->xEmptyStore;
+}
 
-        $xStore->setData(array_merge($this->aViewData, $aViewData))
-            ->setView($xRenderer, $sNamespace, $sViewName);
+$xStore->setData(array_merge($this->aViewData, $aViewData))
+->setView($xRenderer, $sNamespace, $sViewName);
 
-        // Set the store to null so a new store will be created for the next view.
-        $this->xStore = null;
-        // Return the store
-        return $xStore;
-    }
+// Set the store to null so a new store will be created for the next view.
+$this->xStore = null;
+// Return the store
+return $xStore;
+}
 }