feature #1219 [make:entity] Add PHPDoc var type for Collections

Author: b1rdex

src/Util/ClassSourceManipulator.php

@@ -594,6 +594,8 @@ private function addCollectionRelation(BaseCollectionRelation $relation): void
         $this->addProperty(
             name: $relation->getPropertyName(),
             attributes: $attributes,
+            // add @var that advertises this as a collection of specific objects
+            comments: [sprintf('@var %s<int, %s>', $collectionTypeHint, $typeHint)],
             propertyType: $collectionTypeHint,
         );
 

tests/Doctrine/fixtures/expected_no_overwrite/src/Entity/Client.php

@@ -17,6 +17,9 @@ class Client extends BaseClient
     #[ORM\Column]
     private ?string $apiKey = null;
 
+    /**
+     * @var Collection<int, Tag>
+     */
     #[ORM\ManyToMany(targetEntity: Tag::class)]
     private Collection $tags;
 

tests/Doctrine/fixtures/expected_no_overwrite/src/Entity/User.php

@@ -14,12 +14,18 @@ class User
     #[ORM\Column]
     private ?int $id = null;
 
+    /**
+     * @var Collection<int, UserAvatar>
+     */
     #[ORM\OneToMany(targetEntity: UserAvatar::class, mappedBy: 'user')]
     private Collection $avatars;
 
     #[ORM\OneToOne(mappedBy: 'user')]
     private ?UserProfile $userProfile = null;
 
+    /**
+     * @var Collection<int, Tag>
+     */
     #[ORM\ManyToMany(targetEntity: Tag::class)]
     private Collection $tags;
 

tests/Doctrine/fixtures/expected_overwrite/src/Entity/Client.php

@@ -17,6 +17,9 @@ class Client extends BaseClient
     #[ORM\Column]
     private ?string $apiKey = null;
 
+    /**
+     * @var Collection<int, Tag>
+     */
     #[ORM\ManyToMany(targetEntity: Tag::class)]
     private Collection $tags;
 

tests/Doctrine/fixtures/expected_overwrite/src/Entity/User.php

@@ -14,12 +14,18 @@ class User
     #[ORM\Column]
     private ?int $id = null;
 
+    /**
+     * @var Collection<int, UserAvatar>
+     */
     #[ORM\OneToMany(targetEntity: UserAvatar::class, mappedBy: 'user')]
     private Collection $avatars;
 
     #[ORM\OneToOne(mappedBy: 'user')]
     private ?UserProfile $userProfile = null;
 
+    /**
+     * @var Collection<int, Tag>
+     */
     #[ORM\ManyToMany(targetEntity: Tag::class)]
     private Collection $tags;
 

tests/Doctrine/fixtures/expected_xml/src/Entity/UserXml.php

@@ -11,6 +11,9 @@ class UserXml
 
     private ?string $name = null;
 
+    /**
+     * @var Collection<int, UserAvatar>
+     */
     private Collection $avatars;
 
     public function __construct()

tests/Doctrine/fixtures/source_project/src/Entity/Client.php

@@ -16,6 +16,9 @@ class Client extends BaseClient
     #[ORM\Column]
     private ?string $apiKey = null;
 
+    /**
+     * @var Collection<int, Tag>
+     */
     #[ORM\ManyToMany(targetEntity: Tag::class)]
     private Collection $tags;
 

tests/Doctrine/fixtures/source_project/src/Entity/User.php

@@ -14,12 +14,18 @@ class User
     #[ORM\Column]
     private ?int $id = null;
 
+    /**
+     * @var Collection<int, UserAvatar>
+     */
     #[ORM\OneToMany(targetEntity: UserAvatar::class, mappedBy: 'user')]
     private Collection $avatars;
 
     #[ORM\OneToOne(mappedBy: 'user')]
     private ?UserProfile $userProfile = null;
 
+    /**
+     * @var Collection<int, Tag>
+     */
     #[ORM\ManyToMany(targetEntity: Tag::class)]
     private Collection $tags;
 

tests/Util/fixtures/add_many_to_many_relation/User_simple_inverse.php

@@ -14,6 +14,9 @@ class User
     #[ORM\Column()]
     private ?int $id = null;
 
+    /**
+     * @var Collection<int, Recipe>
+     */
     #[ORM\ManyToMany(targetEntity: Recipe::class, mappedBy: 'foods')]
     private Collection $recipes;
 

tests/Util/fixtures/add_many_to_many_relation/User_simple_no_inverse.php

@@ -14,6 +14,9 @@ class User
     #[ORM\Column()]
     private ?int $id = null;
 
+    /**
+     * @var Collection<int, Recipe>
+     */
     #[ORM\ManyToMany(targetEntity: Recipe::class)]
     private Collection $recipes;
 

tests/Util/fixtures/add_many_to_many_relation/User_simple_owning.php

@@ -14,6 +14,9 @@ class User
     #[ORM\Column()]
     private ?int $id = null;
 
+    /**
+     * @var Collection<int, Recipe>
+     */
     #[ORM\ManyToMany(targetEntity: Recipe::class, inversedBy: 'foods')]
     private Collection $recipes;
 

tests/Util/fixtures/add_one_to_many_relation/User_simple.php

@@ -14,6 +14,9 @@ class User
     #[ORM\Column()]
     private ?int $id = null;
 
+    /**
+     * @var Collection<int, UserAvatarPhoto>
+     */
     #[ORM\OneToMany(targetEntity: UserAvatarPhoto::class, mappedBy: 'user')]
     private Collection $avatarPhotos;
 

tests/Util/fixtures/add_one_to_many_relation/User_simple_orphan_removal.php

@@ -14,6 +14,9 @@ class User
     #[ORM\Column()]
     private ?int $id = null;
 
+    /**
+     * @var Collection<int, UserAvatarPhoto>
+     */
     #[ORM\OneToMany(targetEntity: UserAvatarPhoto::class, mappedBy: 'user', orphanRemoval: true)]
     private Collection $avatarPhotos;
 

tests/Util/fixtures/add_one_to_many_relation/User_with_use_statements.php

@@ -17,6 +17,9 @@ class User
     #[ORM\Column()]
     private ?int $id = null;
 
+    /**
+     * @var Collection<int, UserAvatarPhoto>
+     */
     #[ORM\OneToMany(targetEntity: UserAvatarPhoto::class, mappedBy: 'user')]
     private Collection $avatarPhotos;
 

tests/Util/fixtures/add_one_to_many_relation/legacy/User_simple.php

@@ -14,6 +14,9 @@ class User
     #[ORM\Column()]
     private ?int $id = null;
 
+    /**
+     * @var Collection<int, UserAvatarPhoto>
+     */
     #[ORM\OneToMany(mappedBy: 'user', targetEntity: UserAvatarPhoto::class)]
     private Collection $avatarPhotos;
 

tests/Util/fixtures/add_one_to_many_relation/legacy/User_simple_orphan_removal.php

@@ -14,6 +14,9 @@ class User
     #[ORM\Column()]
     private ?int $id = null;
 
+    /**
+     * @var Collection<int, UserAvatarPhoto>
+     */
     #[ORM\OneToMany(mappedBy: 'user', targetEntity: UserAvatarPhoto::class, orphanRemoval: true)]
     private Collection $avatarPhotos;
 

tests/Util/fixtures/add_one_to_many_relation/legacy/User_with_use_statements.php

@@ -17,6 +17,9 @@ class User
     #[ORM\Column()]
     private ?int $id = null;
 
+    /**
+     * @var Collection<int, UserAvatarPhoto>
+     */
     #[ORM\OneToMany(mappedBy: 'user', targetEntity: UserAvatarPhoto::class)]
     private Collection $avatarPhotos;
 

tests/fixtures/make-entity/regenerate/attributes/src/Entity/User.php

@@ -20,6 +20,9 @@ class User
     #[ORM\Column(type: Types::DATETIME_MUTABLE, nullable: true)]
     private ?\DateTimeInterface $createdAt = null;
 
+    /**
+     * @var Collection<int, UserAvatar>
+     */
     #[ORM\OneToMany(targetEntity: UserAvatar::class, mappedBy: 'user')]
     private Collection $avatars;
 

tests/fixtures/make-form/SourFood.php

@@ -17,6 +17,9 @@ class SourFood
     #[ORM\Column(name: 'title', length: 255)]
     private ?string $title = null;
 
+    /**
+     * @var Collection<int, Property>
+     */
     #[ORM\OneToMany(targetEntity: Property::class, mappedBy: 'sourFood')]
     private Collection $properties;