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
	addTraceToOutput ($returnFrames=null)
	onlyForAjaxRequests ($onlyForAjaxRequests=null)
	handle ()
Public Member Functions inherited from Whoops\Handler\Handler
	setRun (Run $run)
	setInspector (Inspector $inspector)
	setException (Exception $exception)

Private Member Functions
	isAjaxRequest ()
	Check, if possible, that this execution was triggered by an AJAX request. More...

Private Attributes
	$returnFrames = false
	$onlyForAjaxRequests = false

Additional Inherited Members
Data Fields inherited from Whoops\Handler\Handler
const	DONE = 0x10
	Return constants that can be returned from Handler::handle to message the handler walker. More...
const	LAST_HANDLER = 0x20
const	QUIT = 0x30
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 32 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:

handle()

Whoops\Handler\JsonResponseHandler::handle

(

)

Returns

int

Implements Whoops\Handler\HandlerInterface.

Definition at line 70 of file JsonResponseHandler.php.

References Whoops\Handler\JsonResponseHandler\addTraceToOutput(), Whoops\Util\Misc\canSendHeaders(), Whoops\Handler\Handler\DONE, Whoops\Handler\Handler\getInspector(), Whoops\Handler\JsonResponseHandler\isAjaxRequest(), Whoops\Handler\JsonResponseHandler\onlyForAjaxRequests(), and Whoops\Handler\Handler\QUIT.

    {
        if ($this->onlyForAjaxRequests() && !$this->isAjaxRequest()) {
            return Handler::DONE;
        }

        $response = array(
            'error' => Formatter::formatExceptionAsDataArray(
                $this->getInspector(),
                $this->addTraceToOutput()
            ),
        );

        if (\Whoops\Util\Misc::canSendHeaders()) {
            header('Content-Type: application/json');
        }

        echo json_encode($response);
        return Handler::QUIT;
    }

Here is the call graph for this function:

isAjaxRequest()

Whoops\Handler\JsonResponseHandler::isAjaxRequest ( )

private

Check, if possible, that this execution was triggered by an AJAX request.

Returns

bool

Definition at line 60 of file JsonResponseHandler.php.

References $_SERVER.

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

    {
        return (
            !empty($_SERVER['HTTP_X_REQUESTED_WITH'])
            && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
    }

Here is the caller graph for this function:

onlyForAjaxRequests()

Whoops\Handler\JsonResponseHandler::onlyForAjaxRequests

(

$onlyForAjaxRequests = null

)

Parameters

bool | null

$onlyForAjaxRequests

Returns

null|bool

Definition at line 46 of file JsonResponseHandler.php.

References Whoops\Handler\JsonResponseHandler\$onlyForAjaxRequests.

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

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

        $this->onlyForAjaxRequests = (bool) $onlyForAjaxRequests;
    }

Here is the caller graph for this function:

Field Documentation

$onlyForAjaxRequests

Whoops\Handler\JsonResponseHandler::$onlyForAjaxRequests = false

private

Definition at line 26 of file JsonResponseHandler.php.

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

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

• Services/Exceptions/lib/Whoops/Handler/JsonResponseHandler.php