feat: improve accidental misconfiguration through the use of constants for all DBAL types (#486)

Co-authored-by: Martin Georgiev <martin-georgiev@users.noreply.github.com>

Author: ThomasLandauer

README.md

@@ -9,20 +9,23 @@ Enhances Doctrine with PostgreSQL-specific features and functions. Supports Post
 
 ## Quick Start
 
+
 ```php
+use MartinGeorgiev\Doctrine\DBAL\Type;
+
 // Register types with Doctrine
-Type::addType('jsonb', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\Jsonb");
-Type::addType('text[]', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\TextArray");
-Type::addType('numrange', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\NumRange");
+Type::addType(Type::JSONB, "MartinGeorgiev\\Doctrine\\DBAL\\Types\\Jsonb");
+Type::addType(Type::TEXT_ARRAY, "MartinGeorgiev\\Doctrine\\DBAL\\Types\\TextArray");
+Type::addType(Type::NUMRANGE, "MartinGeorgiev\\Doctrine\\DBAL\\Types\\NumRange");
 
 // Use in your Doctrine entities
-#[ORM\Column(type: 'jsonb')]
+#[ORM\Column(type: Type::JSONB)]
 private array $data;
 
-#[ORM\Column(type: 'text[]')]
+#[ORM\Column(type: Type::TEXT_ARRAY)]
 private array $tags;
 
-#[ORM\Column(type: 'numrange')]
+#[ORM\Column(type: Type::NUMRANGE)]
 private NumericRange $priceRange;
 
 // Use in DQL

docs/INTEGRATING-WITH-SYMFONY.md

@@ -301,6 +301,7 @@ Once configured, you can use the PostgreSQL types in your Symfony entities:
 namespace App\Entity;
 
 use Doctrine\ORM\Mapping as ORM;
+use MartinGeorgiev\Doctrine\DBAL\Type;
 use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\DateRange;
 use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\Ltree;
 use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\NumericRange;
@@ -316,25 +317,25 @@ class Product
     #[ORM\Column]
     private ?int $id = null;
 
-    #[ORM\Column(type: 'jsonb')]
+    #[ORM\Column(type: Type::JSONB)]
     private array $specifications = [];
 
-    #[ORM\Column(type: 'text[]')]
+    #[ORM\Column(type: Type::TEXT_ARRAY)]
     private array $categories = [];
 
-    #[ORM\Column(type: 'point')]
+    #[ORM\Column(type: Type::POINT)]
     private Point $manufacturingLocation;
 
-    #[ORM\Column(type: 'numrange')]
+    #[ORM\Column(type: Type::NUMRANGE)]
     private NumericRange $priceRange;
 
-    #[ORM\Column(type: 'daterange')]
+    #[ORM\Column(type: Type::DATERANGE)]
     private DateRange $availabilityPeriod;
 
-    #[ORM\Column(type: 'inet')]
+    #[ORM\Column(type: Type::INET)]
     private string $originServerIp;
 
-    #[ORM\Column(type: 'ltree')]
+    #[ORM\Column(type: Type::LTREE)]
     private Ltree $pathFromRoot;
 }
 ```
@@ -377,15 +378,17 @@ If you need to register types programmatically (e.g., in a bundle), you can do s
 namespace App\Service;
 
 use Doctrine\DBAL\Types\Type;
+use MartinGeorgiev\Doctrine\DBAL\Type;
+use MartinGeorgiev\Doctrine\DBAL\Types\Jsonb;
 use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
 
 #[Autoconfigure(lazy: true)]
 class DoctrineTypeRegistrar
 {
     public function registerTypes(): void
     {
-        if (!Type::hasType('jsonb')) {
-            Type::addType('jsonb', \MartinGeorgiev\Doctrine\DBAL\Types\Jsonb::class);
+        if (!Type::hasType(Type::JSONB)) {
+            Type::addType(Type::JSONB, Jsonb::class);
         }
 
         // Register other types as needed...

src/MartinGeorgiev/Doctrine/DBAL/Type.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\DBAL;
+
+final class Type
+{
+    // Array Types
+    public const BIGINT_ARRAY = 'bigint[]';
+
+    public const BOOL_ARRAY = 'bool[]';
+
+    public const CIDR_ARRAY = 'cidr[]';
+
+    public const DOUBLE_PRECISION_ARRAY = 'double precision[]';
+
+    public const GEOGRAPHY_ARRAY = 'geography[]';
+
+    public const GEOMETRY_ARRAY = 'geometry[]';
+
+    public const INET_ARRAY = 'inet[]';
+
+    public const INTEGER_ARRAY = 'integer[]';
+
+    public const JSONB_ARRAY = 'jsonb[]';
+
+    public const MACADDR_ARRAY = 'macaddr[]';
+
+    public const POINT_ARRAY = 'point[]';
+
+    public const REAL_ARRAY = 'real[]';
+
+    public const SMALLINT_ARRAY = 'smallint[]';
+
+    public const TEXT_ARRAY = 'text[]';
+
+    // Scalar Types
+    public const CIDR = 'cidr';
+
+    public const GEOGRAPHY = 'geography';
+
+    public const GEOMETRY = 'geometry';
+
+    public const INET = 'inet';
+
+    public const JSONB = 'jsonb';
+
+    public const LTREE = 'ltree';
+
+    public const MACADDR = 'macaddr';
+
+    public const POINT = 'point';
+
+    // Range Types
+    public const DATERANGE = 'daterange';
+
+    public const INT4RANGE = 'int4range';
+
+    public const INT8RANGE = 'int8range';
+
+    public const NUMRANGE = 'numrange';
+
+    public const TSRANGE = 'tsrange';
+
+    public const TSTZRANGE = 'tstzrange';
+
+    private function __construct()
+    {
+        // Prevent instantiation
+    }
+}

src/MartinGeorgiev/Doctrine/DBAL/Types/BigIntArray.php

@@ -4,6 +4,8 @@
 
 namespace MartinGeorgiev\Doctrine\DBAL\Types;
 
+use MartinGeorgiev\Doctrine\DBAL\Type;
+
 /**
  * Implementation of PostgreSQL BIGINT[] data type.
  *
@@ -17,7 +19,7 @@ class BigIntArray extends BaseIntegerArray
     /**
      * @var string
      */
-    protected const TYPE_NAME = 'bigint[]';
+    protected const TYPE_NAME = Type::BIGINT_ARRAY;
 
     protected function getMinValue(): int
     {

src/MartinGeorgiev/Doctrine/DBAL/Types/BooleanArray.php

@@ -5,6 +5,7 @@
 namespace MartinGeorgiev\Doctrine\DBAL\Types;
 
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use MartinGeorgiev\Doctrine\DBAL\Type;
 
 /**
  * Implementation of PostgreSQL BOOL[] data type.
@@ -19,7 +20,7 @@ class BooleanArray extends BaseArray
     /**
      * @var string
      */
-    protected const TYPE_NAME = 'bool[]';
+    protected const TYPE_NAME = Type::BOOL_ARRAY;
 
     public function convertToDatabaseValue($phpArray, AbstractPlatform $platform): ?string
     {

src/MartinGeorgiev/Doctrine/DBAL/Types/Cidr.php

@@ -5,6 +5,7 @@
 namespace MartinGeorgiev\Doctrine\DBAL\Types;
 
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use MartinGeorgiev\Doctrine\DBAL\Type;
 use MartinGeorgiev\Doctrine\DBAL\Types\Exceptions\InvalidCidrForDatabaseException;
 use MartinGeorgiev\Doctrine\DBAL\Types\Exceptions\InvalidCidrForPHPException;
 use MartinGeorgiev\Doctrine\DBAL\Types\Traits\CidrValidationTrait;
@@ -21,7 +22,7 @@ class Cidr extends BaseType
 {
     use CidrValidationTrait;
 
-    protected const TYPE_NAME = 'cidr';
+    protected const TYPE_NAME = Type::CIDR;
 
     public function convertToDatabaseValue($value, AbstractPlatform $platform): ?string
     {

src/MartinGeorgiev/Doctrine/DBAL/Types/CidrArray.php

@@ -4,6 +4,7 @@
 
 namespace MartinGeorgiev\Doctrine\DBAL\Types;
 
+use MartinGeorgiev\Doctrine\DBAL\Type;
 use MartinGeorgiev\Doctrine\DBAL\Types\Exceptions\InvalidCidrArrayItemForPHPException;
 use MartinGeorgiev\Doctrine\DBAL\Types\Traits\CidrValidationTrait;
 
@@ -19,7 +20,7 @@ class CidrArray extends BaseNetworkTypeArray
 {
     use CidrValidationTrait;
 
-    protected const TYPE_NAME = 'cidr[]';
+    protected const TYPE_NAME = Type::CIDR_ARRAY;
 
     protected function isValidNetworkAddress(string $value): bool
     {

src/MartinGeorgiev/Doctrine/DBAL/Types/DateRange.php

@@ -4,6 +4,7 @@
 
 namespace MartinGeorgiev\Doctrine\DBAL\Types;
 
+use MartinGeorgiev\Doctrine\DBAL\Type;
 use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\DateRange as DateRangeValueObject;
 use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\Range;
 
@@ -18,7 +19,7 @@
  */
 class DateRange extends BaseRangeType
 {
-    protected const TYPE_NAME = 'daterange';
+    protected const TYPE_NAME = Type::DATERANGE;
 
     protected function createFromString(string $value): Range
     {

src/MartinGeorgiev/Doctrine/DBAL/Types/DoublePrecisionArray.php

@@ -4,6 +4,8 @@
 
 namespace MartinGeorgiev\Doctrine\DBAL\Types;
 
+use MartinGeorgiev\Doctrine\DBAL\Type;
+
 /**
  * Implementation of PostgreSQL DOUBLE PRECISION[] data type.
  *
@@ -14,7 +16,7 @@
  */
 class DoublePrecisionArray extends BaseFloatArray
 {
-    protected const TYPE_NAME = 'double precision[]';
+    protected const TYPE_NAME = Type::DOUBLE_PRECISION_ARRAY;
 
     protected function getMinValue(): string
     {

src/MartinGeorgiev/Doctrine/DBAL/Types/Geography.php

@@ -5,6 +5,7 @@
 namespace MartinGeorgiev\Doctrine\DBAL\Types;
 
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use MartinGeorgiev\Doctrine\DBAL\Type;
 use MartinGeorgiev\Doctrine\DBAL\Types\Exceptions\InvalidGeographyForDatabaseException;
 use MartinGeorgiev\Doctrine\DBAL\Types\Exceptions\InvalidGeographyForPHPException;
 use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\Exceptions\InvalidWktSpatialDataException;
@@ -20,7 +21,7 @@
  */
 final class Geography extends BaseSpatialType
 {
-    protected const TYPE_NAME = 'geography';
+    protected const TYPE_NAME = Type::GEOGRAPHY;
 
     public function convertToDatabaseValue($value, AbstractPlatform $platform): ?string
     {