final class TableOptions (View source)

Provides the table options contract for the database subsystem.

Methods

__construct(string|null $engine = null, string|null $charset = null, string|null $collation = null, string|null $comment = null, array $extra = [])
static TableOptions
make()

Builds the requested database value while preserving its framework contract.

engine(string|null $engine)

Provides this part of the database contract while preserving the object's current state and driver semantics.

charset(string|null $charset)

Provides this part of the database contract while preserving the object's current state and driver semantics.

collation(string|null $collation)

Provides this part of the database contract while preserving the object's current state and driver semantics.

comment(string|null $comment)

Provides this part of the database contract while preserving the object's current state and driver semantics.

option(string $name, int|string|bool|SqlExpression|null $value)

Provides this part of the database contract while preserving the object's current state and driver semantics.

string|null

Provides this part of the database contract while preserving the object's current state and driver semantics.

string|null
string|null

Provides this part of the database contract while preserving the object's current state and driver semantics.

string|null
string|null

Provides this part of the database contract while preserving the object's current state and driver semantics.

string|null
string|null

Provides this part of the database contract while preserving the object's current state and driver semantics.

string|null
array
extra()
array

Details

__construct

__construct(string|null $engine = null, string|null $charset = null, string|null $collation = null, string|null $comment = null, array $extra = [])

No description

Parameters

string|null $engine
string|null $charset
string|null $collation
string|null $comment
array $extra

make

static TableOptions make()

Builds the requested database value while preserving its framework contract.

Return Value

TableOptions

engine

TableOptions engine(string|null $engine)

Provides this part of the database contract while preserving the object's current state and driver semantics.

Parameters

string|null $engine

Return Value

TableOptions

charset

TableOptions charset(string|null $charset)

Provides this part of the database contract while preserving the object's current state and driver semantics.

Parameters

string|null $charset

Return Value

TableOptions

collation

TableOptions collation(string|null $collation)

Provides this part of the database contract while preserving the object's current state and driver semantics.

Parameters

string|null $collation

Return Value

TableOptions

comment

TableOptions comment(string|null $comment)

Provides this part of the database contract while preserving the object's current state and driver semantics.

Parameters

string|null $comment

Return Value

TableOptions

option

TableOptions option(string $name, int|string|bool|SqlExpression|null $value)

Provides this part of the database contract while preserving the object's current state and driver semantics.

Parameters

string $name
int|string|bool|SqlExpression|null $value

Return Value

TableOptions

engineName

string|null engineName()

Provides this part of the database contract while preserving the object's current state and driver semantics.

Return Value

string|null

charsetName

string|null charsetName()

Provides this part of the database contract while preserving the object's current state and driver semantics.

Return Value

string|null

collationName

string|null collationName()

Provides this part of the database contract while preserving the object's current state and driver semantics.

Return Value

string|null

commentText

string|null commentText()

Provides this part of the database contract while preserving the object's current state and driver semantics.

Return Value

string|null

extra

array extra()

No description

Return Value

array