W3cubDocs

CacheBasedMaintenanceMode

class CacheBasedMaintenanceMode implements MaintenanceMode (View source)

Properties

protected Factory	$cache	The cache factory.
protected string	$store	The cache store that should be utilized.
protected string	$key	The cache key to use when storing maintenance mode information.

Methods

void

__construct(Factory $cache, string $store, string $key)

Create a new cache based maintenance mode implementation.

void

activate(array $payload)

Take the application down for maintenance.

void

deactivate()

Take the application out of maintenance.

bool

active()

Determine if the application is currently down for maintenance.

array

data()

Get the data array which was provided when the application was placed into maintenance.

Repository

getStore()

Get the cache store to use.

Details

void __construct(Factory $cache, string $store, string $key)

Create a new cache based maintenance mode implementation.

Parameters

Factory	$cache
string	$store
string	$key

Return Value

void

void activate(array $payload)

Take the application down for maintenance.

Parameters

array

$payload

Return Value

void

void deactivate()

Take the application out of maintenance.

Return Value

void

bool active()

Determine if the application is currently down for maintenance.

Return Value

bool

array data()

Get the data array which was provided when the application was placed into maintenance.

Return Value

array

protected Repository getStore()

Get the cache store to use.

Return Value

Repository

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