Subreality\Dilmun\LoggedClassTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setLogger()	0	4	1
A	getLogger()	0	4	1
A	updateLog()	0	12	2

<?php
namespace Subreality\Dilmun;

use Subreality\Dilmun\Nabu\Logger;

/**
 * Provides standard functions for interfacing a class with a Logger
 *
 * @package Subreality\Dilmun
 */
trait LoggedClassTrait
{
    /** @var  Logger */
    protected $logger;

    /**
     * Allows overriding the default file logger created at construction
     *
     * @param Logger $logger
     */
    public function setLogger(Logger $logger)
    {
        $this->logger = $logger;
    }

    /**
     * Gets the Logger set for the Autoloader
     *
     * @return Logger
     */
    public function getLogger()
    {
        return $this->logger;
    }

    /**
     * If it exists, logs the message at the supplied level using the set Logger
     *
     * @param string $level     The log level for the message
     * @param string $message   The message to be logged
     *
     * @return bool             Returns true if the message was logged
     *                          returns false if the message was not logged
     */
    protected function updateLog($level, $message, array $context = array())
    {
        if ($this->logger instanceof Logger) {
            $this->logger->$level($message, $context);

            $message_logged = true;
        } else {
            $message_logged = false;
        }

        return $message_logged;
    }
}