Summary
- File
- Package hierarchy DBAL\Types
- Class hierarchy \Type \DecimalType
- See also https://www.doctrine-project.org
Type that maps an SQL DECIMAL to a PHP double.
A Type object is obtained by calling the static \getType() method.
Class DecimalType
Methods
convertToDatabaseValue()
convertToDatabaseValue(mixed $value, \AbstractPlatform $platform) : mixedConverts a value from its PHP representation to its database representation of this type.
Parameters
| mixed | $value | The value to convert. |
| \AbstractPlatform | $platform | The currently used database platform. |
Returns
mixed
—
The database representation of the value.
- Inherited from \Type
Tags
| None found |
convertToPHPValue()
convertToPHPValue(mixed $value, \AbstractPlatform $platform) : mixedConverts a value from its database representation to its PHP representation of this type.
Parameters
| mixed | $value | The value to convert. |
| \AbstractPlatform | $platform | The currently used database platform. |
Returns
mixed
—
The PHP representation of the value.
- Inherited from \DecimalType
Tags
| None found |
getDefaultLength()
getDefaultLength(\AbstractPlatform $platform) Gets the default length of this type.
Parameters
| \AbstractPlatform | $platform |
- Inherited from \Type
Tags
| todo |
Needed? |
getSqlDeclaration()
getSqlDeclaration(array $fieldDeclaration, \AbstractPlatform $platform) Gets the SQL declaration snippet for a field of this type.
Parameters
| array | $fieldDeclaration | The field declaration. |
| \AbstractPlatform | $platform | The currently used database platform. |
- Inherited from \DecimalType
Tags
| None found |
getName()
getName() : stringGets the name of this type.
Returns
string
- Inherited from \DecimalType
Tags
| None found |
getTypeCode()
getTypeCode() : integerGets the type code of this type.
Returns
integer
- Inherited from \Type
Tags
| None found |
getType()
getType(string $name) : \Doctrine\DBAL\Types\TypeFactory method to create type instances.
Type instances are implemented as flyweights.
Parameters
| string | $name | The name of the type (as returned by getName()). |
Returns
\Doctrine\DBAL\Types\Type
static
- Inherited from \Type
Tags
| static |
addType()
addType(string $name, string $className) Adds a custom type to the type map.
Parameters
| string | $name | Name of the type. This should correspond to what getName() returns. |
| string | $className | The class name of the custom type. |
Throws
- \DoctrineException
static
- Inherited from \Type
Tags
| static |
hasType()
hasType(string $name) : booleanChecks if exists support for a type.
Parameters
| string | $name | Name of the type |
Returns
boolean
—
TRUE if type is supported; FALSE otherwise
static
- Inherited from \Type
Tags
| static |
overrideType()
overrideType(string $name, string $className) Overrides an already defined type to use a different implementation.
Parameters
| string | $name | |
| string | $className |
Throws
- \DoctrineException
static
- Inherited from \Type
Tags
| static |
__construct()
__construct()
- Inherited from \Type
Tags
| None found |