Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/exceptions/PhpdocError.php
PEAR Repository - PHPDoc

PhpdocError

PhpdocError

PHPDoc Error Handling class

 

private class PhpdocError

PHPDoc Error Handling class

PHPDoc "throws" an error class derived from this class whenever
an error occurs. PHPDoc saves the error object to the public array
$this->err[] which exists in every PHPDoc class and tries to return
a useful value that indicates that something might have gone wrong.

The class is widely equal to the PEAR error handling class PEAR_ERROR.

AuthorsUlf Wendel <ulf.wendel@phpdoc.de>
Version1.0

 

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
Errormessage
string $file
Name of the file where the error occured, use __FILE__ for this
string $line
Linenumber 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"<<


$error_message_prefix

private string $error_message_prefix

>>""<<


$error_prepend

private string $error_prepend

>>"<b>"<<


$error_append

private string $error_append

>>"</b>"<<


$message

private string $message

>>""<<

See Also P::P

$file

private string $file

>>""<<

See Also PhpdocError()

$line

private integer $line

>><<

See Also PhpdocError()

$errorHandling

private array $errorHandling

>>array( "print" => false, "trigger" => false, "die" => false )<<

See Also PhpdocError()


Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta