PHPExcel_CalcEngine_Logger Class Reference

Collaboration diagram for PHPExcel_CalcEngine_Logger:

Public Member Functions
	__construct (PHPExcel_CalcEngine_CyclicReferenceStack $stack)
	Instantiate a Calculation engine logger. More...
	setWriteDebugLog ($pValue=FALSE)
	Enable/Disable Calculation engine logging. More...
	getWriteDebugLog ()
	Return whether calculation engine logging is enabled or disabled. More...
	setEchoDebugLog ($pValue=FALSE)
	Enable/Disable echoing of debug log information. More...
	getEchoDebugLog ()
	Return whether echoing of debug log information is enabled or disabled. More...
	writeDebugLog ()
	Write an entry to the calculation engine debug log. More...
	clearLog ()
	Clear the calculation engine debug log. More...
	getLog ()
	Return the calculation engine debug log. More...

Private Attributes
	$_writeDebugLog = FALSE
	$_echoDebugLog = FALSE
	$_debugLog = array()
	$_cellStack

Detailed Description

Definition at line 35 of file Logger.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_CalcEngine_Logger::__construct

(

PHPExcel_CalcEngine_CyclicReferenceStack

$stack

)

Instantiate a Calculation engine logger.

Parameters

PHPExcel_CalcEngine_CyclicReferenceStack

$stack

Definition at line 76 of file Logger.php.

                                                                                     {
                $this->_cellStack = $stack;
        }

Member Function Documentation

clearLog()

PHPExcel_CalcEngine_Logger::clearLog

(

)

Clear the calculation engine debug log.

Definition at line 139 of file Logger.php.

References array.

                                   {
                $this->_debugLog = array();
        }       //      function flushLogger()

getEchoDebugLog()

PHPExcel_CalcEngine_Logger::getEchoDebugLog

(

)

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

Returns

boolean

Definition at line 112 of file Logger.php.

References $_echoDebugLog.

                                          {
                return $this->_echoDebugLog;
        }

getLog()

PHPExcel_CalcEngine_Logger::getLog

(

)

Return the calculation engine debug log.

Returns

string[]

Definition at line 148 of file Logger.php.

References $_debugLog.

                                 {
                return $this->_debugLog;
        }       //      function flushLogger()

getWriteDebugLog()

PHPExcel_CalcEngine_Logger::getWriteDebugLog

(

)

Return whether calculation engine logging is enabled or disabled.

Returns

boolean

Definition at line 94 of file Logger.php.

References $_writeDebugLog.

                                           {
                return $this->_writeDebugLog;
        }

setEchoDebugLog()

PHPExcel_CalcEngine_Logger::setEchoDebugLog

(

$pValue = FALSE

)

Enable/Disable echoing of debug log information.

Parameters

boolean

$pValue

Definition at line 103 of file Logger.php.

                                                         {
                $this->_echoDebugLog = $pValue;
        }

setWriteDebugLog()

PHPExcel_CalcEngine_Logger::setWriteDebugLog

(

$pValue = FALSE

)

Enable/Disable Calculation engine logging.

Parameters

boolean

$pValue

Definition at line 85 of file Logger.php.

                                                          {
                $this->_writeDebugLog = $pValue;
        }

writeDebugLog()

PHPExcel_CalcEngine_Logger::writeDebugLog

(

)

Write an entry to the calculation engine debug log.

Definition at line 119 of file Logger.php.

References $message, and PHP_EOL.

                                        {
                //      Only write the debug log if logging is enabled
                if ($this->_writeDebugLog) {
                        $message = implode(func_get_args());
                        $cellReference = implode(' -> ', $this->_cellStack->showStack());
                        if ($this->_echoDebugLog) {
                                echo $cellReference, 
                                        ($this->_cellStack->count() > 0 ? ' => ' : ''), 
                                        $message, 
                                        PHP_EOL;
                        }
                        $this->_debugLog[] = $cellReference . 
                                ($this->_cellStack->count() > 0 ? ' => ' : '') . 
                                $message;
                }
        }       //      function _writeDebug()

Field Documentation

$_cellStack

PHPExcel_CalcEngine_Logger::$_cellStack

private

Definition at line 68 of file Logger.php.

$_debugLog

PHPExcel_CalcEngine_Logger::$_debugLog = array()

private

Definition at line 61 of file Logger.php.

Referenced by getLog().

$_echoDebugLog

PHPExcel_CalcEngine_Logger::$_echoDebugLog = FALSE

private

Definition at line 54 of file Logger.php.

Referenced by getEchoDebugLog().

$_writeDebugLog

PHPExcel_CalcEngine_Logger::$_writeDebugLog = FALSE

private

Definition at line 44 of file Logger.php.

Referenced by getWriteDebugLog().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/CalcEngine/Logger.php