uw Sun Feb 18 07:36:33 2001 EDT Modified files: /php4/pear/PHPDoc/exceptions PhpdocError.php Log: Sorry, whitespace only changes to follow the PEAR Coding conventions. Replaced tabs with spaces. Index: php4/pear/PHPDoc/exceptions/PhpdocError.php diff -u php4/pear/PHPDoc/exceptions/PhpdocError.php:1.2 php4/pear/PHPDoc/exceptions/PhpdocError.php:1.3 --- php4/pear/PHPDoc/exceptions/PhpdocError.php:1.2 Sun Dec 3 14:37:36 2000 +++ php4/pear/PHPDoc/exceptions/PhpdocError.php Sun Feb 18 07:36:32 2001 @@ -2,6 +2,8 @@ /** * PHPDoc Error Handling class * +* TODO: make this 100% PEAR compatible +* * 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 @@ -9,118 +11,124 @@ * * The class is widely equal to the PEAR error handling class PEAR_ERROR. * -* @author Ulf Wendel <[EMAIL PROTECTED]> -* @version $Id: PhpdocError.php,v 1.2 2000/12/03 22:37:36 uw Exp $ -* @package PHPDoc +* @author Ulf Wendel <[EMAIL PROTECTED]> +* @version $Id: PhpdocError.php,v 1.3 2001/02/18 15:36:32 uw Exp $ +* @package PHPDoc */ class PhpdocError { - - /** - * Name of the error object class used to construct the error message - * @var string $classname - */ - var $classname = "PhpdocError"; - - /** - * Error message prefix. - * @var string $error_message_prefix - */ - var $error_message_prefix = ""; + + /** + * Name of the error object class used to construct the error message + * + * @var string $classname + */ + var $classname = "PhpdocError"; + + /** + * Error message prefix. + * + * @var string $error_message_prefix + */ + var $error_message_prefix = ""; - /** - * Error prepend, used for HTML formatting. - * @var string $error_prepend - */ - var $error_prepend = "<b>"; - - /** - * Error append, used for HTML formatting. - * @var string $error_append - */ - var $error_append = "</b>"; - - /** - * The error message itself. - * - * Use getMessage() to access it. - * - * @var string $message - * @see PhpdocError() - */ - var $message = ""; - - /** - * File where the error occured. - * @var string $file - * @see PhpdocError() - */ - var $file = ""; - - /** - * Line number where the error occured. - * @var integer $line - * @see PhpdocError() - */ - var $line = 0; - - /** - * Array that describes how an error gets handled. - * @var array $errorHandling - * @see PhpdocError() - */ - var $errorHandling = array( - "print" => false, - "trigger" => false, - "die" => false - ); - - /** - * Sets the error message, filename and linenumber. - * - * @param string Errormessage - * @param string Name of the file where the error occured, use __FILE__ for this - * @param string Linenumber where the error occured, use __LINE__ for this - */ - function PhpdocError($message, $file, $line) { - - $this->message = $message; - $this->file = $file; - $this->line = $line; + /** + * Error prepend, used for HTML formatting. + * + * @var string $error_prepend + */ + var $error_prepend = "<b>"; + + /** + * Error append, used for HTML formatting. + * + * @var string $error_append + */ + var $error_append = "</b>"; + + /** + * The error message itself. + * + * Use getMessage() to access it. + * + * @var string $message + * @see PhpdocError() + */ + var $message = ""; + + /** + * File where the error occured. + * + * @var string $file + * @see PhpdocError() + */ + var $file = ""; + + /** + * Line number where the error occured. + * + * @var integer $line + * @see PhpdocError() + */ + var $line = 0; + + /** + * Array that describes how an error gets handled. + * @var array $errorHandling + * @see PhpdocError() + */ + var $errorHandling = array( + "print" => false, + "trigger" => false, + "die" => false + ); + + /** + * Sets the error message, filename and linenumber. + * + * @param string Errormessage + * @param string Name of the file where the error occured, use __FILE__ for +this + * @param string Linenumber where the error occured, use __LINE__ for this + */ + function PhpdocError($message, $file, $line) { + + $this->message = $message; + $this->file = $file; + $this->line = $line; - if ($this->errorHandling["print"]) - $this->printMessage(); - - if ($this->errorHandling["trigger"]) - trigger_error($this->getMessage(), "E_USER_NOTICE"); - - if ($this->errorHandling["die"]) - die($this->getMessage); - - } // end func PhpdocError + if ($this->errorHandling["print"]) + $this->printMessage(); + + if ($this->errorHandling["trigger"]) + trigger_error($this->getMessage(), "E_USER_NOTICE"); + + if ($this->errorHandling["die"]) + die($this->getMessage); + + } // end func PhpdocError - /** - * Returns a string with the error message. - * @access public - */ - function getMessage() { - - return sprintf("%s%s: %s [File: %s, Line: %s]%s", - $this->error_prepend, - $this->error_message_prefix, - $this->message, - $this->file, - $this->line, - $this->error_append); - - } // end func getMessage - - /** - * Prints the error message. - * @brother getMessage() - */ - function printMessage() { - print $this->getMessage(); - } // end func printMessage - + /** + * Returns a string with the error message. + * @access public + */ + function getMessage() { + + return sprintf("%s%s: %s [File: %s, Line: %s]%s", + $this->error_prepend, + $this->error_message_prefix, + $this->message, + $this->file, + $this->line, + $this->error_append); + + } // end func getMessage + + /** + * Prints the error message. + * @brother getMessage() + */ + function printMessage() { + print $this->getMessage(); + } // end func printMessage + } // end class PhpdocError ?> -- PHP CVS Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED]