* @param string exception message
* @param int $code
* @param Exception $previous
- *
- * @internal param array|\Exception|int|null|\PEAR_Error $exception cause
- * @internal param int|null $exception code or null
*/
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
* @var const
*/
CONST FATAL_ERROR = 2;
public static $modeException = NULL;
/**
- * singleton function used to manage this object.
+ * Singleton function used to manage this object.
*
* @param null $package
* @param bool $msgCallback
}
/**
- * constructor
+ * Constructor
*/
function __construct() {
parent::__construct('CiviCRM');
}
/**
- * 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.
}
/**
- * display an error page with an error message describing what happened
+ * Display an error page with an error message describing what happened
*
- * @param null $message
- * @param null $code
- * @param null $email
+ * @param string $message the error message
+ * @param string $code the error code if any
+ * @param string $email the email address to notify of this situation
*
* @throws Exception
- * @internal param \message $string the error message
- * @internal param \code $string the error code if any
- * @internal param \email $string the email address to notify of this situation
*
* @return void
* @static
- * @acess public
+ * @access public
*/
static function fatal($message = NULL, $code = NULL, $email = NULL) {
$vars = array(
}
}
+ 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
- * @acess public
+ * @access public
*/
static function handleUnhandledException($exception) {
$config = CRM_Core_Config::singleton();
}
/**
- * 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
* Similar to the function debug. Only difference is
* in the formatting of the output.
*
- * @param $variable_name
- * @param $variable
- * @param bool $print
- * @param bool $log
+ * @param string $variable_name
+ * @param mixed $variable
+ * @param bool $print should we use print_r ? (else we use var_dump)
+ * @param bool $log should we log or return the output
* @param string $comp variable name
*
- * @internal param \reference $mixed to variables that we need a trace of
- * @internal param \should $bool we use print_r ? (else we use var_dump)
- * @internal param \should $bool we log or return the output
- *
* @return string the generated output
*
* @access public
}
/**
- * display the error message on terminal
+ * Display the error message on terminal
*
* @param $message
* @param bool $out should we log or return the output
$fnName = CRM_Utils_Array::value('function', $trace);
$className = isset($trace['class']) ? ($trace['class'] . $trace['type']) : '';
- // do now show args for a few password related functions
+ // Do not show args for a few password related functions
$skipArgs = ($className == 'DB::' && $fnName == 'connect') ? TRUE : FALSE;
- foreach ($trace['args'] as $arg) {
- if (! $showArgs || $skipArgs) {
- $args[] = '(' . gettype($arg) . ')';
- continue;
- }
- switch ($type = gettype($arg)) {
- case 'boolean':
- $args[] = $arg ? 'TRUE' : 'FALSE';
- break;
- case 'integer':
- case 'double':
- $args[] = $arg;
- break;
- case 'string':
- $args[] = '"' . CRM_Utils_String::ellipsify(addcslashes((string) $arg, "\r\n\t\""), $maxArgLen). '"';
- break;
- case 'array':
- $args[] = '(Array:'.count($arg).')';
- break;
- case 'object':
- $args[] = 'Object(' . get_class($arg) . ')';
- break;
- case 'resource':
- $args[] = 'Resource';
- break;
- case 'NULL':
- $args[] = 'NULL';
- break;
- default:
- $args[] = "($type)";
- break;
+ if (!empty($trace['args'])) {
+ foreach ($trace['args'] as $arg) {
+ if (! $showArgs || $skipArgs) {
+ $args[] = '(' . gettype($arg) . ')';
+ continue;
+ }
+ switch ($type = gettype($arg)) {
+ case 'boolean':
+ $args[] = $arg ? 'TRUE' : 'FALSE';
+ break;
+ case 'integer':
+ case 'double':
+ $args[] = $arg;
+ break;
+ case 'string':
+ $args[] = '"' . CRM_Utils_String::ellipsify(addcslashes((string) $arg, "\r\n\t\""), $maxArgLen). '"';
+ break;
+ case 'array':
+ $args[] = '(Array:'.count($arg).')';
+ break;
+ case 'object':
+ $args[] = 'Object(' . get_class($arg) . ')';
+ break;
+ case 'resource':
+ $args[] = 'Resource';
+ break;
+ case 'NULL':
+ $args[] = 'NULL';
+ break;
+ default:
+ $args[] = "($type)";
+ break;
+ }
}
}
* @param $message
* @param int $code
* @param string $level
- * @param null $params
+ * @param array $params
*
* @return object
*/
}
/**
- * Function to reset the error stack
+ * Reset the error stack
*
* @access public
* @static
projects / civicrm-core.git / blobdiff