\PhpOffice\PhpSpreadsheet\Calculation\EngineLogger

Summary

Methods
Properties
Constants
__construct()
setWriteDebugLog()
getWriteDebugLog()
setEchoDebugLog()
getEchoDebugLog()
writeDebugLog()
mergeDebugLog()
clearLog()
getLog()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$writeDebugLog
$echoDebugLog
$debugLog
$cellStack
N/A

Properties

$writeDebugLog

$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.

Type

bool

$echoDebugLog

$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.

Type

bool

$debugLog

$debugLog : string[]

The debug log generated by the calculation engine.

Type

string[]

$cellStack

$cellStack : \PhpOffice\PhpSpreadsheet\Calculation\Engine\CyclicReferenceStack

The calculation engine cell reference stack.

Type

CyclicReferenceStack

Methods

__construct()

__construct(\PhpOffice\PhpSpreadsheet\Calculation\Engine\CyclicReferenceStack  $stack) : mixed

Instantiate a Calculation engine logger.

Parameters

\PhpOffice\PhpSpreadsheet\Calculation\Engine\CyclicReferenceStack $stack

Returns

mixed —

setWriteDebugLog()

setWriteDebugLog(bool  $pValue) : void

Enable/Disable Calculation engine logging.

Parameters

bool $pValue

getWriteDebugLog()

getWriteDebugLog() : bool

Return whether calculation engine logging is enabled or disabled.

Returns

bool —

setEchoDebugLog()

setEchoDebugLog(bool  $pValue) : void

Enable/Disable echoing of debug log information.

Parameters

bool $pValue

getEchoDebugLog()

getEchoDebugLog() : bool

Return whether echoing of debug log information is enabled or disabled.

Returns

bool —

writeDebugLog()

writeDebugLog(mixed  ...$args) : void

Write an entry to the calculation engine debug log.

Parameters

mixed $args variadic

mergeDebugLog()

mergeDebugLog(string[]  $args) : void

Write a series of entries to the calculation engine debug log.

Parameters

string[] $args

clearLog()

clearLog() : void

Clear the calculation engine debug log.

getLog()

getLog() : string[]

Return the calculation engine debug log.

Returns

string[] —