MaintenanceModeManager

class MaintenanceModeManager extends Manager (View source)

Properties

protected Container	$container	The container instance.	from Manager
protected Repository	$config	The configuration repository instance.	from Manager
protected array	$customCreators	The registered custom driver creators.	from Manager
protected array	$drivers	The array of created "drivers".	from Manager

Methods

void

__construct(Container $container)

Create a new manager instance.

string

getDefaultDriver()

Get the default driver name.

mixed

driver(string|null $driver = null)

Get a driver instance.

mixed

createDriver(string $driver)

Create a new driver instance.

mixed

callCustomCreator(string $driver)

Call a custom driver creator.

$this

extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

array

Get all of the created "drivers".

Get the container instance used by the manager.

$this

setContainer(Container $container)

Set the container instance used by the manager.

$this

forgetDrivers()

Forget all of the resolved driver instances.

mixed

__call(string $method, array $parameters)

Dynamically call the default driver instance.

FileBasedMaintenanceMode

createFileDriver()

Create an instance of the file based maintenance driver.

CacheBasedMaintenanceMode

createCacheDriver()

Create an instance of the cache based maintenance driver.

Details

void __construct(Container $container)

Create a new manager instance.

Parameters

$container

Return Value

void

string getDefaultDriver()

Get the default driver name.

Return Value

string

mixed driver(string|null $driver = null)

Get a driver instance.

Parameters

string|null

$driver

Return Value

mixed

Exceptions

InvalidArgumentException

protected mixed createDriver(string $driver)

Create a new driver instance.

Parameters

string

$driver

Return Value

mixed

Exceptions

InvalidArgumentException

protected mixed callCustomCreator(string $driver)

Call a custom driver creator.

Parameters

string

$driver

Return Value

mixed

$this extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

Parameters

string	$driver
Closure	$callback

Return Value

$this

array getDrivers()

Get all of the created "drivers".

Return Value

array

Container getContainer()

Get the container instance used by the manager.

Return Value

$this setContainer(Container $container)

Set the container instance used by the manager.

Parameters

$container

Return Value

$this

$this forgetDrivers()

Forget all of the resolved driver instances.

Return Value

$this

mixed __call(string $method, array $parameters)

Dynamically call the default driver instance.

Parameters

string	$method
array	$parameters

Return Value

mixed

protected FileBasedMaintenanceMode createFileDriver()

Create an instance of the file based maintenance driver.

Return Value

FileBasedMaintenanceMode

protected CacheBasedMaintenanceMode createCacheDriver()

Create an instance of the cache based maintenance driver.

Return Value

CacheBasedMaintenanceMode

Exceptions

BindingResolutionException

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