Logger.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Log;

/*
 * 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!
 */

class Logger implements \Psr\Log\LoggerInterface
{
    protected $name = '';

    protected $minimumLogLevel = LogLevel::EMERGENCY;

    protected $writers = [];

    protected $processors = [];

    public function __construct($name)
    {
        $this->name = $name;
    }

    protected function setMinimumLogLevel($level)
    {
        LogLevel::validateLevel($level);
        $this->minimumLogLevel = $level;
        return $this;
    }

    protected function getMinimumLogLevel()
    {
        return $this->minimumLogLevel;
    }

    public function getName()
    {
        return $this->name;
    }

    public function addWriter($minimumLevel, Writer\WriterInterface $writer)
    {
        LogLevel::validateLevel($minimumLevel);
        // Cycle through all the log levels which are as severe as or higher
        // than $minimumLevel and add $writer to each severity level
        for ($logLevelWhichTriggersWriter = LogLevel::EMERGENCY; $logLevelWhichTriggersWriter <= $minimumLevel; $logLevelWhichTriggersWriter++) {
            if (!isset($this->writers[$logLevelWhichTriggersWriter])) {
                $this->writers[$logLevelWhichTriggersWriter] = [];
            }
            $this->writers[$logLevelWhichTriggersWriter][] = $writer;
        }
        if ($minimumLevel > $this->getMinimumLogLevel()) {
            $this->setMinimumLogLevel($minimumLevel);
        }
        return $this;
    }

    public function getWriters()
    {
        return $this->writers;
    }

    public function addProcessor($minimumLevel, Processor\ProcessorInterface $processor)
    {
        LogLevel::validateLevel($minimumLevel);
        // Cycle through all the log levels which are as severe as or higher
        // than $minimumLevel and add $processor to each severity level
        for ($logLevelWhichTriggersProcessor = LogLevel::EMERGENCY; $logLevelWhichTriggersProcessor <= $minimumLevel; $logLevelWhichTriggersProcessor++) {
            if (!isset($this->processors[$logLevelWhichTriggersProcessor])) {
                $this->processors[$logLevelWhichTriggersProcessor] = [];
            }
            $this->processors[$logLevelWhichTriggersProcessor][] = $processor;
        }
        if ($minimumLevel > $this->getMinimumLogLevel()) {
            $this->setMinimumLogLevel($minimumLevel);
        }
    }

    public function getProcessors()
    {
        return $this->processors;
    }

    public function log($level, $message, array $data = [])
    {
        $level = LogLevel::normalizeLevel($level);
        LogLevel::validateLevel($level);
        if ($level > $this->minimumLogLevel) {
            return $this;
        }
        $record = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(LogRecord::class, $this->name, $level, $message, $data);
        $record = $this->callProcessors($record);
        $this->writeLog($record);
        return $this;
    }

    protected function callProcessors(LogRecord $record)
    {
        if (!empty($this->processors[$record->getLevel()])) {
            foreach ($this->processors[$record->getLevel()] as $processor) {
                $processedRecord = $processor->processLogRecord($record);
                if (!$processedRecord instanceof LogRecord) {
                    throw new \RuntimeException('Processor ' . get_class($processor) . ' returned invalid data. Instance of TYPO3\\CMS\\Core\\Log\\LogRecord expected', 1343593398);
                }
                $record = $processedRecord;
            }
        }
        return $record;
    }

    protected function writeLog(LogRecord $record)
    {
        if (!empty($this->writers[$record->getLevel()])) {
            foreach ($this->writers[$record->getLevel()] as $writer) {
                $writer->writeLog($record);
            }
        }
    }

    public function emergency($message, array $data = [])
    {
        return $this->log(LogLevel::EMERGENCY, $message, $data);
    }

    public function alert($message, array $data = [])
    {
        return $this->log(LogLevel::ALERT, $message, $data);
    }

    public function critical($message, array $data = [])
    {
        return $this->log(LogLevel::CRITICAL, $message, $data);
    }

    public function error($message, array $data = [])
    {
        return $this->log(LogLevel::ERROR, $message, $data);
    }

    public function warning($message, array $data = [])
    {
        return $this->log(LogLevel::WARNING, $message, $data);
    }

    public function notice($message, array $data = [])
    {
        return $this->log(LogLevel::NOTICE, $message, $data);
    }

    public function info($message, array $data = [])
    {
        return $this->log(LogLevel::INFO, $message, $data);
    }

    public function debug($message, array $data = [])
    {
        return $this->log(LogLevel::DEBUG, $message, $data);
    }
}