TYPO3 CMS  TYPO3_7-6
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 ($name)
 
 getName ()
 
 addWriter ($minimumLevel, Writer\WriterInterface $writer)
 
 getWriters ()
 
 addProcessor ($minimumLevel, Processor\ProcessorInterface $processor)
 
 getProcessors ()
 
 emergency ($message, array $data=[])
 
 alert ($message, array $data=[])
 
 critical ($message, array $data=[])
 
 error ($message, array $data=[])
 
 warning ($message, array $data=[])
 
 notice ($message, array $data=[])
 
 info ($message, array $data=[])
 
 debug ($message, array $data=[])
 

Protected Member Functions

 setMinimumLogLevel ($level)
 
 getMinimumLogLevel ()
 
 callProcessors (LogRecord $record)
 
 writeLog (LogRecord $record)
 

Protected Attributes

 $name = ''
 
 $minimumLogLevel = LogLevel::EMERGENCY
 
 $writers = []
 
 $processors = []
 

Detailed Description

Logger to log events and data for different components.

Definition at line 20 of file Logger.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Log\Logger::__construct (   $name)

Constructor.

Parameters
string$nameA name for the logger.
Returns

Definition at line 59 of file Logger.php.

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

Member Function Documentation

◆ 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$processorThe processor to add.
Returns
void

Definition at line 138 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\getLoggerNames().

◆ addWriter()

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$writerWriter object
Returns
$this

Definition at line 104 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\getLoggerNames().

◆ alert()

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

Shortcut to log an ALERT record.

Parameters
string$messageLog message.
array$dataAdditional data to log
Returns
$this

Definition at line 241 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\ALERT.

◆ callProcessors()

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

Calls all processors and returns log record

Parameters
\TYPO3\CMS\Core\Log\LogRecord$recordRecord to process
Exceptions

Definition at line 193 of file Logger.php.

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

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

◆ critical()

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

Shortcut to log a CRITICAL record.

Parameters
string$messageLog message.
array$dataAdditional data to log
Returns
$this

Definition at line 253 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\CRITICAL.

◆ debug()

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

Shortcut to log a DEBUG record.

Parameters
string$messageLog message.
array$dataAdditional data to log
Returns
$this

Definition at line 313 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\DEBUG.

◆ emergency()

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

Shortcut to log an EMERGENCY record.

Parameters
string$messageLog message.
array$dataAdditional data to log
Returns
$this

Definition at line 229 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\EMERGENCY.

◆ error()

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

Shortcut to log an ERROR record.

Parameters
string$messageLog message.
array$dataAdditional data to log
Returns
$this

Definition at line 265 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\ERROR.

◆ getMinimumLogLevel()

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 82 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()

TYPO3\CMS\Core\Log\Logger::getName ( )

Gets the logger's name.

Returns
string Logger name.

Definition at line 92 of file Logger.php.

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

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

◆ getProcessors()

TYPO3\CMS\Core\Log\Logger::getProcessors ( )

Returns all added processors indexed by log level

Returns
array

Definition at line 159 of file Logger.php.

References TYPO3\CMS\Core\Log\Logger\$processors, TYPO3\CMS\Core\Log\Logger\callProcessors(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Log\LogLevel\normalizeLevel(), TYPO3\CMS\Core\Log\LogLevel\validateLevel(), and TYPO3\CMS\Core\Log\Logger\writeLog().

◆ getWriters()

TYPO3\CMS\Core\Log\Logger::getWriters ( )

Returns all configured writers indexed by log level

Returns
array

Definition at line 126 of file Logger.php.

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

◆ info()

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

Shortcut to log an INFORMATION record.

Parameters
string$messageLog message.
array$dataAdditional data to log
Returns
$this

Definition at line 301 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\INFO.

◆ notice()

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

Shortcut to log a NOTICE record.

Parameters
string$messageLog message.
array$dataAdditional data to log
Returns
$this

Definition at line 289 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\NOTICE.

◆ setMinimumLogLevel()

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

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

Parameters
int$levelMinimum log level
Returns
$this

Definition at line 70 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::warning (   $message,
array  $data = [] 
)

Shortcut to log a WARNING record.

Parameters
string$messageLog message.
array$dataAdditional data to log
Returns
$this

Definition at line 277 of file Logger.php.

References TYPO3\CMS\Core\Log\LogLevel\WARNING.

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

◆ writeLog()

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

Passes the to all registered writers.

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

Definition at line 213 of file Logger.php.

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

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

Member Data Documentation

◆ $minimumLogLevel

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

Definition at line 37 of file Logger.php.

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

◆ $name

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

Definition at line 30 of file Logger.php.

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

◆ $processors

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

Definition at line 51 of file Logger.php.

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

◆ $writers

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

Definition at line 44 of file Logger.php.

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