ForeignKeyDefinition
class ForeignKeyDefinition extends Fluent (View source)
Properties
| protected array | $attributes | All of the attributes set on the fluent instance. |
from Fluent |
Methods
Get an attribute from the fluent instance.
Handle dynamic calls to the fluent instance to set attributes.
Indicate that updates should cascade.
Indicate that updates should be restricted.
Indicate that deletes should cascade.
Indicate that deletes should be restricted.
Indicate that deletes should set the foreign key value to null.
No description
No description
Specify the referenced table
Add an ON DELETE action
Add an ON UPDATE action
No description
Details
in
Fluent at line 25
void
__construct(array|object $attributes = [])
Create a new fluent instance.
in
Fluent at line 39
mixed
get(string $key, mixed $default = null)
Get an attribute from the fluent instance.
in
Fluent at line 53
array
getAttributes()
Get the attributes from the fluent instance.
in
Fluent at line 63
array
toArray()
Convert the fluent instance to an array.
in
Fluent at line 73
array
jsonSerialize()
Convert the object into something JSON serializable.
in
Fluent at line 85
string
toJson(int $options = 0)
Convert the fluent instance to JSON.
in
Fluent at line 96
bool
offsetExists(string $offset)
Determine if the given offset exists.
mixed
offsetGet(string $offset)
Get the value for a given offset.
void
offsetSet(string $offset, mixed $value)
Set the value at the given offset.
void
offsetUnset(string $offset)
Unset the value at the given offset.
$this
__call(string $method, array $parameters)
Handle dynamic calls to the fluent instance to set attributes.
mixed
__get(string $key)
Dynamically retrieve the value of an attribute.
void
__set(string $key, mixed $value)
Dynamically set the value of an attribute.
bool
__isset(string $key)
Dynamically check if an attribute is set.
void
__unset(string $key)
Dynamically unset an attribute.
$this
cascadeOnUpdate()
Indicate that updates should cascade.
$this
restrictOnUpdate()
Indicate that updates should be restricted.
$this
cascadeOnDelete()
Indicate that deletes should cascade.
$this
restrictOnDelete()
Indicate that deletes should be restricted.
$this
nullOnDelete()
Indicate that deletes should set the foreign key value to null.
ForeignKeyDefinition
deferrable(bool $value = true) Set the foreign key as deferrable (PostgreSQL)
No description
ForeignKeyDefinition
initiallyImmediate(bool $value = true) Set the default time to check the constraint (PostgreSQL)
No description
ForeignKeyDefinition
on(string $table)
Specify the referenced table
ForeignKeyDefinition
onDelete(string $action)
Add an ON DELETE action
ForeignKeyDefinition
onUpdate(string $action)
Add an ON UPDATE action
ForeignKeyDefinition
references(string|array $columns) Specify the referenced column(s)
No description