interface IConventions

Methods

string|array|null
getPrimary(string $table)

Returns primary key for table.

array|null
getHasManyReference(string $table, string $key)

Returns referenced table & referenced column.

array|null
getBelongsToReference(string $table, string $key)

Returns referenced table & referencing column.

Details

at line 22
string|array|null getPrimary(string $table)

Returns primary key for table.

Parameters

string $table

Return Value

string|array|null

at line 32
array|null getHasManyReference(string $table, string $key)

Returns referenced table & referenced column.

Example: (author, book) returns [book, author_id]

Parameters

string $table
string $key

Return Value

array|null [referenced table, referenced column]

Exceptions

AmbiguousReferenceKeyException

at line 42
array|null getBelongsToReference(string $table, string $key)

Returns referenced table & referencing column.

Example (book, author) returns [author, author_id] (book, translator) returns [author, translator_id]

Parameters

string $table
string $key

Return Value

array|null [referenced table, referencing column]