FormattedtextLogger
Extends LoggerJoomla! Formatted Text File Log class
This class is designed to use as a base for building formatted text files for output. By default it emulates the Syslog style format output. This is a disk based output format.
| since |
1.7.0 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Constructor.
__construct(mixed||string|int &options) :
| since |
1.7.0 |
|---|
Arguments
- options
array<string|int, mixed>Log object options.
Response
mixed
__destruct
If deferred, write all pending logs.
__destruct() :
| since |
3.9.0 |
|---|
Response
mixed
addEntry
Method to add an entry to the log.
addEntry(\Joomla\CMS\Log\LogEntry entry) :
| since |
1.7.0 |
|---|---|
| throws |
|
Arguments
- entry
LogEntryThe log entry object to add to the log.
Response
void
formatLine
Format a line for the log file.
formatLine(\Joomla\CMS\Log\LogEntry entry) :
generateFileHeader
Method to generate the log file header.
generateFileHeader() :
| since |
1.7.0 |
|---|
Response
stringThe log file header
initFile
Method to initialise the log file. This will create the folder path to the file if it doesn't already exist and also get a new file header if the file doesn't already exist. If the file already exists it will simply open it for writing.
initFile() :
| since |
1.7.0 |
|---|---|
| throws |
|
Response
void
parseFields
Method to parse the format string into an array of fields.
parseFields() :
| since |
1.7.0 |
|---|
Response
void
Properties
options
Options array for the Log instance.
| since |
3.0.1 |
|---|
Type(s)
array<string|int, mixed>
priorities
Translation array for LogEntry priorities to text strings.
| since |
3.0.1 |
|---|
Type(s)
array<string|int, mixed>
format
The format which each entry follows in the log file.
All fields must be named in all caps and be within curly brackets eg. {FOOBAR}.
| since |
1.7.0 |
|---|
Type(s)
string
fields
The parsed fields from the format string.
| since |
1.7.0 |
|---|
Type(s)
array<string|int, mixed>
path
The full filesystem path for the log file.
| since |
1.7.0 |
|---|
Type(s)
string
defer
If true, all writes will be deferred as long as possible.
NOTE: Deferred logs may never be written if the application encounters a fatal error.
| since |
3.9.0 |
|---|
Type(s)
bool
deferredEntries
If deferring, entries will be stored here prior to writing.
| since |
3.9.0 |
|---|
Type(s)
array<string|int, mixed>