ForeignKeyDefinition
class ForeignKeyDefinition extends Fluent (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected | $attributes | 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.
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 from the instance as a Carbon 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.
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.
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
Specify the referenced table
Add an ON DELETE action
Add an ON UPDATE action
No description
Details
$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) truthy.
$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) falsy.
abstract array
all(mixed $keys = null)
Retrieve all data from the instance.
abstract protected mixed
data(string|null $key = null, mixed $default = null)
Retrieve data from the instance.
bool
exists(string|array $key)
Determine if the data contains a given key.
bool
has(string|array $key)
Determine if the data contains a given key.
bool
hasAny(string|array $keys)
Determine if the instance contains any of the given keys.
$this|mixed
whenHas(string $key, callable $callback, callable|null $default = null)
Apply the callback if the instance contains the given key.
bool
filled(string|array $key)
Determine if the instance contains a non-empty value for the given key.
bool
isNotFilled(string|array $key)
Determine if the instance contains an empty value for the given key.
bool
anyFilled(string|array $keys)
Determine if the instance contains a non-empty value for any of the given keys.
$this|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.
bool
missing(string|array $key)
Determine if the instance is missing a given key.
$this|mixed
whenMissing(string $key, callable $callback, callable|null $default = null)
Apply the callback if the instance is missing the given key.
protected bool
isEmptyString(string $key)
Determine if the given key is an empty string for "filled".
Stringable
str(string $key, mixed $default = null)
Retrieve data from the instance as a Stringable instance.
Stringable
string(string $key, mixed $default = null)
Retrieve data from the instance as a Stringable instance.
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.
int
integer(string $key, int $default = 0)
Retrieve data as an integer value.
float
float(string $key, float $default = 0.0)
Retrieve data as a float value.
Carbon|null
date(string $key, string|null $format = null, UnitEnum|string|null $tz = null)
Retrieve data from the instance as a Carbon instance.
TEnum|null
enum(string $key, TEnum> $enumClass, TEnum|null $default = null)
Retrieve data from the instance as an enum.
TEnum[]
enums(string $key, TEnum> $enumClass)
Retrieve data from the instance as an array of enums.
protected bool
isBackedEnum(class-string $enumClass)
Determine if the given enum class is backed.
array
array(array|string|null $key = null)
Retrieve data from the instance as an array.
Collection
collect(array|string|null $key = null)
Retrieve data from the instance as a collection.
array
only(mixed $keys)
Get a subset containing the provided keys with values from the instance data.
array
except(mixed $keys)
Get all of the data except for a specified array of items.
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static void
flushMacros()
Flush the existing macros.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
in
Fluent at line 41
__construct(TValue> $attributes = [])
Create a new fluent instance.
in
Fluent at line 52
static Fluent
make(TValue> $attributes = [])
Create a new fluent instance.
in
Fluent at line 66
get($key, $default = null)
No description
in
Fluent at line 78
$this
set(TKey $key, TValue $value)
Set an attribute on the fluent instance using "dot" notation.
in
Fluent at line 91
$this
fill(TValue> $attributes)
Fill the fluent instance with an array of attributes.
mixed
value(string $key, mixed $default = null)
Get an attribute from the fluent instance.
Fluent
scope(string $key, mixed $default = null)
Get the value of the given key as a new Fluent instance.
getAttributes()
No description
toArray()
No description
array
jsonSerialize()
No description
string
toJson(int $options = 0)
Convert the fluent instance to JSON.
string
toPrettyJson(int $options = 0)
Convert the fluent instance to pretty print formatted JSON.
bool
isEmpty()
Determine if the fluent instance is empty.
bool
isNotEmpty()
Determine if the fluent instance is not empty.
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.
Traversable
getIterator()
Get an iterator for the 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
cascadeOnUpdate()
Indicate that updates should cascade.
$this
restrictOnUpdate()
Indicate that updates should be restricted.
$this
nullOnUpdate()
Indicate that updates should set the foreign key value to null.
$this
noActionOnUpdate()
Indicate that updates should have "no action".
$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.
$this
noActionOnDelete()
Indicate that deletes should have "no action".
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