Docs For Class LoggerAppenderFile

Description

FileAppender appends log events to a file.

FileAppender appends log events to a file. Parameters are ($fileName but option name is file), $append.

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

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

LoggerAppender
   |
   --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

string $fileName

Method Summary

LoggerAppenderFile LoggerAppenderFile (string $name)

void activateOptions ()

void append (mixed $event)

void close ()

void closeFile ()

boolean getAppend ()

string getFile ()

string getFileName ()

void reset ()

void setAppend (mixed $flag)

void setFile ()

void setFileName (mixed $fileName)

Variables

boolean $append = true (line 46)

var: if $file exists, appends events.

string $fileName (line 51)

var: the file name used to append events

Inherited Variables

Inherited from LoggerAppenderSkeleton

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

Methods

Constructor LoggerAppenderFile (line 69)

Constructor.

LoggerAppenderFile LoggerAppenderFile (string $name)

string $name: appender name

activateOptions (line 74)

void activateOptions ()

Redefinition of:

LoggerAppenderSkeleton::activateOptions(): Called after the appender paramters are set with setter methods.

append (line 172)

void append (mixed $event)

Redefinition of:

LoggerAppenderSkeleton::append(): Subclasses of LoggerAppenderSkeleton should implement this method to perform actual logging.

Redefined in descendants as:

LoggerAppenderRollingFile::append()

close (line 88)

void close ()

Redefinition of:

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

closeFile (line 99)

Closes the previously opened file.

void closeFile ()

getAppend (line 109)

boolean getAppend ()

getFile (line 117)

string getFile ()

getFileName (line 125)

string getFileName ()

reset (line 133)

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

void reset ()

setAppend (line 140)

void setAppend (mixed $flag)

setFile (line 154)

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(string $fileName) to set filename.
setFile(string $fileName, boolean $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.

setFileName (line 167)

void setFileName (mixed $fileName)

Redefined in descendants as:

LoggerAppenderRollingFile::setFileName()

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()

Inherited From LoggerAppender

LoggerAppender::factory()
LoggerAppender::singleton()