Logger
in package
Table of Contents
Properties
- $cellStack : CyclicReferenceStack
- The calculation engine cell reference stack.
- $debugLog : array<string|int, string>
- The debug log generated by the calculation engine.
- $echoDebugLog : bool
- Flag to determine whether a debug log should be echoed by the calculation engine If true, then a debug log will be echoed If false, then a debug log will not be echoed A debug log can only be echoed if it is generated.
- $writeDebugLog : bool
- Flag to determine whether a debug log should be generated by the calculation engine If true, then a debug log will be generated If false, then a debug log will not be generated.
Methods
- __construct() : mixed
- Instantiate a Calculation engine logger.
- clearLog() : void
- Clear the calculation engine debug log.
- getEchoDebugLog() : bool
- Return whether echoing of debug log information is enabled or disabled.
- getLog() : array<string|int, string>
- Return the calculation engine debug log.
- getWriteDebugLog() : bool
- Return whether calculation engine logging is enabled or disabled.
- mergeDebugLog() : void
- Write a series of entries to the calculation engine debug log.
- setEchoDebugLog() : void
- Enable/Disable echoing of debug log information.
- setWriteDebugLog() : void
- Enable/Disable Calculation engine logging.
- writeDebugLog() : void
- Write an entry to the calculation engine debug log.
Properties
$cellStack
The calculation engine cell reference stack.
private
CyclicReferenceStack
$cellStack
$debugLog
The debug log generated by the calculation engine.
private
array<string|int, string>
$debugLog
= []
$echoDebugLog
Flag to determine whether a debug log should be echoed by the calculation engine If true, then a debug log will be echoed If false, then a debug log will not be echoed A debug log can only be echoed if it is generated.
private
bool
$echoDebugLog
= false
$writeDebugLog
Flag to determine whether a debug log should be generated by the calculation engine If true, then a debug log will be generated If false, then a debug log will not be generated.
private
bool
$writeDebugLog
= false
Methods
__construct()
Instantiate a Calculation engine logger.
public
__construct(CyclicReferenceStack $stack) : mixed
Parameters
- $stack : CyclicReferenceStack
clearLog()
Clear the calculation engine debug log.
public
clearLog() : void
getEchoDebugLog()
Return whether echoing of debug log information is enabled or disabled.
public
getEchoDebugLog() : bool
Return values
boolgetLog()
Return the calculation engine debug log.
public
getLog() : array<string|int, string>
Return values
array<string|int, string>getWriteDebugLog()
Return whether calculation engine logging is enabled or disabled.
public
getWriteDebugLog() : bool
Return values
boolmergeDebugLog()
Write a series of entries to the calculation engine debug log.
public
mergeDebugLog(array<string|int, string> $args) : void
Parameters
- $args : array<string|int, string>
setEchoDebugLog()
Enable/Disable echoing of debug log information.
public
setEchoDebugLog(bool $echoDebugLog) : void
Parameters
- $echoDebugLog : bool
setWriteDebugLog()
Enable/Disable Calculation engine logging.
public
setWriteDebugLog(bool $writeDebugLog) : void
Parameters
- $writeDebugLog : bool
writeDebugLog()
Write an entry to the calculation engine debug log.
public
writeDebugLog(string $message, mixed ...$args) : void
Parameters
- $message : string
- $args : mixed