\Omega\Database\Migration\Field BoolField

Boolean field class.

The BoolField represents a boolean field for database migrations.

Summary

Methods
Properties
Constants
default
__construct
nullable
alter
default
name
nullable
alter
No public constants found
No protected methods found
No protected properties found
No protected constants found
No private methods found
No private properties found
No private constants found

Properties

$default

$default : bool|null

Default value for the boolean field.

Type

bool|null — Holds the default value or null.

$name

$name : string

Field name.

Type

string — Holds the field name.

$nullable

$nullable : bool

Nullable field.

Type

bool — Determine if field is nullable.

$alter

$alter : bool

Alterable field.

Type

bool — Determine if field is alterable.

Methods

default()

default(bool  $value) : $this

Set the default value for boolean field.

Parameters

bool $value

Holds the default value for the booelean field.

Returns

$this —

Returns the current instance for method chaining.

__construct()

__construct(string  $name) : void

AbstractField class constructor.

Parameters

string $name

Holds the field name.

Returns

void —

nullable()

nullable() : $this

Determine if the field is nullable.

Returns

$this —

alter()

alter() : $this

Determine if the field is alterable.

Returns

$this —