Documentation

DatabaseController extends AbstractController
in package

Console database controller class

Tags
category

Pop\Kettle

author

Nick Sagona, III nick@nolainteractive.com

copyright

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

license

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

version
1.6.2

Table of Contents

$application  : Application
Application object
$console  : Console
Console object
$defaultAction  : string
Default action
__construct()  : mixed
Constructor for the controller
application()  : Application
Get application object
clear()  : void
Clear command
config()  : void
Config command
console()  : Console
Get request object
createSeed()  : void
Create seed command
dispatch()  : void
Dispatch the controller based on the action
error()  : void
Default error action method
getDefaultAction()  : string
Get the default action
install()  : void
Install command
reset()  : void
Reset command
seed()  : void
Seed command
setDefaultAction()  : AbstractController
Set the default action
test()  : void
Test command

Properties

Methods

clear()

Clear command

public clear([string $database = 'default' ]) : void
Parameters
$database : string = 'default'
Return values
void

config()

Config command

public config([string $database = 'default' ]) : void
Parameters
$database : string = 'default'
Return values
void

createSeed()

Create seed command

public createSeed(string $class[, string $database = 'default' ]) : void
Parameters
$class : string
$database : string = 'default'
Return values
void

dispatch()

Dispatch the controller based on the action

public dispatch([string $action = null ][, array<string|int, mixed> $params = null ]) : void
Parameters
$action : string = null
$params : array<string|int, mixed> = null
Tags
throws
Exception
Return values
void

getDefaultAction()

Get the default action

public getDefaultAction() : string
Return values
string

install()

Install command

public install([string $database = 'default' ]) : void
Parameters
$database : string = 'default'
Return values
void

reset()

Reset command

public reset([string $database = 'default' ]) : void
Parameters
$database : string = 'default'
Return values
void

seed()

Seed command

public seed([string $database = 'default' ]) : void
Parameters
$database : string = 'default'
Return values
void

test()

Test command

public test([string $database = 'default' ]) : void
Parameters
$database : string = 'default'
Return values
void

Search results