Parent class for log handlers. More...
Public Member Functions | |
| getInfo () | |
| Content of the info tooltip. More... | |
| getWarning () | |
| Return warning if something is wrong with logger. More... | |
| getVersion () | |
| Version of the module ('x.y.z' or 'dolibarr' or 'experimental' or 'development') More... | |
| isActive () | |
| Is the module active ? More... | |
| configure () | |
| Configuration variables of the module. More... | |
| checkConfiguration () | |
| Function that checks if the configuration is valid. More... | |
| setIdent ($ident) | |
| Set current ident. More... | |
Detailed Description
Parent class for log handlers.
Definition at line 23 of file logHandler.php.
Member Function Documentation
◆ checkConfiguration()
| LogHandler::checkConfiguration | ( | ) |
Function that checks if the configuration is valid.
It will be called after setting the configuration. The function returns an array with error messages
- Returns
- array
Reimplemented in mod_syslog_syslog, and mod_syslog_file.
Definition at line 85 of file logHandler.php.
◆ configure()
| LogHandler::configure | ( | ) |
Configuration variables of the module.
- Returns
- array
Reimplemented in mod_syslog_syslog, and mod_syslog_file.
Definition at line 73 of file logHandler.php.
◆ getInfo()
| LogHandler::getInfo | ( | ) |
Content of the info tooltip.
- Returns
- string
Reimplemented in mod_syslog_syslog, and mod_syslog_file.
Definition at line 33 of file logHandler.php.
◆ getVersion()
| LogHandler::getVersion | ( | ) |
Version of the module ('x.y.z' or 'dolibarr' or 'experimental' or 'development')
- Returns
- string
Reimplemented in mod_syslog_syslog, and mod_syslog_file.
Definition at line 53 of file logHandler.php.
◆ getWarning()
| LogHandler::getWarning | ( | ) |
Return warning if something is wrong with logger.
- Returns
- string
Definition at line 43 of file logHandler.php.
◆ isActive()
| LogHandler::isActive | ( | ) |
Is the module active ?
- Returns
- boolean
Reimplemented in mod_syslog_syslog, and mod_syslog_file.
Definition at line 63 of file logHandler.php.
◆ setIdent()
| LogHandler::setIdent | ( | $ident | ) |
Set current ident.
- Parameters
-
int $ident 1=Increase ident of 1, -1=Decrease ident of 1
- Returns
- void
Definition at line 96 of file logHandler.php.
The documentation for this class was generated from the following file:
- dolibarr_dev/htdocs/core/modules/syslog/logHandler.php