ClassContainer::useUnderscore() - Code Metrics - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

ClassContainer::useUnderscore() A
last analyzed 2025-01-08 16:45 UTC

↳ Parent: ClassContainer
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

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

/**
 * ClassContainer.php
 *
 * Jaxon DI container. Provide container service for the registered classes.
 *
 * @package jaxon-core
 * @author Thierry Feuzeu <[email protected]>
 * @copyright 2024 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\Di;

use Jaxon\App\AbstractCallable;
use Jaxon\App\Config\ConfigManager;
use Jaxon\App\I18n\Translator;
use Jaxon\App\Pagination;
use Jaxon\Exception\SetupException;
use Jaxon\Plugin\Request\CallableClass\CallableClassHelper;
use Jaxon\Plugin\Request\CallableClass\CallableObject;
use Jaxon\Plugin\Request\CallableClass\CallableRegistry;
use Jaxon\Plugin\Response\Dialog\DialogCommand;
use Jaxon\Request\Handler\CallbackManager;
use Jaxon\Script\JxnCall;
use Jaxon\Script\JxnClass;
use Pimple\Container as PimpleContainer;
use Closure;
use ReflectionClass;
use ReflectionException;
use ReflectionNamedType;
use ReflectionParameter;

use function array_map;
use function str_replace;
use function trim;

class ClassContainer
{
    /**
     * If the underscore is used as separator in js class names.
     *
     * @var bool
     */
    private $bUsingUnderscore = false;

    /**
     * The Dependency Injection Container for registered classes
     *
     * @var PimpleContainer
     */
    private $xContainer;

    /**
     * The classes
     *
     * These are all the classes, both registered and found in registered directories.
     *
     * @var array
     */
    protected $aClasses = [];

    /**
     * The class constructor
     *
     * @param Container $di
     * @param Translator $xTranslator
     */
    public function __construct(private Container $di, private Translator $xTranslator)
    {
        $this->xContainer = new PimpleContainer();
        $this->val(ClassContainer::class, $this);

        // Register the call factory for registered functions
        $this->set($this->getRequestFactoryKey(JxnCall::class), function() {
            return new JxnCall($this->di->g(DialogCommand::class),
                $this->di->g(ConfigManager::class)->getOption('core.prefix.function', ''));
        });
    }

    /**
     * @return void
     */
    public function useUnderscore()
    {
        $this->bUsingUnderscore = true;
    }

    /**
     * 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->xContainer->offsetExists($sClass);
    }

    /**
     * Get a class instance
     *
     * @param string $sClass    The full class name
     *
     * @return mixed
     */
    public function get(string $sClass)
    {
        return $this->xContainer->offsetGet($sClass);
    }

    /**
     * Save a closure in the container
     *
     * @param string $sClass    The full class name
     * @param Closure $xClosure    The closure
     *
     * @return void
     */
    public function set(string $sClass, Closure $xClosure)
    {
       $this->xContainer->offsetSet($sClass, function() use($xClosure) {
            return $xClosure($this);
        });
    }

    /**
     * Save a value in the container
     *
     * @param string $sKey    The key
     * @param mixed $xValue    The value
     *
     * @return void
     */
    public function val(string $sKey, $xValue)
    {
       $this->xContainer->offsetSet($sKey, $xValue);
    }

    /**
     *
     * @param string $sClassName    The class name
     * @param array $aOptions    The class options
     *
     * @return void
     */
    public function registerClass(string $sClassName, array $aOptions = [])
    {
        try
        {
            // Make sure the registered class exists
            isset($aOptions['include']) && require_once($aOptions['include']);
            $xReflectionClass = new ReflectionClass($sClassName);
            // Check if the class is registrable
            if($xReflectionClass->isInstantiable() &&
                !$xReflectionClass->isSubclassOf(Pagination::class))
            {
                $this->aClasses[$sClassName] = $aOptions;
                $this->val($this->getReflectionClassKey($sClassName), $xReflectionClass);
            }
        }
        catch(ReflectionException $e)
        {
            throw new SetupException($this->xTranslator->trans('errors.class.invalid',
                ['name' => $sClassName]));
        }
    }

    /**
     * Find the options associated with a registered class name
     *
     * @param string $sClassName The class name
     *
     * @return void
     * @throws SetupException
     */
    private function registerClassOptions(string $sClassName)
    {
        if(!isset($this->aClasses[$sClassName]))
        {
            // Find options for a class registered with namespace.
            /** @var CallableRegistry */
            $xRegistry = $this->di->g(CallableRegistry::class);
            $xRegistry->registerClassFromNamespace($sClassName);
            if(!isset($this->aClasses[$sClassName]))
            {
                // Find options for a class registered without namespace.
                // We need to parse all the classes to be able to find one.
                $xRegistry->parseDirectories();
            }
        }
        if(!isset($this->aClasses[$sClassName]))
        {
            throw new SetupException($this->xTranslator->trans('errors.class.invalid',
                ['name' => $sClassName]));
        }
    }

    /**
     * Get callable objects for known classes
     *
     * @return array
     * @throws SetupException
     */
    public function getCallableObjects(): array
    {
        $aCallableObjects = [];
        foreach($this->aClasses as $sClassName => $_)
        {
            $this->registerCallableClass($sClassName);
            $aCallableObjects[$sClassName] = $this->getCallableObject($sClassName);
        }
        return $aCallableObjects;
    }

    /**
     * @param ReflectionClass $xClass
     * @param ReflectionParameter $xParameter
     *
     * @return mixed
     * @throws SetupException
     */
    protected function getParameter(ReflectionClass $xClass, ReflectionParameter $xParameter)
    protected function getParameter(/** @scrutinizer ignore-unused */ ReflectionClass $xClass, ReflectionParameter $xParameter)
    {
        $xType = $xParameter->getType();
        // Check the parameter class first.
        if($xType instanceof ReflectionNamedType)
        {
            // Check the class + the name
            if($this->di->has($xType->getName() . ' $' . $xParameter->getName()))
            {
                return $this->di->get($xType->getName() . ' $' . $xParameter->getName());
            }
            // Check the class only
            if($this->di->has($xType->getName()))
            {
                return $this->di->get($xType->getName());
            }
        }
        // Check the name only
        return $this->di->get('$' . $xParameter->getName());
    }

    /**
     * Create an instance of a class, getting the constructor parameters from the DI container
     *
     * @param string|ReflectionClass $xClass The class name or the reflection class
     *
     * @return object|null
     * @throws ReflectionException
     * @throws SetupException
     */
    public function make($xClass)
    {
        if(is_string($xClass))
        {
            $xClass = new ReflectionClass($xClass); // Create the reflection class instance
        }
        if(!($xClass instanceof ReflectionClass))

        {
            return null;
        }
        // Use the Reflection class to get the parameters of the constructor
        if(($constructor = $xClass->getConstructor()) === null)
        {
            return $xClass->newInstance();
        }
        $aParameterInstances = array_map(function($xParameter) use($xClass) {
            return $this->getParameter($xClass, $xParameter);
        }, $constructor->getParameters());

        return $xClass->newInstanceArgs($aParameterInstances);
    }

    /**
     * Create an instance of a class by automatically fetching the dependencies in the constructor.
     *
     * @param string $sClass    The class name
     *
     * @return void
     */
    public function auto(string $sClass)
    {
        $this->set($sClass, function() use ($sClass) {
            return $this->make($sClass);
        });
    }

    /**
     * @param string $sClassName The callable class name
     *
     * @return string
     */
    private function getCallableObjectKey(string $sClassName): string
    {
        return $sClassName . '_CallableObject';
    }

    /**
     * @param string $sClassName The callable class name
     *
     * @return string
     */
    private function getCallableHelperKey(string $sClassName): string
    {
        return $sClassName . '_CallableHelper';
    }

    /**
     * @param string $sClassName The callable class name
     *
     * @return string
     */
    private function getReflectionClassKey(string $sClassName): string
    {
        return $sClassName . '_ReflectionClass';
    }

    /**
     * Register a callable class
     *
     * @param string $sClassName The callable class name
     *
     * @return void
     * @throws SetupException
     */
    private function registerCallableClass(string $sClassName)
    {
        $sCallableObject = $this->getCallableObjectKey($sClassName);
        // Prevent duplication. It's important not to use the class name here.
        if($this->has($sCallableObject))
        {
            return;
        }

        // Register the helper class
        $this->set($this->getCallableHelperKey($sClassName), function() use($sClassName) {
            $xFactory = $this->di->getCallFactory();
            return new CallableClassHelper($this, $xFactory->rq($sClassName),
            return new CallableClassHelper($this, /** @scrutinizer ignore-type */ $xFactory->rq($sClassName),
                $xFactory, $this->di->getViewRenderer(),
                $this->di->getLogger(), $this->di->getSessionManager(),
                $this->di->getStash(), $this->di->getUploadHandler());
        });

        $this->registerClassOptions($sClassName);
        $aOptions = $this->aClasses[$sClassName];

        // Register the callable object
        $this->set($sCallableObject, function() use($sClassName, $aOptions) {
            $xReflectionClass = $this->get($this->getReflectionClassKey($sClassName));
            $xRegistry = $this->di->g(CallableRegistry::class);
            $aProtectedMethods = $xRegistry->getProtectedMethods($sClassName);

            return new CallableObject($this, $this->di, $xReflectionClass, $aOptions, $aProtectedMethods);
        });

        // Register the user class, but only if the user didn't already.
        if(!$this->has($sClassName))
        {
            $this->set($sClassName, function() use($sClassName) {
                return $this->make($this->get($this->getReflectionClassKey($sClassName)));
            });
        }
        // Initialize the user class instance
        $this->xContainer->extend($sClassName, function($xClassInstance) use($sClassName) {
            if($xClassInstance instanceof AbstractCallable)
            {
                $xClassInstance->_initCallable($this->di, $this->get($this->getCallableHelperKey($sClassName)));
            }

            // 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 when creating the object instance.
            // The method level DI options are set only when calling the method in the ajax request.
            /** @var CallableObject */
            $xCallableObject = $this->get($this->getCallableObjectKey($sClassName));
            $xCallableObject->setDiClassAttributes($xClassInstance);

            return $xClassInstance;
        });
    }

    /**
     * Get the callable object for a given class
     *
     * @param string $sClassName
     *
     * @return CallableObject
     */
    public function getCallableObject(string $sClassName): CallableObject
    {
        return $this->get($sClassName . '_CallableObject');
    }

    /**
     * Check if a callable object is already in the DI, and register if not
     *
     * @param string $sClassName The class name of the callable object
     *
     * @return string
     * @throws SetupException
     */
    private function checkCallableObject(string $sClassName): string
    {
        // Replace all separators ('.' and '_') with antislashes, and remove the antislashes
        // at the beginning and the end of the class name.
        $sClassName = trim(str_replace('.', '\\', $sClassName), '\\');
        if($this->bUsingUnderscore)
        {
            $sClassName = trim(str_replace('_', '\\', $sClassName), '\\');
        }

        // Register the class.
        $this->registerCallableClass($sClassName);
        return $sClassName;
    }

    /**
     * Get the callable object for a given class
     * The callable object is registered if it is not already in the DI.
     *
     * @param string $sClassName The class name of the callable object
     *
     * @return CallableObject|null
     * @throws SetupException
     */
    public function makeCallableObject(string $sClassName): ?CallableObject
    {
        return $this->getCallableObject($this->checkCallableObject($sClassName));
    }

    /**
     * Get an instance of a Jaxon class by name
     *
     * @param string $sClassName the class name
     *
     * @return mixed
     * @throws SetupException
     */
    public function makeRegisteredObject(string $sClassName)
    {
        $xCallableObject = $this->makeCallableObject($sClassName);
        return !$xCallableObject ? null : $xCallableObject->getRegisteredObject();

    }

    /**
     * Get the callable registry
     *
     * @return CallableRegistry
     */
    public function getCallableRegistry(): CallableRegistry
    {
        return $this->di->g(CallableRegistry::class);
    }

    /**
     * @param string $sClassName The callable class name
     *
     * @return string
     */
    private function getRequestFactoryKey(string $sClassName): string
    {
        return $sClassName . '_RequestFactory';
    }

    /**
     * @param string $sClassName
     * @param string $sFactoryKey
     *
     * @return void
     */
    private function registerRequestFactory(string $sClassName, string $sFactoryKey)
    {
        $this->xContainer->offsetSet($sFactoryKey, function() use($sClassName) {
            if(!($xCallable = $this->makeCallableObject($sClassName)))
            {
                return null;
            }
            $xConfigManager = $this->di->g(ConfigManager::class);
            $sJsObject = $xConfigManager->getOption('core.prefix.class', '') . $xCallable->getJsName();
            return new JxnClass($this->di->g(DialogCommand::class), $sJsObject);
        });
    }

    /**
     * Get a factory for a js function call.
     *
     * @param string $sClassName
     *
     * @return JxnCall|null
     */
    public function getRequestFactory(string $sClassName = ''): ?JxnCall
    {
        $sClassName = trim($sClassName, " \t") ?: JxnCall::class;
        $sFactoryKey = $this->getRequestFactoryKey($sClassName);
        if(!$this->has($sFactoryKey))
        {
            $this->registerRequestFactory($sClassName, $sFactoryKey);
        }
        return $this->get($sFactoryKey);
    }
}

jaxon-php / jaxon-core

ClassContainer::useUnderscore() A last analyzed 2025-01-08 16:45 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ClassContainer::useUnderscore() A
last analyzed 2025-01-08 16:45 UTC
