OXID eShop CE  6.1.5
OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay Class Reference
+ Inheritance diagram for OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay:
+ Collaboration diagram for OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay:

Public Member Functions

 setStackTrace ($sStackTrace)
 
 getStackTrace ()
 
 setValues ($aValues)
 
 addValue ($sName, $sValue)
 
 setExceptionType ($sType)
 
 getErrorClassType ()
 
 getValue ($sName)
 
 setDebug ($bl)
 
 setMessage ($sMessage)
 
 setMessageArgs ()
 
 getOxMessage ()
 
 __toString ()
 

Protected Attributes

 $_blDebug = false
 

Private Attributes

 $_sMessage
 
 $_sStackTrace
 
 $_aValues
 
 $_sType
 

Detailed Description

simplified Exception classes for simply displaying errors saves resources when exception functionality is not needed

Member Function Documentation

◆ __toString()

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::__toString ( )

When exception is converted as string, this magic method return exception message

Returns
string

◆ addValue()

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::addValue (   $sName,
  $sValue 
)

Stores into exception storage message or other value

Parameters
string$sNamestorage name
mixed$sValuevalue to store

◆ getErrorClassType()

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::getErrorClassType ( )

Returns error class type

Returns
string

◆ getOxMessage()

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::getOxMessage ( )

Returns translated exception message

Returns
string

◆ getStackTrace()

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::getStackTrace ( )

Returns stack trace

Returns
string

◆ getValue()

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::getValue (   $sName)

Returns exception stored (by name) value

Parameters
string$sNamestorage name
Returns
mixed

◆ setDebug()

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::setDebug (   $bl)

Exception debug mode setter

Parameters
bool$blif TRUE debug mode on

◆ setExceptionType()

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::setExceptionType (   $sType)

Exception type setter

Parameters
string$sTypeexception type

◆ setMessage()

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::setMessage (   $sMessage)

Exception message setter

Parameters
string$sMessageexception message

◆ setMessageArgs()

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::setMessageArgs ( )

Sets the exception message arguments used when outputing message using sprintf().

◆ setStackTrace()

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::setStackTrace (   $sStackTrace)

Stack trace setter

Parameters
string$sStackTracestack trace

◆ setValues()

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::setValues (   $aValues)

Sets \OxidEsales\Eshop\Core\Exception\ExceptionToDisplay::_aValues value

Parameters
array$aValuesexception values to store

Member Data Documentation

◆ $_aValues

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::$_aValues
private

◆ $_blDebug

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::$_blDebug = false
protected

◆ $_sMessage

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::$_sMessage
private

◆ $_sStackTrace

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::$_sStackTrace
private

◆ $_sType

OxidEsales\EshopCommunity\Core\Exception\ExceptionToDisplay::$_sType
private

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