Class LoggerAppenderFile

(line 25)
LoggerAppender
   |
   --LoggerAppenderFile

Classes extended from LoggerAppenderFile:

LoggerAppenderRollingFile
RollingFileAppender extends FileAppender to backup the log files when they reach a certain size.

Located in File: Program_Root/appender/LoggerAppenderFile.php

FileAppender appends log events to a file.
Class Variable Summary
$fileAppend
Default Value: ->true<-
$fileName
Default Value: -><-
$fp
Default Value: -><-
$requiresLayout
Default Value: ->true<-
Inherited Class Variable Summary
Inherited From Class LoggerAppender
Variable Default Value Description
LoggerAppender::$closed -> <-
LoggerAppender::$errorHandler -> <-
LoggerAppender::$filters ->array() <-
LoggerAppender::$headFilter ->null <-
LoggerAppender::$layout ->null <-
LoggerAppender::$name -> <-
LoggerAppender::$tailFilter ->null <-
LoggerAppender::$threshold -> <-
Method Summary
void constructor LoggerAppenderFile ( $name )
void activateOptions ( )
If the value of File is not null, then setFile(java.lang.String) is called with the values of File and Append properties.
void close ( )
void closeFile ( )
Closes the previously opened file.
void doAppend ( $event )
void getAppend ( )
Returns the value of the Append option.
void getFile ( )
Returns the value of the File option.
void reset ( )
Close any previously opened file and call the parent's reset.
void setAppend ( $flag )
The Append option takes a boolean value.
void setFile ( )
The File property takes a string value which should be the name of the file to append to.
Inherited Method Summary
Inherited From Class LoggerAppender
Function Description
LoggerAppender::LoggerAppender() Constructor
LoggerAppender::addFilter() Add a filter to the end of the filter list.
LoggerAppender::clearFilters() Clear the list of filters by removing all the filters in it.
LoggerAppender::close() Release any resources allocated.
LoggerAppender::doAppend() Log in Appender specific way.
LoggerAppender::factory() Factory
LoggerAppender::getErrorHandler() Returns the ErrorHandler for this appender.
LoggerAppender::getFilter() Returns the head Filter.
LoggerAppender::getLayout() Returns this appender layout.
LoggerAppender::getName() Get the name of this appender.
LoggerAppender::requiresLayout() Configurators call this method to determine if the appender requires a layout.
LoggerAppender::setErrorHandler() Set the ErrorHandler for this appender.
LoggerAppender::setLayout() Set the Layout for this appender.
LoggerAppender::setName() Set the name of this appender.
LoggerAppender::singleton() Singleton
Method Detail

Constructor LoggerAppenderFile

(line 32)

void LoggerAppenderFile( mixed $name)


Function Info:

[ Top ]

activateOptions

(line 40)

void activateOptions( )

If the value of File is not null, then setFile(java.lang.String) is called with the values of File and Append properties.
Function Info:

[ Top ]

close

(line 49)

void close( )

Overrides LoggerAppender::close() (Release any resources allocated.)


Function Info:

[ Top ]

closeFile

(line 60)

void closeFile( )

Closes the previously opened file.
Function Info:

[ Top ]

doAppend

(line 118)

void doAppend( mixed $event)

Overridden in child classes as:

LoggerAppenderRollingFile::doAppend()

Overrides LoggerAppender::doAppend() (Log in Appender specific way.)


Function Info:

[ Top ]

getAppend

(line 70)

void getAppend( )

Returns the value of the Append option.
Function Info:

[ Top ]

getFile

(line 78)

void getFile( )

Returns the value of the File option.
Function Info:

[ Top ]

reset

(line 86)

void reset( )

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

[ Top ]

setAppend

(line 96)

void setAppend( mixed $flag)

The Append option takes a boolean value.
Function Info:

[ Top ]

setFile

(line 105)

void setFile( )

The File property takes a string value which should be the name of the file to append to.

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

Function Info:

[ Top ]

Variable Detail

$fileAppend

(line 29)
Data type: mixed

[ Top ]

$fileName

(line 30)
Data type: mixed

[ Top ]

$fp

(line 27)
Data type: mixed

[ Top ]

$requiresLayout

(line 28)
Data type: mixed

[ Top ]

Documention generated on Thu, 20 Feb 2003 15:43:00 +0100 by phpDocumentor 1.2.0rc1