ForeignIdColumnDefinition

class ForeignIdColumnDefinition extends ColumnDefinition (View source)

Properties

protected array	$attributes	All of the attributes set on the fluent instance.	from Fluent
protected Blueprint	$blueprint	The schema builder blueprint instance.

Methods

void

__construct(Blueprint $blueprint, array|object $attributes = [])

Create a new foreign ID column definition.

mixed

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

Get an attribute from the fluent instance.

from Fluent

array

getAttributes()

Get the attributes from the fluent instance.

from Fluent

array

toArray()

Convert the fluent instance to an array.

from Fluent

array

jsonSerialize()

Convert the object into something JSON serializable.

from Fluent

string

toJson(int $options = 0)

Convert the fluent instance to JSON.

from Fluent

bool

offsetExists(string $offset)

Determine if the given offset exists.

from Fluent

mixed

offsetGet(string $offset)

Get the value for a given offset.

from Fluent

void

offsetSet(string $offset, mixed $value)

Set the value at the given offset.

from Fluent

void

offsetUnset(string $offset)

Unset the value at the given offset.

from Fluent

$this

__call(string $method, array $parameters)

Handle dynamic calls to the fluent instance to set attributes.

from Fluent

mixed

__get(string $key)

Dynamically retrieve the value of an attribute.

from Fluent

void

__set(string $key, mixed $value)

Dynamically set the value of an attribute.

from Fluent

bool

__isset(string $key)

Dynamically check if an attribute is set.

from Fluent

void

__unset(string $key)

Dynamically unset an attribute.

from Fluent

$this

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

No description

from ColumnDefinition

$this

always() $sed 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 (MySQL/PostgreSQL/SQL Server)

No description

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(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()

Add a primary index

from ColumnDefinition

$this

fulltext(string $indexName = null)

Add a fulltext index

from ColumnDefinition

$this

spatialIndex(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(string $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(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(string $expression) Create a virtual generated column (MySQL/PostgreSQL/SQLite)

No description

from ColumnDefinition

ForeignKeyDefinition

constrained(string|null $table = null, string $column = 'id')

Create a foreign key constraint on this column referencing the "id" column of the conventionally related table.

ForeignKeyDefinition

references(string $column)

Specify which column this foreign ID references on another table.

Details

void __construct(Blueprint $blueprint, array|object $attributes = [])

Create a new foreign ID column definition.

Parameters

Blueprint	$blueprint
array\|object	$attributes

Return Value

void

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

Get an attribute from the fluent instance.

Parameters

string	$key
mixed	$default

Return Value

mixed

array getAttributes()

Get the attributes from the fluent instance.

Return Value

array

array toArray()

Convert the fluent instance to an array.

Return Value

array

array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

string toJson(int $options = 0)

Convert the fluent instance to JSON.

Parameters

int

$options

Return Value

string

bool offsetExists(string $offset)

Determine if the given offset exists.

Parameters

string

$offset

Return Value

bool

mixed offsetGet(string $offset)

Get the value for a given offset.

Parameters

string

$offset

Return Value

mixed

void offsetSet(string $offset, mixed $value)

Set the value at the given offset.

Parameters

string	$offset
mixed	$value

Return Value

void

void offsetUnset(string $offset)

Unset the value at the given offset.

Parameters

string

$offset

Return Value

void

$this __call(string $method, array $parameters)

Handle dynamic calls to the fluent instance to set attributes.

Parameters

string	$method
array	$parameters

Return Value

$this

mixed __get(string $key)

Dynamically retrieve the value of an attribute.

Parameters

string

$key

Return Value

mixed

void __set(string $key, mixed $value)

Dynamically set the value of an attribute.

Parameters

string	$key
mixed	$value

Return Value

void

bool __isset(string $key)

Dynamically check if an attribute is set.

Parameters

string

$key

Return Value

bool

void __unset(string $key)

Dynamically unset an attribute.

Parameters

string

$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() $sed as a modifier for generatedAs() (PostgreSQL)

No description

Parameters

)

$sed as a modifier for generatedAs() (PostgreSQL

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 (MySQL/PostgreSQL/SQL Server)

No description

Parameters

string

$collation) Specify a collation for the column (MySQL/PostgreSQL/SQL Server

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(string $indexName = null)

Add an index

Parameters

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()

Add a primary index

Return Value

$this

$this fulltext(string $indexName = null)

Add a fulltext index

Parameters

string

$indexName

Return Value

$this

$this spatialIndex(string $indexName = null)

Add a spatial index

Parameters

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(string $expression) Create a stored generated column (MySQL/PostgreSQL/SQLite)

No description

Parameters

string

$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(string $indexName = null)

Add a unique index

Parameters

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(string $expression) Create a virtual generated column (MySQL/PostgreSQL/SQLite)

No description

Parameters

string

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

Return Value

$this

ForeignKeyDefinition constrained(string|null $table = null, string $column = 'id')

Create a foreign key constraint on this column referencing the "id" column of the conventionally related table.

Parameters

string\|null	$table
string	$column

Return Value

ForeignKeyDefinition

ForeignKeyDefinition references(string $column)

Specify which column this foreign ID references on another table.

Parameters

string

$column

Return Value

ForeignKeyDefinition

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