refactor(http): clarify typed request input sources

Signed-off-by: memleakd <121398829+memleakd@users.noreply.github.com>

Author: memleakd

system/HTTP/IncomingRequest.php

@@ -557,9 +557,9 @@ public function getRawInputVar($index = null, ?int $filter = null, $flags = null
     }
 
     /**
-     * Returns query-string parameters as a typed input object.
+     * Returns GET parameters as a typed input object.
      */
-    public function getQueryInput(): InputData
+    public function getGetInput(): InputData
     {
         $data = $this->getGet();
 
@@ -577,36 +577,17 @@ public function getPostInput(): InputData
     }
 
     /**
-     * Returns request body payload parameters as a typed input object.
+     * Returns JSON body parameters as a typed input object.
      */
-    public function getPayloadInput(): InputData
+    public function getJSONInput(): InputData
     {
-        $contentType = $this->getHeaderLine('Content-Type');
+        $data = $this->getJSON(true) ?? [];
 
-        if (str_contains($contentType, 'application/json')) {
-            $data = $this->getJSON(true) ?? [];
-
-            if (! is_array($data)) {
-                throw HTTPException::forUnsupportedJSONFormat();
-            }
-
-            return service('inputdatafactory')->create($data);
-        }
-
-        if (
-            in_array($this->getMethod(), [Method::PUT, Method::PATCH, Method::DELETE], true)
-            && ! str_contains($contentType, 'multipart/form-data')
-        ) {
-            return service('inputdatafactory')->create($this->getRawInput());
-        }
-
-        if (in_array($this->getMethod(), [Method::GET, Method::HEAD], true)) {
-            return service('inputdatafactory')->create([]);
+        if (! is_array($data)) {
+            throw HTTPException::forUnsupportedJSONFormat();
         }
 
-        $data = $this->getPost();
-
-        return service('inputdatafactory')->create(is_array($data) ? $data : []);
+        return service('inputdatafactory')->create($data);
     }
 
     /**

tests/system/HTTP/IncomingRequestTest.php

@@ -87,14 +87,14 @@ public function testCanGrabPostVars(): void
         $this->assertNull($this->request->getPost('TESTY'));
     }
 
-    public function testGetQueryInputReadsQueryData(): void
+    public function testGetGetInputReadsGetData(): void
     {
         service('superglobals')->setGet('page', '3');
         service('superglobals')->setGet('filters', ['active' => 'true']);
         service('superglobals')->setPost('page', '10');
 
         $request = $this->createRequest();
-        $input   = $request->getQueryInput();
+        $input   = $request->getGetInput();
 
         $this->assertInstanceOf(InputData::class, $input);
         $this->assertSame(3, $input->integer('page'));
@@ -602,7 +602,7 @@ public function testCanGrabGetRawInput(): void
         $this->assertSame($expected, $request->getRawInput());
     }
 
-    public function testGetPayloadInputReadsJsonBody(): void
+    public function testGetJSONInputReadsJsonBody(): void
     {
         $json = json_encode([
             'page'     => '4',
@@ -611,93 +611,43 @@ public function testGetPayloadInputReadsJsonBody(): void
         ]);
 
         $request = $this->createRequest(new App(), $json);
-        $request->setHeader('Content-Type', 'application/json');
 
-        $input = $request->getPayloadInput();
+        $input = $request->getJSONInput();
 
         $this->assertInstanceOf(InputData::class, $input);
         $this->assertSame(4, $input->integer('page'));
         $this->assertTrue($input->boolean('filters.active'));
         $this->assertTrue($input->has('nullable'));
     }
 
-    #[DataProvider('provideGetPayloadInputReadsRawBodyForWriteRequests')]
-    public function testGetPayloadInputReadsRawBodyForWriteRequests(string $method): void
-    {
-        $request = $this->createRequest(new App(), 'title=Hello&published=1')
-            ->withMethod($method);
-
-        $input = $request->getPayloadInput();
-
-        $this->assertSame('Hello', $input->string('title'));
-        $this->assertTrue($input->boolean('published'));
-    }
-
-    /**
-     * @return iterable<string, array{string}>
-     */
-    public static function provideGetPayloadInputReadsRawBodyForWriteRequests(): iterable
-    {
-        yield 'PUT' => ['PUT'];
-
-        yield 'PATCH' => ['PATCH'];
-
-        yield 'DELETE' => ['DELETE'];
-    }
-
-    public function testGetPayloadInputReadsPostBodyForPostRequests(): void
-    {
-        service('superglobals')->setGet('title', 'Query title');
-        service('superglobals')->setPost('title', 'Post title');
-
-        $request = $this->createRequest()->withMethod('POST');
-        $input   = $request->getPayloadInput();
-
-        $this->assertSame('Post title', $input->string('title'));
-    }
-
-    public function testGetPayloadInputDoesNotReadQueryDataForGetRequests(): void
-    {
-        service('superglobals')->setGet('page', '2');
-
-        $request = $this->createRequest()->withMethod('GET');
-        $input   = $request->getPayloadInput();
-
-        $this->assertFalse($input->has('page'));
-        $this->assertSame(1, $input->integer('page', 1));
-    }
-
-    public function testGetPayloadInputReturnsEmptyInputForEmptyJsonBody(): void
+    public function testGetJSONInputReturnsEmptyInputForEmptyJsonBody(): void
     {
         $request = $this->createRequest(new App());
-        $request->setHeader('Content-Type', 'application/json');
 
-        $input = $request->getPayloadInput();
+        $input = $request->getJSONInput();
 
         $this->assertInstanceOf(InputData::class, $input);
         $this->assertFalse($input->has('name'));
     }
 
-    public function testGetPayloadInputRejectsScalarJsonBody(): void
+    public function testGetJSONInputRejectsScalarJsonBody(): void
     {
         $this->expectException(HTTPException::class);
         $this->expectExceptionMessage('The provided JSON format is not supported.');
 
         $request = $this->createRequest(new App(), '"hello"');
-        $request->setHeader('Content-Type', 'application/json');
 
-        $request->getPayloadInput();
+        $request->getJSONInput();
     }
 
-    public function testGetPayloadInputKeepsInvalidJsonError(): void
+    public function testGetJSONInputKeepsInvalidJsonError(): void
     {
         $this->expectException(HTTPException::class);
         $this->expectExceptionMessage('Failed to parse JSON string. Error: Syntax error');
 
         $request = $this->createRequest(new App(), 'Invalid JSON string');
-        $request->setHeader('Content-Type', 'application/json');
 
-        $request->getPayloadInput();
+        $request->getJSONInput();
     }
 
     /**

user_guide_src/source/changelogs/v4.8.0.rst

@@ -261,7 +261,7 @@ HTTP
 
 - Added the ``retry`` option to ``CURLRequest`` for retrying failed responses with configurable delays, retryable status codes, optional transient cURL error retries, and ``Retry-After`` support. See :ref:`curlrequest-request-options-retry`.
 - Added :ref:`Form Requests <form-requests>` - a new ``FormRequest`` base class that encapsulates validation rules, custom error messages, and authorization logic for a single HTTP request.
-- Added ``IncomingRequest::getQueryInput()``, ``getPostInput()``, and ``getPayloadInput()`` to read source-specific request data through ``InputData``.
+- Added ``IncomingRequest::getGetInput()``, ``getPostInput()``, and ``getJSONInput()`` to read GET, POST, and JSON request data through ``InputData``.
 - Added ``SSEResponse`` class for streaming Server-Sent Events (SSE) over HTTP. See :ref:`server-sent-events`.
 - ``Response`` and its child classes no longer require ``Config\App`` passed to their constructors.
   Consequently, ``CURLRequest``'s ``$config`` parameter is unused and will be removed in a future release.

user_guide_src/source/incoming/incomingrequest.rst

@@ -161,27 +161,25 @@ The ``getVar()`` method will pull from ``$_REQUEST``, so will return any data fr
 .. note:: If the incoming request has a ``Content-Type`` header set to ``application/json``,
     the ``getVar()`` method returns the JSON data instead of ``$_REQUEST`` data.
 
-.. _incomingrequest-typed-source-input:
+.. _incomingrequest-typed-request-input:
 
-Typed Source Input
-==================
+Typed Request Input
+===================
 
 .. versionadded:: 4.8.0
 
-``getQueryInput()``, ``getPostInput()``, and ``getPayloadInput()`` return
-request data as a ``CodeIgniter\Input\InputData`` object. Use these methods
-when you want source-explicit access with typed fallback helpers:
+``getGetInput()``, ``getPostInput()``, and ``getJSONInput()`` return
+request data as a ``CodeIgniter\Input\InputData`` object. Use these methods to
+read values from a specific part of the request with typed fallback helpers:
 
 .. literalinclude:: incomingrequest/046.php
    :lines: 2-
 
-``getQueryInput()`` reads query-string parameters. ``getPostInput()`` reads
-POST body parameters. ``getPayloadInput()`` reads the request body payload:
-JSON requests use the decoded JSON body, ``PUT``, ``PATCH``, and ``DELETE``
-requests use ``getRawInput()`` when they are not multipart requests, and
-ordinary form requests use POST body parameters.
-For non-JSON ``GET`` and ``HEAD`` requests, use ``getQueryInput()``;
-``getPayloadInput()`` returns an empty input object.
+``getGetInput()`` reads query-string parameters. ``getPostInput()`` reads
+POST body parameters. ``getJSONInput()`` reads JSON request body parameters.
+These methods keep GET, POST, and JSON data separate. They do not combine
+multiple request sources for you. For raw ``PUT``, ``PATCH``, or ``DELETE``
+data, continue using ``getRawInput()`` or ``getRawInputVar()``.
 
 These methods do not validate input. They are fallback-friendly helpers for
 reading raw request data. Use Validation or :ref:`form-requests` when input
@@ -432,7 +430,7 @@ The methods provided by the parent classes that are available are:
 
         .. literalinclude:: incomingrequest/045.php
 
-    .. php:method:: getQueryInput()
+    .. php:method:: getGetInput()
 
         :returns:       Query-string parameters as a typed input object.
         :rtype: CodeIgniter\\Input\\InputData
@@ -454,9 +452,9 @@ The methods provided by the parent classes that are available are:
         :returns:       POST body parameters as a typed input object.
         :rtype: CodeIgniter\\Input\\InputData
 
-    .. php:method:: getPayloadInput()
+    .. php:method:: getJSONInput()
 
-        :returns:       Request body payload parameters as a typed input object.
+        :returns:       JSON body parameters as a typed input object.
         :rtype: CodeIgniter\\Input\\InputData
 
     .. php:method:: getPostGet([$index = null[, $filter = null[, $flags = null]]])

user_guide_src/source/incoming/incomingrequest/046.php

@@ -1,5 +1,5 @@
 <?php
 
-$page     = $request->getQueryInput()->integer('page', 1);
+$page     = $request->getGetInput()->integer('page', 1);
 $remember = $request->getPostInput()->boolean('remember', false);
-$name     = $request->getPayloadInput()->string('name');
+$name     = $request->getJSONInput()->string('name');