Class LoggerAppenderDailyRollingFile

LoggerAppenderFile appends log events to a file.

This appender uses a layout.

Configurable parameters:

file - Path to the target file. Relative paths are resolved based on the working directory.
append - If set to true, the appender will append to the file, otherwise the file contents will be overwritten.

LoggerConfigurable

LoggerAppender

LoggerAppenderFile

LoggerAppenderDailyRollingFile

Package: log4php\appenders
License: Apache License, Version 2.0
Version: $Revision: 1382274 $
Link: Appender documentation
Located at core/log4php/appenders/LoggerAppenderDailyRollingFile.php

Methods summary
`public`	# `append( LoggerLoggingEvent $event )` Appends a logging event. Appends a logging event. If the target file changes because of passage of time (e.g. at midnight) the current file is closed. A new file, with the new date, will be opened by the write() method. Parameters `$event` Overrides `LoggerAppenderFile::append()`
`protected`	# `write( string $string )` Writes a string to the target file. Opens file if not already open. Writes a string to the target file. Opens file if not already open. Parameters `$string` Data to write. Overrides `LoggerAppenderFile::write()`
`public`	# `activateOptions( )` Additional validation for the date pattern. Additional validation for the date pattern. Overrides `LoggerAppenderFile::activateOptions()`
`protected`	# `getDate( $timestamp = null )` Renders the date using the configured `datePattern.` Renders the date using the configured `datePattern.`
`protected`	# `getTargetFile( )` Determines target file. Replaces %s in file path with a date. Determines target file. Replaces %s in file path with a date. Overrides `LoggerAppenderFile::getTargetFile()`
`public`	# `setDatePattern( string $datePattern )` Sets the 'datePattern' parameter. Sets the 'datePattern' parameter. Parameters `$datePattern`
`public string`	# `getDatePattern( )` Returns the 'datePattern' parameter. Returns the 'datePattern' parameter. Returns string
`public integer`	# `getMaximumFileSize( )` Get the maximum size that the output file is allowed to reach before being rolled over to backup files. Get the maximum size that the output file is allowed to reach before being rolled over to backup files. Returns integer
`public`	# `setMaxBackupIndex( integer $maxBackupIndex )` Set the 'maxBackupIndex' parameter. Set the 'maxBackupIndex' parameter. Parameters `$maxBackupIndex`
`public integer`	# `getMaxBackupIndex( )` Returns the 'maxBackupIndex' parameter. Returns the 'maxBackupIndex' parameter. Returns integer
`public`	# `setMaxFileSize( mixed $maxFileSize )` Set the 'maxFileSize' parameter. Set the 'maxFileSize' parameter. Parameters `$maxFileSize`
`public integer`	# `getMaxFileSize( )` Returns the 'maxFileSize' parameter. Returns the 'maxFileSize' parameter. Returns integer
`public`	# `setMaximumFileSize( mixed $maxFileSize )` Set the 'maxFileSize' parameter (kept for backward compatibility). Set the 'maxFileSize' parameter (kept for backward compatibility). Deprecated Use setMaxFileSize() instead. Parameters `$maxFileSize`

Methods inherited from LoggerAppenderFile
`close(), getAppend(), getFile(), getFileName(), openFile(), setAppend(), setFile(), setFileName(), writeWithLocking(), writeWithoutLocking()`

Methods inherited from LoggerAppender
`__construct(), __destruct(), addFilter(), clearFilters(), doAppend(), getDefaultLayout(), getFilter(), getFirstFilter(), getLayout(), getName(), getThreshold(), isAsSevereAsThreshold(), requiresLayout(), setLayout(), setName(), setThreshold(), warn()`

Methods inherited from LoggerConfigurable
`setBoolean(), setFileSize(), setInteger(), setLevel(), setNumeric(), setPositiveInteger(), setString()`

Properties summary
`protected string`	`$datePattern` The 'datePattern' parameter. Determines how date will be formatted in file name. The 'datePattern' parameter. Determines how date will be formatted in file name.	# `"Ymd"`
`protected string`	`$currentDate` Current date which was used when opening a file. Used to determine if a rollover is needed when the date changes. Current date which was used when opening a file. Used to determine if a rollover is needed when the date changes.	#
`protected integer`	`$maxFileSize` The maximum size (in bytes) that the output file is allowed to reach before being rolled over to backup files. The maximum size (in bytes) that the output file is allowed to reach before being rolled over to backup files. The default maximum file size is 10MB (10485760 bytes). Maximum value for this option may depend on the file system.	# `10485760`
`protected integer`	`$maxBackupIndex` Set the maximum number of backup files to keep around. Set the maximum number of backup files to keep around. 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.	# `1`

Properties inherited from LoggerAppenderFile
`$append, $file, $fp, $locking`

Properties inherited from LoggerAppender
`$closed, $filter, $layout, $name, $requiresLayout, $threshold`

Namespaces

Classes

Interfaces

Exceptions

Class LoggerAppenderDailyRollingFile

Configurable parameters:

Parameters

Overrides

Parameters

Overrides

Overrides

Overrides

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Deprecated

Parameters