Class LoggerAppenderRollingFile

Description

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

Parameters are $maxFileSize, $maxBackupIndex.

Contributors: Sergio Strampelli.

  • author: Marco Vassura
  • version: $Revision: 556784 $

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

LoggerAppender
   |
   --LoggerAppenderSkeleton
      |
      --LoggerAppenderFile
         |
         --LoggerAppenderRollingFile
Variable Summary
integer $maxBackupIndex
integer $maxFileSize
Method Summary
LoggerAppenderRollingFile LoggerAppenderRollingFile (string $name)
void append (LoggerLoggingEvent $event)
integer getExpandedFileName ()
integer getMaxBackupIndex ()
integer getMaximumFileSize ()
void rollOver ()
void setFileName ( $fileName)
void setMaxBackupIndex (mixed $maxBackups)
void setMaxFileSize (mixed $value)
void setMaximumFileSize (mixed $maxFileSize)
Variables
integer $maxBackupIndex = 1 (line 65)

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.

There is one backup file by default.

integer $maxFileSize = 10485760 (line 51)

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 a 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.

The default maximum file size is 10MB.

Note that MaxFileSize cannot exceed 2 GB.

Inherited Variables

Inherited from LoggerAppenderSkeleton

LoggerAppenderSkeleton::$closed
LoggerAppenderSkeleton::$errorHandler
LoggerAppenderSkeleton::$headFilter
LoggerAppenderSkeleton::$layout
LoggerAppenderSkeleton::$name
LoggerAppenderSkeleton::$requiresLayout
LoggerAppenderSkeleton::$tailFilter
LoggerAppenderSkeleton::$threshold
Methods
Constructor LoggerAppenderRollingFile (line 78)

Constructor.

LoggerAppenderRollingFile LoggerAppenderRollingFile (string $name)
  • string $name: appender name
append (line 223)
void append (LoggerLoggingEvent $event)

Redefinition of:
LoggerAppenderFile::append()
getExpandedFileName (line 87)

Returns the value of the MaxBackupIndex option.

integer getExpandedFileName ()
getMaxBackupIndex (line 95)

Returns the value of the MaxBackupIndex option.

integer getMaxBackupIndex ()
getMaximumFileSize (line 104)

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

integer getMaximumFileSize ()
rollOver (line 116)

Implements the usual roll over behaviour.

If MaxBackupIndex is positive, then files File.1, ..., File.MaxBackupIndex -1 are renamed to File.2, ..., File.MaxBackupIndex. Moreover, File is renamed File.1 and closed. A new File is created to receive further log output.

If MaxBackupIndex is equal to zero, then the File is truncated with no backup files created.

void rollOver ()
setFileName (line 148)
void setFileName ( $fileName)
  • $fileName

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

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.

void setMaxBackupIndex (mixed $maxBackups)
  • mixed $maxBackups
setMaxFileSize (line 197)

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.

void setMaxFileSize (mixed $value)
  • mixed $value
setMaximumFileSize (line 180)

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::closeFile()
LoggerAppenderFile::getAppend()
LoggerAppenderFile::getFile()
LoggerAppenderFile::getFileName()
LoggerAppenderFile::reset()
LoggerAppenderFile::setAppend()
LoggerAppenderFile::setFile()
LoggerAppenderFile::setFileName()

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