vendor/symfony/form/Extension/HttpFoundation/HttpFoundationRequestHandler.php line 38

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Form\Extension\HttpFoundation;
  14. use Symfony\Component\Form\Exception\UnexpectedTypeException;
  15. use Symfony\Component\Form\FormError;
  16. use Symfony\Component\Form\FormInterface;
  17. use Symfony\Component\Form\RequestHandlerInterface;
  18. use Symfony\Component\Form\Util\ServerParams;
  19. use Symfony\Component\HttpFoundation\File\File;
  20. use Symfony\Component\HttpFoundation\File\UploadedFile;
  21. use Symfony\Component\HttpFoundation\Request;
  23. /**
  24.  * A request processor using the {@link Request} class of the HttpFoundation
  25.  * component.
  26.  *
  27.  * @author Bernhard Schussek <bschussek@gmail.com>
  28.  */
  29. class HttpFoundationRequestHandler implements RequestHandlerInterface
  30. {
  31.     private ServerParams $serverParams;
  33.     public function __construct(ServerParams $serverParams = null)
  34.     {
  35.         $this->serverParams = $serverParams ?? new ServerParams();
  36.     }
  38.     public function handleRequest(FormInterface $form, mixed $request = null)
  39.     {
  40.         if (!$request instanceof Request) {
  41.             throw new UnexpectedTypeException($request, Request::class);
  42.         }
  44.         $name = $form->getName();
  45.         $method = $form->getConfig()->getMethod();
  47.         if ($method !== $request->getMethod()) {
  48.             return;
  49.         }
  51.         // For request methods that must not have a request body we fetch data
  52.         // from the query string. Otherwise we look for data in the request body.
  53.         if ('GET' === $method || 'HEAD' === $method || 'TRACE' === $method) {
  54.             if ('' === $name) {
  55.                 $data = $request->query->all();
  56.             } else {
  57.                 // Don't submit GET requests if the form's name does not exist
  58.                 // in the request
  59.                 if (!$request->query->has($name)) {
  60.                     return;
  61.                 }
  63.                 $data = $request->query->all()[$name];
  64.             }
  65.         } else {
  66.             // Mark the form with an error if the uploaded size was too large
  67.             // This is done here and not in FormValidator because $_POST is
  68.             // empty when that error occurs. Hence the form is never submitted.
  69.             if ($this->serverParams->hasPostMaxSizeBeenExceeded()) {
  70.                 // Submit the form, but don't clear the default values
  71.                 $form->submit(null, false);
  73.                 $form->addError(new FormError(
  74.                     $form->getConfig()->getOption('upload_max_size_message')(),
  75.                     null,
  76.                     ['{{ max }}' => $this->serverParams->getNormalizedIniPostMaxSize()]
  77.                 ));
  79.                 return;
  80.             }
  82.             if ('' === $name) {
  83.                 $params = $request->request->all();
  84.                 $files = $request->files->all();
  85.             } elseif ($request->request->has($name) || $request->files->has($name)) {
  86.                 $default = $form->getConfig()->getCompound() ? [] : null;
  87.                 $params = $request->request->all()[$name] ?? $default;
  88.                 $files = $request->files->get($name, $default);
  89.             } else {
  90.                 // Don't submit the form if it is not present in the request
  91.                 return;
  92.             }
  94.             if (\is_array($params) && \is_array($files)) {
  95.                 $data = array_replace_recursive($params, $files);
  96.             } else {
  97.                 $data = $params ?: $files;
  98.             }
  99.         }
  101.         // Don't auto-submit the form unless at least one field is present.
  102.         if ('' === $name && \count(array_intersect_key($data, $form->all())) <= 0) {
  103.             return;
  104.         }
  106.         $form->submit($data, 'PATCH' !== $method);
  107.     }
  109.     public function isFileUpload(mixed $data): bool
  110.     {
  111.         return $data instanceof File;
  112.     }
  114.     public function getUploadFileError(mixed $data): ?int
  115.     {
  116.         if (!$data instanceof UploadedFile || $data->isValid()) {
  117.             return null;
  118.         }
  120.         return $data->getError();
  121.     }
  122. }