Aoe\Asdis\System\Factory\AbstractDeclarationBasedFactory

Complexity

Total Complexity

18

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Test Coverage

Coverage

71.74%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setFallbackKey()	0	3	1
A	injectConfigurationProvider()	0	3	1
A	setClassImplements()	0	3	1
A	getDeclarationByKey()	0	8	3
A	addDeclaration()	0	13	4
A	setDeclarations()	0	5	2
A	buildObjectFromKey()	0	29	6

<?php

namespace Aoe\Asdis\System\Factory;

use Aoe\Asdis\System\Configuration\Provider;
use Aoe\Asdis\System\Factory\Exception\DeclarationNotFound;
use Aoe\Asdis\System\Factory\Exception\InvalidDeclaration;
use Aoe\Asdis\System\Factory\Exception\MissingImplementation;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Abstract factory class for factories that create their products from array based declarations.
 */
abstract class AbstractDeclarationBasedFactory
{
    /**
     * @var string
     */
    public const DECLARATION_KEY = 'key';

    /**
     * @var string
     */
    public const DECLARATION_CLASS = 'class';

    /**
     * @var string
     */
    public const DECLARATION_FILE = 'file';

    protected ?Provider $configurationProvider = null;

    private ?string $fallbackKey = null;

    private array $declarations = [];

    private array $classImplements = [];

    public function injectConfigurationProvider(Provider $configurationProvider): void
    {
        $this->configurationProvider = $configurationProvider;
    }

    protected function setClassImplements(array $classImplements): void
    {
        $this->classImplements = $classImplements;
    }

    protected function setDeclarations(array $declarations): void
    {
        $this->declarations = [];
        foreach ($declarations as $declaration) {
            $this->addDeclaration($declaration);
        }
    }

    protected function setFallbackKey(string $fallbackKey): void
    {
        $this->fallbackKey = $fallbackKey;
    }

    /**
     * @return object
     * @throws DeclarationNotFound
     * @throws MissingImplementation
     */
    protected function buildObjectFromKey(string $key)
    {
        $declaration = null;

The assignment to $declaration is dead and can be removed.

        try {
            $declaration = $this->getDeclarationByKey($key);
        } catch (DeclarationNotFound $declarationNotFound) {
            if (!isset($this->fallbackKey)) {
                throw $declarationNotFound;
            }
            $declaration = $this->getDeclarationByKey($this->fallbackKey);

It seems like $this->fallbackKey can also be of type null; however, parameter $key of Aoe\Asdis\System\Factory\AbstractDeclarationBasedFactory::getDeclarationByKey() does only seem to accept string, maybe add an additional type check?

        }

        if (!class_exists($declaration[self::DECLARATION_CLASS])) {
            require_once $declaration[self::DECLARATION_FILE];
        }

        $object = GeneralUtility::makeInstance($declaration[self::DECLARATION_CLASS]);
        $implemented = class_implements($object);
        foreach ($this->classImplements as $classImplement) {
            if (!in_array($classImplement, $implemented)) {
                throw new MissingImplementation(
                    $declaration[self::DECLARATION_CLASS],
                    $classImplement,
                    static::class,
                    1_372_770_673_456

The constant Aoe\Asdis\System\Factory\1_372_770_673_456 was not found. Maybe you did not declare it correctly or list all dependencies?

                );
            }
        }
        return $object;
    }

    /**
     * @throws InvalidDeclaration
     */
    private function addDeclaration(array $declaration): void
    {
        if (
            !array_key_exists(self::DECLARATION_KEY, $declaration) ||
            !array_key_exists(self::DECLARATION_CLASS, $declaration) ||
            !array_key_exists(self::DECLARATION_FILE, $declaration)
        ) {
            throw new InvalidDeclaration(
                'Missing declaration element.',
                1_372_422_185_108

The constant Aoe\Asdis\System\Factory\1_372_422_185_108 was not found. Maybe you did not declare it correctly or list all dependencies?

            );
        }
        $this->declarations[] = $declaration;
    }

    /**
     * @return mixed
     * @throws DeclarationNotFound
     */
    private function getDeclarationByKey(string $key)
    {
        foreach ($this->declarations as $declaration) {
            if (strcmp($declaration[self::DECLARATION_KEY], $key) === 0) {
                return $declaration;
            }
        }
        throw new DeclarationNotFound($key, 1_372_422_430_920);

The constant Aoe\Asdis\System\Factory\1_372_422_430_920 was not found. Maybe you did not declare it correctly or list all dependencies?

    }
}