1. class
  2. Illuminate
  3. \
  4. Database
  5. \
  6. Schema
  7. \
  8. ForeignIdColumnDefinition

ForeignIdColumnDefinition

class ForeignIdColumnDefinition extends ColumnDefinition (View source)

Traits

InteractsWithData
Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected $attributes from  Fluent
protected Blueprint $blueprint

The schema builder blueprint instance.

Methods

array
all(array|mixed|null $keys = null)

Retrieve all data from the instance.

from  InteractsWithData
mixed
data(string|null $key = null, mixed $default = null)

Retrieve data from the instance.

from  InteractsWithData
bool
exists(string|array $key)

Determine if the data contains a given key.

from  InteractsWithData
bool
has(string|array $key)

Determine if the data contains a given key.

from  InteractsWithData
bool
hasAny(string|array $keys)

Determine if the instance contains any of the given keys.

from  InteractsWithData
$this|mixed
whenHas(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance contains the given key.

from  InteractsWithData
bool
filled(string|array $key)

Determine if the instance contains a non-empty value for the given key.

from  InteractsWithData
bool
isNotFilled(string|array $key)

Determine if the instance contains an empty value for the given key.

from  InteractsWithData
bool
anyFilled(string|array $keys)

Determine if the instance contains a non-empty value for any of the given keys.

from  InteractsWithData
$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.

from  InteractsWithData
bool
missing(string|array $key)

Determine if the instance is missing a given key.

from  InteractsWithData
$this|mixed
whenMissing(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance is missing the given key.

from  InteractsWithData
bool
isEmptyString(string $key)

Determine if the given key is an empty string for "filled".

from  InteractsWithData
Stringable
str(string $key, mixed $default = null)

Retrieve data from the instance as a Stringable instance.

from  InteractsWithData
Stringable
string(string $key, mixed $default = null)

Retrieve data from the instance as a Stringable instance.

from  InteractsWithData
bool
boolean(string|null $key = null, bool $default = false)

Retrieve data as a boolean value.

from  InteractsWithData
int
integer(string $key, int $default = 0)

Retrieve data as an integer value.

from  InteractsWithData
float
float(string $key, float $default = 0.0)

Retrieve data as a float value.

from  InteractsWithData
Carbon|null
date(string $key, string|null $format = null, string|null $tz = null)

Retrieve data from the instance as a Carbon instance.

from  InteractsWithData
TEnum|null
enum(string $key, TEnum> $enumClass)

Retrieve data from the instance as an enum.

from  InteractsWithData
TEnum[]
enums(string $key, TEnum> $enumClass)

Retrieve data from the instance as an array of enums.

from  InteractsWithData
bool
isBackedEnum(class-string $enumClass)

Determine if the given enum class is backed.

from  InteractsWithData
array
array(array|string|null $key = null)

Retrieve data from the instance as an array.

from  InteractsWithData
Collection
collect(array|string|null $key = null)

Retrieve data from the instance as a collection.

from  InteractsWithData
array
only(array|mixed $keys)

Get a subset containing the provided keys with values from the instance data.

from  InteractsWithData
array
except(array|mixed $keys)

Get all of the data except for a specified array of items.

from  InteractsWithData
static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
__construct(Blueprint $blueprint, TValue> $attributes = [])

Create a new foreign ID column definition.

get($key, $default = null)

No description

from  Fluent
$this
set(TKey $key, TValue $value)

Set an attribute on the fluent instance using "dot" notation.

from  Fluent
$this
fill(TValue> $attributes)

Fill the fluent instance with an array of attributes.

from  Fluent
mixed
value(string $key, mixed $default = null)

Get an attribute from the fluent instance.

from  Fluent
Fluent
scope(string $key, mixed $default = null)

Get the value of the given key as a new Fluent instance.

from  Fluent
getAttributes()

No description

from  Fluent
toArray()

No description

from  Fluent
array
jsonSerialize()

No description

from  Fluent
string
toJson(int $options = 0)

Convert the fluent instance to JSON.

from  Fluent
bool
offsetExists(TKey $offset)

Determine if the given offset exists.

from  Fluent
mixed
offsetGet(TKey $offset)

Get the value for a given offset.

from  Fluent
void
offsetSet(TKey $offset, TValue $value)

Set the value at the given offset.

from  Fluent
void
offsetUnset(TKey $offset)

Unset the value at the given offset.

from  Fluent
TValue|null
__get(TKey $key)

Dynamically retrieve the value of an attribute.

from  Fluent
void
__set(TKey $key, TValue $value)

Dynamically set the value of an attribute.

from  Fluent
bool
__isset(TKey $key)

Dynamically check if an attribute is set.

from  Fluent
void
__unset(TKey $key)

Dynamically unset an attribute.

from  Fluent
$this
after(string $column) Place the column "after" another column (MySQL)

No description

from  ColumnDefinition
$this
always(bool $value = true) Used as a modifier for generatedAs() (PostgreSQL)

No description

from  ColumnDefinition
$this
autoIncrement() $et INTEGER columns as auto-increment (primary key)

No description

from  ColumnDefinition
$this
change()

Change the column

from  ColumnDefinition
$this
charset(string $charset) Specify a character set for the column (MySQL)

No description

from  ColumnDefinition
$this
collation(string $collation)

Specify a collation for the column

from  ColumnDefinition
$this
comment(string $comment) Add a comment to the column (MySQL/PostgreSQL)

No description

from  ColumnDefinition
$this
default(mixed $value)

Specify a "default" value for the column

from  ColumnDefinition
$this
first() $lace the column "first" in the table (MySQL)

No description

from  ColumnDefinition
$this
from(int $startingValue) Set the starting value of an auto-incrementing field (MySQL / PostgreSQL)

No description

from  ColumnDefinition
$this
generatedAs(Expression $expression = null) Create a SQL compliant identity column (PostgreSQL)

No description

from  ColumnDefinition
$this
index(bool|string $indexName = null)

Add an index

from  ColumnDefinition
$this
invisible() $pecify that the column should be invisible to "SELECT *" (MySQL)

No description

from  ColumnDefinition
$this
nullable(bool $value = true)

Allow NULL values to be inserted into the column

from  ColumnDefinition
$this
persisted() $ark the computed generated column as persistent (SQL Server)

No description

from  ColumnDefinition
$this
primary(bool $value = true)

Add a primary index

from  ColumnDefinition
$this
fulltext(bool|string $indexName = null)

Add a fulltext index

from  ColumnDefinition
$this
spatialIndex(bool|string $indexName = null)

Add a spatial index

from  ColumnDefinition
$this
startingValue(int $startingValue) Set the starting value of an auto-incrementing field (MySQL/PostgreSQL)

No description

from  ColumnDefinition
$this
storedAs(Expression $expression) Create a stored generated column (MySQL/PostgreSQL/SQLite)

No description

from  ColumnDefinition
$this
type(string $type)

Specify a type for the column

from  ColumnDefinition
$this
unique(bool|string $indexName = null)

Add a unique index

from  ColumnDefinition
$this
unsigned() $et the INTEGER column as UNSIGNED (MySQL)

No description

from  ColumnDefinition
$this
useCurrent()

Set the TIMESTAMP column to use CURRENT_TIMESTAMP as default value

from  ColumnDefinition
$this
useCurrentOnUpdate() $et the TIMESTAMP column to use CURRENT_TIMESTAMP when updating (MySQL)

No description

from  ColumnDefinition
$this
virtualAs(Expression $expression) Create a virtual generated column (MySQL/PostgreSQL/SQLite)

No description

from  ColumnDefinition
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.

Details

in InteractsWithData at line 19
abstract array all(array|mixed|null $keys = null)

Retrieve all data from the instance.

Parameters

array|mixed|null $keys

Return Value

array

in InteractsWithData at line 28
abstract protected mixed data(string|null $key = null, mixed $default = null)

Retrieve data from the instance.

Parameters

string|null $key
mixed $default

Return Value

mixed

in InteractsWithData at line 36
bool exists(string|array $key)

Determine if the data contains a given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 47
bool has(string|array $key)

Determine if the data contains a given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 68
bool hasAny(string|array $keys)

Determine if the instance contains any of the given keys.

Parameters

string|array $keys

Return Value

bool

in InteractsWithData at line 85
$this|mixed whenHas(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance contains the given key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

in InteractsWithData at line 104
bool filled(string|array $key)

Determine if the instance contains a non-empty value for the given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 123
bool isNotFilled(string|array $key)

Determine if the instance contains an empty value for the given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 142
bool anyFilled(string|array $keys)

Determine if the instance contains a non-empty value for any of the given keys.

Parameters

string|array $keys

Return Value

bool

in InteractsWithData at line 163
$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.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

in InteractsWithData at line 182
bool missing(string|array $key)

Determine if the instance is missing a given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 197
$this|mixed whenMissing(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance is missing the given key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

in InteractsWithData at line 216
protected bool isEmptyString(string $key)

Determine if the given key is an empty string for "filled".

Parameters

string $key

Return Value

bool

in InteractsWithData at line 230
Stringable str(string $key, mixed $default = null)

Retrieve data from the instance as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

in InteractsWithData at line 242
Stringable string(string $key, mixed $default = null)

Retrieve data from the instance as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

in InteractsWithData at line 256
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.

Parameters

string|null $key
bool $default

Return Value

bool

in InteractsWithData at line 268
int integer(string $key, int $default = 0)

Retrieve data as an integer value.

Parameters

string $key
int $default

Return Value

int

in InteractsWithData at line 280
float float(string $key, float $default = 0.0)

Retrieve data as a float value.

Parameters

string $key
float $default

Return Value

float

in InteractsWithData at line 295
Carbon|null date(string $key, string|null $format = null, string|null $tz = null)

Retrieve data from the instance as a Carbon instance.

Parameters

string $key
string|null $format
string|null $tz

Return Value

Carbon|null

Exceptions

InvalidFormatException

in InteractsWithData at line 317
TEnum|null enum(string $key, TEnum> $enumClass)

Retrieve data from the instance as an enum.

Parameters

string $key
TEnum> $enumClass

Return Value

TEnum|null

in InteractsWithData at line 335
TEnum[] enums(string $key, TEnum> $enumClass)

Retrieve data from the instance as an array of enums.

Parameters

string $key
TEnum> $enumClass

Return Value

TEnum[]

in InteractsWithData at line 353
protected bool isBackedEnum(class-string $enumClass)

Determine if the given enum class is backed.

Parameters

class-string $enumClass

Return Value

bool

in InteractsWithData at line 364
array array(array|string|null $key = null)

Retrieve data from the instance as an array.

Parameters

array|string|null $key

Return Value

array

in InteractsWithData at line 375
Collection collect(array|string|null $key = null)

Retrieve data from the instance as a collection.

Parameters

array|string|null $key

Return Value

Collection

in InteractsWithData at line 386
array only(array|mixed $keys)

Get a subset containing the provided keys with values from the instance data.

Parameters

array|mixed $keys

Return Value

array

in InteractsWithData at line 411
array except(array|mixed $keys)

Get all of the data except for a specified array of items.

Parameters

array|mixed $keys

Return Value

array

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 22
__construct(Blueprint $blueprint, TValue> $attributes = [])

Create a new foreign ID column definition.

Parameters

Blueprint $blueprint
TValue> $attributes

in Fluent at line 51
get($key, $default = null)

No description

Parameters

$key
$default

in Fluent at line 63
$this set(TKey $key, TValue $value)

Set an attribute on the fluent instance using "dot" notation.

Parameters

TKey $key
TValue $value

Return Value

$this

in Fluent at line 76
$this fill(TValue> $attributes)

Fill the fluent instance with an array of attributes.

Parameters

TValue> $attributes

Return Value

$this

in Fluent at line 92
mixed value(string $key, mixed $default = null)

Get an attribute from the fluent instance.

Parameters

string $key
mixed $default

Return Value

mixed

in Fluent at line 108
Fluent scope(string $key, mixed $default = null)

Get the value of the given key as a new Fluent instance.

Parameters

string $key
mixed $default

Return Value

Fluent

in Fluent at line 155
getAttributes()

No description

in Fluent at line 165
toArray()

No description

in Fluent at line 175
array jsonSerialize()

No description

Return Value

array

in Fluent at line 186
string toJson(int $options = 0)

Convert the fluent instance to JSON.

Parameters

int $options

Return Value

string

in Fluent at line 197
bool offsetExists(TKey $offset)

Determine if the given offset exists.

Parameters

TKey $offset

Return Value

bool

in Fluent at line 208
mixed offsetGet(TKey $offset)

Get the value for a given offset.

Parameters

TKey $offset

Return Value

mixed

in Fluent at line 220
void offsetSet(TKey $offset, TValue $value)

Set the value at the given offset.

Parameters

TKey $offset
TValue $value

Return Value

void

in Fluent at line 231
void offsetUnset(TKey $offset)

Unset the value at the given offset.

Parameters

TKey $offset

Return Value

void

in Fluent at line 260
TValue|null __get(TKey $key)

Dynamically retrieve the value of an attribute.

Parameters

TKey $key

Return Value

TValue|null

in Fluent at line 272
void __set(TKey $key, TValue $value)

Dynamically set the value of an attribute.

Parameters

TKey $key
TValue $value

Return Value

void

in Fluent at line 283
bool __isset(TKey $key)

Dynamically check if an attribute is set.

Parameters

TKey $key

Return Value

bool

in Fluent at line 294
void __unset(TKey $key)

Dynamically unset an attribute.

Parameters

TKey $key

Return Value

void

in ColumnDefinition at line 35
$this after(string $column) Place the column "after" another column (MySQL)

No description

Parameters

string $column) Place the column "after" another column (MySQL

Return Value

$this

in ColumnDefinition at line 35
$this always(bool $value = true) Used as a modifier for generatedAs() (PostgreSQL)

No description

Parameters

bool $value

Return Value

$this

in ColumnDefinition at line 35
$this autoIncrement() $et INTEGER columns as auto-increment (primary key)

No description

Parameters

) $et INTEGER columns as auto-increment (primary key

Return Value

$this

in ColumnDefinition at line 35
$this change()

Change the column

Return Value

$this

in ColumnDefinition at line 35
$this charset(string $charset) Specify a character set for the column (MySQL)

No description

Parameters

string $charset) Specify a character set for the column (MySQL

Return Value

$this

in ColumnDefinition at line 35
$this collation(string $collation)

Specify a collation for the column

Parameters

string $collation

Return Value

$this

in ColumnDefinition at line 35
$this comment(string $comment) Add a comment to the column (MySQL/PostgreSQL)

No description

Parameters

string $comment) Add a comment to the column (MySQL/PostgreSQL

Return Value

$this

in ColumnDefinition at line 35
$this default(mixed $value)

Specify a "default" value for the column

Parameters

mixed $value

Return Value

$this

in ColumnDefinition at line 35
$this first() $lace the column "first" in the table (MySQL)

No description

Parameters

) $lace the column "first" in the table (MySQL

Return Value

$this

in ColumnDefinition at line 35
$this from(int $startingValue) Set the starting value of an auto-incrementing field (MySQL / PostgreSQL)

No description

Parameters

int $startingValue) Set the starting value of an auto-incrementing field (MySQL / PostgreSQL

Return Value

$this

in ColumnDefinition at line 35
$this generatedAs(Expression $expression = null) Create a SQL compliant identity column (PostgreSQL)

No description

Parameters

Expression $expression

Return Value

$this

in ColumnDefinition at line 35
$this index(bool|string $indexName = null)

Add an index

Parameters

bool|string $indexName

Return Value

$this

in ColumnDefinition at line 35
$this invisible() $pecify that the column should be invisible to "SELECT *" (MySQL)

No description

Parameters

) $pecify that the column should be invisible to "SELECT *" (MySQL

Return Value

$this

in ColumnDefinition at line 35
$this nullable(bool $value = true)

Allow NULL values to be inserted into the column

Parameters

bool $value

Return Value

$this

in ColumnDefinition at line 35
$this persisted() $ark the computed generated column as persistent (SQL Server)

No description

Parameters

) $ark the computed generated column as persistent (SQL Server

Return Value

$this

in ColumnDefinition at line 35
$this primary(bool $value = true)

Add a primary index

Parameters

bool $value

Return Value

$this

in ColumnDefinition at line 35
$this fulltext(bool|string $indexName = null)

Add a fulltext index

Parameters

bool|string $indexName

Return Value

$this

in ColumnDefinition at line 35
$this spatialIndex(bool|string $indexName = null)

Add a spatial index

Parameters

bool|string $indexName

Return Value

$this

in ColumnDefinition at line 35
$this startingValue(int $startingValue) Set the starting value of an auto-incrementing field (MySQL/PostgreSQL)

No description

Parameters

int $startingValue) Set the starting value of an auto-incrementing field (MySQL/PostgreSQL

Return Value

$this

in ColumnDefinition at line 35
$this storedAs(Expression $expression) Create a stored generated column (MySQL/PostgreSQL/SQLite)

No description

Parameters

Expression $expression) Create a stored generated column (MySQL/PostgreSQL/SQLite

Return Value

$this

in ColumnDefinition at line 35
$this type(string $type)

Specify a type for the column

Parameters

string $type

Return Value

$this

in ColumnDefinition at line 35
$this unique(bool|string $indexName = null)

Add a unique index

Parameters

bool|string $indexName

Return Value

$this

in ColumnDefinition at line 35
$this unsigned() $et the INTEGER column as UNSIGNED (MySQL)

No description

Parameters

) $et the INTEGER column as UNSIGNED (MySQL

Return Value

$this

in ColumnDefinition at line 35
$this useCurrent()

Set the TIMESTAMP column to use CURRENT_TIMESTAMP as default value

Return Value

$this

in ColumnDefinition at line 35
$this useCurrentOnUpdate() $et the TIMESTAMP column to use CURRENT_TIMESTAMP when updating (MySQL)

No description

Parameters

) $et the TIMESTAMP column to use CURRENT_TIMESTAMP when updating (MySQL

Return Value

$this

in ColumnDefinition at line 35
$this virtualAs(Expression $expression) Create a virtual generated column (MySQL/PostgreSQL/SQLite)

No description

Parameters

Expression $expression) Create a virtual generated column (MySQL/PostgreSQL/SQLite

Return Value

$this

at line 37
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.

Parameters

string|null $table
string|null $column
string|null $indexName

Return Value

ForeignKeyDefinition

at line 52
ForeignKeyDefinition references(string $column, string $indexName = null)

Specify which column this foreign ID references on another table.

Parameters

string $column
string $indexName

Return Value

ForeignKeyDefinition