Docs For Class LoggerAppenderFile

Description

FileAppender appends log events to a file.

This appender uses a layout.

Configurable parameters for this appender are:

file - The target file to write to
filename - The target file to write to (deprecated, use "file" instead)
append - Sets if the appender should append to the end of the file or overwrite content ("true" or "false")

An example php file:

require_once dirname(__FILE__).'/../../main/php/Logger.php';
Logger::configure(dirname(__FILE__).'/../resources/appender_file.properties');
$logger = Logger::getRootLogger();
$logger->debug("Hello World!");

An example configuration file:

log4php.appender.default = LoggerAppenderFile
log4php.appender.default.file = target/examples/file.log
log4php.appender.default.layout = LoggerLayoutTTCC
log4php.rootLogger = DEBUG, default

version: $Revision: 1213663 $

Located in /appenders/LoggerAppenderFile.php (line 43)

LoggerConfigurable
   |
   --LoggerAppender
      |
      --LoggerAppenderFile

Direct descendents

Class	Description
LoggerAppenderRollingFile	LoggerAppenderRollingFile extends LoggerAppenderFile to backup the log files when they reach a certain size.
LoggerAppenderDailyFile	An Appender that automatically creates a new logfile each day.

Variable Summary

boolean $append

string $file

mixed $fp

Method Summary

void activateOptions ()

void append (LoggerLoggingEvent $event)

void close ()

boolean getAppend ()

string getFile ()

string getFileName ()

void setAppend ( $append)

void setFile (string $file)

void setFileName (string $fileName)

Variables

boolean $append = true (line 48)

var: if $file exists, appends events.
access: protected

string $file (line 53)

var: the file name used to append events
access: protected

mixed $fp = false (line 58)

var: file resource
access: protected

Inherited Variables

Inherited from LoggerAppender

LoggerAppender::$closed
LoggerAppender::$filter
LoggerAppender::$layout
LoggerAppender::$name
LoggerAppender::$requiresLayout
LoggerAppender::$threshold

Methods

activateOptions (line 60)

access: public

void activateOptions ()

Redefinition of:

LoggerAppender::activateOptions(): Prepares the appender for logging.

Redefined in descendants as:

LoggerAppenderDailyFile::activateOptions() : Similar to parent method, but but replaces "%s" in the file name with the current date in format specified by the 'datePattern' parameter.

append (line 107)

access: public

void append (LoggerLoggingEvent $event)

LoggerLoggingEvent $event

Redefinition of:

LoggerAppender::append(): Forwards the logging event to the destination.

Redefined in descendants as:

LoggerAppenderRollingFile::append()

close (line 94)

access: public

void close ()

Redefinition of:

LoggerAppender::close(): Releases any resources allocated by the appender.

getAppend (line 136)

access: public

boolean getAppend ()

getFile (line 129)

access: public

string getFile ()

getFileName (line 157)

deprecated: Use getFile() instead.
access: public

string getFileName ()

setAppend (line 140)

access: public

void setAppend ( $append)

$append

setFile (line 122)

Sets the file where the log output will go.

access: public

void setFile (string $file)

string $file

Redefined in descendants as:

LoggerAppenderRollingFile::setFile()

setFileName (line 149)

Sets the file where the log output will go.

deprecated: Use setFile() instead.
access: public

void setFileName (string $fileName)

string $fileName

Inherited Methods

Inherited From LoggerAppender

LoggerAppender::__construct()
LoggerAppender::activateOptions()
LoggerAppender::addFilter()
LoggerAppender::append()
LoggerAppender::clearFilters()
LoggerAppender::close()
LoggerAppender::doAppend()
LoggerAppender::getDefaultLayout()
LoggerAppender::getFilter()
LoggerAppender::getFirstFilter()
LoggerAppender::getLayout()
LoggerAppender::getName()
LoggerAppender::getThreshold()
LoggerAppender::isAsSevereAsThreshold()
LoggerAppender::requiresLayout()
LoggerAppender::setLayout()
LoggerAppender::setName()
LoggerAppender::setThreshold()
LoggerAppender::warn()

Inherited From LoggerConfigurable

LoggerConfigurable::setBoolean()
LoggerConfigurable::setFileSize()
LoggerConfigurable::setInteger()
LoggerConfigurable::setLevel()
LoggerConfigurable::setNumeric()
LoggerConfigurable::setPositiveInteger()
LoggerConfigurable::setString()
LoggerConfigurable::warn()