PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of FormattedtextLogger.php

Joomla! Content Management System

Copyright:	(C) 2011 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	297 lines (9 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

FormattedtextLogger:: (7 methods):
  __construct()
  __destruct()
  addEntry()
  formatLine()
  generateFileHeader()
  initFile()
  parseFields()

Class: FormattedtextLogger - X-Ref

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.

__construct(array &$options) X-Ref

Constructor.

param: array &$options Log object options.

__destruct() X-Ref

If deferred, write all pending logs.

addEntry(LogEntry $entry) X-Ref

Method to add an entry to the log.

param: LogEntry $entry The log entry object to add to the log.
return: void

formatLine(LogEntry $entry) X-Ref

Format a line for the log file.

param: LogEntry $entry The log entry to format as a string.
return: String

generateFileHeader() X-Ref

Method to generate the log file header.

return: string The log file header

initFile() X-Ref

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.

return: void

parseFields() X-Ref

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

return: void

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/src/Log/Logger/ -> FormattedtextLogger.php (summary)

Defines 1 class