RollingFile
- AppenderFile
RollingFile extends AppenderFile
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Constant summary
Property summary
Modifier and Type | Property |
---|---|
protected | maxFileSize |
protected integer | maxBackupIndex |
protected boolean | compress |
Methods summary
Modifier and Type | Method |
---|---|
public integer | getMaximumFileSize ( ) |
public | __construct ( unknown name = '' ) |
protected | write ( string string ) |
public | activateOptions ( ) |
public | setMaxBackupIndex ( integer maxBackupIndex ) |
public integer | getMaxBackupIndex ( ) |
public | setMaxFileSize ( mixed maxFileSize ) |
public integer | getMaxFileSize ( ) |
public | setMaximumFileSize ( mixed maxFileSize ) |
public | setCompress ( boolean compress ) |
public | getCompress ( ) |
Constants in detail
-
COMPRESS_CHUNK_SIZE
const COMPRESS_CHUNK_SIZE
Properties in detail
-
maxFileSize
protected maxFileSize
-
maxBackupIndex
protected integer maxBackupIndex
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</var>. There is one backup file by default.var
integer -
compress
protected boolean compress
The compress</var> parameter determindes the compression with zlib. If set to true, the rollover files are compressed and saved with the .gz extension.var
boolean
Methods in detail
-
getMaximumFileSize
integer public getMaximumFileSize ( )Get the maximum size that the output file is allowed to reach before being rolled over to backup files.return
integer -
__construct
public __construct ( unknown name = '' ) -
write
protected write ( string string )Writes a string to the target file. Opens file if not already open.param
string string Data to write. -
activateOptions
public activateOptions ( ) -
setMaxBackupIndex
public setMaxBackupIndex ( integer maxBackupIndex )Set the 'maxBackupIndex' parameter.param
integer maxBackupIndex -
getMaxBackupIndex
integer public getMaxBackupIndex ( )Returns the 'maxBackupIndex' parameter.return
integer -
setMaxFileSize
public setMaxFileSize ( mixed maxFileSize )Set the 'maxFileSize' parameter.param
mixed maxFileSize -
getMaxFileSize
integer public getMaxFileSize ( )Returns the 'maxFileSize' parameter.return
integer -
setMaximumFileSize
public setMaximumFileSize ( mixed maxFileSize )Set the 'maxFileSize' parameter (kept for backward compatibility).param
mixed maxFileSizedeprecated
deprecated -
setCompress
public setCompress ( boolean compress )Sets the 'compress' parameter.param
boolean compress -
getCompress
public getCompress ( )Returns the 'compress' parameter.param
boolean