Error Class Reference

The class managing creation of error messages. More...

Public Member Functions
	__construct ($id, $webservice, $name, $description, $debugInfo, $mime, $level)
	Constructor.
	__destruct ()
	getError ()
	Return the error message serialized given a certain mime type.
	xmlEncode ($string)
	Encode content to be included in XML files.
	jsonEncode ($string)
	Encode a string to put in a JSON value.
Data Fields
	$id = 0
	ID of the error.
	$webservice = ""
	URI of the web service that caused this error.
	$name = ""
	Name of the error.
	$description = ""
	Description of the error.
	$debugInfo = ""
	Debug information for this error.
	$mime = ""
	Mime type used to serialize the error message.
	$level = ""
	Level of the error: Fatal, Warning, Notice.

---

Detailed Description

The class managing creation of error messages.

Author:

Frederick Giasson, Structured Dynamics LLC.

Definition at line 26 of file Error.php.

---

Constructor & Destructor Documentation

__construct	(	$	id,
		$	webservice,
		$	name,
		$	description,
		$	debugInfo,
		$	mime,
		$	level
	)

Constructor.

Parameters:

[in]	$id	ID of the error
[in]	$webservice	URI of the web service that caused this error
[in]	$name	Name of the error
[in]	$description	Description of the error
[in]	$debugInfo	Debug information for this error
[in]	$mime	Mime type used to serialize the error message
[in]	$level	Level of the error: Fatal, Warning, Notice

Returns:

returns NULL

Author:

Frederick Giasson, Structured Dynamics LLC.

Definition at line 67 of file Error.php.

References $debugInfo, $description, $id, $level, $mime, $name, and $webservice.

__destruct

(

)

Definition at line 78 of file Error.php.

---

Member Function Documentation

getError

(

)

Return the error message serialized given a certain mime type.

Author:

Frederick Giasson, Structured Dynamics LLC.

Definition at line 88 of file Error.php.

References jsonEncode(), and xmlEncode().

Here is the call graph for this function:

jsonEncode

(

$

string

)

Encode a string to put in a JSON value.

Parameters:

[in]

$string

The string to escape

Returns:

returns the escaped string

Author:

Frederick Giasson, Structured Dynamics LLC.

Definition at line 156 of file Error.php.

Referenced by getError().

xmlEncode

(

$

string

)

Encode content to be included in XML files.

Parameters:

[in]

$string

The content string to be encoded

Returns:

returns the encoded string

Author:

Frederick Giasson, Structured Dynamics LLC.

Definition at line 141 of file Error.php.

Referenced by getError().

---

Field Documentation

$debugInfo = ""

Debug information for this error.

Definition at line 41 of file Error.php.

Referenced by __construct().

$description = ""

Description of the error.

Definition at line 38 of file Error.php.

Referenced by __construct().

$id = 0

ID of the error.

Definition at line 29 of file Error.php.

Referenced by __construct().

$level = ""

Level of the error: Fatal, Warning, Notice.

Definition at line 47 of file Error.php.

Referenced by __construct().

$mime = ""

Mime type used to serialize the error message.

Definition at line 44 of file Error.php.

Referenced by __construct().

$name = ""

Name of the error.

Definition at line 35 of file Error.php.

Referenced by __construct().

$webservice = ""

URI of the web service that caused this error.

Definition at line 32 of file Error.php.

Referenced by __construct().

---

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

• Error.php