oxexceptionhandler.php

Go to the documentation of this file.

<?php

class oxExceptionHandler
{

    protected $_sFileName = 'EXCEPTION_LOG.txt';

    protected $_iDebug = 0;

    public function __construct($iDebug = 0)
    {
        $this->_iDebug = (int) $iDebug;
    }

    public function setIDebug($iDebug)
    {
        $this->_iDebug = $iDebug;
    }

    public function setLogFileName($sFile)
    {
        $this->_sFileName = $sFile;
    }

    public function getLogFileName()
    {
        return $this->_sFileName;
    }

    public function handleUncaughtException(Exception $oEx)
    {
        // split between php or shop exception
        if (!$oEx instanceof oxException) {
            $this->_dealWithNoOxException($oEx);

            return; // Return straight away ! (in case of unit testing)
        }

        $oEx->setLogFileName($this->_sFileName); // set common log file ...

        $this->_uncaughtException($oEx); // Return straight away ! (in case of unit testing)
    }

    protected function _uncaughtException(oxException $oEx)
    {
        // exception occurred in function processing
        $oEx->setNotCaught();
        // general log entry for all exceptions here
        $oEx->debugOut();

        if (defined('OXID_PHP_UNIT')) {
            return $oEx->getString();
        } elseif (0 != $this->_iDebug) {
            oxRegistry::getUtils()->showMessageAndExit($oEx->getString());
        }

        try {
            oxRegistry::getUtils()->redirectOffline(500);
        } catch (Exception $oException) {
        }

        exit();
    }

    protected function _dealWithNoOxException(Exception $oEx)
    {
        if (0 != $this->_iDebug) {
            $sLogMsg = date('Y-m-d H:i:s') . $oEx . "\n---------------------------------------------\n";
            //deprecated since v5.3 (2016-06-17); Logging mechanism will be changed in 6.0.
            oxRegistry::getUtils()->writeToLog($sLogMsg, $this->getLogFileName());
            //end deprecated
            if (defined('OXID_PHP_UNIT')) {
                return;
            } elseif (0 != $this->_iDebug) {
                oxRegistry::getUtils()->showMessageAndExit($sLogMsg);
            }
        }

        try {
            oxRegistry::getUtils()->redirectOffline(500);
        } catch (Exception $oException) {
        }

        exit();
    }

    public function __call($sMethod, $aArgs)
    {
        if (defined('OXID_PHP_UNIT')) {
            if (substr($sMethod, 0, 4) == "UNIT") {
                $sMethod = str_replace("UNIT", "_", $sMethod);
            }
            if (method_exists($this, $sMethod)) {
                return call_user_func_array(array(& $this, $sMethod), $aArgs);
            }
        }

        throw new oxSystemComponentException("Function '$sMethod' does not exist or is not accessible! (" . __CLASS__ . ")" . PHP_EOL);
    }
}