W3cubDocs

/Laravel 11

CheckForMaintenanceMode

class CheckForMaintenanceMode extends PreventRequestsDuringMaintenance (View source)

Traits

ExcludesPaths

Properties

protected Application $app

The application implementation.

 from PreventRequestsDuringMaintenance
protected array<int,string> $except

The URIs that should be excluded.

 from PreventRequestsDuringMaintenance
static protected array $neverPrevent

The URIs that should be accessible during maintenance.

 from PreventRequestsDuringMaintenance

Methods

bool inExceptArray(Request $request)

Determine if the request has a URI that should be excluded.

 from ExcludesPaths
array getExcludedPaths()

Get the URIs that should be excluded.

 from ExcludesPaths
void __construct(Application $app)

Create a new middleware instance.

 from PreventRequestsDuringMaintenance
mixed handle(Request $request, Closure $next)

Handle an incoming request.

 from PreventRequestsDuringMaintenance
bool hasValidBypassCookie(Request $request, array $data)

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

 from PreventRequestsDuringMaintenance
RedirectResponse bypassResponse(string $secret)

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

 from PreventRequestsDuringMaintenance
array getHeaders(array $data)

Get the headers that should be sent with the response.

 from PreventRequestsDuringMaintenance
static void except(array|string $uris)

Indicate that the given URIs should always be accessible.

 from PreventRequestsDuringMaintenance
static void flushState()

Flush the state of the middleware.

 from PreventRequestsDuringMaintenance

Details

protected bool inExceptArray(Request $request)

Determine if the request has a URI that should be excluded.

Parameters

Request $request

Return Value

bool

array getExcludedPaths()

Get the URIs that should be excluded.

Return Value

array

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
ErrorException

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

static void except(array|string $uris)

Indicate that the given URIs should always be accessible.

Parameters

array|string $uris

Return Value

void

static void flushState()

Flush the state of the middleware.

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Foundation/Http/Middleware/CheckForMaintenanceMode.html