OXID eShop CE  4.8.12
 All Classes Files Functions Variables Pages
oxExceptionToDisplay Class Reference
+ Inheritance diagram for oxExceptionToDisplay:
+ Collaboration diagram for oxExceptionToDisplay:

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

Definition at line 7 of file oxexceptiontodisplay.php.

Member Function Documentation

oxExceptionToDisplay::__toString ( )

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

Returns
string

Definition at line 185 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::addValue (   $sName,
  $sValue 
)

Stores into exception storage message or other value

Parameters
string$sNamestorage name
mixed$sValuevalue to store
Returns
null

Definition at line 86 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::getErrorClassType ( )

Returns error class type

Returns
string

Implements oxIDisplayError.

Definition at line 108 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::getOxMessage ( )

Returns translated exception message

Returns
string

Implements oxIDisplayError.

Definition at line 165 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::getStackTrace ( )

Returns stack trace

Returns
string

Definition at line 61 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::getValue (   $sName)

Returns exception stored (by name) value

Parameters
string$sNamestorage name
Returns
mixed

Implements oxIDisplayError.

Definition at line 120 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::setDebug (   $bl)

Exception debug mode setter

Parameters
bool$blif TRUE debug mode on
Returns
null

Definition at line 132 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::setExceptionType (   $sType)

Exception type setter

Parameters
string$sTypeexception type
Returns
null

Definition at line 98 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::setMessage (   $sMessage)

Exception message setter

Parameters
string$sMessageexception message
Returns
null

Definition at line 144 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::setMessageArgs ( )

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

Returns
null

Definition at line 155 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::setStackTrace (   $sStackTrace)

Stack trace setter

Parameters
string$sStackTracestack trace
Returns
null

Definition at line 51 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::setValues (   $aValues)

Sets oxExceptionToDisplay::_aValues value

Parameters
array$aValuesexception values to store
Returns
null

Definition at line 73 of file oxexceptiontodisplay.php.

Member Data Documentation

oxExceptionToDisplay::$_aValues
private

Definition at line 35 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::$_blDebug = false
protected

Definition at line 21 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::$_sMessage
private

Definition at line 14 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::$_sStackTrace
private

Definition at line 28 of file oxexceptiontodisplay.php.

oxExceptionToDisplay::$_sType
private

Definition at line 42 of file oxexceptiontodisplay.php.


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