leinonen\Yii2Monolog\Yii2Monolog

Complexity

Total Complexity

11

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getLogger()	0	8	2
A	bootstrap()	0	5	1
A	setChannels()	0	4	1
A	setMainChannel()	0	4	1
A	registerLoggers()	0	12	2
A	registerPsrLogger()	0	6	1
A	getMainChannel()	0	8	2

<?php


namespace leinonen\Yii2Monolog;


use leinonen\Yii2Monolog\Factories\MonologFactory;
use Monolog\Logger;
use Psr\Log\LoggerInterface;
use Yii;
use yii\base\Application;
use yii\base\BootstrapInterface;
use yii\base\Component;

class Yii2Monolog extends Component implements BootstrapInterface
{
    /**
     * @var array
     */
    private $channels;

    /**
     * @var MonologFactory
     */
    private $monologFactory;

    /**
     * @var string
     */
    private $mainChannel;

    /**
     * @var LoggerRegistry
     */
    private $loggerRegistry;

    /**
     * Initiates a new Yii2Monolog.
     *
     * @param MonologFactory $monologFactory
     * @param LoggerRegistry $loggerRegistry
     * @param array $config
     */
    public function __construct(MonologFactory $monologFactory, LoggerRegistry $loggerRegistry, array $config = [])
    {
        $this->monologFactory = $monologFactory;
        $this->loggerRegistry = $loggerRegistry;
        parent::__construct($config);
    }

    /**
     * Returns the given logger channel.
     *
     * @param string $channel

Should the type for parameter $channel not be null|string?

     *
     * @return Logger
     */
    public function getLogger(string $channel = null): Logger
    {
        if ($channel === null) {
            $channel = $this->getMainChannel();
        }

        return $this->loggerRegistry->getLogger($channel);
    }

    /**
     * {@inheritdoc}
     */
    public function bootstrap($app)
    {
        $this->registerLoggers();
        $this->registerPsrLogger();
    }

    /**
     * @param array $channelConfiguration
     */
    public function setChannels(array $channelConfiguration)
    {
        $this->channels = $channelConfiguration;
    }

    /**
     * @param string $channelName
     */
    public function setMainChannel(string $channelName)
    {
        $this->mainChannel = $channelName;
    }

    /**
     * Registers loggers into Yii's DI container.
     */
    private function registerLoggers()
    {
        foreach ($this->channels as $configuredChannelName => $channelConfiguration) {
            $channelName = $configuredChannelName;
            $handlers = $channelConfiguration['handlers'] ?? [];
            $processors = $channelConfiguration['processors'] ?? [];

            $this->loggerRegistry->registerLogChannel($channelName, function () use ($channelName, $handlers, $processors) {
                return $this->monologFactory->make($channelName, $handlers, $processors);
            });
        }
    }

    /**
     * Registers the main channel to be used for Psr LoggerInterface.
     */
    private function registerPsrLogger()
    {
        $this->loggerRegistry->registerPsrLogger(function () {
            return $this->getLogger($this->getMainChannel());
        });
    }

    /**
     * Returns the main channel to be used for Yii2Monolog component.
     *
     * @return string
     */
    private function getMainChannel(): string
    {
        if ($this->mainChannel === null) {
            return array_keys($this->channels)[0];
        }

        return $this->mainChannel;
    }
}