Doctrine 3 Compatibility

README.md

@@ -7,7 +7,7 @@
 [![License](https://img.shields.io/packagist/l/laravel-doctrine/fluent.svg?style=flat-square)](https://packagist.org/packages/laravel-doctrine/fluent)
 [![Github actions](https://github.com/laravel-doctrine/fluent/workflows/CI/badge.svg?branch=1.x)](https://github.com/laravel-doctrine/fluent/actions?query=workflow%3ACI+branch%3A1.x)
 
-*A fluent mapping driver for Doctrine2*
+*A fluent mapping driver for Doctrine3*
 
 ```
 composer require laravel-doctrine/fluent

composer.json

@@ -23,9 +23,9 @@
     }
   ],
   "require": {
-    "php": "^7.2|^8.0",
+    "php": "^8.1",
     "doctrine/dbal": "^2.10|^3.3",
-    "doctrine/orm": "^2.6",
+    "doctrine/orm": "^3.1",
     "doctrine/inflector": "^1.4|^2.0",
     "doctrine/persistence": "^1.3.5|^2.0|^3.0"
   },

src/Builders/AbstractBuilder.php

@@ -6,6 +6,7 @@
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Mapping\DefaultNamingStrategy;
 use Doctrine\ORM\Mapping\NamingStrategy;
+use LaravelDoctrine\Fluent\Extensions\ExtensibleClassMetadata;
 
 abstract class AbstractBuilder
 {
@@ -38,7 +39,7 @@ public function getBuilder()
     }
 
     /**
-     * @return ClassMetadata
+     * @return ClassMetadata|ExtensibleClassMetadata
      */
     public function getClassMetadata()
     {

src/Builders/Entity.php

@@ -2,7 +2,7 @@
 
 namespace LaravelDoctrine\Fluent\Builders;
 
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use LaravelDoctrine\Fluent\Builders\Traits\Macroable;
 use LaravelDoctrine\Fluent\Builders\Traits\Queueable;
 use LaravelDoctrine\Fluent\Builders\Traits\QueuesMacros;
@@ -42,7 +42,7 @@ public function readOnly()
      * Depending on the cache mode selected, you may also need to configure
      * lock modes.
      *
-     * @param int         $usage  Cache mode. use ClassMetadataInfo::CACHE_USAGE_* constants.
+     * @param int         $usage  Cache mode. use ClassMetadata::CACHE_USAGE_* constants.
      *                            Defaults to READ_ONLY mode.
      * @param string|null $region The cache region to be used. Doctrine will use a default region
      *                            for each entity, if none is provided.
@@ -51,7 +51,7 @@ public function readOnly()
      *
      * @see http://doctrine-orm.readthedocs.org/en/latest/reference/second-level-cache.html
      */
-    public function cacheable($usage = ClassMetadataInfo::CACHE_USAGE_READ_ONLY, $region = null)
+    public function cacheable($usage = ClassMetadata::CACHE_USAGE_READ_ONLY, $region = null)
     {
         $meta = $this->builder->getClassMetadata();
         $meta->enableCache(compact('usage', $region === null ? [] : 'region'));

src/Builders/Field.php

@@ -6,8 +6,7 @@
 use Doctrine\DBAL\Types\Type;
 use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
 use Doctrine\ORM\Mapping\Builder\FieldBuilder;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
-use Doctrine\Persistence\Mapping\ClassMetadata;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use LaravelDoctrine\Fluent\Buildable;
 use LaravelDoctrine\Fluent\Builders\Traits\Macroable;
 use LaravelDoctrine\Fluent\Builders\Traits\Queueable;
@@ -58,7 +57,7 @@ class Field implements Buildable
     protected $metaDatabuilder;
 
     /**
-     * @var ClassMetadataInfo
+     * @var ClassMetadata|ExtensibleClassMetadata
      */
     protected $classMetadata;
 
@@ -94,7 +93,7 @@ protected function __construct(FieldBuilder $fieldBuilder, ClassMetadataBuilder
      * @param string               $type
      * @param string               $name
      *
-     * @throws \Doctrine\DBAL\DBALException
+     * @throws \Doctrine\DBAL\Exception
      *
      * @return Field
      */

src/Builders/GeneratedValue.php

@@ -3,7 +3,7 @@
 namespace LaravelDoctrine\Fluent\Builders;
 
 use Doctrine\ORM\Mapping\Builder\FieldBuilder;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use LaravelDoctrine\Fluent\Buildable;
 
 class GeneratedValue implements Buildable
@@ -39,15 +39,15 @@ class GeneratedValue implements Buildable
     protected $generator;
 
     /**
-     * @var ClassMetadataInfo
+     * @var ClassMetadata
      */
     protected $classMetadata;
 
     /**
-     * @param FieldBuilder      $builder
-     * @param ClassMetadataInfo $classMetadata
+     * @param FieldBuilder  $builder
+     * @param ClassMetadata $classMetadata
      */
-    public function __construct(FieldBuilder $builder, ClassMetadataInfo $classMetadata)
+    public function __construct(FieldBuilder $builder, ClassMetadata $classMetadata)
     {
         $this->builder = $builder;
         $this->classMetadata = $classMetadata;

src/Builders/Inheritance/Inheritance.php

@@ -2,7 +2,7 @@
 
 namespace LaravelDoctrine\Fluent\Builders\Inheritance;
 
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata;
 
 interface Inheritance
 {
@@ -12,15 +12,15 @@ interface Inheritance
      * @link http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/inheritance-mapping.html#single-table-inheritance
      *       Doctine documentation
      */
-    const SINGLE = ClassMetadataInfo::INHERITANCE_TYPE_SINGLE_TABLE;
+    const SINGLE = ClassMetadata::INHERITANCE_TYPE_SINGLE_TABLE;
 
     /**
      * Set inheritance to joined table mode.
      *
      * @link http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/inheritance-mapping.html#class-table-inheritance
      *       Doctine documentation
      */
-    const JOINED = ClassMetadataInfo::INHERITANCE_TYPE_JOINED;
+    const JOINED = ClassMetadata::INHERITANCE_TYPE_JOINED;
 
     /**
      * Add the discriminator column.

src/Builders/Overrides/AssociationOverride.php

@@ -3,10 +3,11 @@
 namespace LaravelDoctrine\Fluent\Builders\Overrides;
 
 use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Mapping\NamingStrategy;
 use InvalidArgumentException;
 use LaravelDoctrine\Fluent\Buildable;
+use LaravelDoctrine\Fluent\Relations\AssociationCache;
 use LaravelDoctrine\Fluent\Relations\ManyToMany;
 use LaravelDoctrine\Fluent\Relations\ManyToOne;
 use LaravelDoctrine\Fluent\Relations\Relation;
@@ -37,8 +38,8 @@ class AssociationOverride implements Buildable
      * @var array
      */
     protected $relations = [
-        ClassMetadataInfo::MANY_TO_ONE  => ManyToOne::class,
-        ClassMetadataInfo::MANY_TO_MANY => ManyToMany::class,
+        ClassMetadata::MANY_TO_ONE  => ManyToOne::class,
+        ClassMetadata::MANY_TO_MANY => ManyToMany::class,
     ];
 
     /**
@@ -95,7 +96,9 @@ public function build()
             throw new InvalidArgumentException('The callback should return an instance of '.Relation::class);
         }
 
-        $association->build();
+        $association instanceof AssociationCache ?
+            $association->build($source['targetEntity']) :
+            $association->build();
 
         $target = $this->convertToMappingArray($builder);
 
@@ -104,8 +107,8 @@ public function build()
         // ManyToMany mappings
         if ($this->hasJoinTable($target)) {
             $overrideMapping['joinTable'] = $this->mapJoinTable(
-                $target['joinTable'],
-                $source['joinTable']
+                (array) $target['joinTable'],
+                (array) $source['joinTable']
             );
         }
 
@@ -134,7 +137,10 @@ protected function convertToMappingArray(ClassMetadataBuilder $builder)
     {
         $metadata = $builder->getClassMetadata();
 
-        return $metadata->getAssociationMapping($this->name);
+        $associationMappingArray = (array) $metadata->getAssociationMapping($this->name);
+        $associationMappingArray['type'] = $metadata->getAssociationMapping($this->name)->type();
+
+        return $associationMappingArray;
     }
 
     /**
@@ -143,7 +149,7 @@ protected function convertToMappingArray(ClassMetadataBuilder $builder)
     protected function newClassMetadataBuilder()
     {
         return new ClassMetadataBuilder(
-            new ClassMetadataInfo($this->builder->getClassMetadata()->name)
+            new ClassMetadata($this->builder->getClassMetadata()->name)
         );
     }
 
@@ -205,7 +211,7 @@ protected function mapJoinColumns(array $target = [], array $source = [])
         $joinColumns = [];
         foreach ($target as $index => $joinColumn) {
             if (isset($source[$index])) {
-                $diff = array_diff($joinColumn, $source[$index]);
+                $diff = array_diff((array) $joinColumn, (array) $source[$index]);
 
                 if (!empty($diff)) {
                     $joinColumns[] = $diff;

src/Builders/Overrides/AttributeOverride.php

@@ -3,7 +3,7 @@
 namespace LaravelDoctrine\Fluent\Builders\Overrides;
 
 use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Mapping\NamingStrategy;
 use InvalidArgumentException;
 use LaravelDoctrine\Fluent\Buildable;
@@ -116,7 +116,7 @@ protected function convertToMappingArray(ClassMetadataBuilder $builder)
     {
         $metadata = $builder->getClassMetadata();
 
-        return $metadata->getFieldMapping($this->name);
+        return (array) $metadata->getFieldMapping($this->name);
     }
 
     /**
@@ -125,7 +125,7 @@ protected function convertToMappingArray(ClassMetadataBuilder $builder)
     protected function newClassMetadataBuilder()
     {
         return new ClassMetadataBuilder(
-            new ClassMetadataInfo($this->builder->getClassMetadata()->name)
+            new ClassMetadata($this->builder->getClassMetadata()->name)
         );
     }
 

src/Builders/Table.php

@@ -39,7 +39,7 @@ public function __construct(ClassMetadataBuilder $builder, $name = null)
      */
     public function setName($name)
     {
-        $this->builder->setTable($name);
+        $this->getClassMetadata()->setPrimaryTable(['name' => $name]);
 
         return $this;
     }

src/Builders/Traits/Queueable.php

@@ -4,6 +4,7 @@
 
 use LaravelDoctrine\Fluent\Buildable;
 use LaravelDoctrine\Fluent\Builders\Delay;
+use LaravelDoctrine\Fluent\Relations\AssociationCache;
 
 trait Queueable
 {
@@ -43,7 +44,9 @@ public function build()
             if ($buildable instanceof Delay) {
                 $delayed[] = $buildable;
             } else {
-                $buildable->build();
+                $buildable instanceof AssociationCache ?
+                    $buildable->build($this->entity) :
+                    $buildable->build();
             }
         }
 

src/Extensions/ExtensibleClassMetadataFactory.php

@@ -7,17 +7,12 @@
 
 class ExtensibleClassMetadataFactory extends ClassMetadataFactory
 {
-    /**
-     * @var EntityManagerInterface
-     */
-    protected $entityManager;
+    protected EntityManagerInterface $entityManager;
 
     /**
      * Override to hold a reference to the EntityManager here as well (parent property is private).
-     *
-     * {@inheritdoc}
      */
-    public function setEntityManager(EntityManagerInterface $em)
+    public function setEntityManager(EntityManagerInterface $em): void
     {
         parent::setEntityManager($em);
 
@@ -26,10 +21,8 @@ public function setEntityManager(EntityManagerInterface $em)
 
     /**
      * Override to implement our custom ClassMetadata object.
-     *
-     * {@inheritdoc}
      */
-    protected function newClassMetadataInstance($className)
+    protected function newClassMetadataInstance(string $className): ExtensibleClassMetadata
     {
         return new ExtensibleClassMetadata($className, $this->entityManager->getConfiguration()->getNamingStrategy());
     }

src/Extensions/Gedmo/Sluggable.php

@@ -2,7 +2,7 @@
 
 namespace LaravelDoctrine\Fluent\Extensions\Gedmo;
 
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Gedmo\Exception\InvalidArgumentException;
 use Gedmo\Sluggable\Mapping\Driver\Fluent as FluentDriver;
 use LaravelDoctrine\Fluent\Buildable;
@@ -257,14 +257,14 @@ public function suffix($suffix)
     /**
      * Checks if $field type is valid as Sluggable field.
      *
-     * @param ClassMetadataInfo $meta
-     * @param string            $field
+     * @param ClassMetadata $meta
+     * @param string        $field
      *
      * @throws InvalidArgumentException
      *
      * @return bool
      */
-    protected function isValidField(ClassMetadataInfo $meta, $field)
+    protected function isValidField(ClassMetadata $meta, $field)
     {
         $mapping = $meta->getFieldMapping($field);
 

src/Extensions/Gedmo/TreeStrategy.php

@@ -2,6 +2,7 @@
 
 namespace LaravelDoctrine\Fluent\Extensions\Gedmo;
 
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Gedmo\Exception\InvalidMappingException;
 use Gedmo\Tree\Mapping\Driver\Fluent as FluentDriver;
 use LaravelDoctrine\Fluent\Buildable;
@@ -142,7 +143,7 @@ protected function addSelfReferencingRelation($field, ?callable $callback = null
     }
 
     /**
-     * @return ExtensibleClassMetadata
+     * @return ExtensibleClassMetadata|ClassMetadata
      */
     protected function getClassMetadata()
     {

src/FluentDriver.php

@@ -3,6 +3,7 @@
 namespace LaravelDoctrine\Fluent;
 
 use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
+use Doctrine\ORM\Mapping\ClassMetadata as ORMClassMetadata;
 use Doctrine\ORM\Mapping\MappingException;
 use Doctrine\ORM\Mapping\NamingStrategy;
 use Doctrine\Persistence\Mapping\ClassMetadata;
@@ -34,7 +35,7 @@ public function __construct(
         array $mappings = [],
         ?NamingStrategy $namingStrategy = null
     ) {
-        $this->fluentFactory = function (ClassMetadata $metadata) use ($namingStrategy) {
+        $this->fluentFactory = function (ORMClassMetadata $metadata) use ($namingStrategy) {
             return new Builder(new ClassMetadataBuilder($metadata), $namingStrategy);
         };