File
extends AbstractWriter
in package
File log writer class
Tags
Table of Contents
- $file : string
- Log file
- $limit : int
- Log limit
- $type : string
- Log file type
- __construct() : mixed
- Constructor
- getContext() : string
- Get context for log
- getLogLimit() : int
- 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() : File
- Write to the log
Properties
$file
Log file
protected
string
$file
= null
$limit
Log limit
protected
int
$limit
= null
$type
Log file type
protected
string
$type
= null
Methods
__construct()
Constructor
public
__construct(string $file) : mixed
Instantiate the file writer object
Parameters
- $file : string
Return values
mixed —getContext()
Get context for log
public
getContext([array<string|int, mixed> $context = [] ]) : string
Parameters
- $context : array<string|int, mixed> = []
Return values
string —getLogLimit()
Get log limit
public
getLogLimit() : int
Return values
int —hasLogLimit()
Has log limit
public
hasLogLimit() : bool
Return values
bool —isWithinLogLimit()
Check if a log level is within the set log level limit
public
isWithinLogLimit(int $level) : bool
Parameters
- $level : int
Return values
bool —setLogLimit()
Set log limit
public
setLogLimit(int $level) : AbstractWriter
Parameters
- $level : int
Return values
AbstractWriter —writeLog()
Write to the log
public
writeLog(mixed $level, string $message[, array<string|int, mixed> $context = [] ]) : File
Parameters
- $level : mixed
- $message : string
- $context : array<string|int, mixed> = []