CatchHandler Class Reference

Inheritance diagram for CatchHandler:

Public Member Functions
	__construct ($pSetProduct, $pSetLogger=null)
	setLogger ($pLogger)
	setDevMode ($pDevMode)
	getDevMode ()
	setErrorReporting ($pNewReportLvl)
	getErrorReporting ()

Protected Member Functions
	handleError ()
	setSaveLog ($pSaveLog)
	getErrMsg ()
	setNotice ($pNoticeOnly)

Protected Attributes
	$errLogger = null
	$errReportLvl = E_ALL & ~E_NOTICE & ~E_STRICT & ~E_DEPRECATED
	$errRemoteAddr
	$errRequestUri
	$errServerName
	$errPhpSelf
	$errScriptName
	$errQueryString

Private Member Functions
	SaveLogMsg ()

Private Attributes
	$saveLog = false
	$showErrPage = false
	$errPageUrl = ''
	$noticeOnly = false
	$hcuProduct = null
	$hcuDevMode = 0

Detailed Description

Definition at line 20 of file hcuLogError.i.

Constructor & Destructor Documentation

__construct()

CatchHandler::__construct	(		$pSetProduct,
			$pSetLogger = null
	)

PARENT CONSTRUCTOR

Set the logger object if it is defined

Definition at line 86 of file hcuLogError.i.

                                                       {

    $this->hcuProduct = $pSetProduct;

    /**
     * Set the logger object if it is defined
     */
    $this->setLogger($pSetLogger);
    $this->setErrorReporting($this->errReportLvl);

  }

Member Function Documentation

getErrorReporting()

CatchHandler::getErrorReporting

(

)

Get the current level of php debugging

Returns

int the previous value of error reporting

Definition at line 213 of file hcuLogError.i.

                                      {
    return $this->errReportLvl;
  }

handleError()

CatchHandler::handleError ( )

protected

PROTECTED METHODS

Record the _SERVER variables

Definition at line 133 of file hcuLogError.i.

                                   {

    /**
     *  Record the _SERVER variables
     */

    $this->errRemoteAddr = (array_key_exists("REMOTE_ADDR", $_SERVER) ? $_SERVER['REMOTE_ADDR'] : '0.0.0.0');
    $this->errRequestUri = (array_key_exists("REQUEST_URI", $_SERVER) ? $_SERVER['REQUEST_URI'] : '127.0.0.1');
    $this->errServerName = (array_key_exists("SERVER_NAME", $_SERVER) ? $_SERVER['SERVER_NAME'] : '');
    $this->errPhpSelf = (array_key_exists("PHP_SELF", $_SERVER) ? $_SERVER['PHP_SELF'] : '');
    $this->errScriptFileName = (array_key_exists("SCRIPT_FILENAME", $_SERVER) ? $_SERVER['SCRIPT_FILENAME'] : __FILE__);
    $this->errQueryString = (array_key_exists("QUERY_STRING", $_SERVER) ? $_SERVER['QUERY_STRING'] : '');

    if ($this->saveLog) {
      $this->SaveLogMsg();
    }
  }

SaveLogMsg()

CatchHandler::SaveLogMsg ( )

private

PRIVATE METHODSSave the log message for the error being raised

Definition at line 108 of file hcuLogError.i.

                                {

    $lLogMsg = $this->getErrMsg();
    //** If this->errLogger is set then use this for logging the error,
      // * If not, then save to the default error_log
    if (!is_null($this->errLogger)) {
      if ($this->noticeOnly) {
        // * Default error log destination
        $this->errLogger->notice($lLogMsg);
      } else {
        // * Default error log destination
        $this->errLogger->error($lLogMsg);
      }

    } else {
      // ** logger not set, save with built in error_log function
      error_log($lLogMsg);
    }
  }

setErrorReporting()

CatchHandler::setErrorReporting

(

$pNewReportLvl

)

Set the level of php debugging

Parameters

int	The integer value representing the error reporting level

Returns

int the previous value of error reporting

Definition at line 201 of file hcuLogError.i.

                                                    {
    $this->errReportLvl = $pNewReportLvl;
    return error_reporting($pNewReportLvl);
  }

setLogger()

CatchHandler::setLogger

(

$pLogger

)

PUBLIC METHODSthis will set the logger object for the current error exception handler

Parameters

object

$pLogger

This is an instance of the ColorStandardLogger object

Definition at line 173 of file hcuLogError.i.

                                      {

    if (is_a($pLogger, 'StandardLogger')) {
      $this->errLogger = $pLogger;
    }
  }

Member Data Documentation

$errLogger

CatchHandler::$errLogger = null

protected

PROPERTIESThe logger object used for writing to error log

Definition at line 29 of file hcuLogError.i.

---

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

• app/web/shared/library/hcuLogError.i