Add ApiPlatform State Helper

Author: bjoern-hempel

composer.json

@@ -25,7 +25,7 @@
         "ixnode/php-array-to-object": "^0.1.1",
         "ixnode/php-checker": "^0.1.9",
         "ixnode/php-container": "^0.1.8",
-        "ixnode/php-exception": "^0.1.19",
+        "ixnode/php-exception": "^0.1.20",
         "ixnode/php-json-schema-validator": "^0.1.2",
         "ixnode/php-naming-conventions": "^0.1.1",
         "nelmio/cors-bundle": "^2.2",

composer.lock

@@ -30,6 +30,8 @@ abstract class BaseRoute
 
     final public const KEY_TYPE = 'type';
 
+    final public const TYPE_BOOLEAN = 'boolean';
+
     final public const TYPE_STRING = 'string';
 
     final public const TYPE_ENUM_STRING = 'string';

src/ApiPlatform/Route/Base/BaseRoute.php

@@ -21,13 +21,17 @@
 use Ixnode\PhpApiVersionBundle\Utils\TypeCasting\TypeCastingHelper;
 use Ixnode\PhpException\ArrayType\ArrayKeyNotFoundException;
 use Ixnode\PhpException\Case\CaseInvalidException;
+use Ixnode\PhpException\Case\CaseUnsupportedException;
 use Ixnode\PhpException\Type\TypeInvalidException;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputDefinition;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+use Symfony\Component\HttpFoundation\HeaderBag;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
 
 /**
  * Class BaseProvider
@@ -47,16 +51,17 @@ abstract class BaseProvider implements ProviderInterface, ProcessorInterface
     /** @var array<string, mixed> $inputArgumentValues */
     protected array $inputArgumentValues = [];
 
-    protected const NAME_KERNEL_PROJECT_DIR = 'kernel.project_dir';
+    protected ?string $error = null;
+
+    final public const NAME_KERNEL_PROJECT_DIR = 'kernel.project_dir';
 
     protected const TEXT_UNDEFINED_METHOD = 'Please overwrite the "%s" method in your provider to use this function.';
 
     /**
-     * BaseProvider constructor.
-     *
      * @param ParameterBagInterface $parameterBag
+     * @param RequestStack $request
      */
-    public function __construct(protected ParameterBagInterface $parameterBag)
+    public function __construct(protected ParameterBagInterface $parameterBag, protected RequestStack $request)
     {
         $this->input = new ArrayInput([]);
     }
@@ -65,19 +70,25 @@ public function __construct(protected ParameterBagInterface $parameterBag)
      * Do the provided job and returns the base resource.
      *
      * @return BasePublicResource|BasePublicResource[]
-     * @throws CaseInvalidException
+     * @throws CaseUnsupportedException
      * @noRector
      */
-    abstract protected function doProvide(): BasePublicResource|array;
+    protected function doProvide(): BasePublicResource|array
+    {
+        throw new CaseUnsupportedException(sprintf(self::TEXT_UNDEFINED_METHOD, __METHOD__));
+    }
 
     /**
      * Do the processed job and returns the resource wrapper.
      *
      * @return BasePublicResource
-     * @throws CaseInvalidException
+     * @throws CaseUnsupportedException
      * @noRector
      */
-    abstract protected function doProcess(): BasePublicResource;
+    protected function doProcess(): BasePublicResource
+    {
+        throw new CaseUnsupportedException(sprintf(self::TEXT_UNDEFINED_METHOD, __METHOD__));
+    }
 
     /**
      * Binds given input definitions.
@@ -141,6 +152,7 @@ protected function getRouteProperties(): array
      * Gets the project directory.
      *
      * @return string
+     * @throws TypeInvalidException
      * @throws ArrayKeyNotFoundException
      * @throws TypeInvalidException
      */
@@ -152,4 +164,208 @@ protected function getProjectDir(): string
 
         return (new TypeCastingHelper($this->parameterBag->get(self::NAME_KERNEL_PROJECT_DIR)))->strval();
     }
+
+    /**
+     * Returns the current request.
+     *
+     * @return Request
+     * @throws CaseUnsupportedException
+     */
+    protected function getCurrentRequest(): 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;
+    }
+
+    /**
+     * Returns the header bag.
+     *
+     * @return HeaderBag
+     * @throws CaseUnsupportedException
+     */
+    protected function getHeaderBag(): HeaderBag
+    {
+        $currentRequest = $this->getCurrentRequest();
+
+        return $currentRequest->headers;
+    }
+
+    /**
+     * Returns if the given name exists as a header request.
+     *
+     * @param string $name
+     * @return bool
+     * @throws CaseUnsupportedException
+     */
+    public function hasHeader(string $name): bool
+    {
+        $headerBag = $this->getHeaderBag();
+
+        return $headerBag->has($name);
+    }
+
+    /**
+     * Returns the header bag request.
+     *
+     * @param string $name
+     * @return string|null
+     * @throws ArrayKeyNotFoundException
+     * @throws CaseUnsupportedException
+     */
+    public function getHeader(string $name): ?string
+    {
+        if (!$this->hasHeader($name)) {
+            throw new ArrayKeyNotFoundException($name);
+        }
+
+        return $this->getHeaderBag()->get($name);
+    }
+
+    /**
+     * Returns the given name from header (as string).
+     *
+     * @param string $name
+     * @return string|null
+     * @throws CaseUnsupportedException
+     */
+    public function getHeaderAsStringOrNull(string $name): ?string
+    {
+        if (!$this->hasHeader($name)) {
+            return null;
+        }
+
+        return strval($this->getHeaderBag()->get($name));
+    }
+
+    /**
+     * Returns the given name from header (as string).
+     *
+     * @param string $name
+     * @return string
+     * @throws CaseUnsupportedException
+     */
+    public function getHeaderAsString(string $name): string
+    {
+        if (!$this->hasHeader($name)) {
+            throw new CaseUnsupportedException(sprintf('Header missing "%s"', $name));
+        }
+
+        return strval($this->getHeaderBag()->get($name));
+    }
+
+    /**
+     * Returns the given name from header (as float).
+     *
+     * @param string $name
+     * @return float|null
+     * @throws CaseUnsupportedException
+     */
+    public function getHeaderAsFloatOrNull(string $name): ?float
+    {
+        if (!$this->hasHeader($name)) {
+            return null;
+        }
+
+        return floatval($this->getHeaderBag()->get($name));
+    }
+
+    /**
+     * Returns the given name from header (as float).
+     *
+     * @param string $name
+     * @return float
+     * @throws CaseUnsupportedException
+     */
+    public function getHeaderAsFloat(string $name): float
+    {
+        if (!$this->hasHeader($name)) {
+            throw new CaseUnsupportedException(sprintf('Header missing "%s"', $name));
+        }
+
+        return floatval($this->getHeaderBag()->get($name));
+    }
+
+    /**
+     * Returns the given name from header (as integer).
+     *
+     * @param string $name
+     * @return int|null
+     * @throws CaseUnsupportedException
+     */
+    public function getHeaderAsIntOrNull(string $name): ?int
+    {
+        if (!$this->hasHeader($name)) {
+            return null;
+        }
+
+        return intval($this->getHeaderBag()->get($name));
+    }
+
+    /**
+     * Returns the given name from header (as integer).
+     *
+     * @param string $name
+     * @return int
+     * @throws CaseUnsupportedException
+     */
+    public function getHeaderAsInt(string $name): int
+    {
+        if (!$this->hasHeader($name)) {
+            throw new CaseUnsupportedException(sprintf('Header missing "%s"', $name));
+        }
+
+        return intval($this->getHeaderBag()->get($name));
+    }
+
+    /**
+     * Returns the given name from header (as bool).
+     *
+     * @param string $name
+     * @return bool
+     * @throws CaseInvalidException
+     * @throws CaseUnsupportedException
+     * @throws TypeInvalidException
+     */
+    public function isHeaderAsBoolean(string $name): bool
+    {
+        if (!$this->hasHeader($name)) {
+            return false;
+        }
+
+        $value = (new TypeCastingHelper($this->getHeaderBag()->get($name)))->strval();
+
+        return match ($value) {
+            'true' => true,
+            'false' => false,
+            default => throw new CaseInvalidException($value, ['true', 'false']),
+        };
+    }
+
+    /**
+     * Gets an error of this resource.
+     *
+     * @return string|null
+     */
+    protected function getError(): ?string
+    {
+        return $this->error;
+    }
+
+    /**
+     * Sets an error of this resource.
+     *
+     * @param string|null $error
+     * @return self
+     */
+    protected function setError(?string $error): self
+    {
+        $this->error = $error;
+
+        return $this;
+    }
 }

src/ApiPlatform/State/Base/BaseProvider.php

@@ -16,8 +16,9 @@
 use ApiPlatform\Metadata\Operation;
 use Ixnode\PhpApiVersionBundle\ApiPlatform\Resource\Base\BasePublicResource;
 use Ixnode\PhpApiVersionBundle\ApiPlatform\State\Base\BaseProvider;
-use Ixnode\PhpException\Case\CaseInvalidException;
+use Ixnode\PhpException\Case\CaseUnsupportedException;
 use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
 
 /**
  * Class BaseRawProvider
@@ -40,17 +41,17 @@ abstract class BaseRawProvider extends BaseProvider
     /**
      * BaseDirectProvider constructor.
      */
-    public function __construct(protected ParameterBagInterface $parameterBag)
+    public function __construct(protected ParameterBagInterface $parameterBag, protected RequestStack $request)
     {
-        parent::__construct($this->parameterBag);
+        parent::__construct($this->parameterBag, $this->request);
     }
 
     /**
      * @param Operation $operation
      * @param array<string, mixed> $uriVariables
      * @param array<int|string, mixed> $context
      * @return BasePublicResource|BasePublicResource[]
-     * @throws CaseInvalidException
+     * @throws CaseUnsupportedException
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function provide(Operation $operation, array $uriVariables = [], array $context = []): BasePublicResource|array
@@ -64,7 +65,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
      * @param array<string, mixed> $uriVariables
      * @param array<int|string, mixed> $context
      * @return BasePublicResource
-     * @throws CaseInvalidException
+     * @throws CaseUnsupportedException
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = []): BasePublicResource