feature #1040 [make:entity] Change getter PHPDoc return type on Collection (mehdibo)

weaverryan · weaverryan · commit 93057dd6b6a1 · 2022-02-15T19:14:09.000-05:00
This PR was squashed before being merged into the 1.0-dev branch. Discussion ---------- [make:entity] Change getter PHPDoc return type on Collection Improves #979 Commits ------- 64b0799 [make:entity] Change getter PHPDoc return type on Collection
diff --git a/src/Util/ClassSourceManipulator.php b/src/Util/ClassSourceManipulator.php
@@ -682,7 +682,7 @@ private function addCollectionRelation(BaseCollectionRelation $relation): void
             $collectionTypeHint,
             false,
             // add @return that advertises this as a collection of specific objects
-            [sprintf('@return %s|%s[]', $collectionTypeHint, $typeHint)]
+            [sprintf('@return %s<int, %s>', $collectionTypeHint, $typeHint)]
         );
 
         $argName = Str::pluralCamelCaseToSingular($relation->getPropertyName());
diff --git a/tests/Doctrine/fixtures/expected_no_overwrite/src/Entity/Client.php b/tests/Doctrine/fixtures/expected_no_overwrite/src/Entity/Client.php
@@ -61,7 +61,7 @@ public function setApiKey(string $apiKey): self
     }
 
     /**
-     * @return Collection|Tag[]
+     * @return Collection<int, Tag>
      */
     public function getTags(): Collection
     {
diff --git a/tests/Doctrine/fixtures/expected_no_overwrite/src/Entity/User.php b/tests/Doctrine/fixtures/expected_no_overwrite/src/Entity/User.php
@@ -56,7 +56,7 @@ public function setUserProfile(?UserProfile $userProfile)
     }
 
     /**
-     * @return Collection|UserAvatar[]
+     * @return Collection<int, UserAvatar>
      */
     public function getAvatars(): Collection
     {
@@ -91,7 +91,7 @@ public function getUserProfile(): ?UserProfile
     }
 
     /**
-     * @return Collection|Tag[]
+     * @return Collection<int, Tag>
      */
     public function getTags(): Collection
     {
diff --git a/tests/Doctrine/fixtures/expected_overwrite/src/Entity/Client.php b/tests/Doctrine/fixtures/expected_overwrite/src/Entity/Client.php
@@ -61,7 +61,7 @@ public function setApiKey(string $apiKey): self
     }
 
     /**
-     * @return Collection|Tag[]
+     * @return Collection<int, Tag>
      */
     public function getTags(): Collection
     {
diff --git a/tests/Doctrine/fixtures/expected_overwrite/src/Entity/User.php b/tests/Doctrine/fixtures/expected_overwrite/src/Entity/User.php
@@ -67,7 +67,7 @@ public function setUserProfile(?UserProfile $userProfile): self
     }
 
     /**
-     * @return Collection|UserAvatar[]
+     * @return Collection<int, UserAvatar>
      */
     public function getAvatars(): Collection
     {
@@ -102,7 +102,7 @@ public function getUserProfile(): ?UserProfile
     }
 
     /**
-     * @return Collection|Tag[]
+     * @return Collection<int, Tag>
      */
     public function getTags(): Collection
     {
diff --git a/tests/Doctrine/fixtures/expected_xml/src/Entity/UserXml.php b/tests/Doctrine/fixtures/expected_xml/src/Entity/UserXml.php
@@ -37,7 +37,7 @@ public function setName(string $name): self
     }
 
     /**
-     * @return Collection|UserAvatar[]
+     * @return Collection<int, UserAvatar>
      */
     public function getAvatars(): Collection
     {
diff --git a/tests/Util/fixtures/add_many_to_many_relation/User_simple_inverse.php b/tests/Util/fixtures/add_many_to_many_relation/User_simple_inverse.php
@@ -28,7 +28,7 @@ public function getId(): ?int
     }
 
     /**
-     * @return Collection|Recipe[]
+     * @return Collection<int, Recipe>
      */
     public function getRecipes(): Collection
     {
diff --git a/tests/Util/fixtures/add_many_to_many_relation/User_simple_no_inverse.php b/tests/Util/fixtures/add_many_to_many_relation/User_simple_no_inverse.php
@@ -28,7 +28,7 @@ public function getId(): ?int
     }
 
     /**
-     * @return Collection|Recipe[]
+     * @return Collection<int, Recipe>
      */
     public function getRecipes(): Collection
     {
diff --git a/tests/Util/fixtures/add_many_to_many_relation/User_simple_owning.php b/tests/Util/fixtures/add_many_to_many_relation/User_simple_owning.php
@@ -28,7 +28,7 @@ public function getId(): ?int
     }
 
     /**
-     * @return Collection|Recipe[]
+     * @return Collection<int, Recipe>
      */
     public function getRecipes(): Collection
     {
diff --git a/tests/Util/fixtures/add_many_to_many_relation/legacy/User_simple_inverse.php b/tests/Util/fixtures/add_many_to_many_relation/legacy/User_simple_inverse.php
@@ -34,7 +34,7 @@ public function getId(): ?int
     }
 
     /**
-     * @return Collection|Recipe[]
+     * @return Collection<int, Recipe>
      */
     public function getRecipes(): Collection
     {
diff --git a/tests/Util/fixtures/add_many_to_many_relation/legacy/User_simple_no_inverse.php b/tests/Util/fixtures/add_many_to_many_relation/legacy/User_simple_no_inverse.php
@@ -34,7 +34,7 @@ public function getId(): ?int
     }
 
     /**
-     * @return Collection|Recipe[]
+     * @return Collection<int, Recipe>
      */
     public function getRecipes(): Collection
     {
diff --git a/tests/Util/fixtures/add_many_to_many_relation/legacy/User_simple_owning.php b/tests/Util/fixtures/add_many_to_many_relation/legacy/User_simple_owning.php
@@ -34,7 +34,7 @@ public function getId(): ?int
     }
 
     /**
-     * @return Collection|Recipe[]
+     * @return Collection<int, Recipe>
      */
     public function getRecipes(): Collection
     {
diff --git a/tests/Util/fixtures/add_one_to_many_relation/User_simple.php b/tests/Util/fixtures/add_one_to_many_relation/User_simple.php
@@ -28,7 +28,7 @@ public function getId(): ?int
     }
 
     /**
-     * @return Collection|UserAvatarPhoto[]
+     * @return Collection<int, UserAvatarPhoto>
      */
     public function getAvatarPhotos(): Collection
     {
diff --git a/tests/Util/fixtures/add_one_to_many_relation/User_simple_orphan_removal.php b/tests/Util/fixtures/add_one_to_many_relation/User_simple_orphan_removal.php
@@ -28,7 +28,7 @@ public function getId(): ?int
     }
 
     /**
-     * @return Collection|UserAvatarPhoto[]
+     * @return Collection<int, UserAvatarPhoto>
      */
     public function getAvatarPhotos(): Collection
     {
diff --git a/tests/Util/fixtures/add_one_to_many_relation/User_with_use_statements.php b/tests/Util/fixtures/add_one_to_many_relation/User_with_use_statements.php
@@ -30,7 +30,7 @@ public function getId(): ?int
     }
 
     /**
-     * @return Collection|UserAvatarPhoto[]
+     * @return Collection<int, UserAvatarPhoto>
      */
     public function getAvatarPhotos(): Collection
     {
diff --git a/tests/Util/fixtures/add_one_to_many_relation/legacy/User_simple.php b/tests/Util/fixtures/add_one_to_many_relation/legacy/User_simple.php
@@ -34,7 +34,7 @@ public function getId(): ?int
     }
 
     /**
-     * @return Collection|UserAvatarPhoto[]
+     * @return Collection<int, UserAvatarPhoto>
      */
     public function getAvatarPhotos(): Collection
     {
diff --git a/tests/Util/fixtures/add_one_to_many_relation/legacy/User_simple_orphan_removal.php b/tests/Util/fixtures/add_one_to_many_relation/legacy/User_simple_orphan_removal.php
@@ -34,7 +34,7 @@ public function getId(): ?int
     }
 
     /**
-     * @return Collection|UserAvatarPhoto[]
+     * @return Collection<int, UserAvatarPhoto>
      */
     public function getAvatarPhotos(): Collection
     {
diff --git a/tests/Util/fixtures/add_one_to_many_relation/legacy/User_with_use_statements.php b/tests/Util/fixtures/add_one_to_many_relation/legacy/User_with_use_statements.php
@@ -36,7 +36,7 @@ public function getId(): ?int
     }
 
     /**
-     * @return Collection|UserAvatarPhoto[]
+     * @return Collection<int, UserAvatarPhoto>
      */
     public function getAvatarPhotos(): Collection
     {

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public function setApiKey(string $apiKey): self`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`/**`
`64`		`- * @return Collection\|Tag[]`
	`64`	`+ * @return Collection<int, Tag>`
`65`	`65`	`*/`
`66`	`66`	`public function getTags(): Collection`
`67`	`67`	`{`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ public function setUserProfile(?UserProfile $userProfile)`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`/**`
`59`		`- * @return Collection\|UserAvatar[]`
	`59`	`+ * @return Collection<int, UserAvatar>`
`60`	`60`	`*/`
`61`	`61`	`public function getAvatars(): Collection`
`62`	`62`	`{`
`@@ -91,7 +91,7 @@ public function getUserProfile(): ?UserProfile`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`/**`
`94`		`- * @return Collection\|Tag[]`
	`94`	`+ * @return Collection<int, Tag>`
`95`	`95`	`*/`
`96`	`96`	`public function getTags(): Collection`
`97`	`97`	`{`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ public function setUserProfile(?UserProfile $userProfile): self`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`/**`
`70`		`- * @return Collection\|UserAvatar[]`
	`70`	`+ * @return Collection<int, UserAvatar>`
`71`	`71`	`*/`
`72`	`72`	`public function getAvatars(): Collection`
`73`	`73`	`{`
`@@ -102,7 +102,7 @@ public function getUserProfile(): ?UserProfile`
`102`	`102`	`}`
`103`	`103`
`104`	`104`	`/**`
`105`		`- * @return Collection\|Tag[]`
	`105`	`+ * @return Collection<int, Tag>`
`106`	`106`	`*/`
`107`	`107`	`public function getTags(): Collection`
`108`	`108`	`{`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function setName(string $name): self`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`/**`
`40`		`- * @return Collection\|UserAvatar[]`
	`40`	`+ * @return Collection<int, UserAvatar>`
`41`	`41`	`*/`
`42`	`42`	`public function getAvatars(): Collection`
`43`	`43`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public function getId(): ?int`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`/**`
`31`		`- * @return Collection\|Recipe[]`
	`31`	`+ * @return Collection<int, Recipe>`
`32`	`32`	`*/`
`33`	`33`	`public function getRecipes(): Collection`
`34`	`34`	`{`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function getId(): ?int`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`/**`
`37`		`- * @return Collection\|Recipe[]`
	`37`	`+ * @return Collection<int, Recipe>`
`38`	`38`	`*/`
`39`	`39`	`public function getRecipes(): Collection`
`40`	`40`	`{`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public function getId(): ?int`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`/**`
`33`		`- * @return Collection\|UserAvatarPhoto[]`
	`33`	`+ * @return Collection<int, UserAvatarPhoto>`
`34`	`34`	`*/`
`35`	`35`	`public function getAvatarPhotos(): Collection`
`36`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function getId(): ?int`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`/**`
`39`		`- * @return Collection\|UserAvatarPhoto[]`
	`39`	`+ * @return Collection<int, UserAvatarPhoto>`
`40`	`40`	`*/`
`41`	`41`	`public function getAvatarPhotos(): Collection`
`42`	`42`	`{`