Logger
Table of Contents
| $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. | bool |
|---|---|---|
| $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. | bool |
| $debugLog | The debug log generated by the calculation engine. | string[] |
| $cellStack | The calculation engine cell reference stack. | CyclicReferenceStack |
| __construct() | Instantiate a Calculation engine logger. | mixed |
| setWriteDebugLog() | Enable/Disable Calculation engine logging. | void |
| getWriteDebugLog() | Return whether calculation engine logging is enabled or disabled. | bool |
| setEchoDebugLog() | Enable/Disable echoing of debug log information. | void |
| getEchoDebugLog() | Return whether echoing of debug log information is enabled or disabled. | bool |
| writeDebugLog() | Write an entry to the calculation engine debug log. | void |
| mergeDebugLog() | Write a series of entries to the calculation engine debug log. | void |
| clearLog() | Clear the calculation engine debug log. | void |
| getLog() | Return the calculation engine debug log. | string[] |
Properties
$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
$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
$debugLog
The debug log generated by the calculation engine.
private
string[]
$debugLog
= []
$cellStack
The calculation engine cell reference stack.
private
CyclicReferenceStack
$cellStack
Methods
__construct()
Instantiate a Calculation engine logger.
public
__construct(
$stack :
CyclicReferenceStack
)
: mixed
Parameters
- $stack : CyclicReferenceStack
Return values
mixedsetWriteDebugLog()
Enable/Disable Calculation engine logging.
public
setWriteDebugLog(
$pValue :
bool
)
: void
Parameters
- $pValue : bool
getWriteDebugLog()
Return whether calculation engine logging is enabled or disabled.
public
getWriteDebugLog(
)
: bool
Return values
boolsetEchoDebugLog()
Enable/Disable echoing of debug log information.
public
setEchoDebugLog(
$pValue :
bool
)
: void
Parameters
- $pValue : bool
getEchoDebugLog()
Return whether echoing of debug log information is enabled or disabled.
public
getEchoDebugLog(
)
: bool
Return values
boolwriteDebugLog()
Write an entry to the calculation engine debug log.
public
writeDebugLog(
...$args :
mixed
)
: void
Parameters
- $args : mixed
mergeDebugLog()
Write a series of entries to the calculation engine debug log.
public
mergeDebugLog(
$args :
string[]
)
: void
Parameters
- $args : string[]
clearLog()
Clear the calculation engine debug log.
public
clearLog(
)
: void
getLog()
Return the calculation engine debug log.
public
getLog(
)
: string[]