Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Référence de la classe FormattedtextLogger
+ Graphe d'héritage de FormattedtextLogger:

Fonctions membres publiques

 __construct (array &$options)
 
 __destruct ()
 
 addEntry (LogEntry $entry)
 
- Fonctions membres publiques hérités de Logger
 __construct (array &$options)
 
 addEntry (LogEntry $entry)
 

Fonctions membres protégées

 formatLine (LogEntry $entry)
 
 generateFileHeader ()
 
 initFile ()
 
 parseFields ()
 

Attributs protégés

 $format = '{DATETIME} {PRIORITY} {CLIENTIP} {CATEGORY} {MESSAGE}'
 
 $fields = array()
 
 $path
 
 $defer = false
 
 $deferredEntries = array()
 
- Attributs protégés hérités de Logger
 $options = array()
 
 $priorities
 

Description détaillée

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.

Depuis
1.7.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( array &  $options)

Constructor.

Paramètres
array&$optionsLog object options.
Depuis
1.7.0

Références Logger\$options.

◆ __destruct()

__destruct ( )

If deferred, write all pending logs.

Depuis
3.9.0

Documentation des fonctions membres

◆ addEntry()

addEntry ( LogEntry  $entry)

Method to add an entry to the log.

Paramètres
LogEntry$entryThe log entry object to add to the log.
Renvoie
void
Depuis
1.7.0
Exceptions

◆ formatLine()

formatLine ( LogEntry  $entry)
protected

Format a line for the log file.

Paramètres
JLogEntry$entryThe log entry to format as a string.
Renvoie
String
Depuis
3.9.0

Références $field, $format, $tmp, et fields.

◆ generateFileHeader()

generateFileHeader ( )
protected

Method to generate the log file header.

Renvoie
string The log file header
Depuis
1.7.0

Références JPlatform\getLongVersion().

◆ initFile()

initFile ( )
protected

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.

Renvoie
void
Depuis
1.7.0
Exceptions

◆ parseFields()

parseFields ( )
protected

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

Renvoie
void
Depuis
1.7.0

Références fields.

Documentation des champs

◆ $defer

$defer = false
protected

◆ $deferredEntries

$deferredEntries = array()
protected

◆ $fields

$fields = array()
protected

◆ $format

$format = '{DATETIME} {PRIORITY} {CLIENTIP} {CATEGORY} {MESSAGE}'
protected

◆ $path

$path
protected

La documentation de cette classe a été générée à partir du fichier suivant :