Spiral\Logger\LoggerInjector

Complexity

Total Complexity

6

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	createInjection()	0	21	4
A	__construct()	0	3	1
A	extractChannelAttribute()	0	6	1

<?php

declare(strict_types=1);

namespace Spiral\Logger;

use Psr\Log\LoggerInterface;
use Spiral\Core\Container\InjectorInterface;
use Spiral\Logger\Attribute\LoggerChannel;

/**
 * Container injector for {@see LoggerInterface}.
 * Supports {@see LoggerChannel} attribute.
 *
 * @implements InjectorInterface<LoggerInterface>
 */
final class LoggerInjector implements InjectorInterface
{
    public const DEFAULT_CHANNEL = 'default';

    public function __construct(
        private readonly LogsInterface $factory,
    ) {
    }

    /**
     * @param \ReflectionParameter|string|null $context may use extended context if possible.
     */
    public function createInjection(
        \ReflectionClass $class,
        \ReflectionParameter|null|string $context = null,
    ): LoggerInterface {
        $channel = \is_object($context) ? $this->extractChannelAttribute($context) : null;

        if ($channel === null) {
            /**
             * Array of flags to check if the logger allows null argument
             *
             * @var array<class-string<LogsInterface>, bool> $cache
             */
            static $cache = [];

            $cache[$this->factory::class] = (new \ReflectionMethod($this->factory, 'getLogger'))
                ->getParameters()[0]->allowsNull();

            $channel = $cache[$this->factory::class] ? null : self::DEFAULT_CHANNEL;
        }

        return $this->factory->getLogger($channel);

It seems like $channel can also be of type null; however, parameter $channel of Spiral\Logger\LogsInterface::getLogger() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * @return non-empty-string|null

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

     */
    private function extractChannelAttribute(\ReflectionParameter $parameter): ?string
    {
        /** @var \ReflectionAttribute<LoggerChannel>[] $attributes */
        $attributes = $parameter->getAttributes(LoggerChannel::class);

        return $attributes[0]?->newInstance()->name;
    }
}