Collaboration diagram for Whoops\Exception\Inspector:

Public Member Functions
	__construct ($exception)

	getException ()

	getExceptionName ()

	getExceptionMessage ()

	getExceptionDocrefUrl ()
	Returns a url to the php-manual related to the underlying error - when available. More...

	hasPreviousException ()
	Does the wrapped Exception has a previous Exception? More...

	getPreviousExceptionInspector ()
	Returns an Inspector for a previous Exception, if any. More...

	getFrames ()
	Returns an iterator for the inspected exception's frames. More...

Protected Member Functions
	getTrace ($e)
	Gets the backtrace from an exception. More...

	getFrameFromException ($exception)
	Given an exception, generates an array in the format generated by Exception::getTrace() More...

	getFrameFromError (ErrorException $exception)
	Given an error, generates an array in the format generated by ErrorException. More...

	isValidNextFrame (array $frame)
	Determine if the frame can be used to fill in previous frame's missing info happens for call_user_func and call_user_func_array usages (PHP Bug #44428) More...

Private Member Functions
	extractDocrefUrl ($message)

Private Attributes
	$exception

	$frames

	$previousExceptionInspector

Detailed Description

Examples:: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 11 of file Inspector.php.

Constructor & Destructor Documentation

◆ __construct()

Whoops\Exception\Inspector::__construct ( $exception )

Parameters

\Throwable $exception The exception to inspect

Definition at line 31 of file Inspector.php.

References Whoops\Exception\Inspector\$exception.

     {
         $this->exception = $exception;
     }

Member Function Documentation

◆ extractDocrefUrl()

Whoops\Exception\Inspector::extractDocrefUrl ( $message )

private

Definition at line 70 of file Inspector.php.

References $message.

Referenced by Whoops\Exception\Inspector\getExceptionDocrefUrl(), and Whoops\Exception\Inspector\getExceptionMessage().

     {
         $docref = [
             'message' => $message,
             'url' => null,
         ];
 
         // php embbeds urls to the manual into the Exception message with the following ini-settings defined
         // http://php.net/manual/en/errorfunc.configuration.php#ini.docref-root
         if (!ini_get('html_errors') || !ini_get('docref_root')) {
             return $docref;
         }
 
         $pattern = "/\[<a href='([^']+)'>(?:[^<]+)<\/a>\]/";
         if (preg_match($pattern, $message, $matches)) {
             // -> strip those automatically generated links from the exception message
             $docref['message'] = preg_replace($pattern, '', $message, 1);
             $docref['url'] = $matches[1];
         }
 
         return $docref;
     }

Here is the caller graph for this function:

◆ getException()

Whoops\Exception\Inspector::getException ( )

Returns

Definition at line 39 of file Inspector.php.

References Whoops\Exception\Inspector\$exception.

Referenced by Whoops\Exception\Formatter\formatExceptionPlain().

     {
         return $this->exception;
     }

Here is the caller graph for this function:

◆ getExceptionDocrefUrl()

Whoops\Exception\Inspector::getExceptionDocrefUrl ( )

Returns a url to the php-manual related to the underlying error - when available.

Returns: string|null

Definition at line 65 of file Inspector.php.

References Whoops\Exception\Inspector\extractDocrefUrl().

     {
         return $this->extractDocrefUrl($this->exception->getMessage())['url'];
     }

Here is the call graph for this function:

◆ getExceptionMessage()

Whoops\Exception\Inspector::getExceptionMessage ( )

Returns: string

Definition at line 55 of file Inspector.php.

References Whoops\Exception\Inspector\extractDocrefUrl().

     {
         return $this->extractDocrefUrl($this->exception->getMessage())['message'];
     }

Here is the call graph for this function:

◆ getExceptionName()

Whoops\Exception\Inspector::getExceptionName ( )

Returns: string

Definition at line 47 of file Inspector.php.

Referenced by Whoops\Exception\Formatter\formatExceptionPlain().

     {
         return get_class($this->exception);
     }

Here is the caller graph for this function:

◆ getFrameFromError()

Whoops\Exception\Inspector::getFrameFromError ( ErrorException $exception )

protected

Given an error, generates an array in the format generated by ErrorException.

Parameters

ErrorException $exception

Returns: array

Definition at line 243 of file Inspector.php.

     {
         return [
             'file'  => $exception->getFile(),
             'line'  => $exception->getLine(),
             'class' => null,
             'args'  => [],
         ];
     }

◆ getFrameFromException()

Whoops\Exception\Inspector::getFrameFromException ( $exception )

protected

Given an exception, generates an array in the format generated by Exception::getTrace()

Parameters

\Throwable $exception

Returns: array

Definition at line 225 of file Inspector.php.

References Whoops\Exception\Inspector\$exception.

Referenced by Whoops\Exception\Inspector\getFrames().

     {
         return [
             'file'  => $exception->getFile(),
             'line'  => $exception->getLine(),
             'class' => get_class($exception),
             'args'  => [
                 $exception->getMessage(),
             ],
         ];
     }

Here is the caller graph for this function:

◆ getFrames()

Whoops\Exception\Inspector::getFrames ( )

Returns an iterator for the inspected exception's frames.

Returns

Definition at line 125 of file Inspector.php.

References Whoops\Exception\Inspector\$frames, $i, Whoops\Exception\Inspector\getFrameFromException(), Whoops\Exception\Inspector\getPreviousExceptionInspector(), Whoops\Exception\Inspector\getTrace(), and Whoops\Exception\Inspector\isValidNextFrame().

Referenced by Whoops\Exception\Formatter\formatExceptionPlain().

     {
         if ($this->frames === null) {
             $frames = $this->getTrace($this->exception);
 
             // Fill empty line/file info for call_user_func_array usages (PHP Bug #44428)
             foreach ($frames as $k => $frame) {
                 if (empty($frame['file'])) {
                     // Default values when file and line are missing
                     $file = '[internal]';
                     $line = 0;
 
                     $next_frame = !empty($frames[$k + 1]) ? $frames[$k + 1] : [];
 
                     if ($this->isValidNextFrame($next_frame)) {
                         $file = $next_frame['file'];
                         $line = $next_frame['line'];
                     }
 
                     $frames[$k]['file'] = $file;
                     $frames[$k]['line'] = $line;
                 }
             }
 
             // Find latest non-error handling frame index ($i) used to remove error handling frames
             $i = 0;
             foreach ($frames as $k => $frame) {
                 if ($frame['file'] == $this->exception->getFile() && $frame['line'] == $this->exception->getLine()) {
                     $i = $k;
                 }
             }
 
             // Remove error handling frames
             if ($i > 0) {
                 array_splice($frames, 0, $i);
             }
 
             $firstFrame = $this->getFrameFromException($this->exception);
             array_unshift($frames, $firstFrame);
 
             $this->frames = new FrameCollection($frames);
 
             if ($previousInspector = $this->getPreviousExceptionInspector()) {
                 // Keep outer frame on top of the inner one
                 $outerFrames = $this->frames;
                 $newFrames = clone $previousInspector->getFrames();
                 // I assume it will always be set, but let's be safe
                 if (isset($newFrames[0])) {
                     $newFrames[0]->addComment(
                         $previousInspector->getExceptionMessage(),
                         'Exception message:'
                     );
                 }
                 $newFrames->prependFrames($outerFrames->topDiff($newFrames));
                 $this->frames = $newFrames;
             }
         }
 
         return $this->frames;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPreviousExceptionInspector()

Whoops\Exception\Inspector::getPreviousExceptionInspector ( )

Returns an Inspector for a previous Exception, if any.

Todo:: Clean this up a bit, cache stuff a bit better.

Returns: Inspector

Definition at line 107 of file Inspector.php.

References Whoops\Exception\Inspector\$previousExceptionInspector.

Referenced by Whoops\Exception\Inspector\getFrames().

     {
         if ($this->previousExceptionInspector === null) {
             $previousException = $this->exception->getPrevious();
 
             if ($previousException) {
                 $this->previousExceptionInspector = new Inspector($previousException);
             }
         }
 
         return $this->previousExceptionInspector;
     }

Here is the caller graph for this function:

◆ getTrace()

Whoops\Exception\Inspector::getTrace ( $e )

protected

Gets the backtrace from an exception.

If xdebug is installed

Parameters

\Throwable $exception

Returns: array

Definition at line 194 of file Inspector.php.

References Whoops\Util\Misc\isLevelFatal().

Referenced by Whoops\Exception\Inspector\getFrames().

     {
         $traces = $e->getTrace();
 
         // Get trace from xdebug if enabled, failure exceptions only trace to the shutdown handler by default
         if (!$e instanceof \ErrorException) {
             return $traces;
         }
 
         if (!Misc::isLevelFatal($e->getSeverity())) {
             return $traces;
         }
 
         if (!extension_loaded('xdebug') || !xdebug_is_enabled()) {
             return [];
         }
 
         // Use xdebug to get the full stack trace and remove the shutdown handler stack trace
         $stack = array_reverse(xdebug_get_function_stack());
         $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
         $traces = array_diff_key($stack, $trace);
 
         return $traces;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasPreviousException()

Whoops\Exception\Inspector::hasPreviousException ( )

Does the wrapped Exception has a previous Exception?

Returns: bool

Definition at line 97 of file Inspector.php.

     {
         return $this->previousExceptionInspector || $this->exception->getPrevious();
     }

◆ isValidNextFrame()

Whoops\Exception\Inspector::isValidNextFrame ( array $frame )

protected

Determine if the frame can be used to fill in previous frame's missing info happens for call_user_func and call_user_func_array usages (PHP Bug #44428)

Parameters

array $frame

Returns: bool

Definition at line 260 of file Inspector.php.

Referenced by Whoops\Exception\Inspector\getFrames().

     {
         if (empty($frame['file'])) {
             return false;
         }
 
         if (empty($frame['line'])) {
             return false;
         }
 
         if (empty($frame['function']) || !stristr($frame['function'], 'call_user_func')) {
             return false;
         }
 
         return true;
     }

Here is the caller graph for this function:

Field Documentation

◆ $exception

Whoops\Exception\Inspector::$exception

private

Definition at line 16 of file Inspector.php.

Referenced by Whoops\Exception\Inspector\__construct(), Whoops\Exception\Inspector\getException(), and Whoops\Exception\Inspector\getFrameFromException().

◆ $frames

Whoops\Exception\Inspector::$frames

private

Definition at line 21 of file Inspector.php.

Referenced by Whoops\Exception\Inspector\getFrames().

◆ $previousExceptionInspector

Whoops\Exception\Inspector::$previousExceptionInspector

private

Definition at line 26 of file Inspector.php.

Referenced by Whoops\Exception\Inspector\getPreviousExceptionInspector().

The documentation for this class was generated from the following file:

libs/composer/vendor/filp/whoops/src/Whoops/Exception/Inspector.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ extractDocrefUrl()

◆ getException()

◆ getExceptionDocrefUrl()

◆ getExceptionMessage()

◆ getExceptionName()

◆ getFrameFromError()

◆ getFrameFromException()

◆ getFrames()

◆ getPreviousExceptionInspector()

◆ getTrace()

◆ hasPreviousException()

◆ isValidNextFrame()

Field Documentation

◆ $exception

◆ $frames

◆ $previousExceptionInspector