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.

  • layout - Sets the layout class for this appender
  • datePattern - Sets date format for the file name. Should be set before $file!
  • file - The target file name. Should contain a '%s' which gets substituted by the date.
  • 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_dailyfile.properties');
  3.  
  4. $logger Logger::getRootLogger();
  5. $logger->debug("Hello World!");

An example configuration file:

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

The above will create a file like: daily_20090908.log

  • version: $Revision: 883108 $

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

LoggerAppender
   |
   --LoggerAppenderFile
      |
      --LoggerAppenderDailyFile
Variable Summary
string $datePattern
Method Summary
void __destruct ()
string getDatePattern ()
void setDatePattern (string $format)
void setFile ()
Variables
string $datePattern = "Ymd" (line 54)

Format date.

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

  • access: public

Inherited Variables

Inherited from LoggerAppenderFile

LoggerAppenderFile::$fileName
LoggerAppenderFile::$fp

Inherited from LoggerAppender

LoggerAppender::$closed
LoggerAppender::$filter
LoggerAppender::$layout
LoggerAppender::$name
LoggerAppender::$requiresLayout
LoggerAppender::$threshold
Methods
Destructor __destruct (line 56)
  • access: public
void __destruct ()

Redefinition of:
LoggerAppenderFile::__destruct()
getDatePattern (line 71)
  • return: returns date format for the filename
  • access: public
string getDatePattern ()
setDatePattern (line 64)

Sets date format for the file name.

  • access: public
void setDatePattern (string $format)
  • string $format: a regular date() string format
setFile (line 81)

The File property takes a string value which should be the name of the file to append to.

Sets and opens the file where the log output will go.

void setFile ()

Redefinition of:
LoggerAppenderFile::setFile()
Sets and opens the file where the log output will go.

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