[DomCrawler] Clarify the value returned by getPhpFiles()

jakzal · jakzal · commit a694401e350c · 2016-02-12T10:10:06.000Z
The comment was previously suggesting the returned value is similar to the one stored in $_FILES, while it is more similar to the way PHP stores submitted form values. It is actually more convenient to have it this way, so rather then changing the returned value (which would break BC), it is better to clarify the comment.
diff --git a/src/Symfony/Component/DomCrawler/Form.php b/src/Symfony/Component/DomCrawler/Form.php
@@ -157,8 +157,12 @@ public function getPhpValues()
      *
      * This method converts fields with the array notation
      * (like foo[bar] to arrays) like PHP does.
+     * The returned array is consistent with the array for field values
+     * (@see getPhpValues), rather than uploaded files found in $_FILES.
+     * For a compound file field foo[bar] it will create foo[bar][name],
+     * instead of foo[name][bar] which would be found in $_FILES.
      *
-     * @return array An array of field values.
+     * @return array An array of file field values.
      */
     public function getPhpFiles()
     {

Original file line number	Diff line number	Diff line change
`@@ -157,8 +157,12 @@ public function getPhpValues()`
`157`	`157`	`*`
`158`	`158`	`* This method converts fields with the array notation`
`159`	`159`	`* (like foo[bar] to arrays) like PHP does.`
	`160`	`+ * The returned array is consistent with the array for field values`
	`161`	`+ * (@see getPhpValues), rather than uploaded files found in $_FILES.`
	`162`	`+ * For a compound file field foo[bar] it will create foo[bar][name],`
	`163`	`+ * instead of foo[name][bar] which would be found in $_FILES.`
`160`	`164`	`*`
`161`		`- * @return array An array of field values.`
	`165`	`+ * @return array An array of file field values.`
`162`	`166`	`*/`
`163`	`167`	`public function getPhpFiles()`
`164`	`168`	`{`