class PreventRequestsDuringMaintenance (View source)

Properties

protected Application $app

The application implementation.

protected array<int,string> $except

The URIs that should be accessible while maintenance mode is enabled.

Methods

void
__construct(Application $app)

Create a new middleware instance.

mixed
handle(Request $request, Closure $next)

Handle an incoming request.

bool
hasValidBypassCookie(Request $request, array $data)

Determine if the incoming request has a maintenance mode bypass cookie.

bool
inExceptArray(Request $request)

Determine if the request has a URI that should be accessible in maintenance mode.

bypassResponse(string $secret)

Redirect the user back to the root of the application with a maintenance mode bypass cookie.

array
getHeaders(array $data)

Get the headers that should be sent with the response.

array
getExcludedPaths()

Get the URIs that should be accessible even when maintenance mode is enabled.

Details

void __construct(Application $app)

Create a new middleware instance.

Parameters

Application $app

Return Value

void

mixed handle(Request $request, Closure $next)

Handle an incoming request.

Parameters

Request $request
Closure $next

Return Value

mixed

Exceptions

HttpException

protected bool hasValidBypassCookie(Request $request, array $data)

Determine if the incoming request has a maintenance mode bypass cookie.

Parameters

Request $request
array $data

Return Value

bool

protected bool inExceptArray(Request $request)

Determine if the request has a URI that should be accessible in maintenance mode.

Parameters

Request $request

Return Value

bool

protected RedirectResponse bypassResponse(string $secret)

Redirect the user back to the root of the application with a maintenance mode bypass cookie.

Parameters

string $secret

Return Value

RedirectResponse

protected array getHeaders(array $data)

Get the headers that should be sent with the response.

Parameters

array $data

Return Value

array

array getExcludedPaths()

Get the URIs that should be accessible even when maintenance mode is enabled.

Return Value

array