CSMamVolumeLog
in package
Defines the class for the volume logs.
The class provides utility methods to log errors, warning, info and debug information.
Tags
Table of Contents
- logDebugForFile() : void
- Logs a debug info for a given file.
- logDebugForVolume() : void
- Logs a debug info for a given volume.
- logErrorForFile() : void
- Logs an error for a given file.
- logErrorForVolume() : void
- Logs an error for a given volume.
- logInfoForFile() : void
- Logs an info for a given file.
- logInfoForVolume() : void
- Logs an info for a given volume.
- logWarningForFile() : void
- Logs a warning for a given file.
- logWarningForVolume() : void
- Logs a warning for a given volume.
- startPerformanceLog() : void
- Initializes a performance log loop for a given file, to be finalized by usage of stopPerformanceLog().
- stopPerformanceLog() : void
- Logs a performance info for a given file, requires prior usage of startPerformanceLog().
Methods
logDebugForFile()
Logs a debug info for a given file.
public
static logDebugForFile(CSMamFile|MamFile $oFile, string $sMessage, string $sEvent, string $sEventStatus[, array<string|int, mixed> $aAdditionalDetails = [] ]) : void
Parameters
- $oFile : CSMamFile|MamFile
-
The used MAM file to obtain the operation information for log.
- $sMessage : string
-
The message of the log.
- $sEvent : string
-
The service event operation.
- $sEventStatus : string
-
The service event status result.
- $aAdditionalDetails : array<string|int, mixed> = []
-
Additional information, which should be added to the log.
Tags
Return values
void —logDebugForVolume()
Logs a debug info for a given volume.
public
static logDebugForVolume(CSMamVolume|MamVolume $oVolume, string $sMessage, string $sEvent, string $sEventStatus[, array<string|int, mixed> $aAdditionalDetails = [] ]) : void
Parameters
- $oVolume : CSMamVolume|MamVolume
-
The used MAM volume to determine the log level.
- $sMessage : string
-
The message of the log.
- $sEvent : string
-
The service event operation.
- $sEventStatus : string
-
The service event status result.
- $aAdditionalDetails : array<string|int, mixed> = []
-
Additional information, which should be added to the log.
Tags
Return values
void —logErrorForFile()
Logs an error for a given file.
public
static logErrorForFile(CSMamFile|MamFile $oFile, string $sMessage, string $sEvent, string $sEventStatus[, array<string|int, mixed> $aAdditionalDetails = [] ]) : void
Parameters
- $oFile : CSMamFile|MamFile
-
The used MAM file to obtain the operation information for log.
- $sMessage : string
-
The message of the log.
- $sEvent : string
-
The service event operation.
- $sEventStatus : string
-
The service event status result.
- $aAdditionalDetails : array<string|int, mixed> = []
-
Additional information, which should be added to the log.
Tags
Return values
void —logErrorForVolume()
Logs an error for a given volume.
public
static logErrorForVolume(CSMamVolume|MamVolume $oVolume, string $sMessage, string $sEvent, string $sEventStatus[, array<string|int, mixed> $aAdditionalDetails = [] ]) : void
Parameters
- $oVolume : CSMamVolume|MamVolume
-
The used MAM volume to determine the log level.
- $sMessage : string
-
The message of the log.
- $sEvent : string
-
The service event operation.
- $sEventStatus : string
-
The service event status result.
- $aAdditionalDetails : array<string|int, mixed> = []
-
Additional information, which should be added to the log.
Tags
Return values
void —logInfoForFile()
Logs an info for a given file.
public
static logInfoForFile(CSMamFile|MamFile $oFile, string $sMessage, string $sEvent, string $sEventStatus[, array<string|int, mixed> $aAdditionalDetails = [] ]) : void
Parameters
- $oFile : CSMamFile|MamFile
-
The used MAM file to obtain the operation information for log.
- $sMessage : string
-
The message of the log.
- $sEvent : string
-
The service event operation.
- $sEventStatus : string
-
The service event status result.
- $aAdditionalDetails : array<string|int, mixed> = []
-
Additional information, which should be added to the log.
Tags
Return values
void —logInfoForVolume()
Logs an info for a given volume.
public
static logInfoForVolume(CSMamVolume|MamVolume $oVolume, string $sMessage, string $sEvent, string $sEventStatus[, array<string|int, mixed> $aAdditionalDetails = [] ]) : void
Parameters
- $oVolume : CSMamVolume|MamVolume
-
The used MAM volume to determine the log level.
- $sMessage : string
-
The message of the log.
- $sEvent : string
-
The service event operation.
- $sEventStatus : string
-
The service event status result.
- $aAdditionalDetails : array<string|int, mixed> = []
-
Additional information, which should be added to the log.
Tags
Return values
void —logWarningForFile()
Logs a warning for a given file.
public
static logWarningForFile(CSMamFile|MamFile $oFile, string $sMessage, string $sEvent, string $sEventStatus[, array<string|int, mixed> $aAdditionalDetails = [] ]) : void
Parameters
- $oFile : CSMamFile|MamFile
-
The used MAM file to obtain the operation information for log.
- $sMessage : string
-
The message of the log.
- $sEvent : string
-
The service event operation.
- $sEventStatus : string
-
The service event status result.
- $aAdditionalDetails : array<string|int, mixed> = []
-
Additional information, which should be added to the log.
Tags
Return values
void —logWarningForVolume()
Logs a warning for a given volume.
public
static logWarningForVolume(CSMamVolume|MamVolume $oVolume, string $sMessage, string $sEvent, string $sEventStatus[, array<string|int, mixed> $aAdditionalDetails = [] ]) : void
Parameters
- $oVolume : CSMamVolume|MamVolume
-
The used MAM volume to determine the log level.
- $sMessage : string
-
The message of the log.
- $sEvent : string
-
The service event operation.
- $sEventStatus : string
-
The service event status result.
- $aAdditionalDetails : array<string|int, mixed> = []
-
Additional information, which should be added to the log.
Tags
Return values
void —startPerformanceLog()
Initializes a performance log loop for a given file, to be finalized by usage of stopPerformanceLog().
public
static startPerformanceLog(CSMamFile|MamFile $oFile, string $sOperation) : void
Parameters
- $oFile : CSMamFile|MamFile
-
The used MAM file to obtain the operation information for log.
- $sOperation : string
-
The service event status result.
Tags
Return values
void —stopPerformanceLog()
Logs a performance info for a given file, requires prior usage of startPerformanceLog().
public
static stopPerformanceLog(CSMamFile|MamFile $oFile, string $sEvent, string $sEventStatus, string $sOperation[, array<string|int, mixed> $aAdditionalDetails = [] ]) : void
Parameters
- $oFile : CSMamFile|MamFile
-
The used MAM file to obtain the operation information for log.
- $sEvent : string
-
The service event operation.
- $sEventStatus : string
-
The service event status result.
- $sOperation : string
-
The service event status result.
- $aAdditionalDetails : array<string|int, mixed> = []
-
Additional information, which should be added to the log.