W3cubDocs

/Laravel 5.8

ColumnDefinition

class ColumnDefinition extends Fluent (View source)

Properties

protected array $attributes All of the attributes set on the fluent instance. from Fluent

Methods

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

Create a new fluent instance.

 from Fluent
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
ColumnDefinition after(string $column)

Place the column "after" another column (MySQL)
ColumnDefinition always()

Used as a modifier for generatedAs() (PostgreSQL)
ColumnDefinition autoIncrement()

Set INTEGER columns as auto-increment (primary key)
ColumnDefinition change()

Change the column
ColumnDefinition charset(string $charset)

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

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

Add a comment to the column (MySQL)
ColumnDefinition default(mixed $value)

Specify a "default" value for the column
ColumnDefinition first()

Place the column "first" in the table (MySQL)
ColumnDefinition generatedAs(Expression $expression = null)

Create a SQL compliant identity column (PostgreSQL)
ColumnDefinition index(string $indexName = null)

Add an index
ColumnDefinition nullable(bool $value = true)

Allow NULL values to be inserted into the column
ColumnDefinition primary()

Add a primary index
ColumnDefinition spatialIndex()

Add a spatial index
ColumnDefinition storedAs(string $expression)

Create a stored generated column (MySQL)
ColumnDefinition unique()

Add a unique index
ColumnDefinition unsigned()

Set the INTEGER column as UNSIGNED (MySQL)
ColumnDefinition useCurrent()

Set the TIMESTAMP column to use CURRENT_TIMESTAMP as default value
ColumnDefinition virtualAs(string $expression)

Create a virtual generated column (MySQL)
ColumnDefinition persisted()

Mark the computed generated column as persistent (SQL Server)

Details

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

Create a new fluent instance.

Parameters

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

ColumnDefinition after(string $column)

Place the column "after" another column (MySQL)

Parameters

string $column

Return Value

ColumnDefinition

ColumnDefinition always()

Used as a modifier for generatedAs() (PostgreSQL)

Return Value

ColumnDefinition

ColumnDefinition autoIncrement()

Set INTEGER columns as auto-increment (primary key)

Return Value

ColumnDefinition

ColumnDefinition change()

Change the column

Return Value

ColumnDefinition

ColumnDefinition charset(string $charset)

Specify a character set for the column (MySQL)

Parameters

string $charset

Return Value

ColumnDefinition

ColumnDefinition collation(string $collation)

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

Parameters

string $collation

Return Value

ColumnDefinition

ColumnDefinition comment(string $comment)

Add a comment to the column (MySQL)

Parameters

string $comment

Return Value

ColumnDefinition

ColumnDefinition default(mixed $value)

Specify a "default" value for the column

Parameters

mixed $value

Return Value

ColumnDefinition

ColumnDefinition first()

Place the column "first" in the table (MySQL)

Return Value

ColumnDefinition

ColumnDefinition generatedAs(Expression $expression = null)

Create a SQL compliant identity column (PostgreSQL)

Parameters

Expression $expression

Return Value

ColumnDefinition

ColumnDefinition index(string $indexName = null)

Add an index

Parameters

string $indexName

Return Value

ColumnDefinition

ColumnDefinition nullable(bool $value = true)

Allow NULL values to be inserted into the column

Parameters

bool $value

Return Value

ColumnDefinition

ColumnDefinition primary()

Add a primary index

Return Value

ColumnDefinition

ColumnDefinition spatialIndex()

Add a spatial index

Return Value

ColumnDefinition

ColumnDefinition storedAs(string $expression)

Create a stored generated column (MySQL)

Parameters

string $expression

Return Value

ColumnDefinition

ColumnDefinition unique()

Add a unique index

Return Value

ColumnDefinition

ColumnDefinition unsigned()

Set the INTEGER column as UNSIGNED (MySQL)

Return Value

ColumnDefinition

ColumnDefinition useCurrent()

Set the TIMESTAMP column to use CURRENT_TIMESTAMP as default value

Return Value

ColumnDefinition

ColumnDefinition virtualAs(string $expression)

Create a virtual generated column (MySQL)

Parameters

string $expression

Return Value

ColumnDefinition

ColumnDefinition persisted()

Mark the computed generated column as persistent (SQL Server)

Return Value

ColumnDefinition

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