PHP Class Neos\Flow\Log\Backend\FileBackend

Inheritance: extends AbstractBackend

Datei anzeigen Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property	Type	Description
$createParentDirectories	boolean
$fileHandle	resource
$logFileUrl	string
$logFilesToKeep	integer
$logMessageOrigin	boolean
$maximumLogFileSize	integer
$severityLabels	array	An array of severity labels, indexed by their integer constant

Public Methods

Method	Description
append ( string $message, integer $severity = LOG_INFO, mixed $additionalData = null, string $packageKey = null, string $className = null, string $methodName = null ) : void	Appends the given message along with the additional information into the log.
close ( ) : void	Carries out all actions necessary to cleanly close the logging backend, such as closing the log file or disconnecting from a database.
open ( ) : void	Carries out all actions necessary to prepare the logging backend, such as opening the log file or opening a database connection.
setCreateParentDirectories ( boolean $flag ) : void	Sets the flag telling if parent directories in the path leading to the log file URL should be created if they don't exist.
setLogFileURL ( string $logFileUrl ) : void	Sets URL pointing to the log file. Usually the full directory and the filename, however any valid stream URL is possible.
setLogFilesToKeep ( integer $logFilesToKeep ) : void	If a new log file is started, keep this number of old log files.
setLogMessageOrigin ( boolean $flag ) : void	If enabled, a hint about where the log message was created is added to the log file.
setMaximumLogFileSize ( integer $maximumLogFileSize ) : void	Sets the maximum log file size, if the logfile is bigger, a new one is started.

Protected Methods

Method	Description
rotateLogFile ( ) : void	Rotate the log file and make sure the configured number of files is kept.

Method Details

append() public method

Appends the given message along with the additional information into the log.

public append ( string $message, integer $severity = LOG_INFO, mixed $additionalData = null, string $packageKey = null, string $className = null, string $methodName = null ) : void
$message	string	The message to log
$severity	integer	One of the LOG_* constants
$additionalData	mixed	A variable containing more information about the event to be logged
$packageKey	string	Key of the package triggering the log (determined automatically if not specified)
$className	string	Name of the class triggering the log (determined automatically if not specified)
$methodName	string	Name of the method triggering the log (determined automatically if not specified)
return	void

close() public method

Note: for this backend we do nothing here and rely on PHP to close the filehandle when the request ends. This is to allow full logging until request end.

public close ( ) : void
return	void

open() public method

Carries out all actions necessary to prepare the logging backend, such as opening the log file or opening a database connection.

public open ( ) : void
return	void

rotateLogFile() protected method

Rotate the log file and make sure the configured number of files is kept.

protected rotateLogFile ( ) : void
return	void

setCreateParentDirectories() public method

The default is to not create parent directories automatically.

public setCreateParentDirectories ( boolean $flag ) : void
$flag	boolean	TRUE if parent directories should be created
return	void

setLogFileURL() public method

Sets URL pointing to the log file. Usually the full directory and the filename, however any valid stream URL is possible.

public setLogFileURL ( string $logFileUrl ) : void
$logFileUrl	string	URL pointing to the log file
return	void

setLogFilesToKeep() public method

If a new log file is started, keep this number of old log files.

setLogMessageOrigin() public method

If enabled, a hint about where the log message was created is added to the log file.

public setLogMessageOrigin ( boolean $flag ) : void
$flag	boolean
return	void

setMaximumLogFileSize() public method

Sets the maximum log file size, if the logfile is bigger, a new one is started.

Property Details

$createParentDirectories protected_oe property

protected bool $createParentDirectories
return	boolean

$fileHandle protected_oe property

protected resource $fileHandle
return	resource

$logFileUrl protected_oe property

protected string $logFileUrl
return	string

$logFilesToKeep protected_oe property

protected int $logFilesToKeep
return	integer

$logMessageOrigin protected_oe property

protected bool $logMessageOrigin
return	boolean

$maximumLogFileSize protected_oe property

protected int $maximumLogFileSize
return	integer

$severityLabels protected_oe property

An array of severity labels, indexed by their integer constant

protected array $severityLabels
return	array

public setLogFilesToKeep ( integer $logFilesToKeep ) : void
$logFilesToKeep	integer	Number of old log files to keep
return	void

public setMaximumLogFileSize ( integer $maximumLogFileSize ) : void
$maximumLogFileSize	integer	Maximum size in bytes
return	void