Yiisoft\Log\Message

Complexity

Total Complexity

7

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	message()	0	3	1
A	parse()	0	14	2
A	context()	0	7	2
A	level()	0	3	1
A	__construct()	0	6	1

<?php

declare(strict_types=1);

namespace Yiisoft\Log;

use Psr\Log\InvalidArgumentException;
use Psr\Log\LoggerTrait;
use Psr\Log\LogLevel;
use Stringable;

use function preg_replace_callback;

/**
 * Message is a data object that stores log message data.
 *
 * @psalm-type Backtrace = list<array{
 *     file:string,
 *     line:int,
 *     function?:string,
 *     class?:string,
 *     type?:string,
 * }>
 * @psalm-type LogMessageContext = array{
 *     category?:string,
 *     memory?:int,
 *     time?:float,
 *     trace?:Backtrace,
 * }&array
 */
final class Message
{
    /**
     * @var string Log message level.
     *
     * @see LogLevel See constants for valid level names.
     */
    private string $level;

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

    /**
     * @var array<string, mixed> Log message context.
     * @psalm-var LogMessageContext
     *
     * Message context has a following keys:
     *
     * - category: string, message category.
     * - memory: int, memory usage in bytes, obtained by `memory_get_usage()`.
     * - time: float, message timestamp obtained by microtime(true).
     * - trace: array, debug backtrace, contains the application code call stacks.
     */
    private array $context;

    /**
     * @param string $level Log message level.
     * @param string|Stringable $message Log message.
     * @param array<string, mixed> $context Log message context.
     * @psalm-param LogMessageContext $context
     *
     * @throws InvalidArgumentException for invalid log message level.
     *
     * @see LoggerTrait::log()
     * @see LogLevel
     */
    public function __construct(string $level, string|Stringable $message, array $context = [])
    {
        Logger::assertLevelIsSupported($level);
        $this->level = $level;
        $this->message = $this->parse($message, $context);
        $this->context = $context;
    }

    /**
     * Gets a log message level.
     *
     * @return string Log message level.
     */
    public function level(): string
    {
        return $this->level;
    }

    /**
     * Gets a log message.
     *
     * @return string Log message.
     */
    public function message(): string
    {
        return $this->message;
    }

    /**
     * Returns a value of the context parameter for the specified name.
     *
     * If no name is specified, the entire context is returned.
     *
     * @param string|null $name The context parameter name.
     * @param mixed $default If the context parameter does not exist, the `$default` will be returned.
     *
     * @return mixed The context parameter value.
     * @psalm-return LogMessageContext|mixed
     */
    public function context(string $name = null, mixed $default = null): mixed
    {
        if ($name === null) {
            return $this->context;
        }

        return $this->context[$name] ?? $default;
    }

    /**
     * Parses log message resolving placeholders in the form: "{foo}",
     * where foo will be replaced by the context data in key "foo".
     *
     * @param string|Stringable $message Raw log message.
     * @param array<string, mixed> $context Message context.
     * @psalm-param LogMessageContext $context
     *
     * @return string Parsed message.
     */
    private function parse(string|Stringable $message, array $context): string
    {
        $message = (string)$message;

        return preg_replace_callback('/{([\w.]+)}/', static function (array $matches) use ($context) {
            $placeholderName = $matches[1];

            if (isset($context[$placeholderName])) {
                /** @psalm-suppress PossiblyInvalidCast */
                return (string) $context[$placeholderName];
            }

            return $matches[0];
        }, $message);
    }
}