public static function Error::decodeException

Decodes an exception and retrieves the correct caller.

Parameters

\Exception|\Throwable $exception: The exception object that was thrown.

Return value

array An error in the format expected by _drupal_log_error().

File

core/lib/Drupal/Core/Utility/Error.php, line 37

Class

Error

Drupal error utility class.

Namespace

Code

public static function decodeException($exception) {
  $message = $exception
    ->getMessage();
  $backtrace = $exception
    ->getTrace();

  // Add the line throwing the exception to the backtrace.
  array_unshift($backtrace, [
    'line' => $exception
      ->getLine(),
    'file' => $exception
      ->getFile(),
  ]);

  // For PDOException errors, we try to return the initial caller,
  // skipping internal functions of the database layer.
  if ($exception instanceof \PDOException || $exception instanceof DatabaseExceptionWrapper) {

    // The first element in the stack is the call, the second element gives us
    // the caller. We skip calls that occurred in one of the classes of the
    // database layer or in one of its global functions.
    $db_functions = [
      'db_query',
      'db_query_range',
    ];
    while (!empty($backtrace[1]) && ($caller = $backtrace[1]) && (isset($caller['class']) && (strpos($caller['class'], 'Query') !== FALSE || strpos($caller['class'], 'Database') !== FALSE || strpos($caller['class'], 'PDO') !== FALSE) || in_array($caller['function'], $db_functions))) {

      // We remove that call.
      array_shift($backtrace);
    }
    if (isset($exception->query_string, $exception->args)) {
      $message .= ": " . $exception->query_string . "; " . print_r($exception->args, TRUE);
    }
  }
  $caller = static::getLastCaller($backtrace);
  return [
    '%type' => get_class($exception),
    // The standard PHP exception handler considers that the exception message
    // is plain-text. We mimic this behavior here.
    '@message' => $message,
    '%function' => $caller['function'],
    '%file' => $caller['file'],
    '%line' => $caller['line'],
    'severity_level' => static::ERROR,
    'backtrace' => $backtrace,
    '@backtrace_string' => $exception
      ->getTraceAsString(),
  ];
}