Documentation

AbstractController extends AbstractController
in package

AbstractYes

Console abstract controller class

Tags
category

Pop\Kettle

author

Nick Sagona, III nick@nolainteractive.com

copyright

Copyright (c) 2012-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

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

version
2.3.2

Table of Contents

Properties

$application  : Application|null
Application object
$bypassMaintenance  : bool
Bypass maintenance false
$console  : Console|null
Console object
$defaultAction  : string
Default action
$maintenanceAction  : string
Maintenance action

Methods

__construct()  : mixed
Constructor for the controller
application()  : Application
Get application object
bypassMaintenance()  : bool
Check the bypass maintenance check
console()  : Console
Get request object
dispatch()  : void
Dispatch the controller based on the action
error()  : void
Default error action method
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 = true

$maintenanceAction

Maintenance action

protected string $maintenanceAction = 'maintenance'

Methods

bypassMaintenance()

Check the bypass maintenance check

public bypassMaintenance() : bool
Return values
bool

dispatch()

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
throws
Exception

getDefaultAction()

Get the default action

public getDefaultAction() : string
Return values
string

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

        
On this page

Search results