Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 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)
 
 addEntry (LogEntry $entry)
 
- Fonctions membres publiques hérités de Logger
 __construct (array &$options)
 
 addEntry (LogEntry $entry)
 

Fonctions membres protégées

 generateFileHeader ()
 
 initFile ()
 
 parseFields ()
 

Attributs protégés

 $format = '{DATETIME} {PRIORITY} {CLIENTIP} {CATEGORY} {MESSAGE}'
 
 $fields = array()
 
 $path
 
- 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
11.1

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( array &  $options)

Constructor.

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

Références Logger\$options.

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
11.1
Exceptions

Références $field, $format, $tmp, JFile\append(), elseif, et fields.

◆ generateFileHeader()

generateFileHeader ( )
protected

Method to generate the log file header.

Renvoie
string The log file header
Depuis
11.1

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
11.1
Exceptions

Références JFolder\create(), JFile\exists(), et JFile\write().

◆ parseFields()

parseFields ( )
protected

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

Renvoie
void
Depuis
11.1

Références fields.

Documentation des champs

◆ $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 :