Logger.php

Go to the documentation of this file.

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

class Logger implements \Psr\Log\LoggerInterface {

    protected $name = '';

    protected $minimumLogLevel = \TYPO3\CMS\Core\Log\LogLevel::EMERGENCY;

    protected $writers = array();

    protected $processors = array();

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

    protected function setMinimumLogLevel($level) {
        \TYPO3\CMS\Core\Log\LogLevel::validateLevel($level);
        $this->minimumLogLevel = $level;
        return $this;
    }

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

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

    public function addWriter($minimumLevel, \TYPO3\CMS\Core\Log\Writer\WriterInterface $writer) {
        \TYPO3\CMS\Core\Log\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 = \TYPO3\CMS\Core\Log\LogLevel::EMERGENCY; $logLevelWhichTriggersWriter <= $minimumLevel; $logLevelWhichTriggersWriter++) {
            if (!isset($this->writers[$logLevelWhichTriggersWriter])) {
                $this->writers[$logLevelWhichTriggersWriter] = array();
            }
            $this->writers[$logLevelWhichTriggersWriter][] = $writer;
        }
        if ($minimumLevel > $this->getMinimumLogLevel()) {
            $this->setMinimumLogLevel($minimumLevel);
        }
        return $this;
    }

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

    public function addProcessor($minimumLevel, \TYPO3\CMS\Core\Log\Processor\ProcessorInterface $processor) {
        \TYPO3\CMS\Core\Log\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 = \TYPO3\CMS\Core\Log\LogLevel::EMERGENCY; $logLevelWhichTriggersProcessor <= $minimumLevel; $logLevelWhichTriggersProcessor++) {
            if (!isset($this->processors[$logLevelWhichTriggersProcessor])) {
                $this->processors[$logLevelWhichTriggersProcessor] = array();
            }
            $this->processors[$logLevelWhichTriggersProcessor][] = $processor;
        }
        if ($minimumLevel > $this->getMinimumLogLevel()) {
            $this->setMinimumLogLevel($minimumLevel);
        }
    }

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

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

    protected function callProcessors(\TYPO3\CMS\Core\Log\LogRecord $record) {
        if (!empty($this->processors[$record->getLevel()])) {
            foreach ($this->processors[$record->getLevel()] as $processor) {
                $processedRecord = $processor->processLogRecord($record);
                if (!$processedRecord instanceof \TYPO3\CMS\Core\Log\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(\TYPO3\CMS\Core\Log\LogRecord $record) {
        if (!empty($this->writers[$record->getLevel()])) {
            foreach ($this->writers[$record->getLevel()] as $writer) {
                $writer->writeLog($record);
            }
        }
    }

    public function emergency($message, array $data = array()) {
        return $this->log(\TYPO3\CMS\Core\Log\LogLevel::EMERGENCY, $message, $data);
    }

    public function alert($message, array $data = array()) {
        return $this->log(\TYPO3\CMS\Core\Log\LogLevel::ALERT, $message, $data);
    }

    public function critical($message, array $data = array()) {
        return $this->log(\TYPO3\CMS\Core\Log\LogLevel::CRITICAL, $message, $data);
    }

    public function error($message, array $data = array()) {
        return $this->log(\TYPO3\CMS\Core\Log\LogLevel::ERROR, $message, $data);
    }

    public function warning($message, array $data = array()) {
        return $this->log(\TYPO3\CMS\Core\Log\LogLevel::WARNING, $message, $data);
    }

    public function notice($message, array $data = array()) {
        return $this->log(\TYPO3\CMS\Core\Log\LogLevel::NOTICE, $message, $data);
    }

    public function info($message, array $data = array()) {
        return $this->log(\TYPO3\CMS\Core\Log\LogLevel::INFO, $message, $data);
    }

    public function debug($message, array $data = array()) {
        return $this->log(\TYPO3\CMS\Core\Log\LogLevel::DEBUG, $message, $data);
    }

}