ForeignIdColumnDefinition
class ForeignIdColumnDefinition extends ColumnDefinition (View source)
Properties
| protected | $attributes | from Fluent | |
| protected Blueprint | $blueprint | The schema builder blueprint instance. |
Methods
Create a new foreign ID column definition.
Get an attribute from the fluent instance.
Get the value of the given key as a new Fluent instance.
Handle dynamic calls to the fluent instance to set attributes.
No description
No description
No description
No description
No description
No description
No description
No description
Allow NULL values to be inserted into the column
No description
No description
No description
Set the TIMESTAMP column to use CURRENT_TIMESTAMP as default value
No description
No description
Create a foreign key constraint on this column referencing the "id" column of the conventionally related table.
Specify which column this foreign ID references on another table.
Details
void
__construct(Blueprint $blueprint, TValue> $attributes = [])
Create a new foreign ID column definition.
in
Fluent at line 48
get($key, $default = null)
No description
in
Fluent at line 60
mixed
value(string $key, mixed $default = null)
Get an attribute from the fluent instance.
in
Fluent at line 76
Fluent
scope(string $key, mixed $default = null)
Get the value of the given key as a new Fluent instance.
in
Fluent at line 88
getAttributes()
No description
in
Fluent at line 98
toArray()
No description
Collection
collect(string|null $key = null)
Convert the fluent instance to a Collection.
array
jsonSerialize()
No description
string
toJson(int $options = 0)
Convert the fluent instance to JSON.
bool
offsetExists(TKey $offset)
Determine if the given offset exists.
mixed
offsetGet(TKey $offset)
Get the value for a given offset.
void
offsetSet(TKey $offset, TValue $value)
Set the value at the given offset.
void
offsetUnset(TKey $offset)
Unset the value at the given offset.
$this
__call(TKey $method, $parameters)
Handle dynamic calls to the fluent instance to set attributes.
TValue|null
__get(TKey $key)
Dynamically retrieve the value of an attribute.
void
__set(TKey $key, TValue $value)
Dynamically set the value of an attribute.
bool
__isset(TKey $key)
Dynamically check if an attribute is set.
void
__unset(TKey $key)
Dynamically unset an attribute.
$this
after(string $column) Place the column "after" another column (MySQL)
No description
$this
always(bool $value = true) Used as a modifier for generatedAs() (PostgreSQL)
No description
$this
autoIncrement() $et INTEGER columns as auto-increment (primary key)
No description
$this
change()
Change the column
$this
charset(string $charset) Specify a character set for the column (MySQL)
No description
$this
collation(string $collation)
Specify a collation for the column
$this
comment(string $comment) Add a comment to the column (MySQL/PostgreSQL)
No description
$this
default(mixed $value)
Specify a "default" value for the column
$this
first() $lace the column "first" in the table (MySQL)
No description
$this
from(int $startingValue) Set the starting value of an auto-incrementing field (MySQL / PostgreSQL)
No description
$this
generatedAs(Expression $expression = null) Create a SQL compliant identity column (PostgreSQL)
No description
$this
index(bool|string $indexName = null)
Add an index
$this
invisible() $pecify that the column should be invisible to "SELECT *" (MySQL)
No description
$this
nullable(bool $value = true)
Allow NULL values to be inserted into the column
$this
persisted() $ark the computed generated column as persistent (SQL Server)
No description
$this
primary(bool $value = true)
Add a primary index
$this
fulltext(bool|string $indexName = null)
Add a fulltext index
$this
spatialIndex(bool|string $indexName = null)
Add a spatial index
$this
startingValue(int $startingValue) Set the starting value of an auto-incrementing field (MySQL/PostgreSQL)
No description
$this
storedAs(Expression $expression) Create a stored generated column (MySQL/PostgreSQL/SQLite)
No description
$this
type(string $type)
Specify a type for the column
$this
unique(bool|string $indexName = null)
Add a unique index
$this
unsigned() $et the INTEGER column as UNSIGNED (MySQL)
No description
$this
useCurrent()
Set the TIMESTAMP column to use CURRENT_TIMESTAMP as default value
$this
useCurrentOnUpdate() $et the TIMESTAMP column to use CURRENT_TIMESTAMP when updating (MySQL)
No description
$this
virtualAs(Expression $expression) Create a virtual generated column (MySQL/PostgreSQL/SQLite)
No description
ForeignKeyDefinition
constrained(string|null $table = null, string|null $column = null, string|null $indexName = null)
Create a foreign key constraint on this column referencing the "id" column of the conventionally related table.
ForeignKeyDefinition
references(string $column, string $indexName = null)
Specify which column this foreign ID references on another table.