Containers

Author: ariademur

composer.json

@@ -29,6 +29,7 @@
         "fig/http-message-util": "^1",
         "psr/http-message": "^2",
         "webservco/data": "^0",
+        "webservco/dependency-container": "^0",
         "webservco/form": "^0",
         "webservco/http": "^0",
         "webservco/jsonapi": "^0",

src/WebServCo/JSONAPI/Container/APIJSONAPIServiceContainer.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WebServCo\JSONAPI\Container;
+
+use WebServCo\JSONAPI\Contract\Service\Container\APIJSONAPIServiceContainerInterface;
+
+/**
+ * A default JSONAPI service container implementation for API endpoints.
+ *
+ * Can be used directly if no special dependencies are required.
+ */
+final class APIJSONAPIServiceContainer extends AbstractJSONAPIServiceContainer implements
+    APIJSONAPIServiceContainerInterface
+{
+}

src/WebServCo/JSONAPI/Container/APILocalServiceContainer.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WebServCo\JSONAPI\Container;
+
+use WebServCo\Data\Contract\Extraction\DataExtractionContainerInterface;
+use WebServCo\JSONAPI\Contract\Service\Container\APIJSONAPIServiceContainerInterface;
+use WebServCo\JSONAPI\Contract\Service\Container\APILocalServiceContainerInterface;
+
+/**
+ * A default local service container implementation for API endpoints.
+ *
+ * Can be used directly if no special dependencies are required.
+ */
+final class APILocalServiceContainer implements APILocalServiceContainerInterface
+{
+    private ?APIJSONAPIServiceContainerInterface $jsonApiServiceContainer = null;
+
+    public function __construct(private DataExtractionContainerInterface $dataExtractionContainer)
+    {
+    }
+
+    public function getJsonApiServiceContainer(): APIJSONAPIServiceContainerInterface
+    {
+        if ($this->jsonApiServiceContainer === null) {
+            $this->jsonApiServiceContainer = new APIJSONAPIServiceContainer($this->dataExtractionContainer);
+        }
+
+        return $this->jsonApiServiceContainer;
+    }
+}

src/WebServCo/JSONAPI/Container/AbstractJSONAPIServiceContainer.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WebServCo\JSONAPI\Container;
+
+use WebServCo\Data\Contract\Extraction\DataExtractionContainerInterface;
+use WebServCo\Http\Service\Message\Request\RequestBodyService;
+use WebServCo\Http\Service\Message\Request\RequestHeaderService;
+use WebServCo\JSONAPI\Contract\Factory\Handler\JSONAPIHandlerFactoryInterface;
+use WebServCo\JSONAPI\Contract\Service\Container\JSONAPIServiceContainerInterface;
+use WebServCo\JSONAPI\Contract\Service\JSONAPIRequestServiceInterface;
+use WebServCo\JSONAPI\Factory\Handler\JSONAPIDefaultHandlerFactory;
+use WebServCo\JSONAPI\Service\JSONAPIRequestService;
+
+/**
+ * An abstract JSONAPIServiceContainerInterface implementation.
+ */
+abstract class AbstractJSONAPIServiceContainer implements JSONAPIServiceContainerInterface
+{
+    private ?JSONAPIHandlerFactoryInterface $defaultItemHandlerFactory = null;
+
+    private ?JSONAPIRequestServiceInterface $jsonApiRequestService = null;
+
+    public function __construct(protected DataExtractionContainerInterface $dataExtractionContainer)
+    {
+    }
+
+    public function getDefaultHandlerFactory(): JSONAPIHandlerFactoryInterface
+    {
+        if ($this->defaultItemHandlerFactory === null) {
+            $this->defaultItemHandlerFactory = new JSONAPIDefaultHandlerFactory(
+                $this->dataExtractionContainer,
+                $this->getJsonApiRequestService(),
+            );
+        }
+
+        return $this->defaultItemHandlerFactory;
+    }
+
+    public function getJsonApiRequestService(): JSONAPIRequestServiceInterface
+    {
+        if ($this->jsonApiRequestService === null) {
+            $this->jsonApiRequestService = new JSONAPIRequestService(
+                $this->dataExtractionContainer,
+                new RequestBodyService(),
+                new RequestHeaderService(),
+            );
+        }
+
+        return $this->jsonApiRequestService;
+    }
+}

src/WebServCo/JSONAPI/Contract/Factory/Handler/JSONAPIHandlerFactoryInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WebServCo\JSONAPI\Contract\Factory\Handler;
+
+use WebServCo\JSONAPI\Contract\Service\JSONAPIHandlerInterface;
+
+/**
+ * A JSONAPI Handler Factory Interface.
+ */
+interface JSONAPIHandlerFactoryInterface
+{
+    public function createHandler(): JSONAPIHandlerInterface;
+}

src/WebServCo/JSONAPI/Contract/Service/Container/APIJSONAPIServiceContainerInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WebServCo\JSONAPI\Contract\Service\Container;
+
+/**
+ * A default JSONAPI Service Container Interface for API endpoints.
+ *
+ * Can be used directly if no special dependencies are required.
+ */
+interface APIJSONAPIServiceContainerInterface extends JSONAPIServiceContainerInterface
+{
+}

src/WebServCo/JSONAPI/Contract/Service/Container/APILocalServiceContainerInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WebServCo\JSONAPI\Contract\Service\Container;
+
+use WebServCo\DependencyContainer\Contract\LocalDependencyContainerInterface;
+
+/**
+ * A default Local service container for API endpoints.
+ *
+ * Can be used directly if no special dependencies are required.
+ */
+interface APILocalServiceContainerInterface extends LocalDependencyContainerInterface
+{
+    public function getJsonApiServiceContainer(): APIJSONAPIServiceContainerInterface;
+}

src/WebServCo/JSONAPI/Contract/Service/Container/JSONAPIServiceContainerInterface.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WebServCo\JSONAPI\Contract\Service\Container;
+
+use WebServCo\JSONAPI\Contract\Factory\Handler\JSONAPIHandlerFactoryInterface;
+use WebServCo\JSONAPI\Contract\Service\JSONAPIRequestServiceInterface;
+
+/**
+ * A JSONAPI Service Container Interface.
+ */
+interface JSONAPIServiceContainerInterface
+{
+    /**
+     * A factory for a default JSONAPI handler.
+     *
+     * Use case: no custom JSONAPI handler implementation is needed.
+     */
+    public function getDefaultHandlerFactory(): JSONAPIHandlerFactoryInterface;
+
+    public function getJsonApiRequestService(): JSONAPIRequestServiceInterface;
+}

src/WebServCo/JSONAPI/Factory/Handler/JSONAPIDefaultHandlerFactory.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WebServCo\JSONAPI\Factory\Handler;
+
+use Fig\Http\Message\RequestMethodInterface;
+use WebServCo\Data\Contract\Extraction\DataExtractionContainerInterface;
+use WebServCo\JSONAPI\Contract\Factory\Handler\JSONAPIHandlerFactoryInterface;
+use WebServCo\JSONAPI\Contract\Service\JSONAPIHandlerInterface;
+use WebServCo\JSONAPI\Contract\Service\JSONAPIRequestServiceInterface;
+use WebServCo\JSONAPI\Service\Handler\JSONAPIItemHandler;
+
+/**
+ * Creates a default JSONAPI GET handler.
+ *
+ * Use case: take advantage of form validation to handle JSONAPI request errors.
+ */
+final class JSONAPIDefaultHandlerFactory implements JSONAPIHandlerFactoryInterface
+{
+    public function __construct(
+        private DataExtractionContainerInterface $dataExtractionContainer,
+        private JSONAPIRequestServiceInterface $jsonApiRequestService,
+    ) {
+    }
+
+    public function createHandler(): JSONAPIHandlerInterface
+    {
+        return new JSONAPIItemHandler(
+            [
+                RequestMethodInterface::METHOD_GET,
+            ],
+            $this->dataExtractionContainer,
+            $this->jsonApiRequestService,
+            // no fields
+            [],
+            // no filters
+            [],
+            // no validators
+            [],
+        );
+    }
+}