final class StopActionException extends Exception (View source)

This exception is thrown by a controller to stop the execution of the current action and return the control to the dispatcher. The dispatcher catches this exception and - depending on the "dispatched" status of the request - either continues dispatching the request or returns control to the request handler.

See {\Neos\Flow\Mvc\Controller\AbstractController::throwStatus()} or {\Neos\Flow\Mvc\Controller\AbstractController::redirectToUri()} for more information.

Other control flow exceptions: {\Neos\Flow\Mvc\Exception\ForwardException}

Properties

protected string $referenceCode from  Exception
protected int $statusCode from  Exception
$response

The response to be received by the MVC Dispatcher.

Methods

string
getReferenceCode()

Returns a code which can be communicated publicly so that whoever experiences the exception can refer to it and a developer can find more information about it in the system log.

int
getStatusCode()

Returns the HTTP status code this exception corresponds to (defaults to 500).

createForResponse(ResponseInterface $response, string $details)

No description

Details

string getReferenceCode()

Returns a code which can be communicated publicly so that whoever experiences the exception can refer to it and a developer can find more information about it in the system log.

Return Value

string

int getStatusCode()

Returns the HTTP status code this exception corresponds to (defaults to 500).

Return Value

int

static StopActionException createForResponse(ResponseInterface $response, string $details)

No description

Parameters

ResponseInterface $response

The response to be received by the MVC Dispatcher.

string $details

Additional details just for this exception, in case it is logged (the regular exception message).

Return Value

StopActionException