Spiral\Debug\Traits\LoggerTrait

Complexity

Total Complexity

7

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
	iocContainer()	0	1	?
A	setLogger()	0	4	1
A	getLogger()	0	9	2
A	logger()	0	4	1
A	createLogger()	0	10	3

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */

namespace Spiral\Debug\Traits;

use Interop\Container\ContainerInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Spiral\Debug\LogsInterface;

/**
 * On demand logger creation. Allows class to share same logger between instances. Logger trait work
 * thought IoC scope!
 */
trait LoggerTrait
{
    /**
     * Private and null.
     *
     * @internal
     *
     * @var LoggerInterface|null
     */
    private $logger = null;

    /**
     * Sets a logger.
     *
     * @param LoggerInterface $logger
     */
    public function setLogger(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    /**
     * Get associated or create new instance of LoggerInterface.
     *
     * @return LoggerInterface
     */
    protected function getLogger(): LoggerInterface
    {
        if (!empty($this->logger)) {
            return $this->logger;
        }

        //We are using class name as log channel (name) by default
        return $this->logger = $this->createLogger();
    }

    /**
     * Alias for "getLogger" function.
     *
     * @return LoggerInterface
     */
    protected function logger(): LoggerInterface
    {
        return $this->getLogger();
    }

    /**
     * @return ContainerInterface
     */
    abstract protected function iocContainer();

    /**
     * Create new instance of associated logger (on demand creation).
     *
     * @return LoggerInterface
     */
    private function createLogger(): LoggerInterface
    {
        $container = $this->iocContainer();
        if (empty($container) || !$container->has(LogsInterface::class)) {
            return new NullLogger();
        }

        //We are using class name as log channel (name) by default
        return $container->get(LogsInterface::class)->getLogger(static::class);
    }
}