Rade\DI\Traits\DefinitionTrait

Complexity

Total Complexity

33

Size/Duplication

Total Lines	175
Duplicated Lines	0 %

Importance

Changes	19
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	definition()	0	3	1
A	definitions()	0	3	1
A	multiple()	0	5	3
C	set()	0	52	16
B	removeDefinition()	0	20	7
A	initialized()	0	3	1
A	createNotFound()	0	7	2
A	decorate()	0	10	2

<?php

declare(strict_types=1);

/*
 * This file is part of DivineNii opensource projects.
 *
 * PHP version 7.4 and above required
 *
 * @author    Divine Niiquaye Ibok <divineibok@gmail.com>
 * @copyright 2021 DivineNii (https://divinenii.com/)
 * @license   https://opensource.org/licenses/BSD-3-Clause License
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Rade\DI\Traits;

use Nette\Utils\Helpers;
use PhpParser\Node\Expr\ArrowFunction;
use Rade\DI\{ContainerInterface, Definition, Definitions};
use Rade\DI\Exceptions\{FrozenServiceException, NotFoundServiceException};

/**
 * This trait adds definition's functionality to container.
 *
 * @property \Rade\DI\Resolver $resolver
 *
 * @author Divine Niiquaye Ibok <divineibok@gmail.com>
 */
trait DefinitionTrait
{
    use AliasTrait;

    /** @var array<string,Definitions\DefinitionInterface|object> service name => instance */
    protected array $definitions = [];

    /** @var array<string,mixed> A list of already public loaded services (this act as a local cache) */
    protected array $services = [];

    /** @var array<string,mixed> A list of already private loaded services (this act as a local cache) */
    protected array $privates = [];

    /**
     * {@inheritdoc}
     *
     * @return Definition or DefinitionInterface, mixed value which maybe object
     */
    public function definition(string $id)
    {
        return $this->definitions[$this->aliases[$id] ?? $id] ?? null;
    }

    /**
     * Gets all service definitions.
     *
     * @return array<string,Definitions\DefinitionInterface|object>
     */
    public function definitions(): array
    {
        return $this->definitions;
    }

    /**
     * {@inheritdoc}
     */
    public function initialized(string $id): bool
    {
        return \array_key_exists($this->aliases[$id] ?? $id, $this->services);
    }

    /**
     * Remove a registered definition.
     */
    public function removeDefinition(string $id): void
    {
        unset($this->definitions[$id], $this->services[$id]);

        foreach ($this->aliases as $alias => $aliased) {
            if ($id !== $aliased) {
                continue;
            }

            $this->removeAlias($alias);
        }

        if (isset($this->types)) {
            foreach ($this->types as &$serviceIds) {
                foreach ($serviceIds as $offset => $serviceId) {
                    if ($id !== $serviceId) {
                        continue;
                    }

                    unset($serviceIds[$offset]);
                }
            }
        }
    }

    /**
     * {@inheritdoc}
     *
     * @param Definitions\DefinitionInterface|object|null $definition
     *
     * @return Definition|Definitions\ValueDefinition or DefinitionInterface, mixed value which maybe object
     */
    public function set(string $id, object $definition = null): object
    {
        unset($this->aliases[$id]); // Incase new service definition exists in aliases.

        if (null !== ($this->services[$id] ?? $this->privates[$id] ?? null)) {
            throw new FrozenServiceException(\sprintf('The "%s" service is already initialized, and cannot be replaced.', $id));
        }

        if (ContainerInterface::SERVICE_CONTAINER === $id) {
            throw new FrozenServiceException(\sprintf('The "%s" service is reserved, and cannot be set or modified.', $id));
        }

        if (null === $definition) {
            ($definition = new Definition($id))->bindWith($id, $this);
        } elseif ($definition instanceof Definitions\Statement) {
            if ($definition->isClosureWrappable()) {
                if ($this->resolver->getBuilder()) {
                    $entity = new ArrowFunction(['expr' => $this->resolver->resolve($definition->getValue(), $definition->getArguments())]);
                }
                $definition = $entity ?? fn () => $this->resolver->resolve($definition->getValue(), $definition->getArguments());
            } else {
                $definition = new Definition($definition->getValue(), $definition->getArguments());
            }
        } elseif ($definition instanceof Definitions\Reference) {
            if (null === $previousDef = $this->definitions[(string) $definition] ?? null) {
                throw $this->createNotFound((string) $definition);
            }
            $definition = clone $previousDef;

            if ($definition instanceof Definitions\ShareableDefinitionInterface) {
                $definition->abstract(false);
            }
        }

        if ($definition instanceof Definitions\DefinitionInterface) {
            if ($definition instanceof Definitions\TypedDefinitionInterface) {
                $definition->isTyped() && $this->type($id, $definition->getTypes());

It seems like type() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            }

            if ($definition instanceof Definitions\DefinitionAwareInterface) {
                /** @var \Rade\DI\Definitions\Traits\DefinitionAwareTrait $definition */
                if ($definition->hasTags()) {
                    foreach ($definition->getTags() as $tag => $value) {
                        $this->tag($id, $tag, $value);

It seems like tag() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    }
                }

                $definition->bindWith($id, $this);
            }
        }

        return $this->definitions[$id] = $definition;
    }

    /**
     * Sets multiple definitions at once into the container.
     *
     * @param array<int|string,mixed> $definitions indexed by their ids
     */
    public function multiple(array $definitions): void
    {
        foreach ($definitions as $id => $definition) {
            [$id, $definition] = \is_int($id) ? [$definition, null] : [$id, $definition];
            $this->set($id, $definition);
        }
    }

    /**
     * Replaces old service with a new one, but keeps a reference
     * of the old one as: service_id.inner.
     *
     * All decorated services under the tag: container.decorated_services
     *
     * @param Definitions\DefinitionInterface|object|null $definition
     *
     * @return Definition|Definitions\ValueDefinition or DefinitionInterface, mixed value which maybe object
     */
    public function decorate(string $id, object $definition = null, string $newId = null)
    {
        if (null === $innerDefinition = $this->definitions[$id] ?? null) {
            throw $this->createNotFound($id);
        }

        $this->removeDefinition($id);
        $this->set($id . '.inner', $innerDefinition)->tag('container.decorated_services');

        return $this->set($newId ?? $id, $definition);
    }

    /**
     * Throw a PSR-11 not found exception.
     */
    protected function createNotFound(string $id, \Throwable $e = null): NotFoundServiceException
    {
        if (null !== $suggest = Helpers::getSuggestion(\array_keys($this->definitions), $id)) {
            $suggest = " Did you mean: \"$suggest\"?";
        }

        return new NotFoundServiceException(\sprintf('The "%s" requested service is not defined in container.' . $suggest, $id), 0, $e);
    }
}