/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
class CRM_Core_Error extends PEAR_ErrorStack {
/**
- * status code of various types of errors
+ * Status code of various types of errors
* @var const
*/
- CONST FATAL_ERROR = 2;
- CONST DUPLICATE_CONTACT = 8001;
- CONST DUPLICATE_CONTRIBUTION = 8002;
- CONST DUPLICATE_PARTICIPANT = 8003;
+ const FATAL_ERROR = 2;
+ const DUPLICATE_CONTACT = 8001;
+ const DUPLICATE_CONTRIBUTION = 8002;
+ const DUPLICATE_PARTICIPANT = 8003;
/**
* We only need one instance of this object. So we use the singleton
public static $modeException = NULL;
/**
- * singleton function used to manage this object.
+ * Singleton function used to manage this object.
*
* @param null $package
* @param bool $msgCallback
* @return object
* @static
*/
- static function &singleton($package = NULL, $msgCallback = FALSE, $contextCallback = FALSE, $throwPEAR_Error = FALSE, $stackClass = 'PEAR_ErrorStack') {
+ public static function &singleton($package = NULL, $msgCallback = FALSE, $contextCallback = FALSE, $throwPEAR_Error = FALSE, $stackClass = 'PEAR_ErrorStack') {
if (self::$_singleton === NULL) {
self::$_singleton = new CRM_Core_Error('CiviCRM');
}
}
/**
- * constructor
+ * Constructor
*/
- function __construct() {
+ public function __construct() {
parent::__construct('CiviCRM');
$log = CRM_Core_Config::getLog();
* @param $error
* @param string $separator
*/
- static function displaySessionError(&$error, $separator = '<br />') {
+ public static function displaySessionError(&$error, $separator = '<br />') {
$message = self::getMessages($error, $separator);
if ($message) {
$status = ts("Payment Processor Error message") . "{$separator} $message";
}
/**
- * create the main callback method. this method centralizes error processing.
+ * Create the main callback method. this method centralizes error processing.
*
* 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
*
* @return void
- * @access public
*/
public static function handle($pearError) {
}
/**
- * 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
* @param string $code the error code if any
*
* @return void
* @static
- * @access public
*/
- static function fatal($message = NULL, $code = NULL, $email = NULL) {
+ public static function fatal($message = NULL, $code = NULL, $email = NULL) {
$vars = array(
'message' => $message,
'code' => $code,
}
}
+ if ($config->backtrace) {
+ self::backtrace();
+ }
+
+ CRM_Core_Error::debug_var('Fatal Error Details', $vars);
+ CRM_Core_Error::backtrace('backTrace', TRUE);
+
// If we are in an ajax callback, format output appropriately
if (CRM_Utils_Array::value('snippet', $_REQUEST) === CRM_Core_Smarty::PRINT_JSON) {
$out = array(
CRM_Core_Page_AJAX::returnJsonResponse($out);
}
- if ($config->backtrace) {
- self::backtrace();
- }
-
$template = CRM_Core_Smarty::singleton();
$template->assign($vars);
- CRM_Core_Error::debug_var('Fatal Error Details', $vars);
- CRM_Core_Error::backtrace('backTrace', TRUE);
$config->userSystem->outputError($template->fetch($config->fatalErrorTemplate));
self::abend(CRM_Core_Error::FATAL_ERROR);
}
/**
- * 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
*
* @return void
* @static
- * @access public
*/
- static function handleUnhandledException($exception) {
+ public static function handleUnhandledException($exception) {
+ try {
+ CRM_Utils_Hook::unhandledException($exception);
+ } catch (Exception $other) {
+ // if the exception-handler generates an exception, then that sucks! oh, well. carry on.
+ CRM_Core_Error::debug_var('handleUnhandledException_nestedException', self::formatTextException($other));
+ }
$config = CRM_Core_Config::singleton();
$vars = array(
'message' => $exception->getMessage(),
}
/**
- * outputs pre-formatted debug information. Flushes the buffers
+ * Outputs pre-formatted debug information. Flushes the buffers
* so we can interrupt a potential POST/redirect
*
* @param string name of debug section
* subsystem is not initialized - CRM-13765
*
* @return string the generated output
- * @access public
* @static
*/
- static function debug($name, $variable = NULL, $log = TRUE, $html = TRUE, $checkPermission = TRUE) {
+ public static function debug($name, $variable = NULL, $log = TRUE, $html = TRUE, $checkPermission = TRUE) {
$error = self::singleton();
if ($variable === NULL) {
*
* @return string the generated output
*
- * @access public
*
* @static
*
}
/**
- * display the error message on terminal
+ * Display the error message on terminal
*
* @param $message
* @param bool $out should we log or return the output
* @param string $comp message to be output
* @return string format of the backtrace
*
- * @access public
*
* @static
*/
- static function debug_log_message($message, $out = FALSE, $comp = '') {
+ public static function debug_log_message($message, $out = FALSE, $comp = '') {
$config = CRM_Core_Config::singleton();
$file_log = self::createDebugLogger($comp);
/**
* Append to the query log (if enabled)
*/
- static function debug_query($string) {
+ public static function debug_query($string) {
if ( defined( 'CIVICRM_DEBUG_LOG_QUERY' ) ) {
if ( CIVICRM_DEBUG_LOG_QUERY == 'backtrace' ) {
CRM_Core_Error::backtrace( $string, true );
}
}
+ /**
+ * Execute a query and log the results.
+ *
+ * @param string $query
+ */
+ public static function debug_query_result($query) {
+ $dao = CRM_Core_DAO::executeQuery($query);
+ $results = array();
+ while ($dao->fetch()) {
+ $results[] = (array)$dao;
+ }
+ CRM_Core_Error::debug_var('dao result', array('query' => $query, 'results' => $results));
+ }
+
/**
* Obtain a reference to the error log
*
*
* @return Log
*/
- static function createDebugLogger($comp = '') {
+ public static function createDebugLogger($comp = '') {
$config = CRM_Core_Config::singleton();
if ($comp) {
* @param string $msg
* @param bool $log
*/
- static function backtrace($msg = 'backTrace', $log = FALSE) {
+ public static function backtrace($msg = 'backTrace', $log = FALSE) {
$backTrace = debug_backtrace();
$message = self::formatBacktrace($backTrace);
if (!$log) {
* @param int $maxArgLen maximum number of characters to show from each argument string
* @return string printable plain-text
*/
- static function formatBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) {
+ public static function formatBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) {
$message = '';
foreach (self::parseBacktrace($backTrace, $showArgs, $maxArgLen) as $idx => $trace) {
$message .= sprintf("#%s %s\n", $idx, $trace);
* @see debug_backtrace
* @see Exception::getTrace()
*/
- static function parseBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) {
+ public static function parseBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) {
$ret = array();
foreach ($backTrace as $trace) {
$args = array();
* @param Exception $e
* @return string printable HTML text
*/
- static function formatHtmlException(Exception $e) {
+ public static function formatHtmlException(Exception $e) {
$msg = '';
// Exception metadata
* @param Exception $e
* @return string printable plain text
*/
- static function formatTextException(Exception $e) {
+ public static function formatTextException(Exception $e) {
$msg = get_class($e) . ": \"" . $e->getMessage() . "\"\n";
$ei = $e;
* @param $message
* @param int $code
* @param string $level
- * @param null $params
+ * @param array $params
*
* @return object
*/
- static function createError($message, $code = 8000, $level = 'Fatal', $params = NULL) {
+ public static function createError($message, $code = 8000, $level = 'Fatal', $params = NULL) {
$error = CRM_Core_Error::singleton();
$error->push($code, $level, array($params), $message);
return $error;
* @param null $redirect
* @param string $title
* @return void
- * @access public
* @static
*/
public static function statusBounce($status, $redirect = NULL, $title = NULL) {
}
/**
- * reset the error stack
+ * Reset the error stack
*
- * @access public
* @static
*/
public static function reset() {
*
* @param object $obj The PEAR_ERROR object
* @return object $obj
- * @access public
* @static
*/
public static function nullHandler($obj) {
projects / civicrm-core.git / blobdiff