Monolog\Formatter\JsonFormatter Class Reference

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

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, $depth=0)
	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, $depth=0)
	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 25 of file JsonFormatter.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

int	$batchMode
bool	$appendNewline

Definition at line 42 of file JsonFormatter.php.

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

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

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

}

Implements Monolog\Formatter\FormatterInterface.

Definition at line 75 of file JsonFormatter.php.

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

Referenced by Monolog\Formatter\JsonFormatterTest\formatRecordWithExceptionInContext().

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

Here is the call graph for this function:

Here is the caller 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

}

Implements Monolog\Formatter\FormatterInterface.

Definition at line 83 of file JsonFormatter.php.

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

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

            case static::BATCH_MODE_JSON:
            default:
                return $this->formatBatchJson($records);
        }
    }

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 109 of file JsonFormatter.php.

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

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

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

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 121 of file JsonFormatter.php.

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

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

    {
        $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);
    }

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 57 of file JsonFormatter.php.

References Monolog\Formatter\JsonFormatter\$batchMode.

    {
        return $this->batchMode;
    }

includeStacktraces()

Monolog\Formatter\JsonFormatter::includeStacktraces

(

$include = true

)

Parameters

bool

$include

Definition at line 98 of file JsonFormatter.php.

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

    {
        $this->includeStacktraces = $include;
    }

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 67 of file JsonFormatter.php.

References Monolog\Formatter\JsonFormatter\$appendNewline.

    {
        return $this->appendNewline;
    }

normalize()

Monolog\Formatter\JsonFormatter::normalize (   $data,   $depth = 0  )

protected

Normalizes given $data.

Parameters

mixed

$data

Returns

mixed

Definition at line 142 of file JsonFormatter.php.

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

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

    {
        if ($depth > 9) {
            return 'Over 9 levels deep, aborting normalization';
        }

        if (is_array($data) || $data instanceof \Traversable) {
            $normalized = array();

            $count = 1;
            foreach ($data as $key => $value) {
                if ($count++ > 1000) {
                    $normalized['...'] = 'Over 1000 items ('.count($data).' total), aborting normalization';
                    break;
                }

                $normalized[$key] = $this->normalize($value, $depth+1);
            }

            return $normalized;
        }

        if ($data instanceof Exception || $data instanceof Throwable) {
            return $this->normalizeException($data);
        }

        return $data;
    }

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

Definition at line 179 of file JsonFormatter.php.

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

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

    {
        // TODO 2.0 only check for Throwable
        if (!$e instanceof Exception && !$e instanceof Throwable) {
            throw new \InvalidArgumentException('Exception/Throwable expected, got '.gettype($e).' / '.Utils::getClass($e));
        }

        $data = array(
            'class' => Utils::getClass($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;
    }

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 31 of file JsonFormatter.php.

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

$batchMode

Monolog\Formatter\JsonFormatter::$batchMode

protected

Definition at line 30 of file JsonFormatter.php.

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

$includeStacktraces

Monolog\Formatter\JsonFormatter::$includeStacktraces = false

protected

Definition at line 36 of file JsonFormatter.php.

BATCH_MODE_JSON

const Monolog\Formatter\JsonFormatter::BATCH_MODE_JSON = 1

Definition at line 27 of file JsonFormatter.php.

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

BATCH_MODE_NEWLINES

const Monolog\Formatter\JsonFormatter::BATCH_MODE_NEWLINES = 2

Definition at line 28 of file JsonFormatter.php.

Referenced by Monolog\Formatter\LogglyFormatterTest\testConstruct(), Monolog\Formatter\JsonFormatterTest\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