Encodes whatever record data is passed to it as json. More...

Inheritance diagram for Monolog\Formatter\JsonFormatter:

Collaboration diagram for Monolog\Formatter\JsonFormatter:

Public Member Functions

__construct ($batchMode=self::BATCH_MODE_JSON, $appendNewline=true)

getBatchMode ()

The batch mode option configures the formatting style for multiple records. More...

isAppendingNewlines ()

True if newlines are appended to every formatted record. More...

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...

includeStacktraces ($include=true)

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...

format (array $record)

Formats a log record. More...

formatBatch (array $records)

Formats a set of log records. More...

Data Fields
const	BATCH_MODE_JSON = 1

const	BATCH_MODE_NEWLINES = 2

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

Protected Member Functions
	formatBatchJson (array $records)
	Return a JSON-encoded array of records. More...

	formatBatchNewlines (array $records)
	Use new lines to separate records instead of a JSON-encoded array. More...

	normalize ($data)
	Normalizes given $data. More...

	normalizeException ($e)
	Normalizes given exception with or without its own stack trace based on `includeStacktraces` property. More...

Protected Member Functions inherited from Monolog\Formatter\NormalizerFormatter
	normalize ($data)

	normalizeException ($e)

	toJson ($data, $ignoreErrors=false)
	Return the JSON representation of a value. More...

Protected Attributes
	$batchMode

	$appendNewline

	$includeStacktraces = false

Protected Attributes inherited from Monolog\Formatter\NormalizerFormatter
	$dateFormat

Detailed Description

Encodes whatever record data is passed to it as json.

This can be useful to log to databases or remote APIs

Author: Jordi Boggiano j.bog.nosp@m.gian.nosp@m.o@sel.nosp@m.d.be

Definition at line 23 of file JsonFormatter.php.

Constructor & Destructor Documentation

◆ __construct()

Monolog\Formatter\JsonFormatter::__construct	(	$batchMode = `self::BATCH_MODE_JSON`,
		$appendNewline = `true`
	)

Parameters

int $batchMode

Reimplemented in Monolog\Formatter\LogglyFormatter.

Definition at line 38 of file JsonFormatter.php.

    {
        $this->batchMode = $batchMode;
        $this->appendNewline = $appendNewline;
    }

References Monolog\Formatter\JsonFormatter\$appendNewline, and Monolog\Formatter\JsonFormatter\$batchMode.

Member Function Documentation

◆ format()

Monolog\Formatter\JsonFormatter::format ( array $record )

{{Formats a log record.

Parameters

array $record A record to format

Returns: mixed The formatted record

}}

Reimplemented from Monolog\Formatter\NormalizerFormatter.

Reimplemented in Monolog\Formatter\LogglyFormatter.

Definition at line 71 of file JsonFormatter.php.

    {
        return $this->toJson($this->normalize($record), true) . ($this->appendNewline ? "\n" : '');
    }

References Monolog\Formatter\JsonFormatter\normalize(), and Monolog\Formatter\NormalizerFormatter\toJson().

Here is the call graph for this function:

◆ formatBatch()

Monolog\Formatter\JsonFormatter::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

}}

Reimplemented from Monolog\Formatter\NormalizerFormatter.

Definition at line 79 of file JsonFormatter.php.

    {
        switch ($this->batchMode) {
            case static::BATCH_MODE_NEWLINES:
                return $this->formatBatchNewlines($records);
 
            case static::BATCH_MODE_JSON:
            default:
                return $this->formatBatchJson($records);
        }
    }

References Monolog\Formatter\JsonFormatter\formatBatchJson(), and Monolog\Formatter\JsonFormatter\formatBatchNewlines().

Here is the call graph for this function:

◆ formatBatchJson()

Monolog\Formatter\JsonFormatter::formatBatchJson ( array $records )

protected

Return a JSON-encoded array of records.

Parameters

array $records

Returns: string

Definition at line 105 of file JsonFormatter.php.

    {
        return $this->toJson($this->normalize($records), true);
    }

References Monolog\Formatter\JsonFormatter\normalize(), and Monolog\Formatter\NormalizerFormatter\toJson().

Referenced by Monolog\Formatter\JsonFormatter\formatBatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ formatBatchNewlines()

Monolog\Formatter\JsonFormatter::formatBatchNewlines ( array $records )

protected

Use new lines to separate records instead of a JSON-encoded array.

Parameters

array $records

Returns: string

Definition at line 117 of file JsonFormatter.php.

    {
        $instance = $this;
 
        $oldNewline = $this->appendNewline;
        $this->appendNewline = false;
        array_walk($records, function (&$value, $key) use ($instance) {
            $value = $instance->format($value);
        });
        $this->appendNewline = $oldNewline;
 
        return implode("\n", $records);
    }

References Monolog\Formatter\JsonFormatter\$appendNewline, and $records.

Referenced by Monolog\Formatter\JsonFormatter\formatBatch().

Here is the caller graph for this function:

◆ getBatchMode()

Monolog\Formatter\JsonFormatter::getBatchMode ( )

The batch mode option configures the formatting style for multiple records.

By default, multiple records will be formatted as a JSON-encoded array. However, for compatibility with some API endpoints, alternative styles are available.

Returns: int

Definition at line 53 of file JsonFormatter.php.

    {
        return $this->batchMode;
    }

References Monolog\Formatter\JsonFormatter\$batchMode.

◆ includeStacktraces()

Monolog\Formatter\JsonFormatter::includeStacktraces ( $include = true )

Parameters

bool $include

Definition at line 94 of file JsonFormatter.php.

    {
        $this->includeStacktraces = $include;
    }

References Monolog\Formatter\JsonFormatter\includeStacktraces().

Referenced by Monolog\Formatter\JsonFormatter\includeStacktraces(), and Monolog\Formatter\JsonFormatter\normalizeException().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAppendingNewlines()

Monolog\Formatter\JsonFormatter::isAppendingNewlines ( )

True if newlines are appended to every formatted record.

Returns: bool

Definition at line 63 of file JsonFormatter.php.

    {
        return $this->appendNewline;
    }

References Monolog\Formatter\JsonFormatter\$appendNewline.

◆ normalize()

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

protected

Normalizes given $data.

Parameters

mixed $data

Returns: mixed

Reimplemented from Monolog\Formatter\NormalizerFormatter.

Definition at line 138 of file JsonFormatter.php.

    {
        if (is_array($data) || $data instanceof \Traversable) {
            $normalized = array();
 
            $count = 1;
            foreach ($data as $key => $value) {
                if ($count++ >= 1000) {
                    $normalized['...'] = 'Over 1000 items, aborting normalization';
                    break;
                }
                $normalized[$key] = $this->normalize($value);
            }
 
            return $normalized;
        }
 
        if ($data instanceof Exception) {
            return $this->normalizeException($data);
        }
 
        return $data;
    }

References $data, Monolog\Formatter\JsonFormatter\normalize(), and Monolog\Formatter\JsonFormatter\normalizeException().

Referenced by Monolog\Formatter\JsonFormatter\format(), Monolog\Formatter\JsonFormatter\formatBatchJson(), Monolog\Formatter\JsonFormatter\normalize(), and Monolog\Formatter\JsonFormatter\normalizeException().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ normalizeException()

Monolog\Formatter\JsonFormatter::normalizeException ( $e )

protected

Normalizes given exception with or without its own stack trace based on includeStacktraces property.

Parameters

Exception | Throwable $e

Returns: array

Reimplemented from Monolog\Formatter\NormalizerFormatter.

Definition at line 170 of file JsonFormatter.php.

    {
        // TODO 2.0 only check for Throwable
        if (!$e instanceof Exception && !$e instanceof \Throwable) {
            throw new \InvalidArgumentException('Exception/Throwable expected, got '.gettype($e).' / '.get_class($e));
        }
 
        $data = array(
            'class' => get_class($e),
            'message' => $e->getMessage(),
            'code' => $e->getCode(),
            'file' => $e->getFile().':'.$e->getLine(),
        );
 
        if ($this->includeStacktraces) {
            $trace = $e->getTrace();
            foreach ($trace as $frame) {
                if (isset($frame['file'])) {
                    $data['trace'][] = $frame['file'].':'.$frame['line'];
                } elseif (isset($frame['function']) && $frame['function'] === '{closure}') {
                    // We should again normalize the frames, because it might contain invalid items
                    $data['trace'][] = $frame['function'];
                } else {
                    // We should again normalize the frames, because it might contain invalid items
                    $data['trace'][] = $this->normalize($frame);
                }
            }
        }
 
        if ($previous = $e->getPrevious()) {
            $data['previous'] = $this->normalizeException($previous);
        }
 
        return $data;
    }

References $data, Monolog\Formatter\JsonFormatter\includeStacktraces(), Monolog\Formatter\JsonFormatter\normalize(), and Monolog\Formatter\JsonFormatter\normalizeException().

Referenced by Monolog\Formatter\JsonFormatter\normalize(), and Monolog\Formatter\JsonFormatter\normalizeException().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $appendNewline

Monolog\Formatter\JsonFormatter::$appendNewline

protected

Definition at line 29 of file JsonFormatter.php.

Referenced by Monolog\Formatter\JsonFormatter\__construct(), Monolog\Formatter\LogglyFormatter\__construct(), Monolog\Formatter\JsonFormatter\formatBatchNewlines(), and Monolog\Formatter\JsonFormatter\isAppendingNewlines().

◆ $batchMode

Monolog\Formatter\JsonFormatter::$batchMode

protected

Definition at line 28 of file JsonFormatter.php.

Referenced by Monolog\Formatter\JsonFormatter\__construct(), Monolog\Formatter\LogglyFormatter\__construct(), and Monolog\Formatter\JsonFormatter\getBatchMode().

◆ $includeStacktraces

Monolog\Formatter\JsonFormatter::$includeStacktraces = false

protected

Definition at line 33 of file JsonFormatter.php.

◆ BATCH_MODE_JSON

const Monolog\Formatter\JsonFormatter::BATCH_MODE_JSON = 1

Definition at line 25 of file JsonFormatter.php.

Referenced by Monolog\Handler\AmqpHandler\getDefaultFormatter(), Monolog\Handler\CouchDBHandler\getDefaultFormatter(), Monolog\Formatter\JsonFormatterTest\testConstruct(), Monolog\Formatter\LogglyFormatterTest\testConstruct(), and Monolog\Formatter\JsonFormatterTest\testFormat().

◆ BATCH_MODE_NEWLINES

const Monolog\Formatter\JsonFormatter::BATCH_MODE_NEWLINES = 2

Definition at line 26 of file JsonFormatter.php.

Referenced by Monolog\Formatter\JsonFormatterTest\testConstruct(), Monolog\Formatter\LogglyFormatterTest\testConstruct(), and Monolog\Formatter\JsonFormatterTest\testFormatBatchNewlines().

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

libs/composer/vendor/monolog/monolog/src/Monolog/Formatter/JsonFormatter.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ format()

◆ formatBatch()

◆ formatBatchJson()

◆ formatBatchNewlines()

◆ getBatchMode()

◆ includeStacktraces()

◆ isAppendingNewlines()

◆ normalize()

◆ normalizeException()

Field Documentation

◆ $appendNewline

◆ $batchMode

◆ $includeStacktraces

◆ BATCH_MODE_JSON

◆ BATCH_MODE_NEWLINES