Add Http\ServerRequest::getQueryParam method

MauricioFauth · MauricioFauth · commit 4cd6b23007a8 · 2022-10-10T23:00:33.000-03:00
Similar to the Http\ServerRequest::getParsedBodyParam method, this
method retrives a single parameter from the request query, or the
default value if not available.

Signed-off-by: Maurício Meneghini Fauth &lt;mauricio@fauth.dev&gt;
diff --git a/libraries/classes/Controllers/Setup/MainController.php b/libraries/classes/Controllers/Setup/MainController.php
@@ -23,12 +23,9 @@ public function __invoke(ServerRequest $request): void
             Core::fatalError(__('Configuration already exists, setup is disabled!'));
         }
 
-        $params = $request->getQueryParams();
-
-        $page = 'index';
-        if (isset($params['page']) && in_array($params['page'], ['form', 'config', 'servers'], true)) {
-            $page = $params['page'];
-        }
+        /** @var mixed $pageParam */
+        $pageParam = $request->getQueryParam('page');
+        $page = in_array($pageParam, ['form', 'config', 'servers'], true) ? $pageParam : 'index';
 
         Core::noCacheHeader();
 
@@ -37,44 +34,46 @@ public function __invoke(ServerRequest $request): void
 
         if ($page === 'form') {
             echo (new FormController($GLOBALS['ConfigFile'], new Template()))([
-                'formset' => $params['formset'] ?? null,
+                'formset' => $request->getQueryParam('formset'),
             ]);
 
             return;
         }
 
         if ($page === 'config') {
             echo (new ConfigController($GLOBALS['ConfigFile'], new Template()))([
-                'formset' => $params['formset'] ?? null,
-                'eol' => $params['eol'] ?? null,
+                'formset' => $request->getQueryParam('formset'),
+                'eol' => $request->getQueryParam('eol'),
             ]);
 
             return;
         }
 
         if ($page === 'servers') {
             $controller = new ServersController($GLOBALS['ConfigFile'], new Template());
-            if (isset($params['mode']) && $params['mode'] === 'remove' && $request->isPost()) {
+            /** @var mixed $mode */
+            $mode = $request->getQueryParam('mode');
+            if ($mode === 'remove' && $request->isPost()) {
                 $controller->destroy([
-                    'id' => $params['id'] ?? null,
+                    'id' => $request->getQueryParam('id'),
                 ]);
                 header('Location: ../setup/index.php' . Url::getCommonRaw(['route' => '/setup']));
 
                 return;
             }
 
             echo $controller->index([
-                'formset' => $params['formset'] ?? null,
-                'mode' => $params['mode'] ?? null,
-                'id' => $params['id'] ?? null,
+                'formset' => $request->getQueryParam('formset'),
+                'mode' => $mode,
+                'id' => $request->getQueryParam('id'),
             ]);
 
             return;
         }
 
         echo (new HomeController($GLOBALS['ConfigFile'], new Template()))([
-            'formset' => $params['formset'] ?? null,
-            'version_check' => $params['version_check'] ?? null,
+            'formset' => $request->getQueryParam('formset'),
+            'version_check' => $request->getQueryParam('version_check'),
         ]);
     }
 }
diff --git a/libraries/classes/Http/ServerRequest.php b/libraries/classes/Http/ServerRequest.php
@@ -309,11 +309,7 @@ public function getParam(string $param, $default = null)
             return $postParams->$param;
         }
 
-        if (isset($getParams[$param])) {
-            return $getParams[$param];
-        }
-
-        return $default;
+        return $getParams[$param] ?? $default;
     }
 
     /**
@@ -336,6 +332,18 @@ public function getParsedBodyParam(string $param, $default = null)
         return $default;
     }
 
+    /**
+     * @param mixed $default
+     *
+     * @return mixed
+     */
+    public function getQueryParam(string $param, $default = null)
+    {
+        $getParams = $this->getQueryParams();
+
+        return $getParams[$param] ?? $default;
+    }
+
     public function isPost(): bool
     {
         return $this->getMethod() === 'POST';
diff --git a/test/classes/Http/ServerRequestTest.php b/test/classes/Http/ServerRequestTest.php
@@ -47,4 +47,20 @@ public function providerForTestGetRoute(): iterable
             ['/', [], ['db' => 'db', 'table' => 'table']],
         ];
     }
+
+    public function testGetQueryParam(): void
+    {
+        $queryParams = ['key1' => 'value1', 'key2' => ['value2'], 'key4' => ''];
+        $requestStub = $this->createStub(ServerRequestInterface::class);
+        $requestStub->method('getQueryParams')->willReturn($queryParams);
+        $request = new ServerRequest($requestStub);
+        $this->assertSame('value1', $request->getQueryParam('key1'));
+        $this->assertSame('value1', $request->getQueryParam('key1', 'default'));
+        $this->assertSame(['value2'], $request->getQueryParam('key2'));
+        $this->assertSame(['value2'], $request->getQueryParam('key2', 'default'));
+        $this->assertNull($request->getQueryParam('key3'));
+        $this->assertSame('default', $request->getQueryParam('key3', 'default'));
+        $this->assertSame('', $request->getQueryParam('key4'));
+        $this->assertSame('', $request->getQueryParam('key4', 'default'));
+    }
 }
