Updated order of mapping attribute parameters

doctrine · Oct 9, 2023 · a7b9e8f · a7b9e8f
1 parent f3b6c4b
commit a7b9e8f
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,10 @@
 # Upgrade to 3.0
 
+## Minor BC BREAK: Changed order of arguments passed to `OneToOne`, `ManyToOne` and `Index` mapping PHP attributes
+
+To keep PHP mapping attributes consistent, order of arguments passed to above attributes has been changed
+so `$targetEntity` is a first argument now. This change affects only non-named arguments usage.
+
 ## BC BREAK: `Doctrine\ORM\Proxy\ProxyFactory` no longer extends abstract factory from `doctrine/common`
 
 It is no longer possible to call methods, constants or properties inherited

diff --git a/lib/Doctrine/ORM/Mapping/Index.php b/lib/Doctrine/ORM/Mapping/Index.php
@@ -16,9 +16,9 @@ final class Index implements MappingAttribute
      * @param array<string,mixed>|null $options
      */
     public function __construct(
+        public readonly string|null $name = null,
         public readonly array|null $columns = null,
         public readonly array|null $fields = null,
-        public readonly string|null $name = null,
         public readonly array|null $flags = null,
         public readonly array|null $options = null,
     ) {

diff --git a/lib/Doctrine/ORM/Mapping/OneToMany.php b/lib/Doctrine/ORM/Mapping/OneToMany.php
@@ -15,8 +15,8 @@ final class OneToMany implements MappingAttribute
      * @psalm-param 'LAZY'|'EAGER'|'EXTRA_LAZY' $fetch
      */
     public function __construct(
-        public readonly string|null $mappedBy = null,
         public readonly string|null $targetEntity = null,
+        public readonly string|null $mappedBy = null,
         public readonly array|null $cascade = null,
         public readonly string $fetch = 'LAZY',
         public readonly bool $orphanRemoval = false,

diff --git a/lib/Doctrine/ORM/Mapping/OneToOne.php b/lib/Doctrine/ORM/Mapping/OneToOne.php
@@ -15,9 +15,9 @@ final class OneToOne implements MappingAttribute
      * @psalm-param 'LAZY'|'EAGER'|'EXTRA_LAZY' $fetch
      */
     public function __construct(
+        public readonly string|null $targetEntity = null,
         public readonly string|null $mappedBy = null,
         public readonly string|null $inversedBy = null,
-        public readonly string|null $targetEntity = null,
         public readonly array|null $cascade = null,
         public readonly string $fetch = 'LAZY',
         public readonly bool $orphanRemoval = false,