Aplus Framework Dev Commands Library

ShowTable extends DatabaseCommand
in package

Class ShowTable.

Table of Contents

$database  : Database
$databaseInstance  : string
$description  : string
$options  : array<string|int, mixed>
getDatabase()  : Database
run()  : void
setDatabase()  : static
getFields()  : array<int, array<string, string>>
getForeignKeys()  : array<int, array<string, string>>
getIndexes()  : array<int, array<string, string>>
makeKeys()  : array<string|int, object>

Properties

$description

protected string $description = 'Shows a database table structure.'

$options

protected array<string|int, mixed> $options = ['--instance' => 'Database instance name.']

Methods

getDatabase()

public getDatabase() : Database
Return values
Database

run()

public run() : void
Return values
void

setDatabase()

public setDatabase() : static
Return values
static

getFields()

protected getFields(string $table) : array<int, array<string, string>>
Parameters
$table : string
Return values
array<int, array<string, string>>

getForeignKeys()

protected getForeignKeys(string $table) : array<int, array<string, string>>
Parameters
$table : string
Return values
array<int, array<string, string>>

getIndexes()

protected getIndexes(string $table) : array<int, array<string, string>>
Parameters
$table : string
Return values
array<int, array<string, string>>

makeKeys()

protected makeKeys(array<string|int, mixed> $indexes) : array<string|int, object>
Parameters
$indexes : array<string|int, mixed>
Return values
array<string|int, object>

Search results