SimpleSAML\Logger\SyslogLoggingHandler Class Reference

Inheritance diagram for SimpleSAML\Logger\SyslogLoggingHandler:

Collaboration diagram for SimpleSAML\Logger\SyslogLoggingHandler:

Public Member Functions
	__construct (\SimpleSAML_Configuration $config)
	Build a new logging handler based on syslog. More...
	setLogFormat ($format)
	Set the format desired for the logs. More...
	log ($level, $string)
	Log a message to syslog. More...
	__construct (\SimpleSAML_Configuration $config)
	Constructor for log handlers. More...
	log ($level, $string)
	Log a message to its destination. More...
	setLogFormat ($format)
	Set the format desired for the logs. More...

Private Attributes
	$isWindows = false
	$format

Detailed Description

Definition at line 14 of file SyslogLoggingHandler.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML\Logger\SyslogLoggingHandler::__construct

(

\SimpleSAML_Configuration

$config

)

Build a new logging handler based on syslog.

Implements SimpleSAML\Logger\LoggingHandlerInterface.

Definition at line 23 of file SyslogLoggingHandler.php.

    {
        $facility = $config->getInteger('logging.facility', defined('LOG_LOCAL5') ? constant('LOG_LOCAL5') : LOG_USER);
 
        $processname = $config->getString('logging.processname', 'SimpleSAMLphp');
 
        // Setting facility to LOG_USER (only valid in Windows), enable log level rewrite on windows systems
        if (System::getOS() === System::WINDOWS) {
            $this->isWindows = true;
            $facility = LOG_USER;
        }
 
        openlog($processname, LOG_PID, $facility);
    }

References $config, SimpleSAML\Utils\System\getOS(), and SimpleSAML\Utils\System\WINDOWS.

Here is the call graph for this function:

Member Function Documentation

log()

SimpleSAML\Logger\SyslogLoggingHandler::log	(		$level,
			$string
	)

Log a message to syslog.

Parameters

int	$level	The log level.
string	$string	The formatted message to log.

Implements SimpleSAML\Logger\LoggingHandlerInterface.

Definition at line 56 of file SyslogLoggingHandler.php.

    {
        // changing log level to supported levels if OS is Windows
        if ($this->isWindows) {
            if ($level <= 4) {
                $level = LOG_ERR;
            } else {
                $level = LOG_INFO;
            }
        }
 
        $formats = array('%process', '%level');
        $replacements = array('', $level);
        $string = str_replace($formats, $replacements, $string);
        $string = preg_replace('/%\w+(\{[^\}]+\})?/', '', $string);
        $string = trim($string);
 
        syslog($level, $string);
    }

References $formats.

setLogFormat()

SimpleSAML\Logger\SyslogLoggingHandler::setLogFormat

(

$format

)

Set the format desired for the logs.

Parameters

string

$format

The format used for logs.

Implements SimpleSAML\Logger\LoggingHandlerInterface.

Definition at line 44 of file SyslogLoggingHandler.php.

    {
        $this->format = $format;
    }

References SimpleSAML\Logger\SyslogLoggingHandler\$format.

Field Documentation

$format

SimpleSAML\Logger\SyslogLoggingHandler::$format

private

Definition at line 17 of file SyslogLoggingHandler.php.

Referenced by SimpleSAML\Logger\SyslogLoggingHandler\setLogFormat().

$isWindows

SimpleSAML\Logger\SyslogLoggingHandler::$isWindows = false

private

Definition at line 16 of file SyslogLoggingHandler.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Logger/SyslogLoggingHandler.php