cvs: php4 /pear/DB common.php

ssb Tue Aug 14 08:50:33 2001 EDT Modified files: /php4/pear/DB common.php Log: * updated DB_common::raiseError doc Index: php4/pear/DB/common.php diff -u php4/pear/DB/common.php:1.58 php4/pear/DB/common.php:1.59 --- php4/pear/DB/common.php:1.58 Fri Aug 3 12:20:58 2001 +++ php4/pear/DB/common.php Tue Aug 14 08:50:33 2001 @@ -17,7 +17,7 @@ // | | // +----------------------------------------------------------------------+ // -// $Id: common.php,v 1.58 2001/08/03 16:20:58 cox Exp $ +// $Id: common.php,v 1.59 2001/08/14 12:50:33 ssb Exp $ // // Base class for DB implementations. // @@ -168,10 +168,33 @@ // {{{ raiseError() /** - * This method is called by DB to generate an error. + * This method is used to communicate an error and invoke error + * callbacks etc. Basically a wrapper for PEAR::raiseError + * without the message string. * + * @param mixed integer error code, or a PEAR error object (all + * other parameters are ignored if this parameter is + * an object + * + * @param int error mode, see PEAR_Error docs + * + * @param mixed If error mode is PEAR_ERROR_TRIGGER, this is the + * error level (E_USER_NOTICE etc). If error mode is + * PEAR_ERROR_CALLBACK, this is the callback function, + * either as a function name, or as an array of an + * object and method name. For other error modes this + * parameter is ignored. + * + * @param string Extra debug information. Defaults to the last + * query and native error code. + * + * @param mixed Native error code, integer or string depending the + * backend. + * + * @return object a PEAR error object + * + * @see PEAR_Error */ - function &raiseError($code = DB_ERROR, $mode = null, $options = null, $userinfo = null, $nativecode = null) {