Gacela\Framework\ClassResolver\AbstractClassResolver

Complexity

Total Complexity

3

Size/Duplication

Total Lines	134
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	8
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	doResolve()	0	27	5
A	resetCache()	0	3	1
A	resolveCached()	0	5	1
A	getClassNameFinder()	0	10	2
A	createInstance()	0	7	2
A	findClassName()	0	5	1
A	hp$1 ➔ createDefaultGacelaClass()	0	9	3
A	getPossibleResolvableTypes()	0	7	2
A	getGacelaConfigFile()	0	9	2
	createDefaultGacelaClass()	0	9	?

<?php

declare(strict_types=1);

namespace Gacela\Framework\ClassResolver;

use Gacela\Framework\AbstractConfig;
use Gacela\Framework\AbstractFactory;
use Gacela\Framework\ClassResolver\Cache\GacelaCache;
use Gacela\Framework\ClassResolver\ClassNameFinder\ClassNameFinderInterface;
use Gacela\Framework\ClassResolver\Config\ConfigResolver;
use Gacela\Framework\ClassResolver\Factory\FactoryResolver;
use Gacela\Framework\ClassResolver\GlobalInstance\AnonymousGlobal;
use Gacela\Framework\ClassResolver\InstanceCreator\InstanceCreator;
use Gacela\Framework\Config\Config;
use Gacela\Framework\Config\GacelaFileConfig\GacelaConfigFileInterface;

use function is_array;
use function is_object;

abstract class AbstractClassResolver
{
    /** @var array<string,null|object> */
    private static array $cachedInstances = [];

    private ?ClassNameFinderInterface $classNameFinder = null;

    private ?GacelaConfigFileInterface $gacelaFileConfig = null;

    private ?InstanceCreator $instanceCreator = null;

    /**
     * @internal remove all cached instances: facade, factory, config, dependency-provider
     */
    public static function resetCache(): void
    {
        self::$cachedInstances = [];
    }

    /**
     * @param object|class-string $caller

The doc comment object|class-string at position 2 could not be parsed: Unknown type name 'class-string' at position 2 in object|class-string.

     */
    abstract public function resolve($caller): ?object;

    /**
     * @param object|class-string $caller

The doc comment object|class-string at position 2 could not be parsed: Unknown type name 'class-string' at position 2 in object|class-string.

     */
    public function doResolve($caller): ?object
    {
        $classInfo = ClassInfo::from($caller, $this->getResolvableType());

        $cacheKey = $classInfo->getCacheKey();

        $resolvedClass = $this->resolveCached($cacheKey);
        if ($resolvedClass !== null) {
            return $resolvedClass;
        }

        $resolvedClassName = $this->findClassName($classInfo);
        if ($resolvedClassName === null) {
            // Try again with its parent class
            if (is_object($caller)) {
                $parentClass = get_parent_class($caller);
                if ($parentClass !== false) {
                    return $this->doResolve($parentClass);
                }
            }

            return $this->createDefaultGacelaClass();
        }

        self::$cachedInstances[$cacheKey] = $this->createInstance($resolvedClassName);

        return self::$cachedInstances[$cacheKey];
    }

    abstract protected function getResolvableType(): string;

    private function resolveCached(string $cacheKey): ?object
    {
        return AnonymousGlobal::getByKey($cacheKey)
            ?? self::$cachedInstances[$cacheKey]
            ?? null;
    }

    /**
     * @return class-string|null

The doc comment class-string|null at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string|null.

     */
    private function findClassName(ClassInfo $classInfo): ?string
    {
        return $this->getClassNameFinder()->findClassName(
            $classInfo,
            $this->getPossibleResolvableTypes()
        );
    }

    private function getClassNameFinder(): ClassNameFinderInterface
    {
        if ($this->classNameFinder === null) {
            $this->classNameFinder = (new ClassResolverFactory(
                new GacelaCache(Config::getInstance()),
                Config::getInstance()->getSetupGacela()
            ))->createClassNameFinder();
        }

        return $this->classNameFinder;

The expression return $this->classNameFinder could return the type null which is incompatible with the type-hinted return Gacela\Framework\ClassResolver\ClassNameFinder\ClassNameFinderInterface. Consider adding an additional type-check to rule them out.

    }

    /**
     * Allow overriding gacela suffixes resolvable types.
     *
     * @return list<string>
     */
    private function getPossibleResolvableTypes(): array
    {
        $suffixTypes = $this->getGacelaConfigFile()->getSuffixTypes();

        $resolvableTypes = $suffixTypes[$this->getResolvableType()] ?? $this->getResolvableType();

        return is_array($resolvableTypes) ? $resolvableTypes : [$resolvableTypes];
    }

    /**
     * @param class-string $resolvedClassName
     */
    private function createInstance(string $resolvedClassName): ?object
    {
        if ($this->instanceCreator === null) {
            $this->instanceCreator = new InstanceCreator($this->getGacelaConfigFile());
        }

        return $this->instanceCreator->createByClassName($resolvedClassName);

The method createByClassName() does not exist on null.

    }

    private function getGacelaConfigFile(): GacelaConfigFileInterface
    {
        if ($this->gacelaFileConfig === null) {
            $this->gacelaFileConfig = Config::getInstance()
                ->getFactory()
                ->createGacelaFileConfig();
        }

        return $this->gacelaFileConfig;

The expression return $this->gacelaFileConfig could return the type null which is incompatible with the type-hinted return Gacela\Framework\Config\GacelaFileConfig\GacelaConfigFileInterface. Consider adding an additional type-check to rule them out.

    }

    private function createDefaultGacelaClass(): ?object
    {
        switch ($this->getResolvableType()) {
            case FactoryResolver::TYPE:
                return new class() extends AbstractFactory {};
            case ConfigResolver::TYPE:
                return new class() extends AbstractConfig {};
            default:
                return null;
        }
    }
}