ForeignKeyDefinition
class ForeignKeyDefinition extends Fluent
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected TValue> | $attributes | All of the attributes set on the fluent instance. |
from Fluent |
Methods
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
Retrieve data from the instance.
Determine if the instance contains any of the given keys.
Apply the callback if the instance contains the given key.
Determine if the instance contains a non-empty value for the given key.
Determine if the instance contains an empty value for the given key.
Determine if the instance contains a non-empty value for any of the given keys.
Apply the callback if the instance contains a non-empty value for the given key.
Apply the callback if the instance contains a valid enum value for the given key.
Determine if the instance is missing a given key.
Apply the callback if the instance is missing the given key.
Determine if the given key is an empty string for "filled".
Retrieve data from the instance as a Stringable instance.
Retrieve data from the instance as a Stringable instance.
Retrieve data as a boolean value.
Retrieve data as an integer value.
Retrieve data as a float value.
Retrieve data clamped between min and max values.
Retrieve data from the instance as a Carbon instance.
Retrieve data from the instance as a CarbonInterval instance.
Retrieve data from the instance as an enum.
Retrieve data from the instance as an array of enums.
Determine if the given enum class is backed.
Normalize enum input to a strict backed value.
Resolve and cache the enum backing type for repeated lookups.
Retrieve data from the instance as an array.
Retrieve data from the instance as a collection.
Get a subset containing the provided keys with values from the instance data.
Get all of the data except for a specified array of items.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Get an attribute from the fluent instance using "dot" notation.
Set an attribute on the fluent instance using "dot" notation.
Get an attribute from the fluent instance.
Get the value of the given key as a new Fluent instance.
Convert the fluent instance to pretty print formatted JSON.
Indicate that updates should cascade.
Indicate that updates should be restricted.
Indicate that updates should set the foreign key value to null.
Indicate that updates should have "no action".
Indicate that deletes should cascade.
Indicate that deletes should be restricted.
Indicate that deletes should set the foreign key value to null.
Indicate that deletes should have "no action".
No description
No description
No description
Specify the referenced table
Add an ON DELETE action
Add an ON UPDATE action
No description
Details
in
Conditionable at line 23
mixed
when(mixed $value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) truthy.
in
Conditionable at line 56
mixed
unless(mixed $value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) falsy.
in
InteractsWithData at line 30
abstract array
all(mixed $keys = null)
Retrieve all data from the instance.
in
InteractsWithData at line 35
abstract protected mixed
data(string|null $key = null, mixed $default = null)
Retrieve data from the instance.
in
InteractsWithData at line 40
bool
exists(array|string $key)
Determine if the data contains a given key.
in
InteractsWithData at line 48
bool
has(array|string $key)
Determine if the data contains a given key.
in
InteractsWithData at line 66
bool
hasAny(array|string $keys)
Determine if the instance contains any of the given keys.
in
InteractsWithData at line 80
mixed
whenHas(string $key, callable $callback, callable|null $default = null)
Apply the callback if the instance contains the given key.
in
InteractsWithData at line 96
bool
filled(array|string $key)
Determine if the instance contains a non-empty value for the given key.
in
InteractsWithData at line 112
bool
isNotFilled(array|string $key)
Determine if the instance contains an empty value for the given key.
in
InteractsWithData at line 128
bool
anyFilled(array|string $keys)
Determine if the instance contains a non-empty value for any of the given keys.
in
InteractsWithData at line 146
mixed
whenFilled(string $key, callable $callback, callable|null $default = null)
Apply the callback if the instance contains a non-empty value for the given key.
in
InteractsWithData at line 168
mixed
whenEnum(string $key, string $enumClass, callable $callback, callable|null $default = null)
Apply the callback if the instance contains a valid enum value for the given key.
in
InteractsWithData at line 188
bool
missing(array|string $key)
Determine if the instance is missing a given key.
in
InteractsWithData at line 198
mixed
whenMissing(string $key, callable $callback, callable|null $default = null)
Apply the callback if the instance is missing the given key.
in
InteractsWithData at line 214
protected bool
isEmptyString(string $key)
Determine if the given key is an empty string for "filled".
in
InteractsWithData at line 224
Stringable
str(string $key, mixed $default = null)
Retrieve data from the instance as a Stringable instance.
in
InteractsWithData at line 232
Stringable
string(string $key, mixed $default = null)
Retrieve data from the instance as a Stringable instance.
in
InteractsWithData at line 242
bool
boolean(string|null $key = null, bool $default = false)
Retrieve data as a boolean value.
Returns true when value is "1", "true", "on", and "yes". Otherwise, returns false.
in
InteractsWithData at line 250
int
integer(string $key, int $default = 0)
Retrieve data as an integer value.
in
InteractsWithData at line 258
float
float(string $key, float $default = 0.0)
Retrieve data as a float value.
in
InteractsWithData at line 266
int|float
clamp(string $key, int|float $min, int|float $max, int|float $default = 0)
Retrieve data clamped between min and max values.
in
InteractsWithData at line 283
CarbonInterface|null
date(string $key, string|null $format = null, UnitEnum|string|null $tz = null)
Retrieve data from the instance as a Carbon instance.
in
InteractsWithData at line 301
CarbonInterval|null
interval(string $key, Unit|string|null $unit = null)
Retrieve data from the instance as a CarbonInterval instance.
in
InteractsWithData at line 327
mixed
enum(string $key, string $enumClass, mixed $default = null)
Retrieve data from the instance as an enum.
in
InteractsWithData at line 350
array
enums(string $key, string $enumClass)
Retrieve data from the instance as an array of enums.
in
InteractsWithData at line 369
protected bool
isBackedEnum(string $enumClass)
Determine if the given enum class is backed.
in
InteractsWithData at line 377
protected int|string|null
normalizeEnumValue(string $enumClass, mixed $value)
Normalize enum input to a strict backed value.
in
InteractsWithData at line 422
protected string|null
enumBackingType(string $enumClass)
Resolve and cache the enum backing type for repeated lookups.
in
InteractsWithData at line 433
array
array(array|string|null $key = null)
Retrieve data from the instance as an array.
in
InteractsWithData at line 441
Collection
collect(array|string|null $key = null)
Retrieve data from the instance as a collection.
in
InteractsWithData at line 451
array
only(mixed $keys)
Get a subset containing the provided keys with values from the instance data.
in
InteractsWithData at line 475
array
except(mixed $keys)
Get all of the data except for a specified array of items.
in
Macroable at line 28
static void
macro(string $name, callable|object $macro)
Register a custom macro.
Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.
in
Macroable at line 41
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.
in
Macroable at line 57
static bool
hasMacro(string $name)
Check if macro is registered.
in
Macroable at line 68
static void
flushMacros()
Flush the existing macros.
Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.
in
Macroable at line 78
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
in
Macroable at line 103
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
in
Fluent at line 44
__construct(array|object $attributes = [])
Create a new fluent instance.
in
Fluent at line 54
static Fluent
make(array|object $attributes = [])
Create a new fluent instance.
in
Fluent at line 67
mixed
get(string|null $key = null, mixed $default = null)
Get an attribute from the fluent instance using "dot" notation.
in
Fluent at line 75
Fluent
set(string $key, mixed $value)
Set an attribute on the fluent instance using "dot" notation.
in
Fluent at line 87
Fluent
fill(array|object $attributes)
Fill the fluent instance with an array of attributes.
in
Fluent at line 99
mixed
value(string $key, mixed $default = null)
Get an attribute from the fluent instance.
in
Fluent at line 111
Fluent
scope(string $key, mixed $default = null)
Get the value of the given key as a new Fluent instance.
in
Fluent at line 151
array
getAttributes()
Get the attributes from the fluent instance.
in
Fluent at line 161
array
toArray()
Convert the fluent instance to an array.
in
Fluent at line 171
array
jsonSerialize()
Convert the object into something JSON serializable.
in
Fluent at line 179
string
toJson(int $options = 0)
Convert the fluent instance to JSON.
in
Fluent at line 187
string
toPrettyJson(int $options = 0)
Convert the fluent instance to pretty print formatted JSON.
in
Fluent at line 195
bool
isEmpty()
Determine if the fluent instance is empty.
in
Fluent at line 203
bool
isNotEmpty()
Determine if the fluent instance is not empty.
in
Fluent at line 213
bool
offsetExists(mixed $offset)
Determine if the given offset exists.
in
Fluent at line 224
mixed
offsetGet(mixed $offset)
Get the value for a given offset.
in
Fluent at line 235
void
offsetSet(mixed $offset, mixed $value)
Set the value at the given offset.
in
Fluent at line 245
void
offsetUnset(mixed $offset)
Unset the value at the given offset.
in
Fluent at line 255
Traversable
getIterator()
Get an iterator for the attributes.
in
Fluent at line 263
static void
flushState()
Flush all static state.
in
Fluent at line 289
mixed
__get(string $key)
Dynamically retrieve the value of an attribute.
in
Fluent at line 297
void
__set(string $key, mixed $value)
Dynamically set the value of an attribute.
in
Fluent at line 305
bool
__isset(string $key)
Dynamically check if an attribute is set.
in
Fluent at line 313
void
__unset(string $key)
Dynamically unset an attribute.
at line 23
ForeignKeyDefinition
cascadeOnUpdate()
Indicate that updates should cascade.
at line 31
ForeignKeyDefinition
restrictOnUpdate()
Indicate that updates should be restricted.
at line 39
ForeignKeyDefinition
nullOnUpdate()
Indicate that updates should set the foreign key value to null.
at line 47
ForeignKeyDefinition
noActionOnUpdate()
Indicate that updates should have "no action".
at line 55
ForeignKeyDefinition
cascadeOnDelete()
Indicate that deletes should cascade.
at line 63
ForeignKeyDefinition
restrictOnDelete()
Indicate that deletes should be restricted.
at line 71
ForeignKeyDefinition
nullOnDelete()
Indicate that deletes should set the foreign key value to null.
at line 79
ForeignKeyDefinition
noActionOnDelete()
Indicate that deletes should have "no action".
at line 18
ForeignKeyDefinition
deferrable(bool $value = 'true') Set the foreign key as deferrable (PostgreSQL)
No description
at line 18
ForeignKeyDefinition
initiallyImmediate(bool $value = 'true') Set the default time to check the constraint (PostgreSQL)
No description
at line 18
ForeignKeyDefinition
lock(string $value) Specify the DDL lock mode for the foreign key operation (MySQL)
No description
at line 18
ForeignKeyDefinition
on(string $table)
Specify the referenced table
at line 18
ForeignKeyDefinition
onDelete(string $action)
Add an ON DELETE action
at line 18
ForeignKeyDefinition
onUpdate(string $action)
Add an ON UPDATE action
at line 18
ForeignKeyDefinition
references(array|string $columns) Specify the referenced column(s)
No description