interface IStructure

Provides cached reflection for database structure.

Constants

FIELD_TEXT

FIELD_BINARY

FIELD_BOOL

FIELD_INTEGER

FIELD_FLOAT

FIELD_DATE

FIELD_TIME

FIELD_DATETIME

FIELD_UNIX_TIMESTAMP

FIELD_TIME_INTERVAL

Methods

array
getTables()

Returns tables list.

array
getColumns(string $table)

Returns table columns list.

string|array|null
getPrimaryKey(string $table)

Returns table primary key.

string|null
getPrimaryAutoincrementKey(string $table)

Returns autoincrement primary key name.

string|null
getPrimaryKeySequence(string $table)

Returns table primary key sequence.

array|null
getHasManyReference(string $table, string $targetTable = null)

Returns hasMany reference.

array|null
getBelongsToReference(string $table, string $column = null)

Returns belongsTo reference.

void
rebuild()

Rebuilds database structure cache.

bool
isRebuilt()

Returns true if database cached structure has been rebuilt.

Details

at line 33
array getTables()

Returns tables list.

Return Value

array

at line 38
array getColumns(string $table)

Returns table columns list.

Parameters

string $table

Return Value

array

at line 44
string|array|null getPrimaryKey(string $table)

Returns table primary key.

Parameters

string $table

Return Value

string|array|null

at line 49
string|null getPrimaryAutoincrementKey(string $table)

Returns autoincrement primary key name.

Parameters

string $table

Return Value

string|null

at line 54
string|null getPrimaryKeySequence(string $table)

Returns table primary key sequence.

Parameters

string $table

Return Value

string|null

at line 60
array|null getHasManyReference(string $table, string $targetTable = null)

Returns hasMany reference.

If a targetTable is not provided, returns references for all tables.

Parameters

string $table
string $targetTable

Return Value

array|null

at line 66
array|null getBelongsToReference(string $table, string $column = null)

Returns belongsTo reference.

If a column is not provided, returns references for all columns.

Parameters

string $table
string $column

Return Value

array|null

at line 71
void rebuild()

Rebuilds database structure cache.

Return Value

void

at line 76
bool isRebuilt()

Returns true if database cached structure has been rebuilt.

Return Value

bool