AbstractController
in package
implements
ControllerInterface
AbstractYes
Pop abstract controller class
Tags
Table of Contents
Interfaces
- ControllerInterface
- Pop controller interface
Properties
- $bypassMaintenance : bool
- Bypass maintenance false
- $defaultAction : string
- Default action
- $maintenanceAction : string
- Maintenance action
Methods
- bypassMaintenance() : bool
- Check the bypass maintenance check
- dispatch() : void
- Dispatch the controller based on the action
- getDefaultAction() : string
- Get the default action
- getMaintenanceAction() : string
- Get the maintenance action
- setBypassMaintenance() : static
- Check the bypass maintenance check
- setDefaultAction() : AbstractController
- Set the default action
- setMaintenanceAction() : AbstractController
- Set the maintenance action
Properties
$bypassMaintenance
Bypass maintenance false
protected
bool
$bypassMaintenance
= false
$defaultAction
Default action
protected
string
$defaultAction
= 'error'
$maintenanceAction
Maintenance action
protected
string
$maintenanceAction
= 'maintenance'
Methods
bypassMaintenance()
Check the bypass maintenance check
public
bypassMaintenance() : bool
Return values
booldispatch()
Dispatch the controller based on the action
public
dispatch([string|null $action = null ][, array<string|int, mixed>|null $params = null ]) : void
Parameters
- $action : string|null = null
- $params : array<string|int, mixed>|null = null
Tags
getDefaultAction()
Get the default action
public
getDefaultAction() : string
Return values
stringgetMaintenanceAction()
Get the maintenance action
public
getMaintenanceAction() : string
Return values
stringsetBypassMaintenance()
Check the bypass maintenance check
public
setBypassMaintenance([bool $bypass = true ]) : static
Parameters
- $bypass : bool = true
Return values
staticsetDefaultAction()
Set the default action
public
setDefaultAction(string $default) : AbstractController
Parameters
- $default : string
Return values
AbstractControllersetMaintenanceAction()
Set the maintenance action
public
setMaintenanceAction(string $maintenance) : AbstractController
Parameters
- $maintenance : string