Calculate Request parameter within the __construct of BaseProvider

Author: bjoern-hempel

src/ApiPlatform/State/Base/BaseProvider.php

@@ -58,13 +58,24 @@ abstract class BaseProvider implements ProviderInterface, ProcessorInterface
 
     protected const TEXT_UNDEFINED_METHOD = 'Please overwrite the "%s" method in your provider to use this function.';
 
+    protected Request $request;
+
     /**
      * @param ParameterBagInterface $parameterBag
-     * @param RequestStack $request
+     * @param RequestStack $requestStack
+     * @throws CaseUnsupportedException
      */
-    public function __construct(protected ParameterBagInterface $parameterBag, protected RequestStack $request)
+    public function __construct(protected ParameterBagInterface $parameterBag, RequestStack $requestStack)
     {
         $this->input = new ArrayInput([]);
+
+        $request = $requestStack->getCurrentRequest();
+
+        if (is_null($request)) {
+            throw new CaseUnsupportedException('Can\'t get the CurrentRequest class(<code>$this->getRequest()->getCurrentRequest();</code>).');
+        }
+
+        $this->request = $request;
     }
 
     /**
@@ -170,38 +181,29 @@ protected function getProjectDir(): string
      * Returns the current request.
      *
      * @return Request
-     * @throws CaseUnsupportedException
      */
-    protected function getCurrentRequest(): Request
+    protected function getRequest(): Request
     {
-        $currentRequest = $this->request->getCurrentRequest();
-
-        if (is_null($currentRequest)) {
-            throw new CaseUnsupportedException('Can\'t get the CurrentRequest class(<code>$this->getRequest()->getCurrentRequest();</code>).');
-        }
-
-        return $currentRequest;
+        return $this->request;
     }
 
     /**
      * Returns the header bag.
      *
      * @return HeaderBag
-     * @throws CaseUnsupportedException
      */
     protected function getHeaderBag(): HeaderBag
     {
-        $currentRequest = $this->getCurrentRequest();
+        $request = $this->getRequest();
 
-        return $currentRequest->headers;
+        return $request->headers;
     }
 
     /**
      * Returns if the given name exists as a header request.
      *
      * @param string $name
      * @return bool
-     * @throws CaseUnsupportedException
      */
     public function hasHeader(string $name): bool
     {
@@ -216,7 +218,6 @@ public function hasHeader(string $name): bool
      * @param string $name
      * @return string|null
      * @throws ArrayKeyNotFoundException
-     * @throws CaseUnsupportedException
      */
     public function getHeader(string $name): ?string
     {
@@ -232,7 +233,6 @@ public function getHeader(string $name): ?string
      *
      * @param string $name
      * @return string|null
-     * @throws CaseUnsupportedException
      */
     public function getHeaderAsStringOrNull(string $name): ?string
     {
@@ -264,7 +264,6 @@ public function getHeaderAsString(string $name): string
      *
      * @param string $name
      * @return float|null
-     * @throws CaseUnsupportedException
      */
     public function getHeaderAsFloatOrNull(string $name): ?float
     {
@@ -296,7 +295,6 @@ public function getHeaderAsFloat(string $name): float
      *
      * @param string $name
      * @return int|null
-     * @throws CaseUnsupportedException
      */
     public function getHeaderAsIntOrNull(string $name): ?int
     {
@@ -329,7 +327,6 @@ public function getHeaderAsInt(string $name): int
      * @param string $name
      * @return bool
      * @throws CaseInvalidException
-     * @throws CaseUnsupportedException
      * @throws TypeInvalidException
      */
     public function isHeaderAsBoolean(string $name): bool

src/ApiPlatform/State/Base/Raw/BaseRawProvider.php

@@ -41,9 +41,9 @@ abstract class BaseRawProvider extends BaseProvider
     /**
      * BaseDirectProvider constructor.
      */
-    public function __construct(protected ParameterBagInterface $parameterBag, protected RequestStack $request)
+    public function __construct(protected ParameterBagInterface $parameterBag, protected RequestStack $requestStack)
     {
-        parent::__construct($this->parameterBag, $this->request);
+        parent::__construct($this->parameterBag, $this->requestStack);
     }
 
     /**

src/ApiPlatform/State/Base/Wrapper/BaseResourceWrapperProvider.php

@@ -80,15 +80,16 @@ abstract class BaseResourceWrapperProvider extends BaseProvider
     /**
      * @param Version $version
      * @param ParameterBagInterface $parameterBag
-     * @param RequestStack $request
+     * @param RequestStack $requestStack
+     * @throws CaseUnsupportedException
      */
     public function __construct(
         protected Version $version,
         protected ParameterBagInterface $parameterBag,
-        protected RequestStack $request
+        RequestStack $requestStack
     )
     {
-        parent::__construct($parameterBag, $request);
+        parent::__construct($parameterBag, $requestStack);
     }
 
     /**
@@ -223,13 +224,12 @@ private function setContext(array $context): void
      * Returns the request body as string.
      *
      * @return string|null
-     * @throws CaseUnsupportedException
      */
     protected function getRequestBody(): ?string
     {
-        $currentRequest = $this->getCurrentRequest();
+        $request = $this->getRequest();
 
-        $requestBody = $currentRequest->getContent();
+        $requestBody = $request->getContent();
 
         if (empty($requestBody)) {
             return null;
@@ -242,7 +242,6 @@ protected function getRequestBody(): ?string
      * Returns the request body as JSON object.
      *
      * @return Json|null
-     * @throws CaseUnsupportedException
      * @throws FileNotFoundException
      * @throws FileNotReadableException
      * @throws FunctionJsonEncodeException
@@ -643,11 +642,10 @@ protected function isValid(): bool
      * Returns the endpoint.
      *
      * @return string
-     * @throws CaseUnsupportedException
      */
     protected function getEndpoint(): string
     {
-        $pathInfo = explode('/', $this->getCurrentRequest()->getPathInfo());
+        $pathInfo = explode('/', $this->getRequest()->getPathInfo());
 
         return implode('/', array_slice($pathInfo, 3));
     }
@@ -657,11 +655,10 @@ protected function getEndpoint(): string
      *
      * @param string $word
      * @return bool
-     * @throws CaseUnsupportedException
      */
     protected function endpointContains(string $word): bool
     {
-        $pathInfo = explode('/', $this->getCurrentRequest()->getPathInfo());
+        $pathInfo = explode('/', $this->getRequest()->getPathInfo());
 
         return in_array($word, $pathInfo);
     }

src/ApiPlatform/State/VersionProvider.php

@@ -42,13 +42,13 @@ final class VersionProvider extends BaseRawProvider
      * VersionProvider constructor.
      *
      * @param ParameterBagInterface $parameterBag
-     * @param RequestStack $request
+     * @param RequestStack $requestStack
      */
-    public function __construct(protected ParameterBagInterface $parameterBag, protected RequestStack $request)
+    public function __construct(protected ParameterBagInterface $parameterBag, protected RequestStack $requestStack)
     {
         $this->version = new Version();
 
-        parent::__construct($parameterBag, $request);
+        parent::__construct($parameterBag, $requestStack);
     }
 
     /**