OxidEsales\EshopCommunity\Core\Exception\StandardException Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Core\Exception\StandardException:

Collaboration diagram for OxidEsales\EshopCommunity\Core\Exception\StandardException:

Public Member Functions
	__construct ($sMessage="not set", $iCode=0, \Exception $previous=null)
	setLogFileName ($fileName)
	getLogFileName ()
	setMessage ($sMessage)
	setRenderer ()
	isRenderer ()
	setNotCaught ()
	isNotCaught ()
	debugOut ()
	getString ()
	getValues ()
	setDestination ($sDestination)
	getType ()

Protected Attributes
	$type = 'oxException'
	$_sFileName = OX_LOG_FILE
	$_blRenderer = false
	$_blNotCaught = false

Detailed Description

Basic exception class

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Core\Exception\StandardException::__construct	(		$sMessage = "not set",
			$iCode = 0,
		\Exception	$previous = null
	)

Default constructor

Parameters

string	$sMessage	exception message
integer	$iCode	exception code
\Exception | null	$previous	previous exception

Member Function Documentation

debugOut()

OxidEsales\EshopCommunity\Core\Exception\StandardException::debugOut

(

)

Write exception to log file

Deprecated:

since v6.3 (2018-04-25); This method will be removed completely. Use Registry::getLogger() to log error messages in the future.

Returns

mixed

getLogFileName()

OxidEsales\EshopCommunity\Core\Exception\StandardException::getLogFileName

(

)

Get log file path/name

Deprecated:

since v5.3 (2016-06-17); Logging mechanism will change in the future.

Returns

string

getString()

OxidEsales\EshopCommunity\Core\Exception\StandardException::getString

(

)

Get complete string dump, should be overwritten by excptions extending this exceptions if they introduce new fields

Returns

string

getType()

OxidEsales\EshopCommunity\Core\Exception\StandardException::getType

(

)

Get exception type. Currently old class name is used here for compatibility.

Returns

string

getValues()

OxidEsales\EshopCommunity\Core\Exception\StandardException::getValues

(

)

Creates an array of field name => field value of the object. To make a easy conversion of exceptions to error messages possible. Should be extended when additional fields are used!

Returns

array

isNotCaught()

OxidEsales\EshopCommunity\Core\Exception\StandardException::isNotCaught

(

)

Is the exception "not" caught.

Returns

bool

isRenderer()

OxidEsales\EshopCommunity\Core\Exception\StandardException::isRenderer

(

)

Is the exception caught in a renderer

Returns

bool

setDestination()

OxidEsales\EshopCommunity\Core\Exception\StandardException::setDestination

(

$sDestination

)

Defines a name of the view variable containing the messages

Parameters

string

$sDestination

name of the view variable

setLogFileName()

OxidEsales\EshopCommunity\Core\Exception\StandardException::setLogFileName

(

$fileName

)

Set log file name. The file will always be relative to the directory of OX_LOG_FILE

Deprecated:

since v5.3 (2016-06-17); Logging mechanism will change in the future.

Parameters

string

$fileName

File name

setMessage()

OxidEsales\EshopCommunity\Core\Exception\StandardException::setMessage

(

$sMessage

)

Sets the exception message

Deprecated:

since v6.0 (2017-02-27); This method will be removed. Set message in the constructor.

Parameters

string

$sMessage

exception message

setNotCaught()

OxidEsales\EshopCommunity\Core\Exception\StandardException::setNotCaught

(

)

To define that the exception was not caught (only in oxexceptionhandler)

setRenderer()

OxidEsales\EshopCommunity\Core\Exception\StandardException::setRenderer

(

)

To define that the exception was caught in renderer

Member Data Documentation

$_blNotCaught

OxidEsales\EshopCommunity\Core\Exception\StandardException::$_blNotCaught = false

protected

$_blRenderer

OxidEsales\EshopCommunity\Core\Exception\StandardException::$_blRenderer = false

protected

$_sFileName

OxidEsales\EshopCommunity\Core\Exception\StandardException::$_sFileName = OX_LOG_FILE

protected

$type

OxidEsales\EshopCommunity\Core\Exception\StandardException::$type = 'oxException'

protected

---

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

• /oxideshop-ce/source/Core/Exception/StandardException.php