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 the Action Controller's forward() and redirectToUri() methods for more information.

Properties

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

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).

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