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

Class to manage logging to a file. More...

+ Inheritance diagram for mod_syslog_file:
+ Collaboration diagram for mod_syslog_file:

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
 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...
 
 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

mod_syslog_file::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_file.php.

References dol_syslog(), and getFilename().

mod_syslog_file::configure ( )

Return array of configuration data.

Returns
array Return array of configuration data

Implements LogHandlerInterface.

Definition at line 63 of file mod_syslog_file.php.

mod_syslog_file::export (   $content,
  $suffixinfilename = '' 
)

Export the message.

Parameters
array$contentArray containing the info about the message
string$suffixinfilenameWhen output is a file, append this suffix into default log filename.
Returns
void

Definition at line 127 of file mod_syslog_file.php.

References dol_print_date(), getFilename(), and print.

mod_syslog_file::getFilename (   $suffixinfilename = '')
private

Return the parsed logfile path.

Parameters
string$suffixinfilenameWhen output is a file, append this suffix into default log filename.
Returns
string

Definition at line 105 of file mod_syslog_file.php.

Referenced by checkConfiguration(), and export().

mod_syslog_file::getInfo ( )

Content of the info tooltip.

Returns
false|string

Implements LogHandlerInterface.

Definition at line 40 of file mod_syslog_file.php.

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.

mod_syslog_file::getVersion ( )

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

Returns
string

Implements LogHandlerInterface.

Definition at line 30 of file mod_syslog_file.php.

mod_syslog_file::isActive ( )

Is the module active ?

Returns
int

Implements LogHandlerInterface.

Definition at line 52 of file mod_syslog_file.php.


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