oxexception.php

Go to the documentation of this file.

<?php

class oxException extends Exception
{

    protected $_sFileName = 'EXCEPTION_LOG.txt';

    protected $_blRenderer = false;

    protected $_blNotCaught = false;

    public function __construct($sMessage = "not set", $iCode = 0)
    {
        parent::__construct($sMessage, $iCode);
    }

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

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

    public function setMessage($sMessage)
    {
        $this->message = $sMessage;
    }

    public function setRenderer()
    {
        $this->_blRenderer = true;
    }

    public function isRenderer()
    {
        return $this->_blRenderer;
    }

    public function setNotCaught()
    {
        $this->_blNotCaught = true;
    }

    public function isNotCaught()
    {
        return $this->_blNotCaught;
    }

    public function debugOut()
    {
        //We are most likely are already dealing with an exception so making sure no other exceptions interfere
        try {
            $sLogMsg = $this->getString() . "\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
        } catch (Exception $e) {
        }
    }

    public function getString()
    {
        $sWarning = "";
        if ($this->_blNotCaught) {
            $sWarning .= "--!--NOT CAUGHT--!--";
        }

        if ($this->_blRenderer) {
            $sWarning .= "--!--RENDERER--!--";
        }

        return $sWarning . __CLASS__ . " (time: " . date('Y-m-d H:i:s') . "): [{$this->code}]: {$this->message} \n Stack Trace: {$this->getTraceAsString()}\n\n";
    }

    /*
    public function __toString()
    {
        return $this->getString();
    }
    */
    public function getValues()
    {
        return array();
    }

    public function setDestination($sDestination)
    {
    }
}