Documentation

RotatingFileHandler extends StreamHandler

in package

• Application

Stores logs to files that are rotated every day and a limited number of files are kept.

Tags

author

Christophe Coevoet stof@notk.org

author

Jordi Boggiano j.boggiano@seld.be

Table of Contents

Constants

FILE_PER_DAY  = 'Y-m-d'

FILE_PER_MONTH  = 'Y-m'

FILE_PER_YEAR  = 'Y'

DEFAULT_CHUNK_SIZE  = 10 * 1024 * 1024

MAX_CHUNK_SIZE  = 2147483647

Properties

$bubble  : bool

$dateFormat  : string

$filename  : string

$filenameFormat  : string

$fileOpenMode  : string

$filePermission  : int|null

$formatter  : FormatterInterface|null

$level  : int

$maxFiles  : int

$mustRotate  : bool

$nextRotation  : DateTimeImmutable

$processors  : array<string|int, callable>

$stream  : resource|null

$streamChunkSize  : int

$url  : string|null

$useLocking  : bool

Methods

__construct()  : mixed

__destruct()  : mixed

__sleep()  : mixed

close()  : void

Closes the handler.

getBubble()  : bool

Gets the bubbling behavior.

getFormatter()  : FormatterInterface

{@inheritDoc}

getLevel()  : int

Gets minimum logging level at which this handler will be triggered.

getStream()  : resource|null

Return the currently active stream if it is open

getStreamChunkSize()  : int

getUrl()  : string|null

Return the stream URL if it was configured with a URL and not an active resource

handle()  : bool

Handles a record.

handleBatch()  : void

Handles a set of records at once.

isHandling()  : bool

Checks whether the given record will be handled by this handler.

popProcessor()  : callable

{@inheritDoc}

pushProcessor()  : HandlerInterface

{@inheritDoc}

reset()  : void

setBubble()  : self

Sets the bubbling behavior.

setFilenameFormat()  : self

setFormatter()  : HandlerInterface

{@inheritDoc}

setLevel()  : self

Sets minimum logging level at which this handler will be triggered.

getDefaultFormatter()  : FormatterInterface

Gets the default formatter.

getGlobPattern()  : string

getTimedFilename()  : string

processRecord()  : array<string|int, mixed>

Processes a record.

resetProcessors()  : void

rotate()  : void

Rotates the files.

streamWrite()  : void

Write to stream

write()  : void

Writes the record down to the log of the implementing handler