Merge branch '2.15.x' into 3.0.x

derrabus · derrabus · commit 9b1f397ab23b · 2023-01-09T11:47:02.000+07:00
* 2.15.x: Use more precise types for class strings (doctrine#10381) PHPStan 1.9.8, Psalm 5.4.0 (doctrine#10382) fix typo for missing a comma (doctrine#10377) Docs: Removing `type: 'integer'` from mappings (doctrine#10368) Docs: Moving *attributes* mapping to first position (doctrine#10364) Docs: Deleting duplicate mapping example (doctrine#10363)
diff --git a/composer.json b/composer.json
@@ -38,13 +38,13 @@
     "require-dev": {
         "doctrine/coding-standard": "^11.0",
         "phpbench/phpbench": "^1.0 || dev-master",
-        "phpstan/phpstan": "1.9.5",
+        "phpstan/phpstan": "1.9.8",
         "phpunit/phpunit": "^9.5.28@dev",
         "psr/log": "^1 || ^2 || ^3",
         "squizlabs/php_codesniffer": "3.7.1",
         "symfony/cache": "^5.4 || ^6.0",
         "symfony/var-exporter": "^5.4 || ^6.2",
-        "vimeo/psalm": "5.3.0"
+        "vimeo/psalm": "5.4.0"
     },
     "suggest": {
         "ext-dom": "Provides support for XSD validation for XML mapping files",
diff --git a/docs/en/tutorials/composite-primary-keys.rst b/docs/en/tutorials/composite-primary-keys.rst
@@ -32,9 +32,9 @@ and year of production as primary keys:
         class Car
         {
             public function __construct(
-                #[Id, Column(type: 'string')]
+                #[Id, Column]
                 private string $name,
-                #[Id, Column(type: 'integer')]
+                #[Id, Column]
                 private int $year,
             ) {
             }
@@ -89,7 +89,7 @@ And for querying you can use arrays to both DQL and EntityRepositories:
 
     $dql = "SELECT c FROM VehicleCatalogue\Model\Car c WHERE c.id = ?1";
     $audi = $em->createQuery($dql)
-               ->setParameter(1, array("name" => "Audi A8", "year" => 2010))
+               ->setParameter(1, ["name" => "Audi A8", "year" => 2010])
                ->getSingleResult();
 
 You can also use this entity in associations. Doctrine will then generate two foreign keys one for ``name``
@@ -126,95 +126,95 @@ We keep up the example of an Article with arbitrary attributes, the mapping look
 
 .. configuration-block::
 
-    .. code-block:: php
+    .. code-block:: attribute
 
         <?php
         namespace Application\Model;
 
         use Doctrine\Common\Collections\ArrayCollection;
 
-        /**
-         * @Entity
-         */
+        #[Entity]
         class Article
         {
-            /** @Id @Column(type="integer") @GeneratedValue */
+            #[Id, Column, GeneratedValue]
             private int|null $id = null;
-            /** @Column(type="string") */
+            #[Column]
             private string $title;
 
-            /**
-             * @OneToMany(targetEntity="ArticleAttribute", mappedBy="article", cascade={"ALL"}, indexBy="attribute")
-             * @var Collection<int, ArticleAttribute>
-             */
+            /** @var ArrayCollection<string, ArticleAttribute> */
+            #[OneToMany(targetEntity: ArticleAttribute::class, mappedBy: 'article', cascade: ['ALL'], indexBy: 'attribute')]
             private Collection $attributes;
 
-            public function addAttribute($name, $value): void
+            public function addAttribute(string $name, ArticleAttribute $value): void
             {
                 $this->attributes[$name] = new ArticleAttribute($name, $value, $this);
             }
         }
 
-        /**
-         * @Entity
-         */
+        #[Entity]
         class ArticleAttribute
         {
-            /** @Id @ManyToOne(targetEntity="Article", inversedBy="attributes") */
-            private Article|null $article;
+            #[Id, ManyToOne(targetEntity: Article::class, inversedBy: 'attributes')]
+            private Article $article;
 
-            /** @Id @Column(type="string") */
+            #[Id, Column]
             private string $attribute;
 
-            /** @Column(type="string") */
+            #[Column]
             private string $value;
 
-            public function __construct($name, $value, $article)
+            public function __construct(string $name, string $value, Article $article)
             {
                 $this->attribute = $name;
                 $this->value = $value;
                 $this->article = $article;
             }
         }
 
-    .. code-block:: attribute
+    .. code-block:: annotation
 
         <?php
         namespace Application\Model;
 
         use Doctrine\Common\Collections\ArrayCollection;
 
-        #[Entity]
+        /**
+         * @Entity
+         */
         class Article
         {
-            #[Id, Column(type: 'integer'), GeneratedValue]
+            /** @Id @Column(type="integer") @GeneratedValue */
             private int|null $id = null;
-            #[Column(type: 'string')]
+            /** @Column(type="string") */
             private string $title;
 
-            /** @var ArrayCollection<string, ArticleAttribute> */
-            #[OneToMany(targetEntity: ArticleAttribute::class, mappedBy: 'article', cascade: ['ALL'], indexBy: 'attribute')]
+            /**
+             * @OneToMany(targetEntity="ArticleAttribute", mappedBy="article", cascade={"ALL"}, indexBy="attribute")
+             * @var Collection<int, ArticleAttribute>
+             */
             private Collection $attributes;
 
-            public function addAttribute(string $name, ArticleAttribute $value): void
+            public function addAttribute($name, $value): void
             {
                 $this->attributes[$name] = new ArticleAttribute($name, $value, $this);
             }
         }
 
-        #[Entity]
+        /**
+         * @Entity
+         */
         class ArticleAttribute
         {
-            #[Id, ManyToOne(targetEntity: Article::class, inversedBy: 'attributes')]
-            private Article $article;
+            /** @Id @ManyToOne(targetEntity="Article", inversedBy="attributes") */
+            private Article|null $article;
 
-            #[Id, Column(type: 'string')]
+            /** @Id @Column(type="string") */
             private string $attribute;
 
-            #[Column(type: 'string')]
+            /** @Column(type="string") */
             private string $value;
 
-            public function __construct(string $name, string $value, Article $article)
+            public function __construct($name, $value, $article)
             {
                 $this->attribute = $name;
                 $this->value = $value;
@@ -256,7 +256,7 @@ One good example for this is a user-address relationship:
         #[Entity]
         class User
         {
-            #[Id, Column(type: 'integer'), GeneratedValue]
+            #[Id, Column, GeneratedValue]
             private int|null $id = null;
         }
 
@@ -284,18 +284,18 @@ of products purchased and maybe even the current price.
     #[Entity]
     class Order
     {
-        #[Id, Column(type: 'integer'), GeneratedValue]
+        #[Id, Column, GeneratedValue]
         private int|null $id = null;
 
         /** @var ArrayCollection<int, OrderItem> */
         #[OneToMany(targetEntity: OrderItem::class, mappedBy: 'order')]
         private Collection $items;
 
-        #[Column(type: 'boolean')]
+        #[Column]
         private bool $paid = false;
-        #[Column(type: 'boolean')]
+        #[Column]
         private bool $shipped = false;
-        #[Column(type: 'datetime')]
+        #[Column]
         private DateTime $created;
 
         public function __construct(
@@ -310,16 +310,16 @@ of products purchased and maybe even the current price.
     #[Entity]
     class Product
     {
-        #[Id, Column(type: 'integer'), GeneratedValue]
+        #[Id, Column, GeneratedValue]
         private int|null $id = null;
 
-        #[Column(type: 'string')]
+        #[Column]
         private string $name;
 
-        #[Column(type: 'decimal')]
-        private float $currentPrice;
+        #[Column]
+        private int $currentPrice;
 
-        public function getCurrentPrice(): float
+        public function getCurrentPrice(): int
         {
             return $this->currentPrice;
         }
@@ -334,11 +334,11 @@ of products purchased and maybe even the current price.
         #[Id, ManyToOne(targetEntity: Product::class)]
         private Product|null $product = null;
 
-        #[Column(type: 'integer')]
+        #[Column]
         private int $amount = 1;
 
-        #[Column(type: 'decimal')]
-        private float $offeredPrice;
+        #[Column]
+        private int $offeredPrice;
 
         public function __construct(Order $order, Product $product, int $amount = 1)
         {
diff --git a/lib/Doctrine/ORM/Events.php b/lib/Doctrine/ORM/Events.php
@@ -73,7 +73,7 @@ private function __construct()
      * has been applied to it.
      *
      * Note that the postLoad event occurs for an entity before any associations have been
-     * initialized. Therefore it is not safe to access associations in a postLoad callback
+     * initialized. Therefore, it is not safe to access associations in a postLoad callback
      * or event handler.
      *
      * This is an entity lifecycle event.
diff --git a/lib/Doctrine/ORM/Mapping/MappingException.php b/lib/Doctrine/ORM/Mapping/MappingException.php
@@ -27,7 +27,7 @@
 class MappingException extends Exception implements ORMException
 {
     /**
-     * @param string $entityName
+     * @param class-string $entityName
      *
      * @return MappingException
      */
@@ -330,7 +330,7 @@ public static function joinColumnMustPointToMappedField($className, $joinColumn)
     }
 
     /**
-     * @param string $className
+     * @param class-string $className
      *
      * @return MappingException
      */
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="5.3.0@b6faa3e96b8eb50ec71384c53799b8a107236bb6">
+<files psalm-version="5.4.0@62db5d4f6a7ae0a20f7cc5a4952d730272fc0863">
   <file src="lib/Doctrine/ORM/AbstractQuery.php">
     <FalsableReturnStatement occurrences="1">
       <code>! $filteredParameters-&gt;isEmpty() ? $filteredParameters-&gt;first() : null</code>
@@ -624,10 +624,6 @@
     </TypeDoesNotContainType>
   </file>
   <file src="lib/Doctrine/ORM/Mapping/MappingException.php">
-    <ArgumentTypeCoercion occurrences="2">
-      <code>$className</code>
-      <code>$entityName</code>
-    </ArgumentTypeCoercion>
     <MissingParamType occurrences="4">
       <code>$className</code>
       <code>$className</code>
@@ -1622,9 +1618,6 @@
       <code>$collectionToDelete</code>
       <code>$collectionToUpdate</code>
     </InvalidArgument>
-    <InvalidArrayOffset occurrences="1">
-      <code>$commitOrder[$i]</code>
-    </InvalidArrayOffset>
     <InvalidPropertyAssignmentValue occurrences="2">
       <code>$this-&gt;entityChangeSets</code>
       <code>$this-&gt;entityChangeSets</code>

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ private function __construct()`
`73`	`73`	`* has been applied to it.`
`74`	`74`	`*`
`75`	`75`	`* Note that the postLoad event occurs for an entity before any associations have been`
`76`		`- * initialized. Therefore it is not safe to access associations in a postLoad callback`
	`76`	`+ * initialized. Therefore, it is not safe to access associations in a postLoad callback`
`77`	`77`	`* or event handler.`
`78`	`78`	`*`
`79`	`79`	`* This is an entity lifecycle event.`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`class MappingException extends Exception implements ORMException`
`28`	`28`	`{`
`29`	`29`	`/**`
`30`		`- * @param string $entityName`
	`30`	`+ * @param class-string $entityName`
`31`	`31`	`*`
`32`	`32`	`* @return MappingException`
`33`	`33`	`*/`
`@@ -330,7 +330,7 @@ public static function joinColumnMustPointToMappedField($className, $joinColumn)`
`330`	`330`	`}`
`331`	`331`
`332`	`332`	`/**`
`333`		`- * @param string $className`
	`333`	`+ * @param class-string $className`
`334`	`334`	`*`
`335`	`335`	`* @return MappingException`
`336`	`336`	`*/`