Monolog\Formatter\WildfireFormatter Class Reference

Serializes a log message according to Wildfire's header requirements. More...

Inheritance diagram for Monolog\Formatter\WildfireFormatter:

Collaboration diagram for Monolog\Formatter\WildfireFormatter:

Public Member Functions
	format (array $record)
	{Formats a log record. Parameters array $record A record to format Returns mixed The formatted record } More...
	formatBatch (array $records)
	Formats a set of log records. More...
Public Member Functions inherited from Monolog\Formatter\NormalizerFormatter
	__construct ($dateFormat=null)
	format (array $record)
	{Formats a log record. Parameters array $record A record to format Returns mixed The formatted record } More...
	formatBatch (array $records)
	{Formats a set of log records. Parameters array $records A set of records to format Returns mixed The formatted set of records } More...
	detectAndCleanUtf8 (&$data)
	Detect invalid UTF-8 string characters and convert to valid UTF-8. More...

Data Fields
const	TABLE = 'table'
Data Fields inherited from Monolog\Formatter\NormalizerFormatter
const	SIMPLE_DATE = "Y-m-d H:i:s"

Protected Member Functions
	normalize ($data)
Protected Member Functions inherited from Monolog\Formatter\NormalizerFormatter
	normalize ($data)
	normalizeException ($e)
	toJson ($data, $ignoreErrors=false)
	Return the JSON representation of a value. More...

Private Attributes
	$logLevels
	Translates Monolog log levels to Wildfire levels. More...

Additional Inherited Members
Protected Attributes inherited from Monolog\Formatter\NormalizerFormatter
	$dateFormat

Detailed Description

Serializes a log message according to Wildfire's header requirements.

Author

Eric Clemmons () eric@.nosp@m.uxdr.nosp@m.iven..nosp@m.com

Christophe Coevoet stof@.nosp@m.notk.nosp@m..org

Kirill chEbba Chebunin iam@c.nosp@m.hebb.nosp@m.a.org

Definition at line 23 of file WildfireFormatter.php.

Member Function Documentation

format()

Monolog\Formatter\WildfireFormatter::format

(

array

$record

)

{Formats a log record.

Parameters

array

$record

A record to format

Returns

mixed The formatted record

}

Implements Monolog\Formatter\FormatterInterface.

Definition at line 44 of file WildfireFormatter.php.

References $file, $message, $type, array, Monolog\Formatter\WildfireFormatter\normalize(), and Monolog\Formatter\NormalizerFormatter\toJson().

    {
        // Retrieve the line and file if set and remove them from the formatted extra
        $file = $line = '';
        if (isset($record['extra']['file'])) {
            $file = $record['extra']['file'];
            unset($record['extra']['file']);
        }
        if (isset($record['extra']['line'])) {
            $line = $record['extra']['line'];
            unset($record['extra']['line']);
        }

        $record = $this->normalize($record);
        $message = array('message' => $record['message']);
        $handleError = false;
        if ($record['context']) {
            $message['context'] = $record['context'];
            $handleError = true;
        }
        if ($record['extra']) {
            $message['extra'] = $record['extra'];
            $handleError = true;
        }
        if (count($message) === 1) {
            $message = reset($message);
        }

        if (isset($record['context'][self::TABLE])) {
            $type  = 'TABLE';
            $label = $record['channel'] .': '. $record['message'];
            $message = $record['context'][self::TABLE];
        } else {
            $type  = $this->logLevels[$record['level']];
            $label = $record['channel'];
        }

        // Create JSON object describing the appearance of the message in the console
        $json = $this->toJson(array(
            array(
                'Type'  => $type,
                'File'  => $file,
                'Line'  => $line,
                'Label' => $label,
            ),
            $message,
        ), $handleError);

        // The message itself is a serialization of the above JSON object + it's length
        return sprintf(
            '%s|%s|',
            strlen($json),
            $json
        );
    }

Here is the call graph for this function:

formatBatch()

Monolog\Formatter\WildfireFormatter::formatBatch

(

array

$records

)

Formats a set of log records.

Parameters

array

$records

A set of records to format

Returns

mixed The formatted set of records

Implements Monolog\Formatter\FormatterInterface.

Definition at line 100 of file WildfireFormatter.php.

    {
        throw new \BadMethodCallException('Batch formatting does not make sense for the WildfireFormatter');
    }

normalize()

Monolog\Formatter\WildfireFormatter::normalize (   $data )

protected

Definition at line 105 of file WildfireFormatter.php.

References $data.

Referenced by Monolog\Formatter\WildfireFormatter\format().

    {
        if (is_object($data) && !$data instanceof \DateTime) {
            return $data;
        }

        return parent::normalize($data);
    }

Here is the caller graph for this function:

Field Documentation

$logLevels

Monolog\Formatter\WildfireFormatter::$logLevels

private

Initial value:

= array(
        Logger::DEBUG     => 'LOG',
        Logger::INFO      => 'INFO',
        Logger::NOTICE    => 'INFO',
        Logger::WARNING   => 'WARN',
        Logger::ERROR     => 'ERROR',
        Logger::CRITICAL  => 'ERROR',
        Logger::ALERT     => 'ERROR',
        Logger::EMERGENCY => 'ERROR',
    )

Translates Monolog log levels to Wildfire levels.

Definition at line 30 of file WildfireFormatter.php.

TABLE

const Monolog\Formatter\WildfireFormatter::TABLE = 'table'

Definition at line 25 of file WildfireFormatter.php.

Referenced by Monolog\Formatter\WildfireFormatterTest\testTableFormat().

---

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

• libs/composer/vendor/monolog/monolog/src/Monolog/Formatter/WildfireFormatter.php