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 logger active ?
	configure ()
	Return array of configuration data.
	checkConfiguration ()
	Return if configuration is valid.
	export ($content, $suffixinfilename='')
	Export the message.
Public Member Functions inherited from LogHandler
	getWarning ()
	Return warning if something is wrong with logger.
	setIdent ($ident)
	Set current ident.

Detailed Description

Class to manage logging to syslog.

Definition at line 11 of file mod_syslog_syslog.php.

Member Function Documentation

checkConfiguration()

mod_syslog_syslog::checkConfiguration

(

)

Return if configuration is valid.

Returns

bool True if ok.

Reimplemented from LogHandler.

Definition at line 85 of file mod_syslog_syslog.php.

References dol_syslog(), and getDolGlobalString().

configure()

mod_syslog_syslog::configure

(

)

Return array of configuration data.

Returns

array<array{name:string,constant:string,default:string,css?:string}> Return array of configuration data

Reimplemented from LogHandler.

Definition at line 67 of file mod_syslog_syslog.php.

export()

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

Export the message.

Parameters

	array{level:int,ip:string,ospid:string,osuser:string,message:string}	$content Array containing the info about the message
string	$suffixinfilename	When output is a file, append this suffix into default log filename.

Returns

void

Reimplemented from LogHandler.

Definition at line 112 of file mod_syslog_syslog.php.

References $conf, dol_trunc(), and getDolGlobalString().

getInfo()

mod_syslog_syslog::getInfo

(

)

Content of the info tooltip.

Returns

false|string

Reimplemented from LogHandler.

Definition at line 40 of file mod_syslog_syslog.php.

getName()

mod_syslog_syslog::getName

(

)

Return name of logger.

Returns

string Name of logger

Reimplemented from LogHandler.

Definition at line 20 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 30 of file mod_syslog_syslog.php.

isActive()

mod_syslog_syslog::isActive

(

)

Is the logger active ?

Returns

int<0,1> 1 if logger enabled

Reimplemented from LogHandler.

Definition at line 52 of file mod_syslog_syslog.php.

References getDolGlobalString().

---

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

• dolibarr_dev/htdocs/core/modules/syslog/mod_syslog_syslog.php