oxException Class Reference

Inheritance diagram for oxException:

[legend]

Collaboration diagram for oxException:

[legend]

List of all members.

Public Member Functions
	__construct ($sMessage="not set", $iCode=0)
	setLogFileName ($sFile)
	getLogFileName ()
	setMessage ($sMessage)
	setRenderer ()
	isRenderer ()
	setNotCaught ()
	isNotCaught ()
	debugOut ($iDebug=-1)
	getString ()
	getValues ()
	setDestination ($sDestination)
Protected Attributes
	$_sFileName = 'EXCEPTION_LOG.txt'
	$_blRenderer = false
	$_blNotCaught = false

---

Detailed Description

Basic exception class

Definition at line 7 of file oxexception.php.

---

Constructor & Destructor Documentation

oxException.__construct	(	$	sMessage = "not set",
		$	iCode = 0
	)

Default constructor

Parameters:

	string	$sMessage exception message
	integer	$iCode exception code

Definition at line 37 of file oxexception.php.

---

Member Function Documentation

oxException.debugOut

(

$

iDebug = -1

)

Prints exception in file EXCEPTION_LOG.txt

Parameters:

integer

$iDebug current debug level. This parameter is deprecated.

Returns:

null

Definition at line 123 of file oxexception.php.

oxException.getLogFileName

(

)

Get log file path/name

Returns:

string

Definition at line 59 of file oxexception.php.

oxException.getString

(

)

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

Returns:

string

Reimplemented in oxArticleException, oxArticleInputException, oxConnectionException, oxCookieException, oxFileException, oxInputException, oxLanguageException, oxNoArticleException, oxObjectException, oxOutOfStockException, oxShopException, oxSystemComponentException, oxUserException, and oxVoucherException.

Definition at line 139 of file oxexception.php.

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 oxArticleException, oxConnectionException, oxFileException, oxLanguageException, oxOutOfStockException, oxSystemComponentException, and oxVoucherException.

Definition at line 171 of file oxexception.php.

oxException.isNotCaught

(

)

Is the exception "not" caught.

Returns:

bool

Definition at line 111 of file oxexception.php.

oxException.isRenderer

(

)

Is the exception caught in a renderer

Returns:

bool

Definition at line 91 of file oxexception.php.

oxException.setDestination

(

$

sDestination

)

Defines a name of the view variable containing the messages

Parameters:

string

$sDestination name of the view variable

Returns:

null

Reimplemented in oxOutOfStockException.

Definition at line 183 of file oxexception.php.

oxException.setLogFileName

(

$

sFile

)

Set log file path/name

Parameters:

string

$sFile File name

Returns:

null

Definition at line 49 of file oxexception.php.

oxException.setMessage

(

$

sMessage

)

Sets the exception message

Parameters:

string

$sMessage exception message

Returns:

null

Definition at line 71 of file oxexception.php.

oxException.setNotCaught

(

)

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

Returns:

null

Definition at line 101 of file oxexception.php.

oxException.setRenderer

(

)

To define that the exception was caught in renderer

Returns:

null

Definition at line 81 of file oxexception.php.

---

Member Data Documentation

oxException.$_blNotCaught = false [protected]

Definition at line 29 of file oxexception.php.

oxException.$_blRenderer = false [protected]

Definition at line 22 of file oxexception.php.

oxException.$_sFileName = 'EXCEPTION_LOG.txt' [protected]

Reimplemented in oxFileException.

Definition at line 14 of file oxexception.php.

---

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

• core/exception/oxexception.php