ForeignKeyDefinition

class ForeignKeyDefinition extends Fluent (View source)

Properties

protected array

$attributes

All of the attributes set on the fluent instance.

from Fluent

Methods

void

__construct(array|object $attributes = [])

Create a new fluent instance.

from Fluent

mixed

get(string $key, mixed $default = null)

Get an attribute from the fluent instance.

from Fluent

array

getAttributes()

Get the attributes from the fluent instance.

from Fluent

array

toArray()

Convert the fluent instance to an array.

from Fluent

array

jsonSerialize()

Convert the object into something JSON serializable.

from Fluent

string

toJson(int $options = 0)

Convert the fluent instance to JSON.

from Fluent

bool

offsetExists(string $offset)

Determine if the given offset exists.

from Fluent

mixed

offsetGet(string $offset)

Get the value for a given offset.

from Fluent

void

offsetSet(string $offset, mixed $value)

Set the value at the given offset.

from Fluent

void

offsetUnset(string $offset)

Unset the value at the given offset.

from Fluent

$this

__call(string $method, array $parameters)

Handle dynamic calls to the fluent instance to set attributes.

from Fluent

mixed

__get(string $key)

Dynamically retrieve the value of an attribute.

from Fluent

void

__set(string $key, mixed $value)

Dynamically set the value of an attribute.

from Fluent

bool

__isset(string $key)

Dynamically check if an attribute is set.

from Fluent

void

__unset(string $key)

Dynamically unset an attribute.

from Fluent

$this

cascadeOnUpdate()

Indicate that updates should cascade.

$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)

ForeignKeyDefinition

initiallyImmediate(bool $value = true)

Set the default time to check the constraint (PostgreSQL)

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)

Details

void __construct(array|object $attributes = [])

Create a new fluent instance.

Parameters

array|object

$attributes

Return Value

void

mixed get(string $key, mixed $default = null)

Get an attribute from the fluent instance.

Parameters

string	$key
mixed	$default

Return Value

mixed

array getAttributes()

Get the attributes from the fluent instance.

Return Value

array

array toArray()

Convert the fluent instance to an array.

Return Value

array

array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

string toJson(int $options = 0)

Convert the fluent instance to JSON.

Parameters

int

$options

Return Value

string

bool offsetExists(string $offset)

Determine if the given offset exists.

Parameters

string

$offset

Return Value

bool

mixed offsetGet(string $offset)

Get the value for a given offset.

Parameters

string

$offset

Return Value

mixed

void offsetSet(string $offset, mixed $value)

Set the value at the given offset.

Parameters

string	$offset
mixed	$value

Return Value

void

void offsetUnset(string $offset)

Unset the value at the given offset.

Parameters

string

$offset

Return Value

void

$this __call(string $method, array $parameters)

Handle dynamic calls to the fluent instance to set attributes.

Parameters

string	$method
array	$parameters

Return Value

$this

mixed __get(string $key)

Dynamically retrieve the value of an attribute.

Parameters

string

$key

Return Value

mixed

void __set(string $key, mixed $value)

Dynamically set the value of an attribute.

Parameters

string	$key
mixed	$value

Return Value

void

bool __isset(string $key)

Dynamically check if an attribute is set.

Parameters

string

$key

Return Value

bool

void __unset(string $key)

Dynamically unset an attribute.

Parameters

string

$key

Return Value

void

$this cascadeOnUpdate()

Indicate that updates should cascade.

Return Value

$this

$this cascadeOnDelete()

Indicate that deletes should cascade.

Return Value

$this

$this restrictOnDelete()

Indicate that deletes should be restricted.

Return Value

$this

$this nullOnDelete()

Indicate that deletes should set the foreign key value to null.

Return Value

$this