dolibarr 19.0.3
LogHandlerInterface Interface Reference

LogHandlerInterface. More...

Inheritance diagram for LogHandlerInterface:

Public Member Functions

 getName ()
 Return name of logger.
 
 getVersion ()
 Return version of logger.
 
 getInfo ()
 Return information on logger.
 
 getWarning ()
 Return warning if something is wrong with logger.
 
 configure ()
 Return array of configuration data.
 
 checkConfiguration ()
 Return if configuration is valid.
 
 isActive ()
 Return if logger active.
 
 export ($content)
 Output log content.
 

Detailed Description

LogHandlerInterface.

Definition at line 27 of file logHandlerInterface.php.

Member Function Documentation

◆ checkConfiguration()

LogHandlerInterface::checkConfiguration ( )

Return if configuration is valid.

Returns
boolean True if configuration ok

Implemented in mod_syslog_file, and mod_syslog_syslog.

◆ configure()

LogHandlerInterface::configure ( )

Return array of configuration data.

Returns
array Return array of configuration data

Implemented in mod_syslog_file, and mod_syslog_syslog.

◆ export()

LogHandlerInterface::export ( $content)

Output log content.

Parameters
string$contentContent to log
Returns
void

Implemented in mod_syslog_syslog.

◆ getInfo()

LogHandlerInterface::getInfo ( )

Return information on logger.

Returns
string Version of logger

Implemented in mod_syslog_file, and mod_syslog_syslog.

◆ getName()

LogHandlerInterface::getName ( )

Return name of logger.

Returns
string Name of logger

Implemented in mod_syslog_file, and mod_syslog_syslog.

◆ getVersion()

LogHandlerInterface::getVersion ( )

Return version of logger.

Returns
string Version of logger

Implemented in mod_syslog_file, and mod_syslog_syslog.

◆ getWarning()

LogHandlerInterface::getWarning ( )

Return warning if something is wrong with logger.

Returns
string Warning message

◆ isActive()

LogHandlerInterface::isActive ( )

Return if logger active.

Returns
boolean True if active

Implemented in mod_syslog_file, and mod_syslog_syslog.


The documentation for this interface was generated from the following file: