Documentation

LineFormatter extends NormalizerFormatter
in package

Formats incoming records into a one-line string

This is especially useful for logging to files

Tags
author

Jordi Boggiano j.boggiano@seld.be

author

Christophe Coevoet stof@notk.org

Table of Contents

Constants

SIMPLE_DATE  = "Y-m-d\\TH:i:sP"
SIMPLE_FORMAT  = "[%datetime%] %channel%.%level_name%: %message% %context% %extra%\n"

Properties

$allowInlineLineBreaks  : bool
$dateFormat  : string
$format  : string
$ignoreEmptyContextAndExtra  : bool
$includeStacktraces  : bool
$maxNormalizeDepth  : int
$maxNormalizeItemCount  : int
$stacktracesParser  : callable|null
$jsonEncodeOptions  : int

Methods

__construct()  : mixed
addJsonEncodeOption()  : self
allowInlineLineBreaks()  : self
format()  : mixed
Formats a log record.
formatBatch()  : mixed
Formats a set of log records.
getDateFormat()  : string
getMaxNormalizeDepth()  : int
The maximum number of normalization levels to go through
getMaxNormalizeItemCount()  : int
The maximum number of items to normalize per level
ignoreEmptyContextAndExtra()  : self
includeStacktraces()  : self
removeJsonEncodeOption()  : self
setDateFormat()  : self
setJsonPrettyPrint()  : self
Enables `json_encode` pretty print.
setMaxNormalizeDepth()  : self
setMaxNormalizeItemCount()  : self
stringify()  : string
convertToString()  : string
formatDate()  : string
normalize()  : null|scalar|array<string|int, array<string|int, mixed>|scalar|null>
normalizeException()  : array<string|int, mixed>
replaceNewlines()  : string
toJson()  : string
Return the JSON representation of a value
formatException()  : string
stacktracesParser()  : string
stacktracesParserCustom()  : string

Constants

SIMPLE_FORMAT

public mixed SIMPLE_FORMAT = "[%datetime%] %channel%.%level_name%: %message% %context% %extra%\n"

Properties

$allowInlineLineBreaks

protected bool $allowInlineLineBreaks

$ignoreEmptyContextAndExtra

protected bool $ignoreEmptyContextAndExtra

$stacktracesParser

protected callable|null $stacktracesParser

$jsonEncodeOptions

private int $jsonEncodeOptions = \Monolog\Utils::DEFAULT_JSON_FLAGS

Methods

__construct()

public __construct([string|null $format = null ][, string|null $dateFormat = null ][, bool $allowInlineLineBreaks = false ][, bool $ignoreEmptyContextAndExtra = false ][, bool $includeStacktraces = false ]) : mixed
Parameters
$format : string|null = null

The format of the message

$dateFormat : string|null = null

The format of the timestamp: one supported by DateTime::format

$allowInlineLineBreaks : bool = false

Whether to allow inline line breaks in log entries

$ignoreEmptyContextAndExtra : bool = false
$includeStacktraces : bool = false

addJsonEncodeOption()

public addJsonEncodeOption(int $option) : self
Parameters
$option : int
Return values
self

allowInlineLineBreaks()

public allowInlineLineBreaks([bool $allow = true ]) : self
Parameters
$allow : bool = true
Return values
self

format()

Formats a log record.

public format(array<string|int, mixed> $record) : mixed
Parameters
$record : array<string|int, mixed>
Return values
mixed —

The formatted record

formatBatch()

Formats a set of log records.

public formatBatch(array<string|int, mixed> $records) : mixed
Parameters
$records : array<string|int, mixed>

A set of records to format

Return values
mixed —

The formatted set of records

getMaxNormalizeDepth()

The maximum number of normalization levels to go through

public getMaxNormalizeDepth() : int
Return values
int

getMaxNormalizeItemCount()

The maximum number of items to normalize per level

public getMaxNormalizeItemCount() : int
Return values
int

ignoreEmptyContextAndExtra()

public ignoreEmptyContextAndExtra([bool $ignore = true ]) : self
Parameters
$ignore : bool = true
Return values
self

includeStacktraces()

public includeStacktraces([bool $include = true ][, callable|null $parser = null ]) : self
Parameters
$include : bool = true
$parser : callable|null = null
Return values
self

removeJsonEncodeOption()

public removeJsonEncodeOption(int $option) : self
Parameters
$option : int
Return values
self

setDateFormat()

public setDateFormat(string $dateFormat) : self
Parameters
$dateFormat : string
Return values
self

setJsonPrettyPrint()

Enables `json_encode` pretty print.

public setJsonPrettyPrint(bool $enable) : self
Parameters
$enable : bool
Return values
self

setMaxNormalizeDepth()

public setMaxNormalizeDepth(int $maxNormalizeDepth) : self
Parameters
$maxNormalizeDepth : int
Return values
self

setMaxNormalizeItemCount()

public setMaxNormalizeItemCount(int $maxNormalizeItemCount) : self
Parameters
$maxNormalizeItemCount : int
Return values
self

stringify()

public stringify(mixed $value) : string
Parameters
$value : mixed
Return values
string

convertToString()

protected convertToString(mixed $data) : string
Parameters
$data : mixed
Return values
string

formatDate()

protected formatDate(DateTimeInterface $date) : string
Parameters
$date : DateTimeInterface
Return values
string

normalize()

protected normalize(mixed $data[, int $depth = 0 ]) : null|scalar|array<string|int, array<string|int, mixed>|scalar|null>
Parameters
$data : mixed
$depth : int = 0
Return values
null|scalar|array<string|int, array<string|int, mixed>|scalar|null>

normalizeException()

protected normalizeException(Throwable $e[, int $depth = 0 ]) : array<string|int, mixed>
Parameters
$e : Throwable
$depth : int = 0
Return values
array<string|int, mixed>

replaceNewlines()

protected replaceNewlines(string $str) : string
Parameters
$str : string
Return values
string

toJson()

Return the JSON representation of a value

protected toJson(mixed $data[, bool $ignoreErrors = false ]) : string
Parameters
$data : mixed
$ignoreErrors : bool = false
Tags
throws
RuntimeException

if encoding fails and errors are not ignored

Return values
string —

if encoding fails and ignoreErrors is true 'null' is returned

formatException()

private formatException(Throwable $e) : string
Parameters
$e : Throwable
Return values
string

stacktracesParser()

private stacktracesParser(Throwable $e) : string
Parameters
$e : Throwable
Return values
string

stacktracesParserCustom()

private stacktracesParserCustom(string $trace) : string
Parameters
$trace : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results