EnumType
extends Type
in package
Creating a custom enum type for integration with doctrine/dbal
Tags
Table of Contents
- TYPENAME = 'enum'
- $values : mixed
- convertToDatabaseValue() : mixed
- This is executed when the value is written to the database. Make your conversions here, optionally using the $platform.
- convertToPHPValue() : mixed
- This is executed when the value is read from the database. Make your conversions here, optionally using the $platform.
- getName() : mixed
- getSQLDeclaration() : mixed
- return the SQL used to create your column type. To create a portable column type, use the $platform.
- registerDoctrineEnumMapping() : void
- Creating custom type to deal with ENUM.
- requiresSQLCommentHint() : mixed
Constants
TYPENAME
public
mixed
TYPENAME
= 'enum'
Properties
$values
protected
mixed
$values
= array()
Methods
convertToDatabaseValue()
This is executed when the value is written to the database. Make your conversions here, optionally using the $platform.
public
convertToDatabaseValue(mixed $value, AbstractPlatform $platform) : mixed
Parameters
- $value : mixed
- $platform : AbstractPlatform
Return values
mixed —convertToPHPValue()
This is executed when the value is read from the database. Make your conversions here, optionally using the $platform.
public
convertToPHPValue(mixed $value, AbstractPlatform $platform) : mixed
Parameters
- $value : mixed
- $platform : AbstractPlatform
Return values
mixed —getName()
public
getName() : mixed
Return values
mixed —getSQLDeclaration()
return the SQL used to create your column type. To create a portable column type, use the $platform.
public
getSQLDeclaration(array<string|int, mixed> $fieldDeclaration, AbstractPlatform $platform) : mixed
Parameters
- $fieldDeclaration : array<string|int, mixed>
- $platform : AbstractPlatform
Return values
mixed —registerDoctrineEnumMapping()
Creating custom type to deal with ENUM.
public
static registerDoctrineEnumMapping() : void
Return values
void —requiresSQLCommentHint()
public
requiresSQLCommentHint(AbstractPlatform $platform) : mixed
Parameters
- $platform : AbstractPlatform