LoggerTrait::formatMessage() - Code Metrics - Inspection of "Big refactoring" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#190)

by Arman

created 2025-02-06 15:26 UTC

LoggerTrait::formatMessage() A

↳ Parent: LoggerTrait

Complexity

Conditions	3
Paths	1

Size

Total Lines	8
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	6
c	0
b	0
f	0
nc	1
nop	3
dl	0
loc	8
rs	10

<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <[email protected]>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 2.9.5
 */


namespace Quantum\Libraries\Logger\Traits;

use Quantum\Libraries\Logger\Exceptions\LoggerException;
use Quantum\Libraries\Storage\FileSystem;

/**
 * Trait LoggerTrait
 * @package Quantum\Logger
 */
trait LoggerTrait
{

    /**
     * @var FileSystem
     */
    protected $fs;

    /**
     * @var string
     */
    protected $logFile;

    /**
     * Initialize the logger
     * @param array $params
     * @throws LoggerException
     */
    abstract protected function initialize(array $params): void;

    /**
     * Reports a log message
     * @param string $level
     * @param $message
     * @param array|null $context
     * @return void
     */
    public function report(string $level, $message, ?array $context = []): void
    {
        $this->fs->append($this->logFile, $this->formatMessage($level, $message, $context));
    }

    /**
     * Formats the log message
     * @param string $level
     * @param $message
     * @param array|null $context
     * @return string
     */
    protected function formatMessage(string $level, $message, ?array $context = []): string
    {
        return sprintf(
            "[%s] %s: %s%s",
            date('Y-m-d H:i:s'),
            ucfirst($level),
            is_array($message) ? json_encode($message, JSON_PRETTY_PRINT) : $message,
            isset($context['trace']) ? (PHP_EOL . $context['trace'] . PHP_EOL) : PHP_EOL
        );
    }
}

1			<?php
2
3			/**
4			* Quantum PHP Framework
5			*
6			* An open source software development framework for PHP
7			*
8			* @package Quantum
9			* @author Arman Ag. <[email protected]>
10			* @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
11			* @link http://quantum.softberg.org/
12			* @since 2.9.5
13			*/
14
15
16			namespace Quantum\Libraries\Logger\Traits;
17
18			use Quantum\Libraries\Logger\Exceptions\LoggerException;
19			use Quantum\Libraries\Storage\FileSystem;
20
21			/**
22			* Trait LoggerTrait
23			* @package Quantum\Logger
24			*/
25			trait LoggerTrait
26			{
27
28			/**
29			* @var FileSystem
30			*/
31			protected $fs;
32
33			/**
34			* @var string
35			*/
36			protected $logFile;
37
38			/**
39			* Initialize the logger
40			* @param array $params
41			* @throws LoggerException
42			*/
43			abstract protected function initialize(array $params): void;
44
45			/**
46			* Reports a log message
47			* @param string $level
48			* @param $message
49			* @param array\|null $context
50			* @return void
51			*/
52			public function report(string $level, $message, ?array $context = []): void
53			{
54			$this->fs->append($this->logFile, $this->formatMessage($level, $message, $context));
55			}
56
57			/**
58			* Formats the log message
59			* @param string $level
60			* @param $message
61			* @param array\|null $context
62			* @return string
63			*/
64			protected function formatMessage(string $level, $message, ?array $context = []): string
65			{
66			return sprintf(
67			"[%s] %s: %s%s",
68			date('Y-m-d H:i:s'),
69			ucfirst($level),
70			is_array($message) ? json_encode($message, JSON_PRETTY_PRINT) : $message,
71			isset($context['trace']) ? (PHP_EOL . $context['trace'] . PHP_EOL) : PHP_EOL
72			);
73			}
74			}

softberg / quantum-php-core

Pull Request — master (#190)

LoggerTrait::formatMessage() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like