Handler

class Handler implements ExceptionHandler (View source)

Traits

Properties

protected Container	$container	The container implementation.
protected Throwable>>	$dontReport	A list of the exception types that are not reported.
protected ReportableHandler[]	$reportCallbacks	The callbacks that should be used during reporting.
protected	$levels	A map of exceptions with their corresponding custom log levels.
protected Closure[]	$renderCallbacks	The callbacks that should be used during rendering.
protected Closure>	$exceptionMap	The registered exception mappings.
protected Throwable>>	$internalDontReport	A list of the internal exception types that should not be reported.
protected array<int,string>	$dontFlash	A list of the inputs that are never flashed for validation exceptions.

Methods

string

firstClosureParameterType(Closure $closure)

Get the class name of the first parameter of the given Closure.

from ReflectsClosures

array

firstClosureParameterTypes(Closure $closure)

Get the class names of the first parameter of the given Closure, including union types.

from ReflectsClosures

array

closureParameterTypes(Closure $closure)

Get the class names / types of the parameters of the given Closure.

from ReflectsClosures

void

__construct(Container $container)

Create a new exception handler instance.

void

ReportableHandler

reportable(callable $reportUsing)

$this

renderable(callable $renderUsing)

$this

map(Closure|string $from, Closure|string|null $to = null)

$this

ignore(string $class)

Indicate that the given exception type should not be reported.

$this

level(Throwable> $type, $level)

Set the log level for the given exception type.

void

report(Throwable $e)

Report or log an exception.

bool

shouldReport(Throwable $e)

Determine if the exception should be reported.

bool

shouldntReport(Throwable $e)

Determine if the exception is in the "do not report" list.

$this

stopIgnoring(string $exception)

Remove the given exception class from the list of exceptions that should be ignored.

array

buildExceptionContext(Throwable $e)

Create the context array for logging the given exception.

array

exceptionContext(Throwable $e)

Get the default exception context variables for logging.

array

context()

Get the default context variables for logging.

Response

render(Request $request, Throwable $e)

Render an exception into an HTTP response.

Throwable

prepareException(Throwable $e)

Prepare exception for rendering.

Throwable

mapException(Throwable $e)

Map the exception using a registered mapper if possible.

mixed

renderViaCallbacks(Request $request, Throwable $e)

Try to render a response from request and exception via render callbacks.

Response|RedirectResponse

renderExceptionResponse(Request $request, Throwable $e)

Render a default exception response if any.

Response|RedirectResponse

unauthenticated(Request $request, AuthenticationException $exception)

Convert an authentication exception into a response.

Response

convertValidationExceptionToResponse(ValidationException $e, Request $request)

Create a response object from the given validation exception.

Response|RedirectResponse

invalid(Request $request, ValidationException $exception)

Convert a validation exception into a response.

JsonResponse

invalidJson(Request $request, ValidationException $exception)

Convert a validation exception into a JSON response.

bool

shouldReturnJson(Request $request, Throwable $e)

Determine if the exception handler response should be JSON.

Response|RedirectResponse

prepareResponse(Request $request, Throwable $e)

Prepare a response for the given exception.

Response

convertExceptionToResponse(Throwable $e)

Create a Symfony response for the given exception.

string

renderExceptionContent(Throwable $e)

Get the response content for the given exception.

string

renderExceptionWithCustomRenderer(Throwable $e)

Render an exception to a string using the registered ExceptionRenderer.

string

renderExceptionWithSymfony(Throwable $e, bool $debug)

Render an exception to a string using Symfony.

Response

renderHttpException(HttpExceptionInterface $e)

Render the given HttpException.

void

registerErrorViewPaths()

string|null

getHttpExceptionView(HttpExceptionInterface $e)

Get the view used to render HTTP exceptions.

Response|RedirectResponse

toIlluminateResponse(Response $response, Throwable $e)

Map the given exception into an Illuminate response.

JsonResponse

prepareJsonResponse(Request $request, Throwable $e)

Prepare a JSON response for the given exception.

array

convertExceptionToArray(Throwable $e)

Convert the given exception to an array.

void

renderForConsole(OutputInterface $output, Throwable $e)

Render an exception to the console.

bool

isHttpException(Throwable $e)

Determine if the given exception is an HTTP exception.

Details

protected string firstClosureParameterType(Closure $closure)

Get the class name of the first parameter of the given Closure.

Parameters

Closure

$closure

Return Value

string

Exceptions

ReflectionException
RuntimeException

protected array firstClosureParameterTypes(Closure $closure)

Get the class names of the first parameter of the given Closure, including union types.

Parameters

Closure

$closure

Return Value

array

Exceptions

ReflectionException
RuntimeException

protected array closureParameterTypes(Closure $closure)

Get the class names / types of the parameters of the given Closure.

Parameters

Closure

$closure

Return Value

array

Exceptions

ReflectionException

void __construct(Container $container)

Create a new exception handler instance.

Parameters

Container

$container

Return Value

void

void register()

Return Value

void

ReportableHandler reportable(callable $reportUsing)

Parameters

callable

$reportUsing

Return Value

ReportableHandler

$this renderable(callable $renderUsing)

Parameters

callable

$renderUsing

Return Value

$this

$this map(Closure|string $from, Closure|string|null $to = null)

Parameters

Closure\|string	$from
Closure\|string\|null	$to

Return Value

$this

Exceptions

InvalidArgumentException

$this ignore(string $class)

Indicate that the given exception type should not be reported.

Parameters

string

$class

Return Value

$this

$this level(Throwable> $type, $level)

Set the log level for the given exception type.

Parameters

Throwable>	$type
	$level

Return Value

$this

void report(Throwable $e)

Report or log an exception.

Parameters

Throwable

Return Value

void

Exceptions

Throwable

bool shouldReport(Throwable $e)

Determine if the exception should be reported.

Parameters

Throwable

Return Value

bool

protected bool shouldntReport(Throwable $e)

Determine if the exception is in the "do not report" list.

Parameters

Throwable

Return Value

bool

$this stopIgnoring(string $exception)

Remove the given exception class from the list of exceptions that should be ignored.

Parameters

string

$exception

Return Value

$this

protected array buildExceptionContext(Throwable $e)

Create the context array for logging the given exception.

Parameters

Throwable

Return Value

array

protected array exceptionContext(Throwable $e)

Get the default exception context variables for logging.

Parameters

Throwable

Return Value

array

protected array context()

Get the default context variables for logging.

Return Value

array

Response render(Request $request, Throwable $e)

Render an exception into an HTTP response.

Parameters

Request	$request
Throwable	$e

Return Value

Response

Exceptions

Throwable

protected Throwable prepareException(Throwable $e)

Prepare exception for rendering.

Parameters

Throwable

Return Value

Throwable

protected Throwable mapException(Throwable $e)

Map the exception using a registered mapper if possible.

Parameters

Throwable

Return Value

Throwable

protected mixed renderViaCallbacks(Request $request, Throwable $e)

Try to render a response from request and exception via render callbacks.

Parameters

Request	$request
Throwable	$e

Return Value

mixed

Exceptions

ReflectionException

protected Response|RedirectResponse renderExceptionResponse(Request $request, Throwable $e)

Render a default exception response if any.

Parameters

Request	$request
Throwable	$e

Return Value

Response|RedirectResponse

protected Response|RedirectResponse unauthenticated(Request $request, AuthenticationException $exception)

Convert an authentication exception into a response.

Parameters

Request	$request
AuthenticationException	$exception

Return Value

Response|RedirectResponse

protected Response convertValidationExceptionToResponse(ValidationException $e, Request $request)

Create a response object from the given validation exception.

Parameters

ValidationException	$e
Request	$request

Return Value

Response

protected Response|RedirectResponse invalid(Request $request, ValidationException $exception)

Convert a validation exception into a response.

Parameters

Request	$request
ValidationException	$exception

Return Value

Response|RedirectResponse

protected JsonResponse invalidJson(Request $request, ValidationException $exception)

Convert a validation exception into a JSON response.

Parameters

Request	$request
ValidationException	$exception

Return Value

JsonResponse

protected bool shouldReturnJson(Request $request, Throwable $e)

Determine if the exception handler response should be JSON.

Parameters

Request	$request
Throwable	$e

Return Value

bool

protected Response|RedirectResponse prepareResponse(Request $request, Throwable $e)

Prepare a response for the given exception.

Parameters

Request	$request
Throwable	$e

Return Value

Response|RedirectResponse

protected Response convertExceptionToResponse(Throwable $e)

Create a Symfony response for the given exception.

Parameters

Throwable

Return Value

Response

protected string renderExceptionContent(Throwable $e)

Get the response content for the given exception.

Parameters

Throwable

Return Value

string

protected string renderExceptionWithCustomRenderer(Throwable $e)

Render an exception to a string using the registered ExceptionRenderer.

Parameters

Throwable

Return Value

string

protected string renderExceptionWithSymfony(Throwable $e, bool $debug)

Render an exception to a string using Symfony.

Parameters

Throwable	$e
bool	$debug

Return Value

string

protected Response renderHttpException(HttpExceptionInterface $e)

Render the given HttpException.

Parameters

HttpExceptionInterface

Return Value

Response

protected void registerErrorViewPaths()

Return Value

void

protected string|null getHttpExceptionView(HttpExceptionInterface $e)

Get the view used to render HTTP exceptions.

Parameters

HttpExceptionInterface

Return Value

string|null

protected Response|RedirectResponse toIlluminateResponse(Response $response, Throwable $e)

Map the given exception into an Illuminate response.

Parameters

Response	$response
Throwable	$e

Return Value

Response|RedirectResponse

protected JsonResponse prepareJsonResponse(Request $request, Throwable $e)

Prepare a JSON response for the given exception.

Parameters

Request	$request
Throwable	$e

Return Value

JsonResponse

protected array convertExceptionToArray(Throwable $e)

Convert the given exception to an array.

Parameters

Throwable

Return Value

array

void renderForConsole(OutputInterface $output, Throwable $e)

internal

This method is not meant to be used or overwritten outside the framework.

Render an exception to the console.

Parameters

OutputInterface	$output
Throwable	$e

Return Value

void

protected bool isHttpException(Throwable $e)

Determine if the given exception is an HTTP exception.

Parameters

Throwable

Return Value

bool

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Foundation/Exceptions/Handler.html