Public Member Functions | Protected Attributes | Private Attributes

oxExceptionToDisplay Class Reference

Inheritance diagram for oxExceptionToDisplay:
Collaboration diagram for oxExceptionToDisplay:

List of all members.

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 172 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.addValue ( sName,
sValue 
)

Stores into exception storage message or other value

Parameters:
string $sName storage name
mixed $sValue value to store

Definition at line 81 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.getErrorClassType (  ) 

Returns error class type

Returns:
string

Implements oxIDisplayError.

Definition at line 101 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.getOxMessage (  ) 

Returns translated exception message

Returns:
string

Implements oxIDisplayError.

Definition at line 152 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.getStackTrace (  ) 

Returns stack trace

Returns:
string

Definition at line 60 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.getValue ( sName  ) 

Returns exception stored (by name) value

Parameters:
string $sName storage name
Returns:
mixed

Implements oxIDisplayError.

Definition at line 113 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.setDebug ( bl  ) 

Exception debug mode setter

Parameters:
bool $bl if TRUE debug mode on

Definition at line 123 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.setExceptionType ( sType  ) 

Exception type setter

Parameters:
string $sType exception type

Definition at line 91 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.setMessage ( sMessage  ) 

Exception message setter

Parameters:
string $sMessage exception message

Definition at line 133 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.setMessageArgs (  ) 

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

Definition at line 142 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.setStackTrace ( sStackTrace  ) 

Stack trace setter

Parameters:
string $sStackTrace stack trace

Definition at line 50 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.setValues ( aValues  ) 

Sets oxExceptionToDisplay._aValues value

Parameters:
array $aValues exception values to store

Definition at line 70 of file oxexceptiontodisplay.php.


Member Data Documentation

oxExceptionToDisplay.$_aValues [private]

Definition at line 36 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.$_blDebug = false [protected]

Definition at line 22 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.$_sMessage [private]

Definition at line 15 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.$_sStackTrace [private]

Definition at line 29 of file oxexceptiontodisplay.php.

oxExceptionToDisplay.$_sType [private]

Definition at line 43 of file oxexceptiontodisplay.php.


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