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

Inheritance diagram for Monolog\Handler\RotatingFileHandler:

Collaboration diagram for Monolog\Handler\RotatingFileHandler:

Public Member Functions

__construct ($filename, $maxFiles=0, $level=Logger::DEBUG, $bubble=true, $filePermission=null, $useLocking=false)

close ()

{{Closes the handler.This will be called automatically when the object is destroyed}} More...

setFilenameFormat ($filenameFormat, $dateFormat)

Public Member Functions inherited from Monolog\Handler\StreamHandler

__construct ($stream, $level=Logger::DEBUG, $bubble=true, $filePermission=null, $useLocking=false)

close ()

{Closes the handler.This will be called automatically when the object is destroyed} More...

getStream ()

Return the currently active stream if it is open. More...

getUrl ()

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

Public Member Functions inherited from Monolog\Handler\AbstractProcessingHandler

handle (array $record)

{Handles a record.All records may be passed to this method, and the handler should discard those that it does not want to handle.The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record.

Parameters

array $record The record to handle

Returns: Boolean true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling.

} More...

Public Member Functions inherited from Monolog\Handler\AbstractHandler

__construct ($level=Logger::DEBUG, $bubble=true)

isHandling (array $record)

{Checks whether the given record will be handled by this handler.This is mostly done for performance reasons, to avoid calling processors for nothing.Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record.

Parameters

array $record Partial log record containing only a level key

Returns: Boolean

} More...

handleBatch (array $records)

{Handles a set of records at once.

Parameters

array $records The records to handle (an array of record arrays)

} More...

close ()

Closes the handler. More...

pushProcessor ($callback)

{Adds a processor in the stack.

Parameters

callable $callback

Returns: self

} More...

popProcessor ()

{Removes the processor on top of the stack and returns it.

Returns: callable

} More...

setFormatter (FormatterInterface $formatter)

{Sets the formatter.

Parameters

FormatterInterface $formatter

Returns: self

} More...

getFormatter ()

{Gets the formatter.

Returns: FormatterInterface

} More...

setLevel ($level)

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

getLevel ()

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

setBubble ($bubble)

Sets the bubbling behavior. More...

getBubble ()

Gets the bubbling behavior. More...

__destruct ()

isHandling (array $record)

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

handle (array $record)

Handles a record. More...

handleBatch (array $records)

Handles a set of records at once. More...

pushProcessor ($callback)

Adds a processor in the stack. More...

popProcessor ()

Removes the processor on top of the stack and returns it. More...

setFormatter (FormatterInterface $formatter)

Sets the formatter. More...

getFormatter ()

Gets the formatter. More...

Data Fields
const	FILE_PER_DAY = 'Y-m-d'

const	FILE_PER_MONTH = 'Y-m'

const	FILE_PER_YEAR = 'Y'

Protected Member Functions

write (array $record)

{{Writes the record down to the log of the implementing handler.

Parameters

array $record

Returns: void

}} More...

rotate ()

Rotates the files. More...

getTimedFilename ()

getGlobPattern ()

write (array $record)

{Writes the record down to the log of the implementing handler.

Parameters

array $record

Returns: void

} More...

Protected Member Functions inherited from Monolog\Handler\AbstractProcessingHandler

write (array $record)

Writes the record down to the log of the implementing handler. More...

processRecord (array $record)

Processes a record. More...

Protected Member Functions inherited from Monolog\Handler\AbstractHandler

getDefaultFormatter ()

Gets the default formatter. More...

Protected Attributes
	$filename

	$maxFiles

	$mustRotate

	$nextRotation

	$filenameFormat

	$dateFormat

Protected Attributes inherited from Monolog\Handler\StreamHandler
	$stream

	$url

	$filePermission

	$useLocking

Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG

	$bubble = true

	$formatter

	$processors = array()

Detailed Description

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

This rotation is only intended to be used as a workaround. Using logrotate to handle the rotation is strongly encouraged when you can use it.

Author: Christophe Coevoet stof@.nosp@m.notk.nosp@m..org; Jordi Boggiano j.bog.nosp@m.gian.nosp@m.o@sel.nosp@m.d.be

Definition at line 25 of file RotatingFileHandler.php.

Constructor & Destructor Documentation

◆ __construct()

Monolog\Handler\RotatingFileHandler::__construct	(	$filename,
		$maxFiles = `0`,
		$level = `Logger::DEBUG`,
		$bubble = `true`,
		$filePermission = `null`,
		$useLocking = `false`
	)

Parameters

string	$filename
int	$maxFiles	The maximal amount of files to keep (0 means unlimited)
int	$level	The minimum logging level at which this handler will be triggered
Boolean	$bubble	Whether the messages that are handled can bubble up the stack or not
int \| null	$filePermission	Optional file permissions (default (0644) are only for owner read/write)
Boolean	$useLocking	Try to lock log file before doing any writes

Definition at line 46 of file RotatingFileHandler.php.

    {
        $this->filename = $filename;
        $this->maxFiles = (int) $maxFiles;
        $this->nextRotation = new \DateTime('tomorrow');
        $this->filenameFormat = '{filename}-{date}';
        $this->dateFormat = 'Y-m-d';
 
        parent::__construct($this->getTimedFilename(), $level, $bubble, $filePermission, $useLocking);
    }

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\RotatingFileHandler\$filename, Monolog\Handler\StreamHandler\$filePermission, Monolog\Handler\AbstractHandler\$level, Monolog\Handler\RotatingFileHandler\$maxFiles, Monolog\Handler\StreamHandler\$useLocking, and Monolog\Handler\RotatingFileHandler\getTimedFilename().

Here is the call graph for this function:

Member Function Documentation

◆ close()

Monolog\Handler\RotatingFileHandler::close ( )

{{Closes the handler.This will be called automatically when the object is destroyed}}

Reimplemented from Monolog\Handler\StreamHandler.

Definition at line 60 of file RotatingFileHandler.php.

    {
        parent::close();
 
        if (true === $this->mustRotate) {
            $this->rotate();
        }
    }

References Monolog\Handler\RotatingFileHandler\rotate().

Referenced by Monolog\Handler\RotatingFileHandler\setFilenameFormat(), and Monolog\Handler\RotatingFileHandler\write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGlobPattern()

Monolog\Handler\RotatingFileHandler::getGlobPattern ( )

protected

Definition at line 164 of file RotatingFileHandler.php.

    {
        $fileInfo = pathinfo($this->filename);
        $glob = str_replace(
            array('{filename}', '{date}'),
            array($fileInfo['filename'], '*'),
            $fileInfo['dirname'] . '/' . $this->filenameFormat
        );
        if (!empty($fileInfo['extension'])) {
            $glob .= '.'.$fileInfo['extension'];
        }
 
        return $glob;
    }

Referenced by Monolog\Handler\RotatingFileHandler\rotate().

Here is the caller graph for this function:

◆ getTimedFilename()

Monolog\Handler\RotatingFileHandler::getTimedFilename ( )

protected

Definition at line 148 of file RotatingFileHandler.php.

    {
        $fileInfo = pathinfo($this->filename);
        $timedFilename = str_replace(
            array('{filename}', '{date}'),
            array($fileInfo['filename'], date($this->dateFormat)),
            $fileInfo['dirname'] . '/' . $this->filenameFormat
        );
 
        if (!empty($fileInfo['extension'])) {
            $timedFilename .= '.'.$fileInfo['extension'];
        }
 
        return $timedFilename;
    }

References date.

Referenced by Monolog\Handler\RotatingFileHandler\__construct(), Monolog\Handler\RotatingFileHandler\rotate(), and Monolog\Handler\RotatingFileHandler\setFilenameFormat().

Here is the caller graph for this function:

◆ rotate()

Monolog\Handler\RotatingFileHandler::rotate ( )

protected

Rotates the files.

Definition at line 113 of file RotatingFileHandler.php.

    {
        // update filename
        $this->url = $this->getTimedFilename();
        $this->nextRotation = new \DateTime('tomorrow');
 
        // skip GC of old logs if files are unlimited
        if (0 === $this->maxFiles) {
            return;
        }
 
        $logFiles = glob($this->getGlobPattern());
        if ($this->maxFiles >= count($logFiles)) {
            // no files to remove
            return;
        }
 
        // Sorting the files by name to remove the older ones
        usort($logFiles, function ($a, $b) {
            return strcmp($b, $a);
        });
 
        foreach (array_slice($logFiles, $this->maxFiles) as $file) {
            if (is_writable($file)) {
                // suppress errors here as unlink() might fail if two processes
                // are cleaning up/rotating at the same time
                set_error_handler(function ($errno, $errstr, $errfile, $errline) {});
                unlink($file);
                restore_error_handler();
            }
        }
 
        $this->mustRotate = false;
    }

References $file, Monolog\Handler\RotatingFileHandler\getGlobPattern(), and Monolog\Handler\RotatingFileHandler\getTimedFilename().

Referenced by Monolog\Handler\RotatingFileHandler\close().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFilenameFormat()

Monolog\Handler\RotatingFileHandler::setFilenameFormat	(	$filenameFormat,
		$dateFormat
	)

Definition at line 69 of file RotatingFileHandler.php.

    {
        if (!preg_match('{^Y(([/_.-]?m)([/_.-]?d)?)?$}', $dateFormat)) {
            trigger_error(
                'Invalid date format - format must be one of '.
                'RotatingFileHandler::FILE_PER_DAY ("Y-m-d"), RotatingFileHandler::FILE_PER_MONTH ("Y-m") '.
                'or RotatingFileHandler::FILE_PER_YEAR ("Y"), or you can set one of the '.
                'date formats using slashes, underscores and/or dots instead of dashes.',
                E_USER_DEPRECATED
            );
        }
        if (substr_count($filenameFormat, '{date}') === 0) {
            trigger_error(
                'Invalid filename format - format should contain at least `{date}`, because otherwise rotating is impossible.',
                E_USER_DEPRECATED
            );
        }
        $this->filenameFormat = $filenameFormat;
        $this->dateFormat = $dateFormat;
        $this->url = $this->getTimedFilename();
        $this->close();
    }

References Monolog\Handler\RotatingFileHandler\$dateFormat, Monolog\Handler\RotatingFileHandler\$filenameFormat, Monolog\Handler\RotatingFileHandler\close(), and Monolog\Handler\RotatingFileHandler\getTimedFilename().

Here is the call graph for this function:

◆ write()

Monolog\Handler\RotatingFileHandler::write ( array $record )

protected

{{Writes the record down to the log of the implementing handler.

Parameters

array $record

Returns: void

}}

Reimplemented from Monolog\Handler\StreamHandler.

Definition at line 95 of file RotatingFileHandler.php.

    {
        // on the first record written, if the log is new, we should rotate (once per day)
        if (null === $this->mustRotate) {
            $this->mustRotate = !file_exists($this->url);
        }
 
        if ($this->nextRotation < $record['datetime']) {
            $this->mustRotate = true;
            $this->close();
        }
 
        parent::write($record);
    }

References Monolog\Handler\RotatingFileHandler\close().

Here is the call graph for this function:

Field Documentation

◆ $dateFormat

Monolog\Handler\RotatingFileHandler::$dateFormat

protected

Definition at line 36 of file RotatingFileHandler.php.

Referenced by Monolog\Handler\RotatingFileHandler\setFilenameFormat().

◆ $filename

Monolog\Handler\RotatingFileHandler::$filename

protected

Definition at line 31 of file RotatingFileHandler.php.

Referenced by Monolog\Handler\RotatingFileHandler\__construct().

◆ $filenameFormat

Monolog\Handler\RotatingFileHandler::$filenameFormat

protected

Definition at line 35 of file RotatingFileHandler.php.

Referenced by Monolog\Handler\RotatingFileHandler\setFilenameFormat().

◆ $maxFiles

Monolog\Handler\RotatingFileHandler::$maxFiles

protected

Definition at line 32 of file RotatingFileHandler.php.

Referenced by Monolog\Handler\RotatingFileHandler\__construct().

◆ $mustRotate

Monolog\Handler\RotatingFileHandler::$mustRotate

protected

Definition at line 33 of file RotatingFileHandler.php.

◆ $nextRotation

Monolog\Handler\RotatingFileHandler::$nextRotation

protected

Definition at line 34 of file RotatingFileHandler.php.

◆ FILE_PER_DAY

const Monolog\Handler\RotatingFileHandler::FILE_PER_DAY = 'Y-m-d'

Definition at line 27 of file RotatingFileHandler.php.

Referenced by Monolog\Handler\RotatingFileHandlerTest\dateFormatProvider(), Monolog\Handler\RotatingFileHandlerTest\rotationTests(), and Monolog\Handler\RotatingFileHandlerTest\testDisallowFilenameFormatsWithoutDate().

◆ FILE_PER_MONTH

const Monolog\Handler\RotatingFileHandler::FILE_PER_MONTH = 'Y-m'

Definition at line 28 of file RotatingFileHandler.php.

Referenced by Monolog\Handler\RotatingFileHandlerTest\dateFormatProvider(), and Monolog\Handler\RotatingFileHandlerTest\rotationTests().

◆ FILE_PER_YEAR

const Monolog\Handler\RotatingFileHandler::FILE_PER_YEAR = 'Y'

Definition at line 29 of file RotatingFileHandler.php.

Referenced by Monolog\Handler\RotatingFileHandlerTest\dateFormatProvider(), and Monolog\Handler\RotatingFileHandlerTest\rotationTests().

The documentation for this class was generated from the following file:

libs/composer/vendor/monolog/monolog/src/Monolog/Handler/RotatingFileHandler.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ close()

◆ getGlobPattern()

◆ getTimedFilename()

◆ rotate()

◆ setFilenameFormat()

◆ write()

Field Documentation

◆ $dateFormat

◆ $filename

◆ $filenameFormat

◆ $maxFiles

◆ $mustRotate

◆ $nextRotation

◆ FILE_PER_DAY

◆ FILE_PER_MONTH

◆ FILE_PER_YEAR