Whoops\Handler\JsonResponseHandler Class Reference

Catches an exception and converts it to a JSON response. More...

Inheritance diagram for Whoops\Handler\JsonResponseHandler:

Collaboration diagram for Whoops\Handler\JsonResponseHandler:

Public Member Functions
	setJsonApi ($jsonApi=false)
	Returns errors[[]] instead of error[] to be in compliance with the json:api spec. More...
	addTraceToOutput ($returnFrames=null)
	handle ()
	contentType ()
Public Member Functions inherited from Whoops\Handler\Handler
	setRun (RunInterface $run)
	setInspector (Inspector $inspector)
	setException ($exception)

Private Attributes
	$returnFrames = false
	$jsonApi = false

Additional Inherited Members
Data Fields inherited from Whoops\Handler\Handler
const	DONE = 0x10
const	LAST_HANDLER = 0x20
	The Handler has handled the Throwable in some way, and wishes to skip any other Handler. More...
const	QUIT = 0x30
	The Handler has handled the Throwable in some way, and wishes to quit/stop execution. More...
Protected Member Functions inherited from Whoops\Handler\Handler
	getRun ()
	getInspector ()
	getException ()

Detailed Description

Catches an exception and converts it to a JSON response.

Additionally can also return exception frames for consumption by an API.

Definition at line 16 of file JsonResponseHandler.php.

Member Function Documentation

addTraceToOutput()

Whoops\Handler\JsonResponseHandler::addTraceToOutput

(

$returnFrames = null

)

Parameters

bool | null

$returnFrames

Returns

bool|$this

Definition at line 43 of file JsonResponseHandler.php.

References Whoops\Handler\JsonResponseHandler\$returnFrames.

Referenced by Whoops\Handler\JsonResponseHandler\handle().

    {
        if (func_num_args() == 0) {
            return $this->returnFrames;
        }

        $this->returnFrames = (bool) $returnFrames;
        return $this;
    }

Here is the caller graph for this function:

contentType()

Whoops\Handler\JsonResponseHandler::contentType

(

)

Returns

string

Definition at line 84 of file JsonResponseHandler.php.

    {
        return 'application/json';
    }

handle()

Whoops\Handler\JsonResponseHandler::handle

(

)

Returns

int

Implements Whoops\Handler\HandlerInterface.

Definition at line 56 of file JsonResponseHandler.php.

References $response, Whoops\Handler\JsonResponseHandler\addTraceToOutput(), Whoops\Handler\Handler\getInspector(), and Whoops\Handler\Handler\QUIT.

    {
        if ($this->jsonApi === true) {
            $response = [
                'errors' => [
                    Formatter::formatExceptionAsDataArray(
                        $this->getInspector(),
                        $this->addTraceToOutput()
                    ),
                ]
            ];
        } else {
            $response = [
                'error' => Formatter::formatExceptionAsDataArray(
                    $this->getInspector(),
                    $this->addTraceToOutput()
                ),
            ];
        }

        echo json_encode($response, defined('JSON_PARTIAL_OUTPUT_ON_ERROR') ? JSON_PARTIAL_OUTPUT_ON_ERROR : 0);

        return Handler::QUIT;
    }

Here is the call graph for this function:

setJsonApi()

Whoops\Handler\JsonResponseHandler::setJsonApi

(

$jsonApi = false

)

Returns errors[[]] instead of error[] to be in compliance with the json:api spec.

Parameters

bool

$jsonApi

Default is false

Returns

$this

Definition at line 33 of file JsonResponseHandler.php.

References Whoops\Handler\JsonResponseHandler\$jsonApi.

    {
        $this->jsonApi = (bool) $jsonApi;
        return $this;
    }

Field Documentation

$jsonApi

Whoops\Handler\JsonResponseHandler::$jsonApi = false

private

Definition at line 26 of file JsonResponseHandler.php.

Referenced by Whoops\Handler\JsonResponseHandler\setJsonApi().

$returnFrames

Whoops\Handler\JsonResponseHandler::$returnFrames = false

private

Definition at line 21 of file JsonResponseHandler.php.

Referenced by Whoops\Handler\JsonResponseHandler\addTraceToOutput().

---

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

• libs/composer/vendor/filp/whoops/src/Whoops/Handler/JsonResponseHandler.php