Logger
Logger
Logger class for handling logging operations with different log levels.
This class provides methods to write log messages with specified log levels, set the logging level, and retrieve the current logging level.
Properties
level
private LogLevel $level = 'LogLevel'prefix
private string $prefix = 'WARLOCK'writer
private LogWriter $writersilent
Allows the logger to be temporarily silent, meaning it will not output any log messages, but
private bool $silentthe log level will still be respected.
This is useful for scenarios where you want to disable logging without changing the log level.
Methods
__construct
public __construct(LogLevel $level = 'LogLevel::INFO', ?LogWriter $writer): voidParameters
| Parameter | Type | Description |
|---|---|---|
$level | LogLevel | |
$writer | LogWriter |
getNewChildLogger
public getNewChildLogger(string $prefix): selfParameters
| Parameter | Type | Description |
|---|---|---|
$prefix | string |
write
Writes a log message with a specified log level.
public write(string $message, LogLevel $level = 'LogLevel::INFO', ?string $prefix): voidParameters
| Parameter | Type | Description |
|---|---|---|
$message | string | The message to log. It can be an array, an instance of stdClass, or a string. |
$level | LogLevel | The log level of the message. Defaults to LogLevel::INFO. |
$prefix | string |
setLevel
Sets the logging level for the logger.
public setLevel(?LogLevel $level = 'LogLevel::INFO'): voidParameters
| Parameter | Type | Description |
|---|---|---|
$level | LogLevel | The logging level to set. Defaults to LogLevel::INFO if not provided. |
getLevel
Get the current logging level.
public getLevel(): LogLevelsetPrefix
Set a prefix for the logger.
public setPrefix(string $prefix): voidParameters
| Parameter | Type | Description |
|---|---|---|
$prefix | string | the prefix to set |
getPrefix
Get the current prefix of the logger.
public getPrefix(): stringsetSilent
Sets the silent mode for the logger.
public setSilent(bool $silent): voidWhen silent mode is enabled, the logger will suppress output without changing the log level.
Parameters
| Parameter | Type | Description |
|---|---|---|
$silent | bool | whether to enable silent mode |
setWriter
Sets the log writer instance to be used by the logger.
public setWriter(LogWriter $writer): voidParameters
| Parameter | Type | Description |
|---|---|---|
$writer | LogWriter | the log writer instance to set |
Generated by Hazaar API Doc Generator on Sun, 01 Mar 2026 09:22:26 +0000