Class to manage logging to a file. More...
Public Member Functions | |
| getName () | |
| Return name of logger. More... | |
| getVersion () | |
| Version of the module ('x.y.z' or 'dolibarr' or 'experimental' or 'development') More... | |
| getInfo () | |
| Content of the info tooltip. More... | |
| isActive () | |
| Is the module active ? More... | |
| configure () | |
| Return array of configuration data. More... | |
| checkConfiguration () | |
| Return if configuration is valid. More... | |
| export ($content, $suffixinfilename='') | |
| Export the message. More... | |
 Public Member Functions inherited from LogHandler | |
| getWarning () | |
| Return warning if something is wrong with logger. More... | |
| setIdent ($ident) | |
| Set current ident. More... | |
| Public Member Functions inherited from LogHandlerInterface | |
| getWarning () | |
| Return warning if something is wrong with logger. More... | |
| export ($content) | |
| Output log content. More... | |
Private Member Functions | |
| getFilename ($suffixinfilename='') | |
| Return the parsed logfile path. More... | |
Detailed Description
Class to manage logging to a file.
Definition at line 8 of file mod_syslog_file.php.
Member Function Documentation
◆ checkConfiguration()
| mod_syslog_file::checkConfiguration | ( | ) |
Return if configuration is valid.
- Returns
- array Array of errors. Empty array if ok.
Reimplemented from LogHandler.
Definition at line 82 of file mod_syslog_file.php.
◆ configure()
| mod_syslog_file::configure | ( | ) |
Return array of configuration data.
- Returns
- array Return array of configuration data
Reimplemented from LogHandler.
Definition at line 63 of file mod_syslog_file.php.
◆ export()
| mod_syslog_file::export | ( | $content, | |
$suffixinfilename = '' |
|||
| ) |
Export the message.
- Parameters
-
array $content Array containing the info about the message string $suffixinfilename When output is a file, append this suffix into default log filename.
- Returns
- void
Definition at line 134 of file mod_syslog_file.php.
◆ getFilename()
|
private |
Return the parsed logfile path.
- Parameters
-
string $suffixinfilename When output is a file, append this suffix into default log filename.
- Returns
- string
Definition at line 105 of file mod_syslog_file.php.
◆ getInfo()
| mod_syslog_file::getInfo | ( | ) |
Content of the info tooltip.
- Returns
- false|string
Reimplemented from LogHandler.
Definition at line 40 of file mod_syslog_file.php.
◆ getName()
| mod_syslog_file::getName | ( | ) |
Return name of logger.
- Returns
- string Name of logger
Implements LogHandlerInterface.
Definition at line 18 of file mod_syslog_file.php.
◆ getVersion()
| mod_syslog_file::getVersion | ( | ) |
Version of the module ('x.y.z' or 'dolibarr' or 'experimental' or 'development')
- Returns
- string
Reimplemented from LogHandler.
Definition at line 30 of file mod_syslog_file.php.
◆ isActive()
| mod_syslog_file::isActive | ( | ) |
Is the module active ?
- Returns
- int
Reimplemented from LogHandler.
Definition at line 52 of file mod_syslog_file.php.
The documentation for this class was generated from the following file:
- dolibarr_16.0/htdocs/core/modules/syslog/mod_syslog_file.php