Completed
Push — master ( b8fb8b...1f1253 )
by Derek
02:22
created

LoggedClassTrait::updateLog()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 12
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 7
CRAP Score 2

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 12
ccs 7
cts 7
cp 1
rs 9.4285
cc 2
eloc 7
nc 2
nop 2
crap 2
1
<?php
2
namespace Subreality\Dilmun;
3
4
use Subreality\Dilmun\Nabu\Logger;
5
6
/**
7
 * Provides standard functions for interfacing a class with a Logger
8
 *
9
 * @package Subreality\Dilmun
10
 */
11
trait LoggedClassTrait
12
{
13
    /** @var  Logger */
14
    protected $logger;
15
16
    /**
17
     * Allows overriding the default file logger created at construction
18
     *
19
     * @param Logger $logger
20
     */
21 2
    public function setLogger(Logger $logger)
22
    {
23 2
        $this->logger = $logger;
24 2
    }
25
26
    /**
27
     * Gets the Logger set for the Autoloader
28
     *
29
     * @return Logger
30
     */
31 2
    public function getLogger()
32
    {
33 2
        return $this->logger;
34
    }
35
36
    /**
37
     * If it exists, logs the message at the supplied level using the set Logger
38
     *
39
     * @param string $level     The log level for the message
40
     * @param string $message   The message to be logged
41
     *
42
     * @return bool             Returns true if the message was logged
43
     *                          returns false if the message was not logged
44
     */
45 6
    protected function updateLog($level, $message)
46
    {
47 6
        if ($this->logger instanceof Logger) {
48 2
            $this->logger->$level($message);
49
50 2
            $message_logged = true;
51 2
        } else {
52 4
            $message_logged = false;
53
        }
54
55 6
        return $message_logged;
56
    }
57
}
58