‪TYPO3CMS  9.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Core\Log\Logger Class Reference
Inheritance diagram for TYPO3\CMS\Core\Log\Logger:

Public Member Functions

 __construct (string $name, string $requestId='')
 
 __wakeup ()
 
array __sleep ()
 
string getName ()
 
TYPO3 CMS Core Log Logger addWriter ($minimumLevel, Writer\WriterInterface $writer)
 
array getWriters ()
 
 addProcessor ($minimumLevel, Processor\ProcessorInterface $processor)
 
array getProcessors ()
 
mixed log ($level, $message, array $data=[])
 
TYPO3 CMS Core Log Logger emergency ($message, array $data=[])
 
TYPO3 CMS Core Log Logger alert ($message, array $data=[])
 
TYPO3 CMS Core Log Logger critical ($message, array $data=[])
 
TYPO3 CMS Core Log Logger error ($message, array $data=[])
 
TYPO3 CMS Core Log Logger warning ($message, array $data=[])
 
TYPO3 CMS Core Log Logger notice ($message, array $data=[])
 
TYPO3 CMS Core Log Logger info ($message, array $data=[])
 
TYPO3 CMS Core Log Logger debug ($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 = LogLevel::EMERGENCY
 
array $writers = array( )
 
array $processors = array( )
 

Detailed Description

Logger to log events and data for different components.

Definition at line 22 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 63 of file Logger.php.

References TYPO3\CMS\Core\Log\Logger\$name, and TYPO3\CMS\Core\Log\Logger\$requestId.

Member Function Documentation

◆ __sleep()

array TYPO3\CMS\Core\Log\Logger::__sleep ( )

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

Returns
‪array

Definition at line 86 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 72 of file Logger.php.

◆ addProcessor()

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

Adds a processor to the logger.

Parameters
int$minimumLevel
\TYPO3\CMS\Core\Log\Processor\ProcessorInterface$processor‪The processor to add.

Definition at line 164 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\EMERGENCY, TYPO3\CMS\Core\Log\Logger\getMinimumLogLevel(), 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 (   $minimumLevel,
Writer\WriterInterface  $writer 
)

Adds a writer to this logger

Parameters
int$minimumLevel
\TYPO3\CMS\Core\Log\Writer\WriterInterface$writer‪Writer object
Returns
‪\TYPO3\CMS\Core\Log\Logger $this

Definition at line 131 of file Logger.php.

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

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

◆ alert()

TYPO3 CMS Core Log Logger TYPO3\CMS\Core\Log\Logger::alert (   $message,
array  $data = [] 
)

Shortcut to log an ALERT record.

Parameters
string$message‪Log message.
array$data‪Additional data to log
Returns
‪\TYPO3\CMS\Core\Log\Logger $this

Definition at line 266 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\ALERT, and TYPO3\CMS\Core\Log\Logger\log().

◆ 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 219 of file Logger.php.

References TYPO3\CMS\Core\Log\LogRecord\getLevel().

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

◆ critical()

TYPO3 CMS Core Log Logger TYPO3\CMS\Core\Log\Logger::critical (   $message,
array  $data = [] 
)

Shortcut to log a CRITICAL record.

Parameters
string$message‪Log message.
array$data‪Additional data to log
Returns
‪\TYPO3\CMS\Core\Log\Logger $this

Definition at line 278 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\CRITICAL, and TYPO3\CMS\Core\Log\Logger\log().

◆ debug()

TYPO3 CMS Core Log Logger TYPO3\CMS\Core\Log\Logger::debug (   $message,
array  $data = [] 
)

Shortcut to log a DEBUG record.

Parameters
string$message‪Log message.
array$data‪Additional data to log
Returns
‪\TYPO3\CMS\Core\Log\Logger $this

Definition at line 338 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\DEBUG, and TYPO3\CMS\Core\Log\Logger\log().

◆ emergency()

TYPO3 CMS Core Log Logger TYPO3\CMS\Core\Log\Logger::emergency (   $message,
array  $data = [] 
)

Shortcut to log an EMERGENCY record.

Parameters
string$message‪Log message.
array$data‪Additional data to log
Returns
‪\TYPO3\CMS\Core\Log\Logger $this

Definition at line 254 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\EMERGENCY, and TYPO3\CMS\Core\Log\Logger\log().

◆ error()

TYPO3 CMS Core Log Logger TYPO3\CMS\Core\Log\Logger::error (   $message,
array  $data = [] 
)

Shortcut to log an ERROR record.

Parameters
string$message‪Log message.
array$data‪Additional data to log
Returns
‪\TYPO3\CMS\Core\Log\Logger $this

Definition at line 290 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\ERROR, and 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 109 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 119 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 185 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 153 of file Logger.php.

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

◆ info()

TYPO3 CMS Core Log Logger TYPO3\CMS\Core\Log\Logger::info (   $message,
array  $data = [] 
)

Shortcut to log an INFORMATION record.

Parameters
string$message‪Log message.
array$data‪Additional data to log
Returns
‪\TYPO3\CMS\Core\Log\Logger $this

Definition at line 326 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\INFO, and TYPO3\CMS\Core\Log\Logger\log().

◆ log()

mixed TYPO3\CMS\Core\Log\Logger::log (   $level,
  $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$message‪Log message.
array$data‪Additional data to log
Returns
‪mixed

Definition at line 198 of file Logger.php.

References TYPO3\CMS\Core\Log\Logger\callProcessors(), TYPO3\CMS\Core\Log\LogLevel\normalizeLevel(), TYPO3\CMS\Core\Log\LogLevel\validateLevel(), and TYPO3\CMS\Core\Log\Logger\writeLog().

Referenced by TYPO3\CMS\Core\Log\Logger\alert(), TYPO3\CMS\Core\Log\Logger\critical(), TYPO3\CMS\Core\Log\Logger\debug(), TYPO3\CMS\Core\Log\Logger\emergency(), TYPO3\CMS\Core\Log\Logger\error(), TYPO3\CMS\Core\Log\Logger\info(), TYPO3\CMS\Core\Log\Logger\notice(), and TYPO3\CMS\Core\Log\Logger\warning().

◆ notice()

TYPO3 CMS Core Log Logger TYPO3\CMS\Core\Log\Logger::notice (   $message,
array  $data = [] 
)

Shortcut to log a NOTICE record.

Parameters
string$message‪Log message.
array$data‪Additional data to log
Returns
‪\TYPO3\CMS\Core\Log\Logger $this

Definition at line 314 of file Logger.php.

References TYPO3\CMS\Core\Log\Logger\log(), and TYPO3\CMS\Core\Log\LogLevel\NOTICE.

◆ 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 97 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().

◆ warning()

TYPO3 CMS Core Log Logger TYPO3\CMS\Core\Log\Logger::warning (   $message,
array  $data = [] 
)

Shortcut to log a WARNING record.

Parameters
string$message‪Log message.
array$data‪Additional data to log
Returns
‪\TYPO3\CMS\Core\Log\Logger $this

Definition at line 302 of file Logger.php.

References TYPO3\CMS\Core\Log\Logger\log(), and TYPO3\CMS\Core\Log\LogLevel\WARNING.

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

◆ writeLog()

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

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

Parameters
\TYPO3\CMS\Core\Log\LogRecord$record

Definition at line 238 of file Logger.php.

References TYPO3\CMS\Core\Log\LogRecord\getLevel().

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

Member Data Documentation

◆ $minimumLogLevel

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

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

Definition at line 43 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 31 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 = array( )
protected

Processors used by this logger

Definition at line 55 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 37 of file Logger.php.

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

◆ $writers

array TYPO3\CMS\Core\Log\Logger::$writers = array( )
protected

Writers used by this logger

Definition at line 49 of file Logger.php.

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