minor #25040 [Form] Add phpdoc to RequestHandlerInterface::isFileUpload() method (issei-m)

nicolas-grekas · nicolas-grekas · commit f1b792139008 · 2017-11-20T18:59:32.000+01:00
This PR was squashed before being merged into the 2.7 branch (closes #25040). Discussion ---------- [Form] Add phpdoc to `RequestHandlerInterface::isFileUpload()` method | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | no | New feature? | no  | BC breaks? | no | Deprecations? | no  | Tests pass? | Not confirmed, but the changes are completely minor | Fixed tickets | - | License | MIT | Doc PR | -  Commits ------- faf5470 [Form] Add phpdoc to `RequestHandlerInterface::isFileUpload()` method
diff --git a/src/Symfony/Component/Form/Extension/HttpFoundation/HttpFoundationRequestHandler.php b/src/Symfony/Component/Form/Extension/HttpFoundation/HttpFoundationRequestHandler.php
@@ -108,6 +108,9 @@ public function handleRequest(FormInterface $form, $request = null)
         $form->submit($data, 'PATCH' !== $method);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function isFileUpload($data)
     {
         return $data instanceof File;
diff --git a/src/Symfony/Component/Form/NativeRequestHandler.php b/src/Symfony/Component/Form/NativeRequestHandler.php
@@ -118,6 +118,9 @@ public function handleRequest(FormInterface $form, $request = null)
         $form->submit($data, 'PATCH' !== $method);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function isFileUpload($data)
     {
         // POST data will always be strings or arrays of strings. Thus, we can be sure
diff --git a/src/Symfony/Component/Form/RequestHandlerInterface.php b/src/Symfony/Component/Form/RequestHandlerInterface.php
@@ -27,7 +27,9 @@ interface RequestHandlerInterface
     public function handleRequest(FormInterface $form, $request = null);
 
     /**
-     * @param mixed $data
+     * Returns true if the given data is a file upload.
+     *
+     * @param mixed $data The form field data
      *
      * @return bool
      */

Original file line number	Diff line number	Diff line change
`@@ -108,6 +108,9 @@ public function handleRequest(FormInterface $form, $request = null)`
`108`	`108`	`$form->submit($data, 'PATCH' !== $method);`
`109`	`109`	`}`
`110`	`110`
	`111`	`+ /**`
	`112`	`+ * {@inheritdoc}`
	`113`	`+ */`
`111`	`114`	`public function isFileUpload($data)`
`112`	`115`	`{`
`113`	`116`	`return $data instanceof File;`
Original file line number	Diff line number	Diff line change
`@@ -118,6 +118,9 @@ public function handleRequest(FormInterface $form, $request = null)`
`118`	`118`	`$form->submit($data, 'PATCH' !== $method);`
`119`	`119`	`}`
`120`	`120`
	`121`	`+ /**`
	`122`	`+ * {@inheritdoc}`
	`123`	`+ */`
`121`	`124`	`public function isFileUpload($data)`
`122`	`125`	`{`
`123`	`126`	`// POST data will always be strings or arrays of strings. Thus, we can be sure`