Class JLogLoggerFormattedtext

Joomla! 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.

JLogLogger

JLogLoggerFormattedtext

Direct known subclasses

JLogLoggerW3c

Package: Joomla\Platform\Log
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Located at joomla/log/logger/formattedtext.php

Methods summary

`public`	# `__construct( array & $options )` Constructor. Constructor. Parameters `$options` `array` - &$options Log object options. Since 11.1 Overrides `JLogLogger::__construct`
`public`	# `addEntry( JLogEntry $entry )` Method to add an entry to the log. Method to add an entry to the log. Parameters `$entry` `JLogEntry` - $entry The log entry object to add to the log. Throws `RuntimeException` Since 11.1
`protected string`	# `generateFileHeader( )` Method to generate the log file header. Method to generate the log file header. Returns `string` - The log file header Since 11.1
`protected`	# `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. 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. Throws `RuntimeException` Since 11.1
`protected`	# `parseFields( )` Method to parse the format string into an array of fields. Method to parse the format string into an array of fields. Since 11.1

Magic methods summary

Properties summary

`protected string`	`$format`	# The format which each entry follows in the log file. 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 11.1
`protected array`	`$fields`	# The parsed fields from the format string. The parsed fields from the format string. Since 11.1
`protected string`	`$path`	# The full filesystem path for the log file. The full filesystem path for the log file. Since 11.1

Properties inherited from JLogLogger

$options, $priorities

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JLogLoggerFormattedtext

Direct known subclasses

Methods summary

Parameters

Since

Overrides

Parameters

Throws

Since

Returns

Since

Throws

Since

Since

Magic methods summary

Properties summary

Since

Since

Since

Properties inherited from JLogLogger