Docs For Class LoggerAppenderFile

Description

FileAppender appends log events to a file.

FileAppender appends log events to a file. Parameters are $file, $append.

version: $Revision: 1.9 $
author: VxR <mailto:vxr@vxr.it>

Located in Program_Root/src/log4php/appenders/LoggerAppenderFile.php (line 31)

LoggerAppenderSkeleton
   |
   --LoggerAppenderFile

Direct descendents

Class	Description
LoggerAppenderDailyFile	LoggerAppenderDailyFile appends log events to a file ne.
LoggerAppenderRollingFile	LoggerAppenderRollingFile extends LoggerAppenderFile to backup the log files when they reach a certain size.

Variable Summary

boolean $append

mixed $file

mixed $fp

mixed $requiresLayout

Method Summary

LoggerAppenderFile LoggerAppenderFile (mixed $name)

void activateOptions ()

void append (mixed $event)

void close ()

void closeFile ()

void getAppend ()

void getFile ()

void reset ()

void setAppend (mixed $flag)

void setFile ()

Variables

boolean $append = true (line 36)

var: if $file exists, appends events.

mixed $file (line 37)

mixed $fp (line 39)

mixed $requiresLayout = true (line 40)

Redefinition of:

LoggerAppenderSkeleton::$requiresLayout

Inherited Variables

Inherited from LoggerAppenderSkeleton

LoggerAppenderSkeleton::$closed
LoggerAppenderSkeleton::$errorHandler
LoggerAppenderSkeleton::$headFilter
LoggerAppenderSkeleton::$layout
LoggerAppenderSkeleton::$name
LoggerAppenderSkeleton::$tailFilter
LoggerAppenderSkeleton::$threshold

Methods

Constructor LoggerAppenderFile (line 42)

LoggerAppenderFile LoggerAppenderFile (mixed $name)

activateOptions (line 47)

void activateOptions ()

Redefinition of:

LoggerAppenderSkeleton::activateOptions()

append (line 122)

void append (mixed $event)

Redefinition of:

LoggerAppenderSkeleton::append()

Subclasses of


1     LoggerAppenderSkeleton

should implement this method to perform actual logging.

Redefined in descendants as:

LoggerAppenderRollingFile::append()

close (line 59)

void close ()

Redefinition of:

LoggerAppenderSkeleton::close(): Release any resources allocated.

closeFile (line 70)

Closes the previously opened file.

void closeFile ()

getAppend (line 77)

void getAppend ()

getFile (line 82)

void getFile ()

reset (line 90)

Close any previously opened file and call the parent's reset.

void reset ()

setAppend (line 97)

void setAppend (mixed $flag)

setFile (line 109)

Sets and opens the file where the log output will go.

Sets and opens the file where the log output will go. This is an overloaded method. It can be called with:

setFile($fileName) to set filename.
setFile($fileName, $append) to set filename and append.

void setFile ()

Redefined in descendants as:

LoggerAppenderDailyFile::setFile() : The File property takes a string value which should be the name of the file to append to.

Inherited Methods

Inherited From LoggerAppenderSkeleton

LoggerAppenderSkeleton::LoggerAppenderSkeleton()
LoggerAppenderSkeleton::activateOptions()
LoggerAppenderSkeleton::addFilter()
LoggerAppenderSkeleton::append()
LoggerAppenderSkeleton::clearFilters()
LoggerAppenderSkeleton::close()
LoggerAppenderSkeleton::doAppend()
LoggerAppenderSkeleton::finalize()
LoggerAppenderSkeleton::getErrorHandler()
LoggerAppenderSkeleton::getFilter()
LoggerAppenderSkeleton::getFirstFilter()
LoggerAppenderSkeleton::getLayout()
LoggerAppenderSkeleton::getName()
LoggerAppenderSkeleton::getThreshold()
LoggerAppenderSkeleton::isAsSevereAsThreshold()
LoggerAppenderSkeleton::requiresLayout()
LoggerAppenderSkeleton::setErrorHandler()
LoggerAppenderSkeleton::setLayout()
LoggerAppenderSkeleton::setName()
LoggerAppenderSkeleton::setThreshold()