Documentation

MaintenanceTrait

Maintenance trait

Tags
category

Pop

author

Nick Sagona, III nick@popphp.org

copyright

Copyright (c) 2009-2026 Nick Sagona, III

license

https://www.popphp.org/license New BSD License

version
5.0.0

Table of Contents

Properties

$bypassMaintenance  : bool
Bypass maintenance false
$maintenanceAction  : string
Maintenance action

Methods

bypassMaintenance()  : bool
Check the bypass maintenance check
dispatchMaintenance()  : void
Dispatch the maintenance action
getMaintenanceAction()  : string
Get the maintenance action
setBypassMaintenance()  : static
Check the bypass maintenance check
setMaintenanceAction()  : static
Set the maintenance action

Properties

$bypassMaintenance

Bypass maintenance false

protected bool $bypassMaintenance = false

$maintenanceAction

Maintenance action

protected string $maintenanceAction = 'maintenance'

Methods

bypassMaintenance()

Check the bypass maintenance check

public bypassMaintenance() : bool
Return values
bool

getMaintenanceAction()

Get the maintenance action

public getMaintenanceAction() : string
Return values
string

setBypassMaintenance()

Check the bypass maintenance check

public setBypassMaintenance([bool $bypass = true ]) : static
Parameters
$bypass : bool = true
Return values
static

setMaintenanceAction()

Set the maintenance action

public setMaintenanceAction(string $maintenance) : static
Parameters
$maintenance : string
Return values
static

        
On this page

Search results