ControllerInterface
in
Pop controller interface
Tags
Table of Contents
Methods
- bypassMaintenance() : bool
- Check the bypass maintenace check
- dispatch() : void
- Dispatch the controller based on the action
- getDefaultAction() : string
- Get the default action
- getMaintenanceAction() : string
- Get the maintenance action
- setBypassMaintenance() : static
- Set bypass maintenance flag
- setDefaultAction() : ControllerInterface
- Set the default action
- setMaintenanceAction() : AbstractController
- Set the maintenance action
Methods
bypassMaintenance()
Check the bypass maintenace 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()
Set bypass maintenance flag
public
setBypassMaintenance([bool $bypass = true ]) : static
Parameters
- $bypass : bool = true
Return values
staticsetDefaultAction()
Set the default action
public
setDefaultAction(string $default) : ControllerInterface
Parameters
- $default : string
Return values
ControllerInterfacesetMaintenanceAction()
Set the maintenance action
public
setMaintenanceAction(string $maintenance) : AbstractController
Parameters
- $maintenance : string