Whoops\Exception\Inspector Class Reference

Collaboration diagram for Whoops\Exception\Inspector:

Public Member Functions
	__construct (Exception $exception)
	getException ()
	getExceptionName ()
	getExceptionMessage ()
	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
	getFrameFromException (Exception $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...

Private Attributes
	$exception
	$frames
	$previousExceptionInspector

Detailed Description

Definition at line 11 of file Inspector.php.

Constructor & Destructor Documentation

__construct()

Whoops\Exception\Inspector::__construct

(

Exception

$exception

)

Parameters

Exception

$exception

The exception to inspect

Definition at line 31 of file Inspector.php.

References Whoops\Exception\Inspector\$exception.

    {
        $this->exception = $exception;
    }

Member Function Documentation

getException()

Whoops\Exception\Inspector::getException

(

)

Returns

Exception

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:

getExceptionMessage()

Whoops\Exception\Inspector::getExceptionMessage

(

)

Returns

string

Definition at line 55 of file Inspector.php.

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

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 152 of file Inspector.php.

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

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

Here is the caller graph for this function:

getFrameFromException()

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

protected

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

Parameters

Exception

$exception

Returns

array

Definition at line 134 of file Inspector.php.

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

    {
        return array(
            'file'  => $exception->getFile(),
            'line'  => $exception->getLine(),
            'class' => get_class($exception),
            'args'  => array(
                $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 92 of file Inspector.php.

References Whoops\Exception\Inspector\$frames, Whoops\Exception\Inspector\getFrameFromError(), Whoops\Exception\Inspector\getFrameFromException(), and Whoops\Exception\Inspector\getPreviousExceptionInspector().

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

    {
        if ($this->frames === null) {
            $frames = $this->exception->getTrace();

            // If we're handling an ErrorException thrown by Whoops,
            // get rid of the last frame, which matches the handleError method,
            // and do not add the current exception to trace. We ensure that
            // the next frame does have a filename / linenumber, though.
            if ($this->exception instanceof ErrorException && empty($frames[1]['line'])) {
                $frames = array($this->getFrameFromError($this->exception));
            } else {
                $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 74 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:

hasPreviousException()

Whoops\Exception\Inspector::hasPreviousException

(

)

Does the wrapped Exception has a previous Exception?

Returns

bool

Definition at line 64 of file Inspector.php.

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

Field Documentation

$exception

Whoops\Exception\Inspector::$exception

private

Definition at line 16 of file Inspector.php.

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

$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:

• Services/Exceptions/lib/Whoops/Exception/Inspector.php