minor #46360 [Form] Add approriate description to CollectionToArrayTransformer::reverseTransform docblock (Xesau)

nicolas-grekas · nicolas-grekas · commit bb6d26afc2b1 · 2022-05-17T11:15:43.000+02:00
This PR was submitted for the 6.1 branch but it was merged into the 4.4 branch instead. Discussion ---------- [Form] Add approriate description to CollectionToArrayTransformer::reverseTransform docblock | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | Deprecations? | no | License | MIT | Doc PR | N/A It seems that during creation of CollectionToArrayTransformer, the source code of another class was used as base, and the documentation for one of the methods was not changed according with the function of the new class. Not sure which branch this should be applied to, since its not a new feature, and technically not a bug fix but a documentation fix. Commits ------- 09f47f4 Add approriate description to CollectionToArrayTransformer::reverseTransform docblock
diff --git a/src/Symfony/Bridge/Doctrine/Form/DataTransformer/CollectionToArrayTransformer.php b/src/Symfony/Bridge/Doctrine/Form/DataTransformer/CollectionToArrayTransformer.php
@@ -24,8 +24,6 @@ class CollectionToArrayTransformer implements DataTransformerInterface
     /**
      * Transforms a collection into an array.
      *
-     * @return mixed An array of entities
-     *
      * @throws TransformationFailedException
      */
     public function transform($collection)
@@ -48,11 +46,9 @@ public function transform($collection)
     }
 
     /**
-     * Transforms choice keys into entities.
-     *
-     * @param mixed $array An array of entities
+     * Transforms an array into a collection.
      *
-     * @return Collection A collection of entities
+     * @return Collection
      */
     public function reverseTransform($array)
     {

Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,6 @@ class CollectionToArrayTransformer implements DataTransformerInterface`
`24`	`24`	`/**`
`25`	`25`	`* Transforms a collection into an array.`
`26`	`26`	`*`
`27`		`- * @return mixed An array of entities`
`28`		`- *`
`29`	`27`	`* @throws TransformationFailedException`
`30`	`28`	`*/`
`31`	`29`	`public function transform($collection)`
`@@ -48,11 +46,9 @@ public function transform($collection)`
`48`	`46`	`}`
`49`	`47`
`50`	`48`	`/**`
`51`		`- * Transforms choice keys into entities.`
`52`		`- *`
`53`		`- * @param mixed $array An array of entities`
	`49`	`+ * Transforms an array into a collection.`
`54`	`50`	`*`
`55`		`- * @return Collection A collection of entities`
	`51`	`+ * @return Collection`
`56`	`52`	`*/`
`57`	`53`	`public function reverseTransform($array)`
`58`	`54`	`{`