[PropertyInfo] Support Doctrine custom mapping type in DoctrineExtractor

Also use Doctrine\DBAL\Types\Type class constants

Author: teohhanhui

PropertyInfo/DoctrineExtractor.php

@@ -13,6 +13,7 @@
 
 use Doctrine\Common\Persistence\Mapping\ClassMetadataFactory;
 use Doctrine\Common\Persistence\Mapping\MappingException;
+use Doctrine\DBAL\Types\Type as DBALType;
 use Doctrine\ORM\Mapping\ClassMetadataInfo;
 use Doctrine\ORM\Mapping\MappingException as OrmMappingException;
 use Symfony\Component\PropertyInfo\PropertyListExtractorInterface;
@@ -93,23 +94,26 @@ public function getTypes($class, $property, array $context = array())
             $nullable = $metadata instanceof ClassMetadataInfo && $metadata->isNullable($property);
 
             switch ($typeOfField) {
-                case 'date':
-                case 'datetime':
-                case 'datetimetz':
-                case 'time':
+                case DBALType::DATE:
+                case DBALType::DATETIME:
+                case DBALType::DATETIMETZ:
+                case 'vardatetime':
+                case DBALType::TIME:
                     return array(new Type(Type::BUILTIN_TYPE_OBJECT, $nullable, 'DateTime'));
 
-                case 'array':
+                case DBALType::TARRAY:
                     return array(new Type(Type::BUILTIN_TYPE_ARRAY, $nullable, null, true));
 
-                case 'simple_array':
+                case DBALType::SIMPLE_ARRAY:
                     return array(new Type(Type::BUILTIN_TYPE_ARRAY, $nullable, null, true, new Type(Type::BUILTIN_TYPE_INT), new Type(Type::BUILTIN_TYPE_STRING)));
 
-                case 'json_array':
+                case DBALType::JSON_ARRAY:
                     return array(new Type(Type::BUILTIN_TYPE_ARRAY, $nullable, null, true));
 
                 default:
-                    return array(new Type($this->getPhpType($typeOfField), $nullable));
+                    $builtinType = $this->getPhpType($typeOfField);
+
+                    return $builtinType ? array(new Type($builtinType, $nullable)) : null;
             }
         }
     }
@@ -119,36 +123,37 @@ public function getTypes($class, $property, array $context = array())
      *
      * @param string $doctrineType
      *
-     * @return string
+     * @return string|null
      */
     private function getPhpType($doctrineType)
     {
         switch ($doctrineType) {
-            case 'smallint':
-                // No break
-            case 'bigint':
-                // No break
-            case 'integer':
+            case DBALType::SMALLINT:
+            case DBALType::BIGINT:
+            case DBALType::INTEGER:
                 return Type::BUILTIN_TYPE_INT;
 
-            case 'decimal':
+            case DBALType::FLOAT:
+            case DBALType::DECIMAL:
                 return Type::BUILTIN_TYPE_FLOAT;
 
-            case 'text':
-                // No break
-            case 'guid':
+            case DBALType::STRING:
+            case DBALType::TEXT:
+            case DBALType::GUID:
                 return Type::BUILTIN_TYPE_STRING;
 
-            case 'boolean':
+            case DBALType::BOOLEAN:
                 return Type::BUILTIN_TYPE_BOOL;
 
-            case 'blob':
-                // No break
+            case DBALType::BLOB:
             case 'binary':
                 return Type::BUILTIN_TYPE_RESOURCE;
 
+            case DBALType::OBJECT:
+                return Type::BUILTIN_TYPE_OBJECT;
+
             default:
-                return $doctrineType;
+                return;
         }
     }
 }

Tests/PropertyInfo/DoctrineExtractorTest.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Bridge\Doctrine\PropertyInfo\Tests;
 
+use Doctrine\DBAL\Types\Type as DBALType;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Tools\Setup;
 use Symfony\Bridge\Doctrine\PropertyInfo\DoctrineExtractor;
@@ -31,6 +32,11 @@ protected function setUp()
         $config = Setup::createAnnotationMetadataConfiguration(array(__DIR__.DIRECTORY_SEPARATOR.'Fixtures'), true);
         $entityManager = EntityManager::create(array('driver' => 'pdo_sqlite'), $config);
 
+        if (!DBALType::hasType('foo')) {
+            DBALType::addType('foo', 'Symfony\Bridge\Doctrine\Tests\PropertyInfo\Fixtures\DoctrineFooType');
+            $entityManager->getConnection()->getDatabasePlatform()->registerDoctrineTypeMapping('custom_foo', 'foo');
+        }
+
         $this->extractor = new DoctrineExtractor($entityManager->getMetadataFactory());
     }
 
@@ -45,6 +51,7 @@ public function testGetProperties()
                 'simpleArray',
                 'bool',
                 'binary',
+                'customFoo',
                 'foo',
                 'bar',
             ),
@@ -78,6 +85,7 @@ public function typesProvider()
                 new Type(Type::BUILTIN_TYPE_OBJECT, false, 'Symfony\Bridge\Doctrine\Tests\PropertyInfo\Fixtures\DoctrineRelation')
             ))),
             array('simpleArray', array(new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, new Type(Type::BUILTIN_TYPE_INT), new Type(Type::BUILTIN_TYPE_STRING)))),
+            array('customFoo', null),
             array('notMapped', null),
         );
     }

Tests/PropertyInfo/Fixtures/DoctrineDummy.php

@@ -70,5 +70,10 @@ class DoctrineDummy
      */
     private $binary;
 
+    /**
+     * @Column(type="custom_foo")
+     */
+    private $customFoo;
+
     public $notMapped;
 }

Tests/PropertyInfo/Fixtures/DoctrineFooType.php

@@ -0,0 +1,84 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Doctrine\Tests\PropertyInfo\Fixtures;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\ConversionException;
+use Doctrine\DBAL\Types\Type;
+
+/**
+ * @author Teoh Han Hui <[email protected]>
+ */
+class DoctrineFooType extends Type
+{
+    /**
+     * Type name.
+     */
+    const NAME = 'foo';
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return self::NAME;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
+    {
+        return $platform->getClobTypeDeclarationSQL(array());
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function convertToDatabaseValue($value, AbstractPlatform $platform)
+    {
+        if (null === $value) {
+            return;
+        }
+        if (!$value instanceof Foo) {
+            throw new ConversionException(sprintf('Expected %s, got %s', 'Symfony\Bridge\Doctrine\Tests\PropertyInfo\Fixtures\Foo', gettype($value)));
+        }
+
+        return $foo->bar;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function convertToPHPValue($value, AbstractPlatform $platform)
+    {
+        if (null === $value) {
+            return;
+        }
+        if (!is_string($value)) {
+            throw ConversionException::conversionFailed($value, self::NAME);
+        }
+
+        $foo = new Foo();
+        $foo->bar = $value;
+
+        return $foo;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function requiresSQLCommentHint(AbstractPlatform $platform)
+    {
+        return true;
+    }
+}

Tests/PropertyInfo/Fixtures/Foo.php

@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Doctrine\Tests\PropertyInfo\Fixtures;
+
+/**
+ * @author Teoh Han Hui <[email protected]>
+ */
+class Foo
+{
+    /**
+     * @var string
+     */
+    public $bar;
+}