InMemoryLogWriter extends AbstractWriter implements SingletonInterface
Log writer that writes the log records into a static public class variable for InMemory processing. Note this implements SingletonInterface so multiple calls to this class can accumulate log records in the same instance.
Table of Contents
Interfaces
- SingletonInterface
- "empty" interface for singletons (marker interface pattern)
Methods
- __construct() : mixed
- Constructs this log writer
- __wakeup() : mixed
- Deny object deserialization.
- getLogEntries() : array<string|int, LogRecord>
- writeLog() : WriterInterface
- Writes the log record
- formatContextValue() : string
- Escape or quote a value from the context appropriate for the output.
- formatException() : string
- Formats an exception into a string.
- interpolate() : string
- Interpolates context values into the message placeholders.
Methods
__construct()
Constructs this log writer
public
__construct([array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $options : array<string|int, mixed> = []
-
Configuration options - depends on the actual log writer
Tags
__wakeup()
Deny object deserialization.
public
__wakeup() : mixed
getLogEntries()
public
getLogEntries() : array<string|int, LogRecord>
Return values
array<string|int, LogRecord>writeLog()
Writes the log record
public
writeLog(LogRecord $record) : WriterInterface
Parameters
- $record : LogRecord
-
Log record
Return values
WriterInterface —$this
formatContextValue()
Escape or quote a value from the context appropriate for the output.
protected
formatContextValue(string $value) : string
Note: In some output cases, escaping should not be done here but later on output, such as if it's being written to a database for later display.
Parameters
- $value : string
Return values
stringformatException()
Formats an exception into a string.
protected
formatException(Throwable $ex) : string
The format here is nearly the same as just casting an exception to a string, but omits the full class namespace and stack trace, as those get very long.
Parameters
- $ex : Throwable
Return values
stringinterpolate()
Interpolates context values into the message placeholders.
protected
interpolate(string $message[, array<string|int, mixed> $context = [] ]) : string
Parameters
- $message : string
- $context : array<string|int, mixed> = []