PHPDOC 2000/12/03 - PHPDoc

PhpdocError

PHPDoc Error Handling class

private class PhpdocError

PHPDoc Error Handling class
PHPDoc "throws" an error class derived from this class wheneveran error occurs. PHPDoc saves the error object to the public array$this->err[] which exists in every PHPDoc class and tries to returna useful value that indicates that something might have gone wrong.The class is widely equal to the PEAR error handling class PEAR_ERROR.

Version $Id: $

Public Method Summary
void	PhpdocError(string $message, string $file, string $line) Sets the error message, filename and linenumber.
void	getMessage() Returns a string with the error message.

Private Method Summary
void	printMessage() Prints the error message.

Private Field Summary
string	$classname Name of the error object class used to construct the error message
string	$error_message_prefix Error message prefix.
string	$error_prepend Error prepend, used for HTML formatting.
string	$error_append Error append, used for HTML formatting.
string	$message The error message itself.
string	$file File where the error occured.
integer	$line Line number where the error occured.
array	$errorHandling Array that describes how an error gets handled.

Public Method Details

PhpdocError

public void PhpdocError( string $message, string $file, string $line )

Sets the error message, filename and linenumber.

Parameter

string	$message

string	$file
	of the file where the error occured, use __FILE__ for this

string	$line
	where the error occured, use __LINE__ for this

Returns

void

getMessage

public void getMessage( )

Returns a string with the error message.

Returns

void

Private Method Details
printMessage
private void printMessage( )
	Prints the error message.
Returns	void

Private Field Details
$classname
private string $classname >>`"PhpdocError"`<< Name of the error object class used to construct the error message

$error_message_prefix
private string $error_message_prefix >>`""`<< Error message prefix.

$error_prepend
private string $error_prepend >>`"<b>"`<< Error prepend, used for HTML formatting.

$error_append
private string $error_append >>`"</b>"`<< Error append, used for HTML formatting.

$message
private string $message >>`""`<< The error message itself. Use getMessage() to access it.
See Also	PhpdocError()

$file
private string $file >>`""`<< File where the error occured.
See Also	PhpdocError()

$line
private integer $line >><< Line number where the error occured.
See Also	PhpdocError()

$errorHandling
private array $errorHandling >>`array( "print" => false, "trigger" => false, "die" => false )`<< Array that describes how an error gets handled.
See Also	PhpdocError()