class PHPExcel_CalcEngine_Logger in Loft Data Grids 6.2

PHPExcel_CalcEngine_Logger

@category PHPExcel @package PHPExcel_Calculation @copyright Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)

Hierarchy

• class \PHPExcel_CalcEngine_Logger

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/CalcEngine/Logger.php, line 35

class PHPExcel_CalcEngine_Logger {

  /**
   * 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
   *
   * @var boolean
   */
  private $_writeDebugLog = FALSE;

  /**
   * 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
   *
   * @var boolean
   */
  private $_echoDebugLog = FALSE;

  /**
   * The debug log generated by the calculation engine
   *
   * @var string[]
   */
  private $_debugLog = array();

  /**
   * The calculation engine cell reference stack
   *
   * @var PHPExcel_CalcEngine_CyclicReferenceStack
   */
  private $_cellStack;

  /**
   * Instantiate a Calculation engine logger
   *
   * @param  PHPExcel_CalcEngine_CyclicReferenceStack $stack
   */
  public function __construct(PHPExcel_CalcEngine_CyclicReferenceStack $stack) {
    $this->_cellStack = $stack;
  }

  /**
   * Enable/Disable Calculation engine logging
   *
   * @param  boolean $pValue
   */
  public function setWriteDebugLog($pValue = FALSE) {
    $this->_writeDebugLog = $pValue;
  }

  /**
   * Return whether calculation engine logging is enabled or disabled
   *
   * @return  boolean
   */
  public function getWriteDebugLog() {
    return $this->_writeDebugLog;
  }

  /**
   * Enable/Disable echoing of debug log information
   *
   * @param  boolean $pValue
   */
  public function setEchoDebugLog($pValue = FALSE) {
    $this->_echoDebugLog = $pValue;
  }

  /**
   * Return whether echoing of debug log information is enabled or disabled
   *
   * @return  boolean
   */
  public function getEchoDebugLog() {
    return $this->_echoDebugLog;
  }

  /**
   * Write an entry to the calculation engine debug log
   */
  public function writeDebugLog() {

    //	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()

  /**
   * Clear the calculation engine debug log
   */
  public function clearLog() {
    $this->_debugLog = array();
  }

  //	function flushLogger()

  /**
   * Return the calculation engine debug log
   *
   * @return  string[]
   */
  public function getLog() {
    return $this->_debugLog;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PHPExcel_CalcEngine_Logger::$_cellStack	private	property	* The calculation engine cell reference stack * *
PHPExcel_CalcEngine_Logger::$_debugLog	private	property	* The debug log generated by the calculation engine * *
PHPExcel_CalcEngine_Logger::$_echoDebugLog	private	property	* 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 * *
PHPExcel_CalcEngine_Logger::$_writeDebugLog	private	property	* 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 * *
PHPExcel_CalcEngine_Logger::clearLog	public	function	* Clear the calculation engine debug log
PHPExcel_CalcEngine_Logger::getEchoDebugLog	public	function	* Return whether echoing of debug log information is enabled or disabled * *
PHPExcel_CalcEngine_Logger::getLog	public	function	* Return the calculation engine debug log * *
PHPExcel_CalcEngine_Logger::getWriteDebugLog	public	function	* Return whether calculation engine logging is enabled or disabled * *
PHPExcel_CalcEngine_Logger::setEchoDebugLog	public	function	* Enable/Disable echoing of debug log information * *
PHPExcel_CalcEngine_Logger::setWriteDebugLog	public	function	* Enable/Disable Calculation engine logging * *
PHPExcel_CalcEngine_Logger::writeDebugLog	public	function	* Write an entry to the calculation engine debug log
PHPExcel_CalcEngine_Logger::__construct	public	function	* Instantiate a Calculation engine logger * *