Class LoggerAppenderRollingFile

Description

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

Parameters 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")
  • maxBackupIndex - Set the maximum number of backup files to keep around (int)
  • maxFileSize - Set the maximum size that the output file is allowed to reach before being rolled over to backup files. Suffixes like "KB", "MB" or "GB" are allowed, f. e. "10KB" is interpreted as 10240
  • maximumFileSize - Alias to MaxFileSize
<p>Contributors: Sergio Strampelli.</p>

An example:

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

  1. log4php.appender.default = LoggerAppenderSocket
  2. log4php.appender.default.layout = LoggerLayoutSimple
  3. log4php.appender.default.remoteHost = localhost
  4. log4php.appender.default.port = 4242
  5. log4php.appender.default.useXml = true
  6. log4php.appender.default.locationInfo = false
  7. log4php.rootLogger = DEBUG, default

  • version: $Revision: 883108 $

Located in /appenders/LoggerAppenderRollingFile.php (line 49)

LoggerAppender
   |
   --LoggerAppenderFile
      |
      --LoggerAppenderRollingFile
Method Summary
void __destruct ()
void append (LoggerLoggingEvent $event)
void setFileName ( $fileName)
void setMaxBackupIndex (mixed $maxBackups)
the setMaxFileSize (mixed $value)
void setMaximumFileSize (mixed $maxFileSize)
Variables
Methods
Destructor __destruct (line 89)
  • access: public
void __destruct ()

Redefinition of:
LoggerAppenderFile::__destruct()
append (line 224)
  • access: public
void append (LoggerLoggingEvent $event)

Redefinition of:
LoggerAppenderFile::append()
setFileName (line 148)
  • access: public
void setFileName ( $fileName)
  • $fileName

Redefinition of:
LoggerAppenderFile::setFileName()
setMaxBackupIndex (line 169)

Set the maximum number of backup files to keep around.

The MaxBackupIndex option determines how many backup files are kept before the oldest is erased. This option takes a positive integer value. If set to zero, then there will be no backup files and the log file will be truncated when it reaches MaxFileSize.

  • access: public
void setMaxBackupIndex (mixed $maxBackups)
  • mixed $maxBackups
setMaxFileSize (line 200)

Set the maximum size that the output file is allowed to reach before being rolled over to backup files.

In configuration files, the MaxFileSize option takes an long integer in the range 0 - 2^63. You can specify the value with the suffixes "KB", "MB" or "GB" so that the integer is interpreted being expressed respectively in kilobytes, megabytes or gigabytes. For example, the value "10KB" will be interpreted as 10240.

  • return: actual file size set
  • access: public
the setMaxFileSize (mixed $value)
  • mixed $value
setMaximumFileSize (line 183)

Set the maximum size that the output file is allowed to reach before being rolled over to backup files.

void setMaximumFileSize (mixed $maxFileSize)
  • mixed $maxFileSize

Inherited Methods

Inherited From LoggerAppenderFile

LoggerAppenderFile::__construct()
LoggerAppenderFile::activateOptions()
LoggerAppenderFile::append()
LoggerAppenderFile::close()
LoggerAppenderFile::getAppend()
LoggerAppenderFile::getFile()
LoggerAppenderFile::getFileName()
LoggerAppenderFile::setAppend()
LoggerAppenderFile::setFile()
LoggerAppenderFile::setFileName()
LoggerAppenderFile::__destruct()

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:48 +0100 by phpDocumentor 1.4.3