PEAR::raiseError() – Create a new PEAR_Error object and optionally specify error-handling instructions


require_once 'PEAR.php';

PEAR_Error PEAR::raiseError ( mixed $message , int $code , int $mode , int|array $options , mixed $userinfo , string $error_class , boolean $skipmsg )




string $message

Error message string or PEAR_Error object. The default message is unknown error if left blank.

integer $code

Error code. It is recommended to use an error code for even the simplest errors, in order to simplify error handling and processing.

integer $mode

Error mode. This is one of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT, PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE, PEAR_ERROR_CALLBACK, or PEAR_ERROR_EXCEPTION. See setErrorHandling() for detailed information and examples of the meaning of these constants.

mixed $options

Error options. This depends on the value of $mode, and is documented in setErrorHandling().

mixed $userinfo

Optional user information. This can be used to store any error-specific information, and has an unspecified format.

string $error_class

Error class name to use as the error object. The default error class is PEAR_Error. Use this parameter to specify another class to use, such as a custom class extending PEAR_Error

boolean $skipmsg

Use this parameter if you are using a custom class that does not accept an error message in its constructor. Never use this parameter without the $error_class parameter - it will not work.

Return value

A PEAR_Error object is returned, unless PEAR_ERROR_DIE terminates execution or a PEAR_ERROR_EXCEPTION is never handled.

checks for a PEAR_Error object (Previous) sets handling of errors generated through PEAR packages (Next)
Last updated: Sat, 16 Feb 2019 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report.
View this page in:
  • English

User Notes:

There are no user contributed notes for this page.