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

Data Fields
const	BATCH_MODE_JSON = 1
const	BATCH_MODE_NEWLINES = 2

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

Protected Attributes
	$batchMode
	$appendNewline

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

Constructor & Destructor Documentation

__construct()

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

Parameters

int

$batchMode

Definition at line 32 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 65 of file JsonFormatter.php.

    {
        return json_encode($record) . ($this->appendNewline ? "\n" : '');
    }

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

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

    {
        return json_encode($records);
    }

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

References Monolog\Formatter\JsonFormatter\$appendNewline.

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

References Monolog\Formatter\JsonFormatter\$batchMode.

    {
        return $this->batchMode;
    }

isAppendingNewlines()

Monolog\Formatter\JsonFormatter::isAppendingNewlines

(

)

True if newlines are appended to every formatted record.

Returns

bool

Definition at line 57 of file JsonFormatter.php.

References Monolog\Formatter\JsonFormatter\$appendNewline.

    {
        return $this->appendNewline;
    }

Field Documentation

$appendNewline

Monolog\Formatter\JsonFormatter::$appendNewline

protected

Definition at line 27 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 26 of file JsonFormatter.php.

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

BATCH_MODE_JSON

const Monolog\Formatter\JsonFormatter::BATCH_MODE_JSON = 1

Definition at line 23 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 24 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:

• Services/Logging/lib/vendor/monolog/monolog/src/Monolog/Formatter/JsonFormatter.php