Added comment support for Doctrine's custom typess

Author: benatespina

CHANGELOG.md

@@ -5,6 +5,8 @@ This changelog references the relevant changes done between versions.
 To get the diff for a specific change, go to https://github.com/LIN3S/SharedKernel/commit/XXX where XXX is the change hash 
 To get the diff between two versions, go to https://github.com/LIN3S/SharedKernel/compare/v0.7.0...v0.8.0
 
+* 0.9.2
+    * Added comment support for Doctrine's custom types.
 * 0.9.1
     * Fixed typo in the Doctrine's mappings in the standalone way.
 * 0.9.0

src/LIN3S/SharedKernel/Infrastructure/Persistence/Doctrine/DBAL/Domain/Model/Iban/Types/IbanType.php

@@ -22,7 +22,7 @@
  */
 class IbanType extends TextType
 {
-    public function convertToDatabaseValue($value, AbstractPlatform $platform)
+    public function convertToDatabaseValue($value, AbstractPlatform $platform) : ?string
     {
         if ($value instanceof Iban) {
             return $value->iban();
@@ -31,7 +31,7 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
         return $value;
     }
 
-    public function convertToPHPValue($value, AbstractPlatform $platform)
+    public function convertToPHPValue($value, AbstractPlatform $platform) : ?Iban
     {
         if (null === $value) {
             return;
@@ -40,6 +40,11 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         return Iban::from($value);
     }
 
+    public function requiresSQLCommentHint(AbstractPlatform $platform) : bool
+    {
+        return true;
+    }
+
     public function getName()
     {
         return 'iban';

src/LIN3S/SharedKernel/Infrastructure/Persistence/Doctrine/DBAL/Domain/Model/Phone/Types/PhoneType.php

@@ -22,7 +22,7 @@
  */
 class PhoneType extends TextType
 {
-    public function convertToDatabaseValue($value, AbstractPlatform $platform)
+    public function convertToDatabaseValue($value, AbstractPlatform $platform) : ?string
     {
         if ($value instanceof Phone) {
             return $value->phone();
@@ -31,7 +31,7 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
         return $value;
     }
 
-    public function convertToPHPValue($value, AbstractPlatform $platform)
+    public function convertToPHPValue($value, AbstractPlatform $platform) : ?Phone
     {
         if (null === $value) {
             return;
@@ -40,7 +40,12 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         return Phone::fromInternatinal($value);
     }
 
-    public function getName()
+    public function requiresSQLCommentHint(AbstractPlatform $platform) : bool
+    {
+        return true;
+    }
+
+    public function getName() : string
     {
         return 'phone';
     }

src/LIN3S/SharedKernel/Infrastructure/Persistence/Doctrine/DBAL/Domain/Model/TaxIdNumber/Types/TaxIdNumberType.php

@@ -22,7 +22,7 @@
  */
 class TaxIdNumberType extends TextType
 {
-    public function convertToDatabaseValue($value, AbstractPlatform $platform)
+    public function convertToDatabaseValue($value, AbstractPlatform $platform) : ?string
     {
         if ($value instanceof TaxIdNumber) {
             return $value->number();
@@ -31,7 +31,7 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
         return $value;
     }
 
-    public function convertToPHPValue($value, AbstractPlatform $platform)
+    public function convertToPHPValue($value, AbstractPlatform $platform) : ?TaxIdNumber
     {
         if (null === $value) {
             return;
@@ -40,7 +40,12 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         return TaxIdNumber::fromSpain($value);
     }
 
-    public function getName()
+    public function requiresSQLCommentHint(AbstractPlatform $platform) : bool
+    {
+        return true;
+    }
+
+    public function getName() : string
     {
         return 'tax_id_number';
     }