Formattedtext

Extends \Joomla\Log\AbstractLogger

Joomla! Formatted Text File Log class

deprecated

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.0

deprecated

The joomla/log package is deprecated

Methods

__construct

Constructor.

__construct(array &$options) 
inherited
since

1.0

Arguments

$options

array

__destruct

Destructor.

__destruct() 
since

1.0

addEntry

Method to add an entry to the log.

addEntry(\Joomla\Log\LogEntry $entry) : void
inherited abstract
since

1.0

Arguments

$entry

\Joomla\Log\LogEntryThe log entry object to add to the log.

generateFileHeader

Method to generate the log file header.

generateFileHeader() : string
since

1.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() : void
since

1.0

throws

\RuntimeException

parseFields

Method to parse the format string into an array of fields.

parseFields() : void
since

1.0

Properties

file

The file pointer for the log file.

since

1.0

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

1.0

Type(s)

string

fields

The parsed fields from the format string.

since

1.0

Type(s)

array

path

The full filesystem path for the log file.

since

1.0

Type(s)

string

options

Options array for the Log instance.

inherited
since

1.0

Type(s)

array

priorities

Translation array for LogEntry priorities to text strings.

inherited
since

1.0

Type(s)

array