leinonen\Yii2Monolog\Yii2LogMessage

Complexity

Total Complexity

20

Size/Duplication

Total Lines	172
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	25	6
A	getMessage()	0	4	1
A	getTimestamp()	0	4	1
A	getException()	0	4	1
A	getContext()	0	22	5
A	getPsr3LogLevel()	0	14	1
A	setMessage()	0	7	2
A	convertYiisMessageToString()	0	8	3

<?php

declare(strict_types=1);

namespace leinonen\Yii2Monolog;

use yii\log\Logger;
use Psr\Log\LogLevel;
use yii\helpers\VarDumper;

class Yii2LogMessage
{
    /**
     * @var string
     */
    private $category;

    /**
     * @var array
     */
    private $trace;

    /**
     * @var int
     */
    private $memory;

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

    /**
     * @var int
     */
    private $timestamp;

    /**
     * @var int|mixed
     */
    private $yiiLogLevel;

    /**
     * @var \Throwable|null
     */
    private $exception;

    /**
     * Initializes a new Yii2LogMessage.
     *
     * @param array $message
     * @param bool $exceptionInContext
     */
    public function __construct(array $message, bool $exceptionInContext = false)
    {
        if (true === $exceptionInContext && $message[0] instanceof \Throwable) {
            $this->exception = $message[0];
            $this->setMessage(\get_class($message[0]) . ': ' . $message[0]->getMessage());
        } else {
            $this->setMessage($message[0]);
        }

        $this->yiiLogLevel = $message[1];

        if (isset($message[2])) {
            $this->category = $message[2];
        }

        $this->timestamp = $message[3];

        if (isset($message[4])) {
            $this->trace = $message[4];
        }

        if (isset($message[5])) {
            $this->memory = $message[5];
        }
    }

    /**
     * Returns the message string.
     *
     * @return string
     */
    public function getMessage()
    {
        return $this->message;
    }

    /**
     * Returns the timestamp for the Yii2LogMessage.
     *
     * @return int
     */
    public function getTimestamp()
    {
        return $this->timestamp;
    }

    /**
     * @return null|\Throwable
     */
    public function getException()
    {
        return $this->exception;
    }

    /**
     * Returns the context for the Yii2LogMessage.
     *
     * @return array
     */
    public function getContext(): array
    {
        $context = [];

        if ($this->category !== null) {
            $context['category'] = $this->category;
        }

        if ($this->trace !== null) {
            $context['trace'] = $this->trace;
        }

        if ($this->memory !== null) {
            $context['memory'] = $this->memory;
        }

        if ($this->exception !== null) {
            $context['exception'] = $this->exception;
        }

        return $context;
    }

    /**
     * Returns the PSR-3 compliant log level.
     *
     * @return string
     */
    public function getPsr3LogLevel(): string
    {
        $psrLevels = [
            Logger::LEVEL_ERROR => LogLevel::ERROR,
            Logger::LEVEL_WARNING => LogLevel::WARNING,
            Logger::LEVEL_INFO => LogLevel::INFO,
            Logger::LEVEL_TRACE => LogLevel::DEBUG,
            Logger::LEVEL_PROFILE => LogLevel::DEBUG,
            Logger::LEVEL_PROFILE_BEGIN => LogLevel::DEBUG,
            Logger::LEVEL_PROFILE_END => LogLevel::DEBUG,
        ];

        return $psrLevels[$this->yiiLogLevel];
    }

    /**
     * @param array|\Throwable|string $message
     */
    private function setMessage($message)
    {
        if (! \is_string($message)) {
            $message = $this->convertYiisMessageToString($message);
        }
        $this->message = $message;
    }

    /**
     * Converts Yii's message to string format.
     *
     * @param array|\Throwable $message
     *
     * @return string
     */
    private function convertYiisMessageToString($message): string
    {
        if ($message instanceof \Throwable || $message instanceof \Exception) {
            return (string) $message;
        }

        return VarDumper::export($message);
    }
}