AbstractWriter
in package
implements
WriterInterface
AbstractYes
Log writer abstract class
Tags
Table of Contents
Interfaces
- WriterInterface
- Log writer interface
Properties
- $limit : string|null
- Log limit, stored as the canonical PSR-3 level string
Methods
- getContext() : string
- Get context for log
- getLogLimit() : string|null
- Get log limit
- hasLogLimit() : bool
- Has log limit
- isWithinLogLimit() : bool
- Check if a log level is within the set log level limit
- setLogLimit() : AbstractWriter
- Set log limit
- writeLog() : AbstractWriter
- Write to the log
- sanitize() : string
- Strip CR/LF from a value before it's written into a delimited/line-based log format, to prevent an embedded newline from forging a fake extra line (or, for writers that build header-style text like Mail's Subject line, a fake extra header).
Properties
$limit
Log limit, stored as the canonical PSR-3 level string
protected
string|null
$limit
= null
Methods
getContext()
Get context for log
public
getContext([array<string|int, mixed> $context = [] ]) : string
Parameters
- $context : array<string|int, mixed> = []
Return values
stringgetLogLimit()
Get log limit
public
getLogLimit() : string|null
Return values
string|nullhasLogLimit()
Has log limit
public
hasLogLimit() : bool
Return values
boolisWithinLogLimit()
Check if a log level is within the set log level limit
public
isWithinLogLimit(string|int $level) : bool
Parameters
- $level : string|int
Return values
boolsetLogLimit()
Set log limit
public
setLogLimit(string|int $level) : AbstractWriter
Accepts either a PSR-3 level string or a legacy severity int (0-7) for backward compatibility; always normalized and stored as the canonical PSR-3 string.
Parameters
- $level : string|int
Return values
AbstractWriterwriteLog()
Write to the log
public
abstract writeLog(string $level, string $message[, array<string|int, mixed> $context = [] ]) : AbstractWriter
Parameters
- $level : string
- $message : string
- $context : array<string|int, mixed> = []
Return values
AbstractWritersanitize()
Strip CR/LF from a value before it's written into a delimited/line-based log format, to prevent an embedded newline from forging a fake extra line (or, for writers that build header-style text like Mail's Subject line, a fake extra header).
protected
sanitize(string $value) : string
Parameters
- $value : string