JLoggerFormattedText
Extends \JLoggerJoomla! 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.
| package |
Joomla.Platform |
|---|---|
| subpackage |
Log |
| since |
11.1 |
Methods
__construct
Constructor.
__construct(array &$options)
| since |
11.1 |
|---|
Arguments
- $options
array
__destruct
Destructor.
__destruct()
| since |
11.1 |
|---|
addEntry
Method to add an entry to the log.
addEntry(\JLogEntry $entry) : void
generateFileHeader
Method to generate the log file header.
generateFileHeader() : string
| since |
11.1 |
|---|
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() : void
| since |
11.1 |
|---|
parseFields
Method to parse the format string into an array of fields.
parseFields() : void
| since |
11.1 |
|---|
Properties
file
The file pointer for the log file.
| since |
11.1 |
|---|
Type(s)
resource
format
The format for which each entry follows in the log file. All fields must be named in all caps and be within curly brackets eg. {FOOBAR}.
| since |
11.1 |
|---|
Type(s)
string
fields
The parsed fields from the format string.
| since |
11.1 |
|---|
Type(s)
array
path
The full filesystem path for the log file.
| since |
11.1 |
|---|
Type(s)
string
priorities
Translation array for JLogEntry priorities to text strings.
| since |
11.1 |
|---|
Type(s)
array
options
Options array for the JLog instance.
| since |
11.1 |
|---|
Type(s)
array