<?php
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
| 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
* Class CRM_Exception
*/
class CRM_Exception extends PEAR_Exception {
- // Redefine the exception so message isn't optional
/**
+ * Redefine the exception so message isn't optional
* Supported signatures:
* - PEAR_Exception(string $message);
* - PEAR_Exception(string $message, int $code);
* - 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) {
+ public function __construct($message = NULL, $code = 0, Exception $previous = NULL) {
parent::__construct($message, $code, $previous);
}
+
}
/**
/**
* Status code of various types of errors
- * @var const
*/
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
* @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') {
+ 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');
}
* 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
*/
}
// create the error array
- $error = array();
- $error['callback'] = $pearError->getCallback();
- $error['code'] = $pearError->getCode();
- $error['message'] = $pearError->getMessage();
- $error['mode'] = $pearError->getMode();
+ $error = array();
+ $error['callback'] = $pearError->getCallback();
+ $error['code'] = $pearError->getCode();
+ $error['message'] = $pearError->getMessage();
+ $error['mode'] = $pearError->getMode();
$error['debug_info'] = $pearError->getDebugInfo();
- $error['type'] = $pearError->getType();
- $error['user_info'] = $pearError->getUserInfo();
- $error['to_string'] = $pearError->toString();
+ $error['type'] = $pearError->getType();
+ $error['user_info'] = $pearError->getUserInfo();
+ $error['to_string'] = $pearError->toString();
if (function_exists('mysql_error') &&
mysql_error()
) {
self::abend(1);
}
- // this function is used to trap and print errors
- // during system initialization time. Hence the error
- // message is quite ugly
/**
+ * this function is used to trap and print errors
+ * during system initialization time. Hence the error
+ * message is quite ugly
+ *
* @param $pearError
*/
public static function simpleHandler($pearError) {
// create the error array
- $error = array();
- $error['callback'] = $pearError->getCallback();
- $error['code'] = $pearError->getCode();
- $error['message'] = $pearError->getMessage();
- $error['mode'] = $pearError->getMode();
+ $error = array();
+ $error['callback'] = $pearError->getCallback();
+ $error['code'] = $pearError->getCode();
+ $error['message'] = $pearError->getMessage();
+ $error['mode'] = $pearError->getMode();
$error['debug_info'] = $pearError->getDebugInfo();
- $error['type'] = $pearError->getType();
- $error['user_info'] = $pearError->getUserInfo();
- $error['to_string'] = $pearError->toString();
+ $error['type'] = $pearError->getType();
+ $error['user_info'] = $pearError->getUserInfo();
+ $error['to_string'] = $pearError->toString();
// ensure that debug does not check permissions since we are in bootstrap
// mode and need to print a decent message to help the user
* Also, if we do not return any value the PEAR_ErrorStack::push() then does the
* action of PEAR_ERRORSTACK_PUSHANDLOG which displays the errors on the screen,
* since the logger set for this error stack is 'display' - see CRM_Core_Config::getLog();
- *
*/
public static function handlePES($pearError) {
return PEAR_ERRORSTACK_PUSH;
/**
* 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
- * @param string $email the email address to notify of this situation
+ * @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
*
* @return void
- * @static
*/
public static function fatal($message = NULL, $code = NULL, $email = NULL) {
$vars = array(
$details = 'A fatal error was triggered';
if ($message) {
$details .= ': ' . $message;
- }
+ }
throw new Exception($details, $code);
}
* @param Exception $exception
*
* @return void
- * @static
*/
public static function handleUnhandledException($exception) {
try {
CRM_Utils_Hook::unhandledException($exception);
- } catch (Exception $other) {
+ }
+ 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));
}
* 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
+ * @return string
+ * the generated output
*/
public static function debug($name, $variable = NULL, $log = TRUE, $html = TRUE, $checkPermission = TRUE) {
$error = self::singleton();
*
* @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
+ * @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.
*
- * @return string the generated output
+ * @return string
+ * the generated output
*
*
- * @static
*
* @see CRM_Core_Error::debug()
* @see CRM_Core_Error::debug_log_message()
*/
- static function debug_var($variable_name,
+ public static function debug_var(
+ $variable_name,
$variable,
$print = TRUE,
- $log = TRUE,
- $comp = ''
+ $log = TRUE,
+ $comp = ''
) {
// check if variable is set
if (!isset($variable)) {
* Display the error message on terminal
*
* @param $message
- * @param bool $out should we log or return the output
+ * @param bool $out
+ * Should we log or return the output.
*
- * @param string $comp message to be output
- * @return string format of the backtrace
+ * @param string $comp
+ * Message to be output.
+ * @return string
+ * format of the backtrace
*
*
- * @static
*/
public static function debug_log_message($message, $out = FALSE, $comp = '') {
$config = CRM_Core_Config::singleton();
* Append to the query log (if enabled)
*/
public static function debug_query($string) {
- if ( defined( 'CIVICRM_DEBUG_LOG_QUERY' ) ) {
- if ( CIVICRM_DEBUG_LOG_QUERY == 'backtrace' ) {
- CRM_Core_Error::backtrace( $string, true );
- } else if ( CIVICRM_DEBUG_LOG_QUERY ) {
- CRM_Core_Error::debug_var( 'Query', $string, false, true );
+ if (defined('CIVICRM_DEBUG_LOG_QUERY')) {
+ if (CIVICRM_DEBUG_LOG_QUERY == 'backtrace') {
+ CRM_Core_Error::backtrace($string, TRUE);
+ }
+ elseif (CIVICRM_DEBUG_LOG_QUERY) {
+ CRM_Core_Error::debug_var('Query', $string, FALSE, TRUE);
}
}
}
$dao = CRM_Core_DAO::executeQuery($query);
$results = array();
while ($dao->fetch()) {
- $results[] = (array)$dao;
+ $results[] = (array) $dao;
}
CRM_Core_Error::debug_var('dao result', array('query' => $query, 'results' => $results));
}
/**
* Render a backtrace array as a string
*
- * @param array $backTrace array of stack frames
- * @param boolean $showArgs TRUE if we should try to display content of function arguments (which could be sensitive); FALSE to display only the type of each function argument
- * @param int $maxArgLen maximum number of characters to show from each argument string
- * @return string printable plain-text
+ * @param array $backTrace
+ * Array of stack frames.
+ * @param bool $showArgs
+ * TRUE if we should try to display content of function arguments (which could be sensitive); FALSE to display only the type of each function argument.
+ * @param int $maxArgLen
+ * Maximum number of characters to show from each argument string.
+ * @return string
+ * printable plain-text
*/
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);
}
- $message .= sprintf("#%s {main}\n", 1+$idx);
+ $message .= sprintf("#%s {main}\n", 1 + $idx);
return $message;
}
/**
* Render a backtrace array as an array
*
- * @param array $backTrace array of stack frames
- * @param boolean $showArgs TRUE if we should try to display content of function arguments (which could be sensitive); FALSE to display only the type of each function argument
- * @param int $maxArgLen maximum number of characters to show from each argument string
+ * @param array $backTrace
+ * Array of stack frames.
+ * @param bool $showArgs
+ * TRUE if we should try to display content of function arguments (which could be sensitive); FALSE to display only the type of each function argument.
+ * @param int $maxArgLen
+ * Maximum number of characters to show from each argument string.
* @return array
* @see debug_backtrace
* @see Exception::getTrace()
if (!empty($trace['args'])) {
foreach ($trace['args'] as $arg) {
- if (! $showArgs || $skipArgs) {
+ if (!$showArgs || $skipArgs) {
$args[] = '(' . gettype($arg) . ')';
continue;
}
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). '"';
+ $args[] = '"' . CRM_Utils_String::ellipsify(addcslashes((string) $arg, "\r\n\t\""), $maxArgLen) . '"';
break;
+
case 'array':
- $args[] = '(Array:'.count($arg).')';
+ $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;
* Render an exception as HTML string
*
* @param Exception $e
- * @return string printable HTML text
+ * @return string
+ * printable HTML text
*/
public static function formatHtmlException(Exception $e) {
$msg = '';
$msg .= '<tbody>';
foreach (array('Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo') as $f) {
$msg .= sprintf('<tr><td>%s</td><td>%s</td></tr>', $f, call_user_func(array($ei->getCause(), "get$f")));
- }
+ }
$msg .= '</tbody></table>';
- }
+ }
$ei = $ei->getCause();
- }
+ }
$msg .= $e->toHtml();
- } else {
+ }
+ else {
$msg .= '<p><b>' . get_class($e) . ': "' . htmlentities($e->getMessage()) . '"</b></p>';
$msg .= '<pre>' . htmlentities(self::formatBacktrace($e->getTrace())) . '</pre>';
}
* Write details of an exception to the log
*
* @param Exception $e
- * @return string printable plain text
+ * @return string
+ * printable plain text
*/
public static function formatTextException(Exception $e) {
$msg = get_class($e) . ": \"" . $e->getMessage() . "\"\n";
/**
* Set a status message in the session, then bounce back to the referrer.
*
- * @param string $status The status message to set
+ * @param string $status
+ * The status message to set.
*
* @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
*
- * @static
*/
public static function reset() {
$error = self::singleton();
/**
* PEAR error-handler to quietly catch otherwise fatal errors. Intended for use with smtp transport.
*
- * @param object $obj The PEAR_ERROR object
- * @return object $obj
- * @static
+ * @param object $obj
+ * The PEAR_ERROR object.
+ * @return object
+ * $obj
*/
public static function nullHandler($obj) {
CRM_Core_Error::debug_log_message("Ignoring exception thrown by nullHandler: {$obj->code}, {$obj->message}");
return $obj;
}
- /*
+ /**
* @deprecated
* This function is no longer used by v3 api.
* @fixme Some core files call it but it should be re-thought & renamed or removed
- */
- /**
+ *
* @param $msg
* @param null $data
*
}
/**
- * @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