oxException Class Reference
Detailed Description
Basic exception classPublic Member Functions | |
| __construct ($sMessage="not set", $iCode=0) | |
| setLogFileName ($sFile) | |
| getLogFileName () | |
| setMessage ($sMessage) | |
| setRenderer () | |
| isRenderer () | |
| setNotCaught () | |
| isNotCaught () | |
| debugOut ($iDebug=-1) | |
| getString () | |
| getValues () | |
Protected Attributes | |
| $_sFileName = 'EXCEPTION_LOG.txt' | |
| $_blRenderer = false | |
| $_blNotCaught = false | |
Constructor & Destructor Documentation
| oxException.__construct | ( | $ | sMessage = "not set", |
|
| $ | iCode = 0 | |||
| ) |
Default constructor
- Parameters:
-
string $sMessage exception message integer $iCode exception code
Member Function Documentation
| oxException.setLogFileName | ( | $ | sFile | ) |
Set log file path/name
- Parameters:
-
string $sFile File name
- Returns:
- null
| oxException.getLogFileName | ( | ) |
Get log file path/name
- Returns:
- string
| oxException.setMessage | ( | $ | sMessage | ) |
Sets the exception message
- Parameters:
-
string $sMessage exception message
- Returns:
- null
| oxException.setRenderer | ( | ) |
To define that the exception was caught in renderer
- Returns:
- null
| oxException.isRenderer | ( | ) |
Is the exception caught in a renderer
- Returns:
- bool
| oxException.setNotCaught | ( | ) |
To define that the exception was not caught (only in oxexceptionhandler)
- Returns:
- null
| oxException.isNotCaught | ( | ) |
Is the exception "not" caught.
- Returns:
- bool
| oxException.debugOut | ( | $ | iDebug = -1 |
) |
Prints exception in file EXCEPTION_LOG.txt
- Parameters:
-
integer $iDebug current debug level (will only print out on debug != 0)
- Returns:
- null
| oxException.getString | ( | ) |
Get complete string dump, should be overwritten by excptions extending this exceptions if they introduce new fields
- Returns:
- string
Reimplemented in oxAccessRightException, oxArticleException, oxArticleInputException, oxConnectionException, oxCookieException, oxFileException, oxInputException, oxLanguageException, oxNoArticleException, oxObjectException, oxOutOfStockException, oxShopException, oxSystemComponentException, oxUserException, and oxVoucherException.
| oxException.getValues | ( | ) |
Default __toString method wraps getString(). In the shop no __toString() is used to be PHP 5.1 compatible,
- Returns:
- string 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!
array
Reimplemented in oxAccessRightException, oxArticleException, oxConnectionException, oxFileException, oxLanguageException, oxOutOfStockException, oxSystemComponentException, and oxVoucherException.
Member Data Documentation
oxException.$_sFileName = 'EXCEPTION_LOG.txt' [protected] |
Reimplemented in oxFileException.
oxException.$_blRenderer = false [protected] |
oxException.$_blNotCaught = false [protected] |
The documentation for this class was generated from the following file:
- core/exception/oxexception.php
