TYPO3\CMS\Core\Log\Writer\FileWriter Class Reference

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

Public Member Functions
	__construct (array $options=[])
	__destruct ()
	setLogFile ($relativeLogFile)
	getLogFile ()
	writeLog (LogRecord $record)
Public Member Functions inherited from TYPO3\CMS\Core\Log\Writer\AbstractWriter
	__construct (array $options=[])
Public Member Functions inherited from TYPO3\CMS\Core\Log\Writer\WriterInterface
	writeLog (\TYPO3\CMS\Core\Log\LogRecord $record)

Protected Member Functions
	openLogFile ()
	closeLogFile ()
	createLogFile ()
	createHtaccessFile ($htaccessFile)
	getDefaultLogFileName ()

Protected Attributes
	$logFile = ''
	$defaultLogFileTemplate = 'typo3temp/logs/typo3_%s.log'

Static Protected Attributes
static	$logFileHandles = []

Detailed Description

Log writer that writes the log records into a file.

Definition at line 26 of file FileWriter.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Log\Writer\FileWriter::__construct

(

array

$options = []

)

Constructor, opens the log file handle

Parameters

array

$options

Returns

FileWriter

Definition at line 59 of file FileWriter.php.

References TYPO3\CMS\Core\Log\Writer\FileWriter\getDefaultLogFileName(), and TYPO3\CMS\Core\Log\Writer\FileWriter\setLogFile().

__destruct()

TYPO3\CMS\Core\Log\Writer\FileWriter::__destruct

(

)

Destructor, closes the log file handle

Definition at line 71 of file FileWriter.php.

References TYPO3\CMS\Core\Log\Writer\FileWriter\closeLogFile().

Member Function Documentation

closeLogFile()

TYPO3\CMS\Core\Log\Writer\FileWriter::closeLogFile ( )

protected

Closes the log file handle.

Returns

void

Definition at line 172 of file FileWriter.php.

Referenced by TYPO3\CMS\Core\Log\Writer\FileWriter\__destruct().

createHtaccessFile()

TYPO3\CMS\Core\Log\Writer\FileWriter::createHtaccessFile (   $htaccessFile )

protected

Creates .htaccess file inside a new directory to access protect it

Parameters

string

$htaccessFile

Path of .htaccess file

Returns

void

Definition at line 210 of file FileWriter.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

Referenced by TYPO3\CMS\Core\Log\Writer\FileWriter\createLogFile().

createLogFile()

TYPO3\CMS\Core\Log\Writer\FileWriter::createLogFile ( )

protected

Creates the log file with correct permissions and parent directories, if needed

Returns

void

Definition at line 186 of file FileWriter.php.

References TYPO3\CMS\Core\Log\Writer\FileWriter\createHtaccessFile(), TYPO3\CMS\Core\Utility\PathUtility\getCommonPrefix(), TYPO3\CMS\Core\Utility\GeneralUtility\mkdir_deep(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

Referenced by TYPO3\CMS\Core\Log\Writer\FileWriter\openLogFile().

getDefaultLogFileName()

TYPO3\CMS\Core\Log\Writer\FileWriter::getDefaultLogFileName ( )

protected

Returns the path to the default log file.

Uses the defaultLogFileTemplate and replaces the s placeholder with a short MD5 hash based on a static string and the current encryption key.

Returns

string

Definition at line 239 of file FileWriter.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\hmac().

Referenced by TYPO3\CMS\Core\Log\Writer\FileWriter\__construct().

getLogFile()

TYPO3\CMS\Core\Log\Writer\FileWriter::getLogFile

(

)

Gets the path to the log file.

Returns

string Path to the log file.

Definition at line 104 of file FileWriter.php.

References TYPO3\CMS\Core\Log\Writer\FileWriter\$logFile.

openLogFile()

TYPO3\CMS\Core\Log\Writer\FileWriter::openLogFile ( )

protected

Opens the log file handle

Returns

void

Exceptions

Definition at line 154 of file FileWriter.php.

References TYPO3\CMS\Core\Log\Writer\FileWriter\$logFile, and TYPO3\CMS\Core\Log\Writer\FileWriter\createLogFile().

Referenced by TYPO3\CMS\Core\Log\Writer\FileWriter\setLogFile().

setLogFile()

TYPO3\CMS\Core\Log\Writer\FileWriter::setLogFile

(

$relativeLogFile

)

Sets the path to the log file.

Parameters

string

$relativeLogFile

path to the log file, relative to PATH_site

Returns

WriterInterface

Exceptions

InvalidLogWriterConfigurationException

Definition at line 83 of file FileWriter.php.

References TYPO3\CMS\Core\Log\Writer\FileWriter\$logFile, TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Core\Utility\PathUtility\isAbsolutePath(), and TYPO3\CMS\Core\Log\Writer\FileWriter\openLogFile().

Referenced by TYPO3\CMS\Core\Log\Writer\FileWriter\__construct().

writeLog()

TYPO3\CMS\Core\Log\Writer\FileWriter::writeLog

(

LogRecord

$record

)

Writes the log record

Parameters

LogRecord

$record

Log record

Returns

WriterInterface $this

Exceptions

Definition at line 116 of file FileWriter.php.

References TYPO3\CMS\Core\Log\LogRecord\getComponent(), TYPO3\CMS\Core\Log\LogRecord\getCreated(), TYPO3\CMS\Core\Log\LogRecord\getData(), TYPO3\CMS\Core\Log\LogRecord\getLevel(), TYPO3\CMS\Core\Log\LogRecord\getMessage(), TYPO3\CMS\Core\Log\LogLevel\getName(), and TYPO3\CMS\Core\Log\LogRecord\getRequestId().

Member Data Documentation

$defaultLogFileTemplate

TYPO3\CMS\Core\Log\Writer\FileWriter::$defaultLogFileTemplate = 'typo3temp/logs/typo3_%s.log'

protected

Definition at line 40 of file FileWriter.php.

$logFile

TYPO3\CMS\Core\Log\Writer\FileWriter::$logFile = ''

protected

Definition at line 33 of file FileWriter.php.

Referenced by TYPO3\CMS\Core\Log\Writer\FileWriter\getLogFile(), TYPO3\CMS\Core\Log\Writer\FileWriter\openLogFile(), and TYPO3\CMS\Core\Log\Writer\FileWriter\setLogFile().

$logFileHandles

TYPO3\CMS\Core\Log\Writer\FileWriter::$logFileHandles = []

staticprotected

Definition at line 51 of file FileWriter.php.