Docs For Class LoggerAppenderDailyFile

Description

An Appender that automatically creates a new logfile each day.

The file is rolled over once a day. That means, for each day a new file is created. A formatted version of the date pattern is used as to create the file name using the http://www.php.net/sprintf function.

This appender uses a layout.

Configurable parameters for this appender are:

datePattern - The date format for the file name. Should be set before $file. Default value: "Ymd".
file - The path to the target log file. The filename should contain a '%s' which will be substituted by the date.
append - Sets if the appender should append to the end of the file or overwrite content ("true" or "false"). Default value: true.

An example php file:

require_once dirname(__FILE__).'/../../main/php/Logger.php';
Logger::configure(dirname(__FILE__).'/../resources/appender_dailyfile.properties');
$logger = Logger::getRootLogger();
$logger->debug("Hello World!");

An example configuration file:

log4php.appender.default = LoggerAppenderDailyFile
log4php.appender.default.layout = LoggerLayoutTTCC
log4php.appender.default.datePattern = Ymd
log4php.appender.default.file = target/examples/daily_%s.log
log4php.rootLogger = DEBUG, default

The above will create a file like: daily_20090908.log

version: $Revision: 1213283 $

Located in /appenders/LoggerAppenderDailyFile.php (line 53)

LoggerConfigurable
   |
   --LoggerAppender
      |
      --LoggerAppenderFile
         |
         --LoggerAppenderDailyFile

Variable Summary

string $datePattern

Method Summary

void activateOptions ()

string getDatePattern ()

void setDatePattern (string $datePattern)

Variables

string $datePattern = "Ymd" (line 60)

Format date.

It follows the http://www.php.net/date() formatting rules and should always be set before $file param.

access: protected

Inherited Variables

Inherited from LoggerAppenderFile

LoggerAppenderFile::$append
LoggerAppenderFile::$file
LoggerAppenderFile::$fp

Inherited from LoggerAppender

LoggerAppender::$closed
LoggerAppender::$filter
LoggerAppender::$layout
LoggerAppender::$name
LoggerAppender::$requiresLayout
LoggerAppender::$threshold

Methods

activateOptions (line 81)

Similar to parent method, but but replaces "%s" in the file name with the current date in format specified by the 'datePattern' parameter.

access: public

void activateOptions ()

Redefinition of:

LoggerAppenderFile::activateOptions()

getDatePattern (line 73)

return: returns date format for the filename
access: public

string getDatePattern ()

setDatePattern (line 66)

Sets date format for the file name.

access: public

void setDatePattern (string $datePattern)

string $datePattern: a regular date() string format

Inherited Methods

Inherited From LoggerAppenderFile

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

Inherited From LoggerAppender

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

Inherited From LoggerConfigurable

LoggerConfigurable::setBoolean()
LoggerConfigurable::setFileSize()
LoggerConfigurable::setInteger()
LoggerConfigurable::setLevel()
LoggerConfigurable::setNumeric()
LoggerConfigurable::setPositiveInteger()
LoggerConfigurable::setString()
LoggerConfigurable::warn()