Class LoggerAppenderFile

Description

FileAppender appends log events to a file.

Parameters are ($fileName but option name is file), $append.

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

LoggerAppender
   |
   --LoggerAppenderSkeleton
      |
      --LoggerAppenderFile
Direct descendents
Class Description
LoggerAppenderRollingFile LoggerAppenderRollingFile extends LoggerAppenderFile to backup the log files when they reach a certain size.
LoggerAppenderDailyFile LoggerAppenderDailyFile appends log events to a file ne.
Method Summary
LoggerAppenderFile __construct ( $name)
void activateOptions ()
void append ( $event)
void close ()
void closeFile ()
boolean getAppend ()
string getFile ()
string getFileName ()
void reset ()
void setAppend ( $flag)
void setFile ()
void setFileName ( $fileName)
Variables
Methods
Constructor __construct (line 49)
  • access: public
LoggerAppenderFile __construct ( $name)
  • $name

Redefinition of:
LoggerAppenderSkeleton::__construct()
Constructor
activateOptions (line 54)
  • access: public
void activateOptions ()

Redefinition of:
LoggerAppenderSkeleton::activateOptions()
Derived appenders should override this method if option structure requires it.
append (line 142)
  • access: public
void append ( $event)
  • $event

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

Redefined in descendants as:
close (line 68)
  • access: public
void close ()

Redefinition of:
LoggerAppender::close()
Release any resources allocated.
closeFile (line 80)

Closes the previously opened file.

  • access: public
void closeFile ()
getAppend (line 88)
  • access: public
boolean getAppend ()
getFile (line 95)
  • access: public
string getFile ()
getFileName (line 102)
  • access: public
string getFileName ()
reset (line 109)

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

  • access: public
void reset ()
setAppend (line 115)
  • access: public
void setAppend ( $flag)
  • $flag
setFile (line 126)

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.

  • access: public
void setFile ()

Redefined in descendants as:
setFileName (line 138)
  • access: public
void setFileName ( $fileName)
  • $fileName

Redefined in descendants as:

Inherited Methods

Inherited From LoggerAppenderSkeleton

LoggerAppenderSkeleton::__construct()
LoggerAppenderSkeleton::activateOptions()
LoggerAppenderSkeleton::addFilter()
LoggerAppenderSkeleton::append()
LoggerAppenderSkeleton::clearFilters()
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()
LoggerAppenderSkeleton::__sleep()
LoggerAppenderSkeleton::__wakeup()

Inherited From LoggerAppender

LoggerAppender::addFilter()
LoggerAppender::clearFilters()
LoggerAppender::close()
LoggerAppender::doAppend()
LoggerAppender::factory()
LoggerAppender::getErrorHandler()
LoggerAppender::getFilter()
LoggerAppender::getLayout()
LoggerAppender::getName()
LoggerAppender::requiresLayout()
LoggerAppender::setErrorHandler()
LoggerAppender::setLayout()
LoggerAppender::setName()
LoggerAppender::singleton()

Documentation generated by phpDocumentor 1.3.2