Documentation

Column
in package
implements MappingAttribute

FinalYes
Tags
Annotation
NamedArgumentConstructor
Target

({"PROPERTY","ANNOTATION"})

Table of Contents

Interfaces

MappingAttribute
A marker interface for mapping attributes.

Properties

$columnDefinition  : string|null
$enumType  : BackedEnum>|null
$generated  : string|null
$insertable  : bool
$length  : int|null
$name  : string|null
$nullable  : bool
$options  : array<string, mixed>
$precision  : int|null
The precision for a decimal (exact numeric) column (Applies only for decimal column).
$scale  : int|null
The scale for a decimal (exact numeric) column (Applies only for decimal column).
$type  : mixed
$unique  : bool
$updatable  : bool

Methods

__construct()  : mixed

Properties

$columnDefinition

public string|null $columnDefinition
Tags
readonly

$enumType

public BackedEnum>|null $enumType = null
Tags
readonly

$generated

public string|null $generated
Tags
readonly
psalm-var

'NEVER'|'INSERT'|'ALWAYS'|null

Enum

({"NEVER", "INSERT", "ALWAYS"})

$insertable

public bool $insertable = true
Tags
readonly

$length

public int|null $length
Tags
readonly

$name

public string|null $name
Tags
readonly

$nullable

public bool $nullable = false
Tags
readonly

$options

public array<string, mixed> $options = []
Tags
readonly

$precision

The precision for a decimal (exact numeric) column (Applies only for decimal column).

public int|null $precision = 0
Tags
readonly

$scale

The scale for a decimal (exact numeric) column (Applies only for decimal column).

public int|null $scale = 0
Tags
readonly

$type

public mixed $type
Tags
readonly

$unique

public bool $unique = false
Tags
readonly

$updatable

public bool $updatable = true
Tags
readonly

Methods

__construct()

public __construct([string|null $name = null ][, string|null $type = null ][, int|null $length = null ][, int|null $precision = null ][, int|null $scale = null ][, bool $unique = false ][, bool $nullable = false ][, bool $insertable = true ][, bool $updatable = true ][, BackedEnum>|null $enumType = null ][, array<string, mixed> $options = [] ][, string|null $columnDefinition = null ][, string|null $generated = null ]) : mixed
Parameters
$name : string|null = null
$type : string|null = null
$length : int|null = null
$precision : int|null = null
$scale : int|null = null
$unique : bool = false
$nullable : bool = false
$insertable : bool = true
$updatable : bool = true
$enumType : BackedEnum>|null = null
$options : array<string, mixed> = []
$columnDefinition : string|null = null
$generated : string|null = null
Tags
psalm-param

'NEVER'|'INSERT'|'ALWAYS'|null $generated


        
On this page

Search results