| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
* Start of the Error framework. We should check out and inherit from
* - PEAR_Exception(string $message, array $causes);
* - PEAR_Exception(string $message, array $causes, int $code);
*
- * @param string exception message
+ * @param string $message exception message
* @param int $code
* @param Exception $previous
*/
public function __construct($message = NULL, $code = 0, Exception $previous = NULL) {
parent::__construct($message, $code, $previous);
}
+
}
/**
class CRM_Core_Error extends PEAR_ErrorStack {
/**
- * Status code of various types of errors
+ * Status code of various types of errors.
*/
const FATAL_ERROR = 2;
const DUPLICATE_CONTACT = 8001;
* We only need one instance of this object. So we use the singleton
* pattern and cache the instance in this variable
* @var object
- * @static
*/
private static $_singleton = NULL;
/**
- * The logger object for this application
+ * The logger object for this application.
* @var object
- * @static
*/
private static $_log = NULL;
/**
* If modeException == true, errors are raised as exception instead of returning civicrm_errors
- * @static
*/
public static $modeException = NULL;
* @param string $stackClass
*
* @return object
- * @static
*/
public static function &singleton($package = NULL, $msgCallback = FALSE, $contextCallback = FALSE, $throwPEAR_Error = FALSE, $stackClass = 'PEAR_ErrorStack') {
if (self::$_singleton === NULL) {
}
/**
- * Constructor
+ * Constructor.
*/
public function __construct() {
parent::__construct('CiviCRM');
}
/**
- * Status display function specific to payment processor errors
+ * Status display function specific to payment processor errors.
* @param $error
* @param string $separator
*/
* the errors we expect are from the pear modules DB, DB_DataObject
* which currently use PEAR::raiseError to notify of error messages.
*
- * @param object PEAR_Error
+ * @param object $pearError PEAR_Error
*
* @return void
*/
$error['type'] = $pearError->getType();
$error['user_info'] = $pearError->getUserInfo();
$error['to_string'] = $pearError->toString();
- if (function_exists('mysql_error') &&
+
+ // We access connection info via _DB_DATAOBJECT instead
+ // of, e.g., calling getDatabaseConnection(), so that we
+ // can avoid infinite loops.
+ global $_DB_DATAOBJECT;
+
+ if (!isset($_DB_DATAOBJECT['CONFIG']['database'])) {
+ // we haven't setup sql, so it's not our sql error...
+ }
+ elseif (preg_match('/^mysql:/', $_DB_DATAOBJECT['CONFIG']['database']) &&
mysql_error()
) {
$mysql_error = mysql_error() . ', ' . mysql_errno();
// execute a dummy query to clear error stack
mysql_query('select 1');
}
- elseif (function_exists('mysqli_error')) {
+ elseif (preg_match('/^mysqli:/', $_DB_DATAOBJECT['CONFIG']['database'])) {
$dao = new CRM_Core_DAO();
- // we do it this way, since calling the function
- // getDatabaseConnection could potentially result
- // in an infinite loop
- global $_DB_DATAOBJECT;
if (isset($_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5])) {
$conn = $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5];
$link = $conn->connection;
}
/**
- * Display an error page with an error message describing what happened
+ * Display an error page with an error message describing what happened.
*
* @param string $message
* The error message.
* @throws Exception
*
* @return void
- * @static
*/
public static function fatal($message = NULL, $code = NULL, $email = NULL) {
$vars = array(
}
/**
- * Display an error page with an error message describing what happened
+ * Display an error page with an error message describing what happened.
*
* This function is evil -- it largely replicates fatal(). Hopefully the
* entire CRM_Core_Error system can be hollowed out and replaced with
* @param Exception $exception
*
* @return void
- * @static
*/
public static function handleUnhandledException($exception) {
try {
* Outputs pre-formatted debug information. Flushes the buffers
* so we can interrupt a potential POST/redirect
*
- * @param string name of debug section
- * @param mixed reference to variables that we need a trace of
- * @param bool should we log or return the output
- * @param bool whether to generate a HTML-escaped output
- * @param bool should we check permissions before displaying output
+ * @param string $name name of debug section
+ * @param $variable mixed reference to variables that we need a trace of
+ * @param bool $log should we log or return the output
+ * @param bool $html whether to generate a HTML-escaped output
+ * @param bool $checkPermission should we check permissions before displaying output
* useful when we die during initialization and permissioning
* subsystem is not initialized - CRM-13765
*
* @return string
* the generated output
- * @static
*/
public static function debug($name, $variable = NULL, $log = TRUE, $html = TRUE, $checkPermission = TRUE) {
$error = self::singleton();
* the generated output
*
*
- * @static
*
* @see CRM_Core_Error::debug()
* @see CRM_Core_Error::debug_log_message()
*/
- static function debug_var(
+ public static function debug_var(
$variable_name,
$variable,
$print = TRUE,
}
/**
- * Display the error message on terminal
+ * Display the error message on terminal.
*
* @param $message
* @param bool $out
* format of the backtrace
*
*
- * @static
*/
public static function debug_log_message($message, $out = FALSE, $comp = '') {
$config = CRM_Core_Config::singleton();
if ($config->userFrameworkLogging) {
// should call $config->userSystem->logger($message) here - but I got a situation where userSystem was not an object - not sure why
if ($config->userSystem->is_drupal and function_exists('watchdog')) {
- watchdog('civicrm', $message, NULL, WATCHDOG_DEBUG);
+ watchdog('civicrm', '%message', array('%message' => $message), WATCHDOG_DEBUG);
}
}
}
/**
- * Obtain a reference to the error log
+ * Obtain a reference to the error log.
*
* @param string $comp
*
}
/**
- * Render a backtrace array as a string
+ * Render a backtrace array as a string.
*
* @param array $backTrace
* Array of stack frames.
}
/**
- * Render a backtrace array as an array
+ * Render a backtrace array as an array.
*
* @param array $backTrace
* Array of stack frames.
}
/**
- * Render an exception as HTML string
+ * Render an exception as HTML string.
*
* @param Exception $e
* @return string
}
/**
- * Write details of an exception to the log
+ * Write details of an exception to the log.
*
* @param Exception $e
* @return string
* @param null $redirect
* @param string $title
* @return void
- * @static
*/
public static function statusBounce($status, $redirect = NULL, $title = NULL) {
$session = CRM_Core_Session::singleton();
}
/**
- * Reset the error stack
+ * Reset the error stack.
*
- * @static
*/
public static function reset() {
$error = self::singleton();
* The PEAR_ERROR object.
* @return object
* $obj
- * @static
*/
public static function nullHandler($obj) {
CRM_Core_Error::debug_log_message("Ignoring exception thrown by nullHandler: {$obj->code}, {$obj->message}");
}
/**
- * Terminate execution abnormally
+ * Terminate execution abnormally.
*/
protected static function abend($code) {
// do a hard rollback of any pending transactions
}
/**
- * @param $error
- * @param const $type
+ * @param array $error
+ * @param int $type
*
* @return bool
*/
}
return FALSE;
}
+
}
$e = new PEAR_ErrorStack('CRM');
projects / civicrm-core.git / blobdiff