Index

  1. \com\setasign\SetaFramework
    1. Database
      1. Manager
        1. Column
          1. AbstractBlob
          2. AbstractColumn
          3. AbstractFloat
          4. AbstractInteger
          5. AbstractLengthColumn
          6. AbstractNoDefault
          7. AbstractNumeric
          8. AbstractText
          9. BigInt
          10. Binary
          11. Blob
          12. Char
          13. Date
          14. DateTime
          15. Decimal
          16. Double
          17. EnumColumn
          18. FloatColumn
          19. HasCollation
          20. HasCollationTrait
          21. Integer
          22. LongBlob
          23. LongText
          24. MediumBlob
          25. MediumInt
          26. MediumText
          27. SmallInt
          28. Text
          29. Time
          30. TinyBlob
          31. TinyInt
          32. TinyText
          33. VarBinary
          34. VarChar

com\setasign\SetaFramework\Database\Manager\Column

EnumColumn Class Enum

File: /SetaFramework/src/Database/Manager/Column/EnumColumn.php

Class hierarchy

Uses

Implements

Summary

Methods

Properties

Constants

Constants

DEFAULT_CURRENT_TIMESTAMP

public const AbstractColumn::DEFAULT_CURRENT_TIMESTAMP = 'current_timestamp()'

DEFAULT_NULL

public const AbstractColumn::DEFAULT_NULL = 'NULL'

Properties

$allowNull

protected bool AbstractColumn::$allowNull = false

$collation

protected ?string HasCollationTrait::$collation

$columnName

protected string AbstractColumn::$columnName

$default

protected mixed AbstractColumn::$default

$enumeration

protected string[] EnumColumn::$enumeration

$indexes

protected array AbstractColumn::$indexes = array()

$oldColumnName

protected ?string AbstractColumn::$oldColumnName

$tableSchema

protected ?\com\setasign\SetaFramework\Database\Manager\TableSchema AbstractColumn::$tableSchema

Methods

__construct()

public EnumColumn::__construct (
string $columnName,
string[] $enumeration
)

Enum constructor.

Parameters
$columnName : string
 
$enumeration : string[]
 

addIndex()

public AbstractColumn::addIndex (
string $type = \com\setasign\SetaFramework\Database\Manager\TableSchema::INDEX,
?string $indexName = null
): $this
Parameters
$type : string
 
$indexName : ?string
 

addPrimaryKey()

public AbstractColumn::addPrimaryKey (
void
): $this

addUnique()

public AbstractColumn::addUnique (
?string $indexName = null
): $this
Parameters
$indexName : ?string
 

changeDataType()

public EnumColumn::changeDataType (
AbstractColumn $newColumnObject
): AbstractColumn

Change the dataType of a column (with all possible attributes)

Parameters
$newColumnObject : AbstractColumn
 

copy()

public AbstractColumn::copy (
void
): AbstractColumn

This method clones this object, removes the tableSchema and returns the clone.

getCollation()

public HasCollationTrait::getCollation (
void
): ?string

getDefault()

public AbstractColumn::getDefault (
void
): mixed

getEnumeration()

public EnumColumn::getEnumeration (
void
): array

getIndexes()

public AbstractColumn::getIndexes (
void
): array

getName()

public AbstractColumn::getName (
void
): string

getOldColumnName()

public AbstractColumn::getOldColumnName (
void
): ?string

hasChanged()

public EnumColumn::hasChanged (
AbstractColumn $compareColumn,
bool $compareDataType = true,
bool $compareName = true
): bool

Checks whether this column is the same as $compareColumn.

Parameters
$compareColumn : AbstractColumn
 
$compareDataType : bool

Check whether both dataTypes are equal.

$compareName : bool

Check whether both columnNames are equal.

Exceptions

Throws \JsonException

isAllowedNull()

public AbstractColumn::isAllowedNull (
void
): bool

removeAllIndexes()

public AbstractColumn::removeAllIndexes (
void
): $this

removeIndex()

public AbstractColumn::removeIndex (
?string $indexName = null
): $this
Parameters
$indexName : ?string
 

rename()

public AbstractColumn::rename (
string $newName
): $this
Parameters
$newName : string
 
Exceptions

Throws \com\setasign\SetaFramework\Exception

setAllowNull()

public AbstractColumn::setAllowNull (
bool $allowNull = true
): $this
Parameters
$allowNull : bool
 

setCollation()

public HasCollationTrait::setCollation (
?string $collation
): $this
Parameters
$collation : ?string
 

setDefault()

public AbstractColumn::setDefault (
null|string|int $default
): $this
Parameters
$default : null|string|int
 

setEnumeration()

public EnumColumn::setEnumeration (
string[] $enumeration
): $this

Change the enumeration list.

Parameters
$enumeration : string[]
 

setOldColumnName()

public AbstractColumn::setOldColumnName (
string $oldColumnName
): $this

Used for TableSchemaBuilder. Will be ignored for hasChanged

Parameters
$oldColumnName : string
 

© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)