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.
	getVersion ()
	Version of the module ('x.y.z' or 'dolibarr' or 'experimental' or 'development')
	getInfo ()
	Content of the info tooltip.
	isActive ()
	Is the module active ?
	configure ()
	Return array of configuration data.
	checkConfiguration ()
	Return if configuration is valid.
	export ($content)
	Export the message.
Public Member Functions inherited from LogHandler
	getWarning ()
	Return warning if something is wrong with logger.
	setIdent ($ident)
	Set current ident.
Public Member Functions inherited from LogHandlerInterface
	getWarning ()
	Return warning if something is wrong with logger.

Detailed Description

Class to manage logging to syslog.

Definition at line 8 of file mod_syslog_syslog.php.

Member Function Documentation

checkConfiguration()

mod_syslog_syslog::checkConfiguration

(

)

Return if configuration is valid.

Returns

array Array of errors. Empty array if ok.

Reimplemented from LogHandler.

Definition at line 84 of file mod_syslog_syslog.php.

References dol_syslog().

configure()

mod_syslog_syslog::configure

(

)

Return array of configuration data.

Returns

array Return array of configuration data

Reimplemented from LogHandler.

Definition at line 66 of file mod_syslog_syslog.php.

export()

mod_syslog_syslog::export

(

$content

)

Export the message.

Parameters

array

$content

Array containing the info about the message

Returns

void

Implements LogHandlerInterface.

Definition at line 111 of file mod_syslog_syslog.php.

getInfo()

mod_syslog_syslog::getInfo

(

)

Content of the info tooltip.

Returns

false|string

Reimplemented from LogHandler.

Definition at line 37 of file mod_syslog_syslog.php.

getName()

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.

getVersion()

mod_syslog_syslog::getVersion

(

)

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

Returns

string

Reimplemented from LogHandler.

Definition at line 27 of file mod_syslog_syslog.php.

isActive()

mod_syslog_syslog::isActive

(

)

Is the module active ?

Returns

int

Reimplemented from LogHandler.

Definition at line 49 of file mod_syslog_syslog.php.

---

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

• dolibarr_18.0/htdocs/core/modules/syslog/mod_syslog_syslog.php