SimplePie\UtilityPack\Mixin\LoggerTrait

Complexity

Total Complexity

2

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	setLogger()	0	12	1
A	getLogger()	0	3	1

<?php
/**
 * Copyright (c) 2010–2019 Ryan Parman <http://ryanparman.com>.
 * Copyright (c) 2016–2019 Contributors.
 *
 * http://opensource.org/licenses/Apache2.0
 */

declare(strict_types=1);

namespace SimplePie\UtilityPack\Mixin;

use Psr\Log\LoggerInterface;
use SimplePie\UtilityPack\Util\Types;

/**
 * Shared code for working with the logger.
 */
trait LoggerTrait
{
    /**
     * A PSR-3 logger.
     *
     * @var LoggerInterface
     */
    protected $logger;

Protected member variable "logger" must contain a leading underscore

    /**
     * Sets the PSR-3 logger.
     *
     * @param LoggerInterface $logger A PSR-3 compatible logger.
     */
    public function setLogger(LoggerInterface $logger): self
    {
        $this->logger = $logger;

        // What are we logging with?
        $this->logger->debug(\sprintf(
            'Class `%s` configured to use `%s`.',
            Types::getClassOrType($this),
            Types::getClassOrType($this->logger)
        ));

        return $this;
    }

    /**
     * Retrieves the PSR-3 logger.
     */
    public function getLogger(): LoggerInterface
    {
        return $this->logger;
    }
}