Inheritance diagram for TYPO3\CMS\Core\Log\Writer\RotatingFileWriter:

Public Member Functions
	__construct (array $options=[])

	setLogFile (string $relativeLogFile)

	writeLog (LogRecord $record)

‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Log\Writer\FileWriter
	__destruct ()

	setLogFileInfix (string $infix)

	getLogFile ()

Protected Member Functions
	setInterval (string\|Interval $interval)

	setMaxFiles (int $maxFiles)

	rotate ()

	getLastRotation ()

	determineNextRotation ()

	needsRotation ()

	updateRuntimeRotationState (\DateTimeImmutable $lastRotation)

‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Log\Writer\FileWriter
	openLogFile ()

	closeLogFile ()

	createLogFile ()

	createHtaccessFile ($htaccessFile)

string	getDefaultLogFileName ()

‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Log\Writer\AbstractWriter
	interpolate (string $message, array $context=[])

	formatContextValue (string $value)

	formatException (\Throwable $ex)

Private Attributes
const	ROTATION_DATE_FORMAT = 'YmdHis'

Interval	$interval = Interval::DAILY

int	$maxFiles = 5

DateTimeImmutable	$lastRotation

DateTimeImmutable	$nextRotation

Additional Inherited Members
‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Log\Writer\FileWriter
string	$logFile = ''

string	$logFileInfix = ''

string	$defaultLogFileTemplate = '/log/typo3_%s.log'

‪Static Protected Attributes inherited from ‪TYPO3\CMS\Core\Log\Writer\FileWriter
static array	$logFileHandles = []

static array	$logFileHandlesCount = []

Detailed Description

Write logs into files while providing basic rotation capabilities. This is a very basic approach, suitable for environments where established tools like logrotate are not available.

Definition at line 32 of file RotatingFileWriter.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Log\Writer\RotatingFileWriter::__construct ( array $options = [] )

Constructor, opens the log file handle

Reimplemented from TYPO3\CMS\Core\Log\Writer\FileWriter.

Definition at line 41 of file RotatingFileWriter.php.

Member Function Documentation

◆ determineNextRotation()

TYPO3\CMS\Core\Log\Writer\RotatingFileWriter::determineNextRotation ( )

protected

Definition at line 145 of file RotatingFileWriter.php.

Referenced by TYPO3\CMS\Core\Log\Writer\RotatingFileWriter\updateRuntimeRotationState().

◆ getLastRotation()

TYPO3\CMS\Core\Log\Writer\RotatingFileWriter::getLastRotation ( )

protected

Definition at line 123 of file RotatingFileWriter.php.

Referenced by TYPO3\CMS\Core\Log\Writer\RotatingFileWriter\setLogFile(), and TYPO3\CMS\Core\Log\Writer\RotatingFileWriter\writeLog().

◆ needsRotation()

TYPO3\CMS\Core\Log\Writer\RotatingFileWriter::needsRotation ( )

protected

Check if log files need to be rotated under following conditions:

1. a) either the next rotation is due b) logs were never rotated before

‪the log file is not empty - FileWriter::setLogFile() creates one if missing

Definition at line 158 of file RotatingFileWriter.php.

Referenced by TYPO3\CMS\Core\Log\Writer\RotatingFileWriter\writeLog().

◆ rotate()

TYPO3\CMS\Core\Log\Writer\RotatingFileWriter::rotate ( )

protected

This method rotates all log files found by using glob() to take all already rotated logs into account, even after a configuration change.

Log files are rotated using the "copytruncate" approach: the current open log file is copied as-is to a new location, the current log file gets flushed afterward. This way, file handles don't need to get re-created.

Definition at line 103 of file RotatingFileWriter.php.

References TYPO3\CMS\Core\Log\Writer\RotatingFileWriter\updateRuntimeRotationState().

Referenced by TYPO3\CMS\Core\Log\Writer\RotatingFileWriter\writeLog().