TYPO3\CMS\Core\Log\Logger Class Reference

Inheritance diagram for TYPO3\CMS\Core\Log\Logger:

Public Member Functions
	__construct (string $name, string $requestId='')
	__wakeup ()
	__sleep ()
string	getName ()
TYPO3 CMS Core Log Logger	addWriter (string $minimumLevel, WriterInterface $writer)
array	getWriters ()
	addProcessor (string $minimumLevel, ProcessorInterface $processor)
array	getProcessors ()
	log ($level, string|\Stringable $message, array $data=[])

Protected Member Functions
TYPO3 CMS Core Log Logger	setMinimumLogLevel ($level)
int	getMinimumLogLevel ()
TYPO3 CMS Core Log LogRecord	callProcessors (LogRecord $record)
	writeLog (LogRecord $record)

Protected Attributes
string	$name = ''
string	$requestId = ''
int	$minimumLogLevel
array	$writers = []
array	$processors = []

Detailed Description

Logger to log events and data for different components.

Definition at line 27 of file Logger.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Log\Logger::__construct	(	string	$name,
		string	$requestId = ''
	)

Constructor.

Parameters

string	$name	‪A name for the logger.
string	$requestId	‪Unique ID of the request

Definition at line 66 of file Logger.php.

References TYPO3\CMS\Core\Log\Logger\$name, TYPO3\CMS\Core\Log\Logger\$requestId, and TYPO3\CMS\Core\Log\LogLevel\normalizeLevel().

Member Function Documentation

__sleep()

TYPO3\CMS\Core\Log\Logger::__sleep

(

)

Remove everything except the name, to be able to restore it on wakeup

Definition at line 88 of file Logger.php.

__wakeup()

TYPO3\CMS\Core\Log\Logger::__wakeup

(

)

Re-initialize instance with creating a new instance with up to date information

Definition at line 76 of file Logger.php.

addProcessor()

TYPO3\CMS\Core\Log\Logger::addProcessor	(	string	$minimumLevel,
		ProcessorInterface	$processor
	)

Adds a processor to the logger.

Parameters

\TYPO3\CMS\Core\Log\Processor\ProcessorInterface

$processor

‪The processor to add.

Definition at line 162 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\getInternalName(), TYPO3\CMS\Core\Log\Logger\getMinimumLogLevel(), TYPO3\CMS\Core\Log\LogLevel\normalizeLevel(), TYPO3\CMS\Core\Log\Logger\setMinimumLogLevel(), and TYPO3\CMS\Core\Log\LogLevel\validateLevel().

Referenced by TYPO3\CMS\Core\Log\LogManager\setProcessorsForLogger().

addWriter()

TYPO3 CMS Core Log Logger TYPO3\CMS\Core\Log\Logger::addWriter	(	string	$minimumLevel,
		WriterInterface	$writer
	)

Adds a writer to this logger

Parameters

\TYPO3\CMS\Core\Log\Writer\WriterInterface

$writer

‪Writer object

Returns

‪\TYPO3\CMS\Core\Log\Logger $this

Definition at line 132 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\atLeast(), TYPO3\CMS\Core\Log\Logger\getMinimumLogLevel(), TYPO3\CMS\Core\Log\LogLevel\normalizeLevel(), and TYPO3\CMS\Core\Log\Logger\setMinimumLogLevel().

Referenced by TYPO3\CMS\Core\Log\LogManager\setWritersForLogger().

callProcessors()

TYPO3 CMS Core Log LogRecord TYPO3\CMS\Core\Log\Logger::callProcessors ( LogRecord  $record )

protected

Calls all processors and returns log record

Parameters

\TYPO3\CMS\Core\Log\LogRecord

$record

‪Record to process

Exceptions

Definition at line 214 of file Logger.php.

References TYPO3\CMS\Webhooks\Message\$record.

Referenced by TYPO3\CMS\Core\Log\Logger\log().

getMinimumLogLevel()

int TYPO3\CMS\Core\Log\Logger::getMinimumLogLevel ( )

protected

Gets the minimum log level for which log records are written.

Returns

‪int Minimum log level

Definition at line 111 of file Logger.php.

References TYPO3\CMS\Core\Log\Logger\$minimumLogLevel.

Referenced by TYPO3\CMS\Core\Log\Logger\addProcessor(), and TYPO3\CMS\Core\Log\Logger\addWriter().

getName()

string TYPO3\CMS\Core\Log\Logger::getName

(

)

Gets the logger's name.

Returns

‪string Logger name.

Definition at line 121 of file Logger.php.

References TYPO3\CMS\Core\Log\Logger\$name.

Referenced by TYPO3\CMS\Core\Log\LogManager\setProcessorsForLogger(), and TYPO3\CMS\Core\Log\LogManager\setWritersForLogger().

getProcessors()

array TYPO3\CMS\Core\Log\Logger::getProcessors

(

)

Returns all added processors indexed by log level

Returns

‪array

Definition at line 183 of file Logger.php.

References TYPO3\CMS\Core\Log\Logger\$processors.

getWriters()

array TYPO3\CMS\Core\Log\Logger::getWriters

(

)

Returns all configured writers indexed by log level

Returns

‪array

Definition at line 152 of file Logger.php.

References TYPO3\CMS\Core\Log\Logger\$writers.

log()

TYPO3\CMS\Core\Log\Logger::log	(		$level,
		string|\Stringable	$message,
		array	$data = []
	)

Adds a log record.

Parameters

int | string	$level	‪Log level. Value according to \TYPO3\CMS\Core\Log\LogLevel. Alternatively accepts a string.
string | \Stringable	$message	‪Log message.
array	$data	‪Additional data to log

Definition at line 195 of file Logger.php.

References TYPO3\CMS\Webhooks\Message\$record, TYPO3\CMS\Core\Log\Logger\callProcessors(), TYPO3\CMS\Core\Log\LogLevel\getInternalName(), TYPO3\CMS\Core\Log\LogLevel\normalizeLevel(), TYPO3\CMS\Core\Log\LogLevel\validateLevel(), and TYPO3\CMS\Core\Log\Logger\writeLog().

setMinimumLogLevel()

TYPO3 CMS Core Log Logger TYPO3\CMS\Core\Log\Logger::setMinimumLogLevel (   $level )

protected

Sets the minimum log level for which log records are written.

Parameters

int

$level

‪Minimum log level

Returns

‪\TYPO3\CMS\Core\Log\Logger $this

Definition at line 99 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\validateLevel().

Referenced by TYPO3\CMS\Core\Log\Logger\addProcessor(), and TYPO3\CMS\Core\Log\Logger\addWriter().

writeLog()

TYPO3\CMS\Core\Log\Logger::writeLog ( LogRecord  $record )

protected

Passes the \TYPO3\CMS\Core\Log\LogRecord to all registered writers.

Definition at line 230 of file Logger.php.

References TYPO3\CMS\Webhooks\Message\$record.

Referenced by TYPO3\CMS\Core\Log\Logger\log().

Member Data Documentation

$minimumLogLevel

int TYPO3\CMS\Core\Log\Logger::$minimumLogLevel

protected

Minimum log level, anything below this level will be ignored.

Definition at line 48 of file Logger.php.

Referenced by TYPO3\CMS\Core\Log\Logger\getMinimumLogLevel().

$name

string TYPO3\CMS\Core\Log\Logger::$name = ''

protected

Logger name or component for which this logger is meant to be used for.

This should be a dot-separated name and should normally be based on the class name or the name of a subsystem, such as core.t3lib.cache.manager, core.backend.workspaces or extension.news

Definition at line 38 of file Logger.php.

Referenced by TYPO3\CMS\Core\Log\Logger\__construct(), and TYPO3\CMS\Core\Log\Logger\getName().

$processors

array TYPO3\CMS\Core\Log\Logger::$processors = []

protected

Processors used by this logger

Definition at line 58 of file Logger.php.

Referenced by TYPO3\CMS\Core\Log\Logger\getProcessors().

$requestId

string TYPO3\CMS\Core\Log\Logger::$requestId = ''

protected

Unique ID of the request

Definition at line 43 of file Logger.php.

Referenced by TYPO3\CMS\Core\Log\Logger\__construct().

$writers

array TYPO3\CMS\Core\Log\Logger::$writers = []

protected

Writers used by this logger

Definition at line 53 of file Logger.php.

Referenced by TYPO3\CMS\Core\Log\Logger\getWriters().