vendor/doctrine/dbal/src/Types/Type.php line 152

Open in your IDE?
  1. <?php
  3. namespace Doctrine\DBAL\Types;
  5. use Doctrine\DBAL\Exception;
  6. use Doctrine\DBAL\ParameterType;
  7. use Doctrine\DBAL\Platforms\AbstractPlatform;
  8. use Doctrine\Deprecations\Deprecation;
  10. use function array_map;
  11. use function get_class;
  13. /**
  14.  * The base class for so-called Doctrine mapping types.
  15.  *
  16.  * A Type object is obtained by calling the static {@see getType()} method.
  17.  */
  18. abstract class Type
  19. {
  20.     /**
  21.      * The map of supported doctrine mapping types.
  22.      */
  23.     private const BUILTIN_TYPES_MAP = [
  24.         Types::ARRAY                => ArrayType::class,
  25.         Types::ASCII_STRING         => AsciiStringType::class,
  26.         Types::BIGINT               => BigIntType::class,
  27.         Types::BINARY               => BinaryType::class,
  28.         Types::BLOB                 => BlobType::class,
  29.         Types::BOOLEAN              => BooleanType::class,
  30.         Types::DATE_MUTABLE         => DateType::class,
  31.         Types::DATE_IMMUTABLE       => DateImmutableType::class,
  32.         Types::DATEINTERVAL         => DateIntervalType::class,
  33.         Types::DATETIME_MUTABLE     => DateTimeType::class,
  34.         Types::DATETIME_IMMUTABLE   => DateTimeImmutableType::class,
  35.         Types::DATETIMETZ_MUTABLE   => DateTimeTzType::class,
  36.         Types::DATETIMETZ_IMMUTABLE => DateTimeTzImmutableType::class,
  37.         Types::DECIMAL              => DecimalType::class,
  38.         Types::FLOAT                => FloatType::class,
  39.         Types::GUID                 => GuidType::class,
  40.         Types::INTEGER              => IntegerType::class,
  41.         Types::JSON                 => JsonType::class,
  42.         Types::OBJECT               => ObjectType::class,
  43.         Types::SIMPLE_ARRAY         => SimpleArrayType::class,
  44.         Types::SMALLINT             => SmallIntType::class,
  45.         Types::STRING               => StringType::class,
  46.         Types::TEXT                 => TextType::class,
  47.         Types::TIME_MUTABLE         => TimeType::class,
  48.         Types::TIME_IMMUTABLE       => TimeImmutableType::class,
  49.     ];
  51.     private static ?TypeRegistry $typeRegistry = null;
  53.     /**
  54.      * @internal Do not instantiate directly - use {@see Type::addType()} method instead.
  55.      */
  56.     final public function __construct()
  57.     {
  58.     }
  60.     /**
  61.      * Converts a value from its PHP representation to its database representation
  62.      * of this type.
  63.      *
  64.      * @param mixed            $value    The value to convert.
  65.      * @param AbstractPlatform $platform The currently used database platform.
  66.      *
  67.      * @return mixed The database representation of the value.
  68.      *
  69.      * @throws ConversionException
  70.      */
  71.     public function convertToDatabaseValue($value, AbstractPlatform $platform)
  72.     {
  73.         return $value;
  74.     }
  76.     /**
  77.      * Converts a value from its database representation to its PHP representation
  78.      * of this type.
  79.      *
  80.      * @param mixed            $value    The value to convert.
  81.      * @param AbstractPlatform $platform The currently used database platform.
  82.      *
  83.      * @return mixed The PHP representation of the value.
  84.      *
  85.      * @throws ConversionException
  86.      */
  87.     public function convertToPHPValue($value, AbstractPlatform $platform)
  88.     {
  89.         return $value;
  90.     }
  92.     /**
  93.      * Gets the SQL declaration snippet for a column of this type.
  94.      *
  95.      * @param mixed[]          $column   The column definition
  96.      * @param AbstractPlatform $platform The currently used database platform.
  97.      *
  98.      * @return string
  99.      */
  100.     abstract public function getSQLDeclaration(array $column, AbstractPlatform $platform);
  102.     /**
  103.      * Gets the name of this type.
  104.      *
  105.      * @deprecated this method will be removed in Doctrine DBAL 4.0.
  106.      *
  107.      * @return string
  108.      */
  109.     abstract public function getName();
  111.     final public static function getTypeRegistry(): TypeRegistry
  112.     {
  113.         return self::$typeRegistry ??= self::createTypeRegistry();
  114.     }
  116.     private static function createTypeRegistry(): TypeRegistry
  117.     {
  118.         $instances = [];
  120.         foreach (self::BUILTIN_TYPES_MAP as $name => $class) {
  121.             $instances[$name] = new $class();
  122.         }
  124.         return new TypeRegistry($instances);
  125.     }
  127.     /**
  128.      * Factory method to create type instances.
  129.      * Type instances are implemented as flyweights.
  130.      *
  131.      * @param string $name The name of the type (as returned by getName()).
  132.      *
  133.      * @return Type
  134.      *
  135.      * @throws Exception
  136.      */
  137.     public static function getType($name)
  138.     {
  139.         return self::getTypeRegistry()->get($name);
  140.     }
  142.     /**
  143.      * Adds a custom type to the type map.
  144.      *
  145.      * @param string             $name      The name of the type. This should correspond to what getName() returns.
  146.      * @param class-string<Type> $className The class name of the custom type.
  147.      *
  148.      * @return void
  149.      *
  150.      * @throws Exception
  151.      */
  152.     public static function addType($name, $className)
  153.     {
  154.         self::getTypeRegistry()->register($name, new $className());
  155.     }
  157.     /**
  158.      * Checks if exists support for a type.
  159.      *
  160.      * @param string $name The name of the type.
  161.      *
  162.      * @return bool TRUE if type is supported; FALSE otherwise.
  163.      */
  164.     public static function hasType($name)
  165.     {
  166.         return self::getTypeRegistry()->has($name);
  167.     }
  169.     /**
  170.      * Overrides an already defined type to use a different implementation.
  171.      *
  172.      * @param string             $name
  173.      * @param class-string<Type> $className
  174.      *
  175.      * @return void
  176.      *
  177.      * @throws Exception
  178.      */
  179.     public static function overrideType($name, $className)
  180.     {
  181.         self::getTypeRegistry()->override($name, new $className());
  182.     }
  184.     /**
  185.      * Gets the (preferred) binding type for values of this type that
  186.      * can be used when binding parameters to prepared statements.
  187.      *
  188.      * This method should return one of the {@see ParameterType} constants.
  189.      *
  190.      * @return int
  191.      */
  192.     public function getBindingType()
  193.     {
  194.         return ParameterType::STRING;
  195.     }
  197.     /**
  198.      * Gets the types array map which holds all registered types and the corresponding
  199.      * type class
  200.      *
  201.      * @return array<string, string>
  202.      */
  203.     public static function getTypesMap()
  204.     {
  205.         return array_map(
  206.             static function (Type $type): string {
  207.                 return get_class($type);
  208.             },
  209.             self::getTypeRegistry()->getMap()
  210.         );
  211.     }
  213.     /**
  214.      * Does working with this column require SQL conversion functions?
  215.      *
  216.      * This is a metadata function that is required for example in the ORM.
  217.      * Usage of {@see convertToDatabaseValueSQL} and
  218.      * {@see convertToPHPValueSQL} works for any type and mostly
  219.      * does nothing. This method can additionally be used for optimization purposes.
  220.      *
  221.      * @deprecated Consumers should call {@see convertToDatabaseValueSQL} and {@see convertToPHPValueSQL}
  222.      * regardless of the type.
  223.      *
  224.      * @return bool
  225.      */
  226.     public function canRequireSQLConversion()
  227.     {
  228.         return false;
  229.     }
  231.     /**
  232.      * Modifies the SQL expression (identifier, parameter) to convert to a database value.
  233.      *
  234.      * @param string $sqlExpr
  235.      *
  236.      * @return string
  237.      */
  238.     public function convertToDatabaseValueSQL($sqlExpr, AbstractPlatform $platform)
  239.     {
  240.         return $sqlExpr;
  241.     }
  243.     /**
  244.      * Modifies the SQL expression (identifier, parameter) to convert to a PHP value.
  245.      *
  246.      * @param string           $sqlExpr
  247.      * @param AbstractPlatform $platform
  248.      *
  249.      * @return string
  250.      */
  251.     public function convertToPHPValueSQL($sqlExpr, $platform)
  252.     {
  253.         return $sqlExpr;
  254.     }
  256.     /**
  257.      * Gets an array of database types that map to this Doctrine type.
  258.      *
  259.      * @return string[]
  260.      */
  261.     public function getMappedDatabaseTypes(AbstractPlatform $platform)
  262.     {
  263.         return [];
  264.     }
  266.     /**
  267.      * If this Doctrine Type maps to an already mapped database type,
  268.      * reverse schema engineering can't tell them apart. You need to mark
  269.      * one of those types as commented, which will have Doctrine use an SQL
  270.      * comment to typehint the actual Doctrine Type.
  271.      *
  272.      * @deprecated
  273.      *
  274.      * @return bool
  275.      */
  276.     public function requiresSQLCommentHint(AbstractPlatform $platform)
  277.     {
  278.         Deprecation::triggerIfCalledFromOutside(
  279.             'doctrine/dbal',
  280.             'https://github.com/doctrine/dbal/pull/5509',
  281.             '%s is deprecated.',
  282.             __METHOD__
  283.         );
  285.         return false;
  286.     }
  287. }