feature #49614 [HttpFoundation] add Request::getPayload() (kbond)

This PR was merged into the 6.3 branch.

Discussion
----------

[HttpFoundation] add `Request::getPayload()`

| Q             | A
| ------------- | ---
| Branch?       | 6.3
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Tickets       | Fix #47646
| License       | MIT
| Doc PR        | todo

Alternative for #47938 based on feedback there.

```php
/** `@var` InputBag $input wrapping either Request::$request or Request::toArray() */
$input = $request->getPayload();
```

Commits
-------

4a0a439933 [HttpFoundation] add `Request::getPayload()`

Author: fabpot

CHANGELOG.md

@@ -10,7 +10,8 @@ CHANGELOG
  * Create migration for session table when pdo handler is used
  * Add support for Relay PHP extension for Redis
  * The `Response::sendHeaders()` method now takes an optional HTTP status code as parameter, allowing to send informational responses such as Early Hints responses (103 status code)
- * Add `IpUtils::isPrivateIp`
+ * Add `IpUtils::isPrivateIp()`
+ * Add `Request::getPayload(): InputBag`
  * Deprecate conversion of invalid values in `ParameterBag::getInt()` and `ParameterBag::getBoolean()`,
  * Deprecate ignoring invalid values when using `ParameterBag::filter()`, unless flag `FILTER_NULL_ON_FAILURE` is set
 

Request.php

@@ -1504,6 +1504,14 @@ public function getContent(bool $asResource = false)
         return $this->content;
     }
 
+    /**
+     * Gets the decoded form or json request body.
+     */
+    public function getPayload(): InputBag
+    {
+        return $this->request->count() ? clone $this->request : new InputBag($this->toArray());
+    }
+
     /**
      * Gets the request body decoded as array, typically from a JSON payload.
      *

Tests/RequestTest.php

@@ -1300,6 +1300,17 @@ public function testToArray()
         $this->assertEquals(['foo' => 'bar'], $req->toArray());
     }
 
+    public function testGetPayload()
+    {
+        $req = new Request([], [], [], [], [], [], json_encode(['foo' => 'bar']));
+        $this->assertSame(['foo' => 'bar'], $req->getPayload()->all());
+        $req->getPayload()->set('new', 'key');
+        $this->assertSame(['foo' => 'bar'], $req->getPayload()->all());
+
+        $req = new Request([], ['foo' => 'bar'], [], [], [], [], json_encode(['baz' => 'qux']));
+        $this->assertSame(['foo' => 'bar'], $req->getPayload()->all());
+    }
+
     /**
      * @dataProvider provideOverloadedMethods
      */