Gacela::container() - Code Metrics - Inspection of "chore: expose Gacela::container()" - gacela-project/gacela - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — feat/debug-container-command ( cf5949...f59681 )

by Chema

created 2025-11-09 00:18 UTC

Gacela::container() A

↳ Parent: Gacela

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	3
c	1
b	0
f	0
nc	2
nop	0
dl	0
loc	7
rs	10

<?php

declare(strict_types=1);

namespace Gacela\Framework;

use Closure;
use Gacela\Framework\Bootstrap\GacelaConfig;
use Gacela\Framework\Bootstrap\SetupGacela;
use Gacela\Framework\Bootstrap\SetupGacelaInterface;
use Gacela\Framework\ClassResolver\AbstractClassResolver;
use Gacela\Framework\ClassResolver\Cache\GacelaFileCache;
use Gacela\Framework\ClassResolver\Cache\InMemoryCache;
use Gacela\Framework\ClassResolver\ClassResolverCache;
use Gacela\Framework\ClassResolver\GlobalInstance\AnonymousGlobal;
use Gacela\Framework\Config\Config;
use Gacela\Framework\Config\ConfigFactory;
use Gacela\Framework\Container\Container;
use Gacela\Framework\Container\Locator;
use Gacela\Framework\DocBlockResolver\DocBlockResolverCache;
use Gacela\Framework\Exception\GacelaNotBootstrappedException;

use function is_string;
use function sprintf;

final class Gacela
{
    private const GACELA_PHP_FILENAME = 'gacela.php';

    private static ?Container $mainContainer = null;

    private static ?string $appRootDir = null;

    /**
     * Define the entry point of Gacela.
     *
     * @param  null|Closure(GacelaConfig):void  $configFn
     */
    public static function bootstrap(string $appRootDir, ?Closure $configFn = null): void
    {
        self::$appRootDir = $appRootDir;
        self::$mainContainer = null;

        $setup = self::processConfigFnIntoSetup($configFn);

        if ($setup->shouldResetInMemoryCache()) {
            self::resetCache();
        }

        $config = Config::createWithSetup($setup);
        $config->setAppRootDir($appRootDir)
            ->init();

        self::runPlugins($config);
    }

    /**
     * @template T
     *
     * @param  class-string<T>  $className

     *
     * @return T|null
     */
    public static function get(string $className): mixed
    {
        return Locator::getSingleton($className, self::$mainContainer);
    }

    /**
     * Get the main dependency injection container.
     * This is the actual container created during bootstrap with all runtime bindings and frozen services.
     *
     * @throws GacelaNotBootstrappedException if Gacela has not been bootstrapped yet
     */
    public static function container(): Container
    {
        if (!self::$mainContainer instanceof Container) {
            throw new GacelaNotBootstrappedException();
        }

        return self::$mainContainer;
    }

    /**
     * Get the application root dir set when bootstrapping gacela
     */
    public static function rootDir(): string
    {
        if (self::$appRootDir === null) {
            throw new GacelaNotBootstrappedException();
        }

        return self::$appRootDir;
    }

    /**
     * Add an anonymous class as 'Config', 'Factory' or 'Provider' as a global resource
     * bound to the context that it is passed as second argument.
     *
     * @param  object|string  $context  It can be the string-key (file path) or the class/object itself.
     *                               If empty then the caller's file will be use
     */
    public static function addGlobal(object $resolvedClass, object|string $context = ''): void
    {
        if (is_string($context) && is_file($context)) {
            $context = basename($context, '.php');
        } elseif ($context === '') {
            $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
            $callerFile = $trace[0]['file'] ?? __FILE__;
            $context = basename($callerFile, '.php');
        }

        AnonymousGlobal::addGlobal($context, $resolvedClass);
    }

    public static function overrideExistingResolvedClass(string $className, object $resolvedClass): void
    {
        AnonymousGlobal::overrideExistingResolvedClass($className, $resolvedClass);
    }

    /**
     * @param  null|Closure(GacelaConfig):void  $configFn
     */
    private static function processConfigFnIntoSetup(?Closure $configFn = null): SetupGacelaInterface
    {
        if ($configFn instanceof Closure) {
            return SetupGacela::fromCallable($configFn);
        }

        $gacelaFilePath = sprintf(
            '%s%s%s',
            self::rootDir(),
            DIRECTORY_SEPARATOR,
            self::GACELA_PHP_FILENAME,
        );

        if (is_file($gacelaFilePath)) {
            return SetupGacela::fromFile($gacelaFilePath);
        }

        return new SetupGacela();
    }

    private static function resetCache(): void
    {
        AnonymousGlobal::resetCache();
        AbstractFacade::resetCache();
        AbstractFactory::resetCache();
        AbstractClassResolver::resetCache();
        InMemoryCache::resetCache();
        GacelaFileCache::resetCache();
        DocBlockResolverCache::resetCache();
        ClassResolverCache::resetCache();
        ConfigFactory::resetCache();
        Config::resetInstance();
        Locator::resetInstance();
    }

    private static function runPlugins(Config $config): void
    {
        self::$mainContainer = Container::withConfig($config);

        $plugins = $config->getSetupGacela()->getPlugins();

        foreach ($plugins as $plugin) {
            /** @var callable $current */
            $current = is_string($plugin)
                ? self::$mainContainer->get($plugin)
                : $plugin;

            self::$mainContainer->resolve($current);
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Gacela\Framework;
6
7			use Closure;
8			use Gacela\Framework\Bootstrap\GacelaConfig;
9			use Gacela\Framework\Bootstrap\SetupGacela;
10			use Gacela\Framework\Bootstrap\SetupGacelaInterface;
11			use Gacela\Framework\ClassResolver\AbstractClassResolver;
12			use Gacela\Framework\ClassResolver\Cache\GacelaFileCache;
13			use Gacela\Framework\ClassResolver\Cache\InMemoryCache;
14			use Gacela\Framework\ClassResolver\ClassResolverCache;
15			use Gacela\Framework\ClassResolver\GlobalInstance\AnonymousGlobal;
16			use Gacela\Framework\Config\Config;
17			use Gacela\Framework\Config\ConfigFactory;
18			use Gacela\Framework\Container\Container;
19			use Gacela\Framework\Container\Locator;
20			use Gacela\Framework\DocBlockResolver\DocBlockResolverCache;
21			use Gacela\Framework\Exception\GacelaNotBootstrappedException;
22
23			use function is_string;
24			use function sprintf;
25
26			final class Gacela
27			{
28			private const GACELA_PHP_FILENAME = 'gacela.php';
29
30			private static ?Container $mainContainer = null;
31
32			private static ?string $appRootDir = null;
33
34			/**
35			* Define the entry point of Gacela.
36			*
37			* @param null\|Closure(GacelaConfig):void $configFn
38			*/
39			public static function bootstrap(string $appRootDir, ?Closure $configFn = null): void
40			{
41			self::$appRootDir = $appRootDir;
42			self::$mainContainer = null;
43
44			$setup = self::processConfigFnIntoSetup($configFn);
45
46			if ($setup->shouldResetInMemoryCache()) {
47			self::resetCache();
48			}
49
50			$config = Config::createWithSetup($setup);
51			$config->setAppRootDir($appRootDir)
52			->init();
53
54			self::runPlugins($config);
55			}
56
57			/**
58			* @template T
59			*
60			* @param class-string<T> $className
			0 ignored issues – show Documentation Bug introduced 2021-10-31 19:37 UTC by Report Bug Copy Issue Report The doc comment `class-string<T>` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<T>. Loading history...
61			*
62			* @return T\|null
63			*/
64			public static function get(string $className): mixed
65			{
66			return Locator::getSingleton($className, self::$mainContainer);
67			}
68
69			/**
70			* Get the main dependency injection container.
71			* This is the actual container created during bootstrap with all runtime bindings and frozen services.
72			*
73			* @throws GacelaNotBootstrappedException if Gacela has not been bootstrapped yet
74			*/
75			public static function container(): Container
76			{
77			if (!self::$mainContainer instanceof Container) {
78			throw new GacelaNotBootstrappedException();
79			}
80
81			return self::$mainContainer;
82			}
83
84			/**
85			* Get the application root dir set when bootstrapping gacela
86			*/
87			public static function rootDir(): string
88			{
89			if (self::$appRootDir === null) {
90			throw new GacelaNotBootstrappedException();
91			}
92
93			return self::$appRootDir;
94			}
95
96			/**
97			* Add an anonymous class as 'Config', 'Factory' or 'Provider' as a global resource
98			* bound to the context that it is passed as second argument.
99			*
100			* @param object\|string $context It can be the string-key (file path) or the class/object itself.
101			* If empty then the caller's file will be use
102			*/
103			public static function addGlobal(object $resolvedClass, object\|string $context = ''): void
104			{
105			if (is_string($context) && is_file($context)) {
106			$context = basename($context, '.php');
107			} elseif ($context === '') {
108			$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
109			$callerFile = $trace[0]['file'] ?? __FILE__;
110			$context = basename($callerFile, '.php');
111			}
112
113			AnonymousGlobal::addGlobal($context, $resolvedClass);
114			}
115
116			public static function overrideExistingResolvedClass(string $className, object $resolvedClass): void
117			{
118			AnonymousGlobal::overrideExistingResolvedClass($className, $resolvedClass);
119			}
120
121			/**
122			* @param null\|Closure(GacelaConfig):void $configFn
123			*/
124			private static function processConfigFnIntoSetup(?Closure $configFn = null): SetupGacelaInterface
125			{
126			if ($configFn instanceof Closure) {
127			return SetupGacela::fromCallable($configFn);
128			}
129
130			$gacelaFilePath = sprintf(
131			'%s%s%s',
132			self::rootDir(),
133			DIRECTORY_SEPARATOR,
134			self::GACELA_PHP_FILENAME,
135			);
136
137			if (is_file($gacelaFilePath)) {
138			return SetupGacela::fromFile($gacelaFilePath);
139			}
140
141			return new SetupGacela();
142			}
143
144			private static function resetCache(): void
145			{
146			AnonymousGlobal::resetCache();
147			AbstractFacade::resetCache();
148			AbstractFactory::resetCache();
149			AbstractClassResolver::resetCache();
150			InMemoryCache::resetCache();
151			GacelaFileCache::resetCache();
152			DocBlockResolverCache::resetCache();
153			ClassResolverCache::resetCache();
154			ConfigFactory::resetCache();
155			Config::resetInstance();
156			Locator::resetInstance();
157			}
158
159			private static function runPlugins(Config $config): void
160			{
161			self::$mainContainer = Container::withConfig($config);
162
163			$plugins = $config->getSetupGacela()->getPlugins();
164
165			foreach ($plugins as $plugin) {
166			/** @var callable $current */
167			$current = is_string($plugin)
168			? self::$mainContainer->get($plugin)
169			: $plugin;
170
171			self::$mainContainer->resolve($current);
172			}
173			}
174			}
175

gacela-project / gacela

Push — feat/debug-container-command ( cf5949...f59681 )

Gacela::container() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like