sspmod_core_Stats_Output_File Class Reference

Inheritance diagram for sspmod_core_Stats_Output_File:

Collaboration diagram for sspmod_core_Stats_Output_File:

Public Member Functions
	__construct (SimpleSAML_Configuration $config)
	Initialize the output. More...
	emit (array $data)
	Write a stats event. More...
Public Member Functions inherited from SimpleSAML_Stats_Output
	__construct (SimpleSAML_Configuration $config)
	Initialize the output. More...
	emit (array $data)
	Write a stats event. More...

Private Member Functions
	openLog ($date)
	Open a log file. More...

Private Attributes
	$logDir
	$file = NULL
	$fileDate = NULL

Detailed Description

Definition at line 8 of file File.php.

Constructor & Destructor Documentation

__construct()

sspmod_core_Stats_Output_File::__construct

(

SimpleSAML_Configuration

$config

)

Initialize the output.

Parameters

SimpleSAML_Configuration

$config

The configuration for this output.

Definition at line 35 of file File.php.

References SimpleSAML_Configuration\getPathValue().

                                                                      {

                $this->logDir = $config->getPathValue('directory');
                if ($this->logDir === NULL) {
                        throw new Exception('Missing "directory" option for core:File');
                }
                if (!is_dir($this->logDir)) {
                        throw new Exception('Could not find log directory: ' . var_export($this->logDir, TRUE));
                }

        }

Here is the call graph for this function:

Member Function Documentation

emit()

sspmod_core_Stats_Output_File::emit

(

array

$data

)

Write a stats event.

Parameters

array

$data

The event.

Definition at line 79 of file File.php.

References $time, $timestamp, file, and openLog().

                                          {
                assert('isset($data["time"])');

                $time = $data['time'];
                $milliseconds = (int)(($time - (int)$time) * 1000);

                $timestamp = gmdate('Y-m-d\TH:i:s', $time) . sprintf('.%03dZ', $milliseconds);

                $outDate = substr($timestamp, 0, 10); // The date-part of the timstamp

                if ($outDate !== $this->fileDate) {
                        $this->openLog($outDate);
                }

                $line = $timestamp . ' ' . json_encode($data) . "\n";
                fwrite($this->file, $line);
        }

Here is the call graph for this function:

openLog()

sspmod_core_Stats_Output_File::openLog (   $date )

private

Open a log file.

Parameters

string

$date

The date for the log file.

Definition at line 53 of file File.php.

References file.

Referenced by emit().

                                        {
                assert('is_string($date)');

                if ($this->file !== NULL && $this->file !== FALSE) {
                        fclose($this->file);
                        $this->file = NULL;
                }

                $fileName = $this->logDir . '/' . $date . '.log';
                $this->file = @fopen($fileName, 'a');
                if ($this->file === FALSE) {
                        throw new SimpleSAML_Error_Exception('Error opening log file: ' . var_export($fileName, TRUE));
                }

                // Disable output buffering
                stream_set_write_buffer($this->file, 0);

                $this->fileDate = $date;
        }

Here is the caller graph for this function:

Field Documentation

$file

sspmod_core_Stats_Output_File::$file = NULL

private

Definition at line 21 of file File.php.

$fileDate

sspmod_core_Stats_Output_File::$fileDate = NULL

private

Definition at line 27 of file File.php.

$logDir

sspmod_core_Stats_Output_File::$logDir

private

Definition at line 14 of file File.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/core/lib/Stats/Output/File.php