SimpleSAML\Logger\FileLoggingHandler Class Reference

Inheritance diagram for SimpleSAML\Logger\FileLoggingHandler:

Collaboration diagram for SimpleSAML\Logger\FileLoggingHandler:

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

Protected Attributes
	$logFile = null
	$processname = null
	$format

Static Private Attributes
static	$levelNames
	This array contains the mappings from syslog log levels to names. More...

Detailed Description

Definition at line 14 of file FileLoggingHandler.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML\Logger\FileLoggingHandler::__construct

(

\SimpleSAML_Configuration

$config

)

Build a new logging handler based on files.

Implements SimpleSAML\Logger\LoggingHandlerInterface.

Definition at line 45 of file FileLoggingHandler.php.

References SimpleSAML_Configuration\getPathValue(), SimpleSAML_Configuration\getString(), and SimpleSAML\Utils\Time\initTimezone().

    {
        // get the metadata handler option from the configuration
        $this->logFile = $config->getPathValue('loggingdir', 'log/').
            $config->getString('logging.logfile', 'simplesamlphp.log');
        $this->processname = $config->getString('logging.processname', 'SimpleSAMLphp');

        if (@file_exists($this->logFile)) {
            if (!@is_writeable($this->logFile)) {
                throw new \Exception("Could not write to logfile: ".$this->logFile);
            }
        } else {
            if (!@touch($this->logFile)) {
                throw new \Exception(
                    "Could not create logfile: ".$this->logFile.
                    " The logging directory is not writable for the web server user."
                );
            }
        }

        \SimpleSAML\Utils\Time::initTimezone();
    }

Here is the call graph for this function:

Member Function Documentation

log()

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

Log a message to the log file.

Parameters

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

Implements SimpleSAML\Logger\LoggingHandlerInterface.

Definition at line 86 of file FileLoggingHandler.php.

References SimpleSAML\Logger\FileLoggingHandler\$format, $formats, array, and format.

    {
        if (!is_null($this->logFile)) {
            // set human-readable log level. Copied from SimpleSAML\Logger\ErrorLogLoggingHandler.
            $levelName = sprintf('UNKNOWN%d', $level);
            if (array_key_exists($level, self::$levelNames)) {
                $levelName = self::$levelNames[$level];
            }

            $formats = array('%process', '%level');
            $replacements = array($this->processname, $levelName);

            $matches = array();
            if (preg_match('/%date(?:\{([^\}]+)\})?/', $this->format, $matches)) {
                $format = "%b %d %H:%M:%S";
                if (isset($matches[1])) {
                    $format = $matches[1];
                }

                array_push($formats, $matches[0]);
                array_push($replacements, strftime($format));
            }

            $string = str_replace($formats, $replacements, $string);
            file_put_contents($this->logFile, $string.PHP_EOL, FILE_APPEND);
        }
    }

setLogFormat()

SimpleSAML\Logger\FileLoggingHandler::setLogFormat

(

$format

)

Set the format desired for the logs.

Parameters

string

$format

The format used for logs.

Implements SimpleSAML\Logger\LoggingHandlerInterface.

Definition at line 74 of file FileLoggingHandler.php.

References SimpleSAML\Logger\FileLoggingHandler\$format, and format.

    {
        $this->format = $format;
    }

Field Documentation

$format

SimpleSAML\Logger\FileLoggingHandler::$format

protected

Definition at line 39 of file FileLoggingHandler.php.

Referenced by SimpleSAML\Logger\FileLoggingHandler\log(), and SimpleSAML\Logger\FileLoggingHandler\setLogFormat().

$levelNames

SimpleSAML\Logger\FileLoggingHandler::$levelNames

staticprivate

Initial value:

= array(
        Logger::EMERG   => 'EMERGENCY',
        Logger::ALERT   => 'ALERT',
        Logger::CRIT    => 'CRITICAL',
        Logger::ERR     => 'ERROR',
        Logger::WARNING => 'WARNING',
        Logger::NOTICE  => 'NOTICE',
        Logger::INFO    => 'INFO',
        Logger::DEBUG   => 'DEBUG',
    )

This array contains the mappings from syslog log levels to names.

Copied more or less directly from SimpleSAML.

Definition at line 28 of file FileLoggingHandler.php.

$logFile

SimpleSAML\Logger\FileLoggingHandler::$logFile = null

protected

Definition at line 22 of file FileLoggingHandler.php.

$processname

SimpleSAML\Logger\FileLoggingHandler::$processname = null

protected

Definition at line 38 of file FileLoggingHandler.php.

---

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

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