class ForeignIdColumnDefinition extends ColumnDefinition (View source)

Traits

Properties

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.

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.

bool
isEmptyString(string $key)

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

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

Retrieve data from the instnce as a Stringable instance.

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.

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, string|null $tz = null)

Retrieve data from the instance as a Carbon instance.

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

Retrieve data from the instance as an enum.

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

Retrieve data from the instance as an array of enums.

bool
isBackedEnum(class-string $enumClass)

Determine if the given enum class is backed.

collect(array|string|null $key = null)

Retrieve data from the instance as a collection.

array
only(array|mixed $keys)

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

array
except(array|mixed $keys)

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

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

Create a new foreign ID column definition.

get($key, $default = null)

No description

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

Get an attribute from the fluent instance.

from  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
$this
__call(TKey $method, $parameters)

Handle dynamic calls to the fluent instance to set attributes.

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

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

No description

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

No description

$this
change()

Change the column

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

No description

$this
collation(string $collation)

Specify a collation for the column

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

No description

$this
default(mixed $value)

Specify a "default" value for the column

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

No description

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

No description

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

No description

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

Add an index

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

No description

$this
nullable(bool $value = true)

Allow NULL values to be inserted into the column

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

No description

$this
primary(bool $value = true)

Add a primary index

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

Add a fulltext index

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

Add a spatial index

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

No description

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

No description

$this
type(string $type)

Specify a type for the column

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

Add a unique index

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

No description

$this
useCurrent()

Set the TIMESTAMP column to use CURRENT_TIMESTAMP as default value

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

No description

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

No description

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.

references(string $column, string $indexName = null)

Specify which column this foreign ID references on another table.

Details

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

Retrieve all data from the instance.

Parameters

array|mixed|null $keys

Return Value

array

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

bool exists(string|array $key)

Determine if the data contains a given key.

Parameters

string|array $key

Return Value

bool

bool has(string|array $key)

Determine if the data contains a given key.

Parameters

string|array $key

Return Value

bool

bool hasAny(string|array $keys)

Determine if the instance contains any of the given keys.

Parameters

string|array $keys

Return Value

bool

$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

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

bool isNotFilled(string|array $key)

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

Parameters

string|array $key

Return Value

bool

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

$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

bool missing(string|array $key)

Determine if the instance is missing a given key.

Parameters

string|array $key

Return Value

bool

$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

protected bool isEmptyString(string $key)

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

Parameters

string $key

Return Value

bool

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

Retrieve data from the instnce as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

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

Retrieve data from the instance as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

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

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

Retrieve data as an integer value.

Parameters

string $key
int $default

Return Value

int

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

Retrieve data as a float value.

Parameters

string $key
float $default

Return Value

float

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

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

Retrieve data from the instance as an enum.

Parameters

string $key
TEnum> $enumClass

Return Value

TEnum|null

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

Retrieve data from the instance as an array of enums.

Parameters

string $key
TEnum> $enumClass

Return Value

TEnum[]

protected bool isBackedEnum(class-string $enumClass)

Determine if the given enum class is backed.

Parameters

class-string $enumClass

Return Value

bool

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

Retrieve data from the instance as a collection.

Parameters

array|string|null $key

Return Value

Collection

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

array except(array|mixed $keys)

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

Parameters

array|mixed $keys

Return Value

array

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

Create a new foreign ID column definition.

Parameters

Blueprint $blueprint
TValue> $attributes

Return Value

void

get($key, $default = null)

No description

Parameters

$key
$default

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

Get an attribute from the fluent instance.

Parameters

string $key
mixed $default

Return Value

mixed

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

getAttributes()

No description

toArray()

No description

array jsonSerialize()

No description

Return Value

array

string toJson(int $options = 0)

Convert the fluent instance to JSON.

Parameters

int $options

Return Value

string

bool offsetExists(TKey $offset)

Determine if the given offset exists.

Parameters

TKey $offset

Return Value

bool

mixed offsetGet(TKey $offset)

Get the value for a given offset.

Parameters

TKey $offset

Return Value

mixed

void offsetSet(TKey $offset, TValue $value)

Set the value at the given offset.

Parameters

TKey $offset
TValue $value

Return Value

void

void offsetUnset(TKey $offset)

Unset the value at the given offset.

Parameters

TKey $offset

Return Value

void

$this __call(TKey $method, $parameters)

Handle dynamic calls to the fluent instance to set attributes.

Parameters

TKey $method
$parameters

Return Value

$this

TValue|null __get(TKey $key)

Dynamically retrieve the value of an attribute.

Parameters

TKey $key

Return Value

TValue|null

void __set(TKey $key, TValue $value)

Dynamically set the value of an attribute.

Parameters

TKey $key
TValue $value

Return Value

void

bool __isset(TKey $key)

Dynamically check if an attribute is set.

Parameters

TKey $key

Return Value

bool

void __unset(TKey $key)

Dynamically unset an attribute.

Parameters

TKey $key

Return Value

void

$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

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

No description

Parameters

bool $value

Return Value

$this

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

No description

Parameters

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

Return Value

$this

$this change()

Change the column

Return Value

$this

$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

$this collation(string $collation)

Specify a collation for the column

Parameters

string $collation

Return Value

$this

$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

$this default(mixed $value)

Specify a "default" value for the column

Parameters

mixed $value

Return Value

$this

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

No description

Parameters

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

Return Value

$this

$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

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

No description

Parameters

Expression $expression

Return Value

$this

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

Add an index

Parameters

bool|string $indexName

Return Value

$this

$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

$this nullable(bool $value = true)

Allow NULL values to be inserted into the column

Parameters

bool $value

Return Value

$this

$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

$this primary(bool $value = true)

Add a primary index

Parameters

bool $value

Return Value

$this

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

Add a fulltext index

Parameters

bool|string $indexName

Return Value

$this

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

Add a spatial index

Parameters

bool|string $indexName

Return Value

$this

$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

$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

$this type(string $type)

Specify a type for the column

Parameters

string $type

Return Value

$this

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

Add a unique index

Parameters

bool|string $indexName

Return Value

$this

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

No description

Parameters

) $et the INTEGER column as UNSIGNED (MySQL

Return Value

$this

$this useCurrent()

Set the TIMESTAMP column to use CURRENT_TIMESTAMP as default value

Return Value

$this

$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

$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

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

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