oxException Class Reference

Inheritance diagram for oxException:

Collaboration diagram for oxException:

Public Member Functions
	__construct ($sMessage="not set", $iCode=0)
	setLogFileName ($sFile)
	getLogFileName ()
	setMessage ($sMessage)
	setRenderer ()
	isRenderer ()
	setNotCaught ()
	isNotCaught ()
	debugOut ()
	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 40 of file oxexception.php.

Member Function Documentation

oxException::debugOut

(

)

Prints exception in file EXCEPTION_LOG.txt

Definition at line 118 of file oxexception.php.

oxException::getLogFileName

(

)

Get log file path/name

Deprecated:

since v5.3 (2016-06-17); Logging mechanism will be changed in 6.0.

Returns

string

Definition at line 64 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 oxConnectionException, oxFileException, oxArticleException, oxOutOfStockException, oxSystemComponentException, oxObjectException, oxLanguageException, oxVoucherException, oxInputException, oxUserException, oxArticleInputException, oxShopException, oxCookieException, and oxNoArticleException.

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

Definition at line 168 of file oxexception.php.

oxException::isNotCaught

(

)

Is the exception "not" caught.

Returns

bool

Definition at line 110 of file oxexception.php.

oxException::isRenderer

(

)

Is the exception caught in a renderer

Returns

bool

Definition at line 92 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

Reimplemented in oxOutOfStockException.

Definition at line 178 of file oxexception.php.

oxException::setLogFileName

(

$sFile

)

Set log file path/name

Deprecated:

since v5.3 (2016-06-17); Logging mechanism will be changed in 6.0.

Parameters

string

$sFile

File name

Definition at line 52 of file oxexception.php.

oxException::setMessage

(

$sMessage

)

Sets the exception message

Parameters

string

$sMessage

exception message

Definition at line 74 of file oxexception.php.

oxException::setNotCaught

(

)

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

Definition at line 100 of file oxexception.php.

oxException::setRenderer

(

)

To define that the exception was caught in renderer

Definition at line 82 of file oxexception.php.

Member Data Documentation

oxException::$_blNotCaught = false

protected

Definition at line 32 of file oxexception.php.

oxException::$_blRenderer = false

protected

Definition at line 25 of file oxexception.php.

oxException::$_sFileName = 'EXCEPTION_LOG.txt'

protected

Definition at line 17 of file oxexception.php.

---

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

• core/exception/oxexception.php