LogRecord.php

Go to the documentation of this file.

<?php
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Log;
 
class ‪LogRecord implements \ArrayAccess
{
    protected string ‪$requestId = '';
 
    protected float ‪$created = 0.0;
 
    protected string ‪$component = '';
 
    protected string ‪$level = \Psr\Log\LogLevel::INFO;
 
    protected string ‪$message = '';
 
    protected array ‪$data = [];
 
    private array ‪$gettableProperties = [
        'requestId',
        'created',
        'component',
        'level',
        'message',
        'data',
    ];
 
    private array ‪$settableProperties = [
        'level',
        'message',
        'data',
    ];
 
    public function ‪__construct(string ‪$component, string ‪$level, string ‪$message, array ‪$data = [], string ‪$requestId = '')
    {
        $this->‪setRequestId($requestId)
            ->‪setCreated(microtime(true))
            ->‪setComponent(‪$component)
            ->‪setLevel(‪$level)
            ->‪setMessage(‪$message)
            ->‪setData(‪$data);
    }
 
    public function ‪setComponent(‪$component)
    {
        $this->component = ‪$component;
        return $this;
    }
 
    public function ‪getComponent()
    {
        return ‪$this->component;
    }
 
    public function ‪setCreated(‪$created)
    {
        $this->created = ‪$created;
        return $this;
    }
 
    public function ‪getCreated()
    {
        return ‪$this->created;
    }
 
    public function ‪setLevel(string ‪$level)
    {
        ‪LogLevel::validateLevel(‪LogLevel::normalizeLevel(‪$level));
        $this->level = ‪$level;
        return $this;
    }
 
    public function ‪getLevel(): string
    {
        return ‪$this->level;
    }
 
    public function ‪setData(‪$data)
    {
        $this->data = ‪$data;
        return $this;
    }
 
    public function ‪getData()
    {
        return ‪$this->data;
    }
 
    public function ‪addData(array ‪$data)
    {
        $this->data = array_merge($this->data, ‪$data);
        return $this;
    }
 
    public function ‪setMessage(‪$message)
    {
        $this->message = (string)‪$message;
        return $this;
    }
 
    public function ‪getMessage()
    {
        return ‪$this->message;
    }
 
    public function ‪setRequestId(‪$requestId)
    {
        $this->requestId = ‪$requestId;
        return $this;
    }
 
    public function ‪getRequestId()
    {
        return ‪$this->requestId;
    }
 
    public function ‪__toString(): string
    {
        $timestamp = date('r', (int)$this->created);
        $levelName = strtoupper($this->level);
        ‪$data = '';
        if (!empty($this->data)) {
            // According to PSR3 the exception-key may hold an \Exception
            // Since json_encode() does not encode an exception, we run the _toString() here
            if (isset($this->data['exception']) && $this->data['exception'] instanceof \‪Exception) {
                $this->data['exception'] = (string)$this->data['exception'];
            }
            ‪$data = '- ' . json_encode($this->data);
        }
        $logRecordString = sprintf(
            '%s [%s] request="%s" component="%s": %s %s',
            $timestamp,
            $levelName,
            $this->requestId,
            $this->component,
            $this->message,
            ‪$data
        );
        return $logRecordString;
    }
 
    public function ‪toArray()
    {
        return [
            'requestId' => ‪$this->requestId,
            'created' => ‪$this->created,
            'component' => ‪$this->component,
            'level' => ‪$this->level,
            'message' => ‪$this->message,
            'data' => ‪$this->data,
        ];
    }
 
    public function ‪offsetExists($offset): bool
    {
        $offsetExists = false;
        if (in_array($offset, $this->gettableProperties, true) && isset($this->{$offset})) {
            $offsetExists = true;
        }
        return $offsetExists;
    }
 
    public function ‪offsetGet($offset): mixed
    {
        if (!in_array($offset, $this->gettableProperties, true)) {
            return null;
        }
        return $this->{$offset};
    }
 
    public function ‪offsetSet($offset, $value): void
    {
        if (in_array($offset, $this->settableProperties, true)) {
            $this->{$offset} = $offset;
        }
    }
 
    public function ‪offsetUnset($offset): void
    {
        if (in_array($offset, $this->settableProperties, true)) {
            unset($this->{$offset});
        }
    }
}