Class: GalleryStatus

Source Location: /modules/core/classes/GalleryStatus.class

Class GalleryStatus

Class Overview

Container for error status.

Located in /modules/core/classes/GalleryStatus.class [line 33]

Properties

Methods

[ Top ]

Property Summary

int	$_errorCode	The actual error code
string	$_errorMessage	A descriptive message of the error
array	$_stack	The stack trace, if possible.

[ Top ]

Method Summary

GalleryStatus	GalleryStatus()	Constructor
void	addErrorCode()	Add a new code to our set of codes
string	getAsHtml()	Return the error as an HTML string
string	getAsText()	Return the error as a plain text string delimited by newlines
int	getErrorCode()	Return the actual error code
array	getErrorCodeConstants()	Break down an error code into a list of constants
string	getErrorMessage()	Return the error message
void	putInSession()	Store error in session for reporting after a redirect
void	setStackTrace()	Set the stack trace
GalleryStatus	wrap()	Deprecated. Remove in the next major API bump.
void	_getAsArray()	Internal function collect error code and stack trace info

[ Top ]

Properties

int $_errorCode [line 47]

The actual error code

API Tags:

Access:

private

[ Top ]

string $_errorMessage [line 54]

A descriptive message of the error

API Tags:

Access:

private

[ Top ]

array $_stack [line 40]

The stack trace, if possible.

API Tags:

Access:

private

[ Top ]

Methods

Constructor GalleryStatus [line 62]

GalleryStatus GalleryStatus(
int
$errorCode, [string
$errorMessage = null] 
)

Constructor

Parameters:

int	$errorCode:	an error code
string	$errorMessage:	(optional) descriptive message of the error

[ Top ]

addErrorCode [line 95]

void addErrorCode(
int
$code 
)

Add a new code to our set of codes

Parameters:

int

$code:

an error code

[ Top ]

getAsHtml [line 116]

string getAsHtml(
[boolean
$showMessage = true] 
)

Return the error as an HTML string

Parameters:

boolean

$showMessage:

(optional) false to omit errorMessage

[ Top ]

getAsText [line 146]

string getAsText(
[boolean
$showMessage = true] 
)

Return the error as a plain text string delimited by newlines

Parameters:

boolean

$showMessage:

(optional) false to omit errorMessage

[ Top ]

getErrorCode [line 79]

int getErrorCode(
)

Return the actual error code

[ Top ]

getErrorCodeConstants [line 185]

array getErrorCodeConstants(

$errorCode 
)

Break down an error code into a list of constants

Parameters:

$errorCode:

API Tags:

Return:

of strings

[ Top ]

getErrorMessage [line 87]

string getErrorMessage(
)

Return the error message

[ Top ]

putInSession [line 170]

void putInSession(
)

Store error in session for reporting after a redirect

[ Top ]

setStackTrace [line 71]

void setStackTrace(
array
$trace 
)

Set the stack trace

Parameters:

array

$trace:

(array, array)

[ Top ]

wrap [line 106]

GalleryStatus wrap(
)

Deprecated. Remove in the next major API bump.

Add a new file name and line number to our stack trace

API Tags:

Return:	the new status object
Deprecated:

[ Top ]

_getAsArray [line 210]

void _getAsArray(
)

Internal function collect error code and stack trace info

API Tags:

Access:

private

[ Top ]

Documentation generated on Fri, 08 Oct 2010 05:04:10 -0700 by phpDocumentor 1.3.0RC6

	GalleryCore Classes

[ class tree: GalleryCore ] [ index: GalleryCore ] [ all elements ]