class Structure implements IStructure

Cached reflection of database structure.

Properties

protected $connection
protected $cache
protected $structure
protected $isRebuilt

Methods

__construct(Connection $connection, Storage $cacheStorage)

No description

array
getTables()

No description

array
getColumns(string $table)

No description

string|array|null
getPrimaryKey(string $table)

No description

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|null $targetTable = null)

Returns hasMany reference.

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

Returns belongsTo reference.

void
rebuild()

Rebuilds database structure cache.

bool
isRebuilt()

Returns true if database cached structure has been rebuilt.

void
needStructure()

No description

array
loadStructure()

No description

analyzePrimaryKey(array $columns)

No description

void
analyzeForeignKeys(array $structure, string $table)

No description

string
resolveFQTableName(string $table)

No description

Details

at line 31
__construct(Connection $connection, Storage $cacheStorage)

No description

Parameters

Connection $connection
Storage $cacheStorage

at line 39
array getTables()

No description

Return Value

array

at line 47
array getColumns(string $table)

No description

Parameters

string $table

Return Value

array

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

No description

Parameters

string $table

Return Value

string|array|null

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

Returns autoincrement primary key name.

Parameters

string $table

Return Value

string|null

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

Returns table primary key sequence.

Parameters

string $table

Return Value

string|null

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

Returns hasMany reference.

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

Parameters

string $table
string|null $targetTable

Return Value

array|null

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

Returns belongsTo reference.

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

Parameters

string $table
string|null $column

Return Value

array|null

at line 160
void rebuild()

Rebuilds database structure cache.

Return Value

void

at line 167
bool isRebuilt()

Returns true if database cached structure has been rebuilt.

Return Value

bool

at line 173
protected void needStructure()

No description

Return Value

void

at line 183
protected array loadStructure()

No description

Return Value

array

at line 219
protected analyzePrimaryKey(array $columns)

No description

Parameters

array $columns

at line 238
protected void analyzeForeignKeys(array $structure, string $table)

No description

Parameters

array $structure
string $table

Return Value

void

at line 257
protected string resolveFQTableName(string $table)

No description

Parameters

string $table

Return Value

string

Traits

SmartObject