W3cubDocs

ForeignIdColumnDefinition

class ForeignIdColumnDefinition extends ColumnDefinition (View source)

Properties

protected	$attributes		from Fluent
protected Blueprint	$blueprint	The schema builder blueprint instance.

Methods

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

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

Collection

collect(string|null $key = null)

Convert the fluent instance to a Collection.

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

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 = 'id', 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

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

Collection collect(string|null $key = null)

Convert the fluent instance to a Collection.

Parameters

string|null

$key

Return Value

Collection

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 = 'id', 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

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Database/Schema/ForeignIdColumnDefinition.html