Class LoggerAppenderFile

Description

FileAppender appends log events to a file.

Configurable parameters for this appender are:

  • layout - Sets the layout class for this appender
  • file - The target file to write to
  • filename - The target file to write to
  • append - Sets if the appender should append to the end of the file or overwrite content ("true" or "false")
An example php file:

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

An example configuration file:

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

  • version: $Revision: 883108 $

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

LoggerAppender
   |
   --LoggerAppenderFile
Direct descendents
Class Description
LoggerAppenderDailyFile An Appender that automatically creates a new logfile each day.
LoggerAppenderRollingFile LoggerAppenderRollingFile extends LoggerAppenderFile to backup the log files when they reach a certain size.
Variable Summary
string $fileName
mixed $fp
Method Summary
LoggerAppenderFile __construct ([ $name = ''])
void __destruct ()
void activateOptions ()
void append (LoggerLoggingEvent $event)
void close ()
boolean getAppend ()
string getFile ()
string getFileName ()
void setAppend ( $flag)
void setFile ()
void setFileName ( $fileName)
Variables
string $fileName (line 52)
  • var: the file name used to append events
  • access: protected
mixed $fp = false (line 56)
  • var: file resource
  • access: protected

Inherited Variables

Inherited from LoggerAppender

LoggerAppender::$closed
LoggerAppender::$filter
LoggerAppender::$layout
LoggerAppender::$name
LoggerAppender::$requiresLayout
LoggerAppender::$threshold
Methods
Constructor __construct (line 58)
  • access: public
LoggerAppenderFile __construct ([ $name = ''])
  • $name

Redefinition of:
LoggerAppender::__construct()
Constructor
Destructor __destruct (line 63)
  • access: public
void __destruct ()

Redefined in descendants as:
activateOptions (line 67)
  • access: public
void activateOptions ()

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

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

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

Redefinition of:
LoggerAppender::close()
Release any resources allocated.
getAppend (line 150)
  • access: public
boolean getAppend ()
getFile (line 143)
  • access: public
string getFile ()
getFileName (line 165)
  • access: public
string getFileName ()
setAppend (line 154)
  • access: public
void setAppend ( $flag)
  • $flag
setFile (line 128)

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.
TODO: remove overloading. Use only file as alias to filename

  • access: public
void setFile ()

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

Redefined in descendants as:

Inherited Methods

Inherited From LoggerAppender

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

Documentation generated on Fri, 27 Nov 2009 07:44:47 +0100 by phpDocumentor 1.4.3