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

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.     /** @internal Do not instantiate directly - use {@see Type::addType()} method instead. */
  54.     final public function __construct()
  55.     {
  56.     }
  58.     /**
  59.      * Converts a value from its PHP representation to its database representation
  60.      * of this type.
  61.      *
  62.      * @param mixed            $value    The value to convert.
  63.      * @param AbstractPlatform $platform The currently used database platform.
  64.      *
  65.      * @return mixed The database representation of the value.
  66.      *
  67.      * @throws ConversionException
  68.      */
  69.     public function convertToDatabaseValue($value, AbstractPlatform $platform)
  70.     {
  71.         return $value;
  72.     }
  74.     /**
  75.      * Converts a value from its database representation to its PHP representation
  76.      * of this type.
  77.      *
  78.      * @param mixed            $value    The value to convert.
  79.      * @param AbstractPlatform $platform The currently used database platform.
  80.      *
  81.      * @return mixed The PHP representation of the value.
  82.      *
  83.      * @throws ConversionException
  84.      */
  85.     public function convertToPHPValue($value, AbstractPlatform $platform)
  86.     {
  87.         return $value;
  88.     }
  90.     /**
  91.      * Gets the SQL declaration snippet for a column of this type.
  92.      *
  93.      * @param mixed[]          $column   The column definition
  94.      * @param AbstractPlatform $platform The currently used database platform.
  95.      *
  96.      * @return string
  97.      */
  98.     abstract public function getSQLDeclaration(array $column, AbstractPlatform $platform);
  100.     /**
  101.      * Gets the name of this type.
  102.      *
  103.      * @deprecated this method will be removed in Doctrine DBAL 4.0.
  104.      *
  105.      * @return string
  106.      */
  107.     abstract public function getName();
  109.     final public static function getTypeRegistry(): TypeRegistry
  110.     {
  111.         return self::$typeRegistry ??= self::createTypeRegistry();
  112.     }
  114.     private static function createTypeRegistry(): TypeRegistry
  115.     {
  116.         $instances = [];
  118.         foreach (self::BUILTIN_TYPES_MAP as $name => $class) {
  119.             $instances[$name] = new $class();
  120.         }
  122.         return new TypeRegistry($instances);
  123.     }
  125.     /**
  126.      * Factory method to create type instances.
  127.      * Type instances are implemented as flyweights.
  128.      *
  129.      * @param string $name The name of the type (as returned by getName()).
  130.      *
  131.      * @return Type
  132.      *
  133.      * @throws Exception
  134.      */
  135.     public static function getType($name)
  136.     {
  137.         return self::getTypeRegistry()->get($name);
  138.     }
  140.     /**
  141.      * Adds a custom type to the type map.
  142.      *
  143.      * @param string             $name      The name of the type. This should correspond to what getName() returns.
  144.      * @param class-string<Type> $className The class name of the custom type.
  145.      *
  146.      * @return void
  147.      *
  148.      * @throws Exception
  149.      */
  150.     public static function addType($name, $className)
  151.     {
  152.         self::getTypeRegistry()->register($name, new $className());
  153.     }
  155.     /**
  156.      * Checks if exists support for a type.
  157.      *
  158.      * @param string $name The name of the type.
  159.      *
  160.      * @return bool TRUE if type is supported; FALSE otherwise.
  161.      */
  162.     public static function hasType($name)
  163.     {
  164.         return self::getTypeRegistry()->has($name);
  165.     }
  167.     /**
  168.      * Overrides an already defined type to use a different implementation.
  169.      *
  170.      * @param string             $name
  171.      * @param class-string<Type> $className
  172.      *
  173.      * @return void
  174.      *
  175.      * @throws Exception
  176.      */
  177.     public static function overrideType($name, $className)
  178.     {
  179.         self::getTypeRegistry()->override($name, new $className());
  180.     }
  182.     /**
  183.      * Gets the (preferred) binding type for values of this type that
  184.      * can be used when binding parameters to prepared statements.
  185.      *
  186.      * This method should return one of the {@see ParameterType} constants.
  187.      *
  188.      * @return int
  189.      */
  190.     public function getBindingType()
  191.     {
  192.         return ParameterType::STRING;
  193.     }
  195.     /**
  196.      * Gets the types array map which holds all registered types and the corresponding
  197.      * type class
  198.      *
  199.      * @return array<string, string>
  200.      */
  201.     public static function getTypesMap()
  202.     {
  203.         return array_map(
  204.             static function (Type $type): string {
  205.                 return get_class($type);
  206.             },
  207.             self::getTypeRegistry()->getMap(),
  208.         );
  209.     }
  211.     /**
  212.      * Does working with this column require SQL conversion functions?
  213.      *
  214.      * This is a metadata function that is required for example in the ORM.
  215.      * Usage of {@see convertToDatabaseValueSQL} and
  216.      * {@see convertToPHPValueSQL} works for any type and mostly
  217.      * does nothing. This method can additionally be used for optimization purposes.
  218.      *
  219.      * @deprecated Consumers should call {@see convertToDatabaseValueSQL} and {@see convertToPHPValueSQL}
  220.      * regardless of the type.
  221.      *
  222.      * @return bool
  223.      */
  224.     public function canRequireSQLConversion()
  225.     {
  226.         return false;
  227.     }
  229.     /**
  230.      * Modifies the SQL expression (identifier, parameter) to convert to a database value.
  231.      *
  232.      * @param string $sqlExpr
  233.      *
  234.      * @return string
  235.      */
  236.     public function convertToDatabaseValueSQL($sqlExpr, AbstractPlatform $platform)
  237.     {
  238.         return $sqlExpr;
  239.     }
  241.     /**
  242.      * Modifies the SQL expression (identifier, parameter) to convert to a PHP value.
  243.      *
  244.      * @param string           $sqlExpr
  245.      * @param AbstractPlatform $platform
  246.      *
  247.      * @return string
  248.      */
  249.     public function convertToPHPValueSQL($sqlExpr, $platform)
  250.     {
  251.         return $sqlExpr;
  252.     }
  254.     /**
  255.      * Gets an array of database types that map to this Doctrine type.
  256.      *
  257.      * @return string[]
  258.      */
  259.     public function getMappedDatabaseTypes(AbstractPlatform $platform)
  260.     {
  261.         return [];
  262.     }
  264.     /**
  265.      * If this Doctrine Type maps to an already mapped database type,
  266.      * reverse schema engineering can't tell them apart. You need to mark
  267.      * one of those types as commented, which will have Doctrine use an SQL
  268.      * comment to typehint the actual Doctrine Type.
  269.      *
  270.      * @deprecated
  271.      *
  272.      * @return bool
  273.      */
  274.     public function requiresSQLCommentHint(AbstractPlatform $platform)
  275.     {
  276.         Deprecation::triggerIfCalledFromOutside(
  277.             'doctrine/dbal',
  278.             'https://github.com/doctrine/dbal/pull/5509',
  279.             '%s is deprecated.',
  280.             __METHOD__,
  281.         );
  283.         return false;
  284.     }
  285. }