dolibarr  7.0.0-beta
Public Member Functions | List of all members
mod_syslog_syslog Class Reference

Class to manage logging to syslog. More...

+ Inheritance diagram for mod_syslog_syslog:
+ Collaboration diagram for mod_syslog_syslog:

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)
 Export the message. More...
 
- Public Member Functions inherited from LogHandler
 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...
 
- Public Member Functions inherited from LogHandlerInterface
 getWarning ()
 Return warning if something is wrong with logger. More...
 

Detailed Description

Class to manage logging to syslog.

Definition at line 8 of file mod_syslog_syslog.php.

Member Function Documentation

mod_syslog_syslog::checkConfiguration ( )

Return if configuration is valid.

Returns
array Array of errors. Empty array if ok.

Implements LogHandlerInterface.

Definition at line 82 of file mod_syslog_syslog.php.

References dol_syslog().

mod_syslog_syslog::configure ( )

Return array of configuration data.

Returns
array Return array of configuration data

Implements LogHandlerInterface.

Definition at line 64 of file mod_syslog_syslog.php.

mod_syslog_syslog::export (   $content)

Export the message.

Parameters
array$contentArray containing the info about the message
Returns
void

Implements LogHandlerInterface.

Definition at line 110 of file mod_syslog_syslog.php.

mod_syslog_syslog::getInfo ( )

Content of the info tooltip.

Returns
false|string

Implements LogHandlerInterface.

Definition at line 37 of file mod_syslog_syslog.php.

mod_syslog_syslog::getName ( )

Return name of logger.

Returns
string Name of logger

Implements LogHandlerInterface.

Definition at line 17 of file mod_syslog_syslog.php.

mod_syslog_syslog::getVersion ( )

Version of the module ('x.y.z' or 'dolibarr' or 'experimental' or 'development')

Returns
string

Implements LogHandlerInterface.

Definition at line 27 of file mod_syslog_syslog.php.

mod_syslog_syslog::isActive ( )

Is the module active ?

Returns
int

Implements LogHandlerInterface.

Definition at line 49 of file mod_syslog_syslog.php.


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