Creating hydrator container

Author: akadlec

phpstan.neon

@@ -1,9 +1,10 @@
 parameters:
-	level: max
-	stubFiles:
-		- tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Factories/FactoryInterface.php
-		- tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Schema/ContextInterface.php
-		- tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Schema/LinkInterface.php
-		- tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Schema/SchemaContainerInterface.php
-		- tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Schema/SchemaInterface.php
-		- tests/PHPStan/stubs/Neomerx/JsonApi/Factories/Factory.php
+    level: max
+    stubFiles:
+        - tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Factories/FactoryInterface.php
+        - tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Schema/ContextInterface.php
+        - tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Schema/LinkInterface.php
+        - tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Schema/SchemaContainerInterface.php
+        - tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Schema/SchemaInterface.php
+        - tests/PHPStan/stubs/Neomerx/JsonApi/Factories/Factory.php
+    checkGenericClassInNonGenericObjectType: false

src/DI/JsonApiExtension.php

@@ -17,6 +17,7 @@
 
 use FastyBird\JsonApi\Builder;
 use FastyBird\JsonApi\Helpers;
+use FastyBird\JsonApi\Hydrators;
 use FastyBird\JsonApi\JsonApi;
 use FastyBird\JsonApi\Middleware;
 use FastyBird\JsonApi\Schemas;
@@ -96,6 +97,9 @@ public function loadConfiguration(): void
 				],
 			]);
 
+		$builder->addDefinition($this->prefix('hydrators.container'), new DI\Definitions\ServiceDefinition())
+			->setType(Hydrators\HydratorsContainer::class);
+
 		$builder->addDefinition($this->prefix('schemas.container'), new DI\Definitions\ServiceDefinition())
 			->setType(JsonApi\JsonApiSchemaContainer::class);
 
@@ -130,6 +134,23 @@ public function beforeCompile(): void
 				$schemaContainerService->addSetup('add', [$schemasService]);
 			}
 		}
+
+		/**
+		 * JSON:API HYDRATORS
+		 */
+
+		$hydratorContainerServiceName = $builder->getByType(Hydrators\HydratorsContainer::class, true);
+
+		if ($hydratorContainerServiceName !== null) {
+			$hydratorContainerService = $builder->getDefinition($hydratorContainerServiceName);
+			assert($hydratorContainerService instanceof DI\Definitions\ServiceDefinition);
+
+			$hydratorsServices = $builder->findByType(Hydrators\Hydrator::class);
+
+			foreach ($hydratorsServices as $hydratorService) {
+				$hydratorContainerService->addSetup('add', [$hydratorService]);
+			}
+		}
 	}
 
 }

src/Hydrators/Hydrator.php

@@ -241,6 +241,13 @@ public function hydrate(
 		return $result;
 	}
 
+	/**
+	 * @return string
+	 *
+	 * @phpstan-return class-string
+	 */
+	abstract public function getEntityName(): string;
+
 	/**
 	 * @param string $entityClassName
 	 *
@@ -685,13 +692,6 @@ private function parseAnnotation(ReflectionProperty $rp, string $name): ?string
 		return null;
 	}
 
-	/**
-	 * @return string
-	 *
-	 * @phpstan-return class-string
-	 */
-	abstract protected function getEntityName(): string;
-
 	/**
 	 * @param string $className
 	 * @param JsonAPIDocument\Objects\IStandardObject<string, mixed> $attributes

src/Hydrators/HydratorsContainer.php

@@ -0,0 +1,81 @@
+<?php declare(strict_types = 1);
+
+/**
+ * HydratorsContainer.php
+ *
+ * @license        More in LICENSE.md
+ * @copyright      https://www.fastybird.com
+ * @author         Adam Kadlec <[email protected]>
+ * @package        FastyBird:JsonApi!
+ * @subpackage     Hydrators
+ * @since          0.7.0
+ *
+ * @date           11.01.22
+ */
+
+namespace FastyBird\JsonApi\Hydrators;
+
+use FastyBird\JsonApi\JsonApi;
+use IPub\JsonAPIDocument;
+use SplObjectStorage;
+
+/**
+ * API hydrators container
+ *
+ * @package        FastyBird:JsonApi!
+ * @subpackage     Hydrators
+ */
+class HydratorsContainer
+{
+
+	/** @var SplObjectStorage<Hydrator, null> */
+	private SplObjectStorage $hydrators;
+
+	/** @var JsonApi\JsonApiSchemaContainer */
+	private JsonApi\JsonApiSchemaContainer $jsonApiSchemaContainer;
+
+	public function __construct(
+		JsonApi\JsonApiSchemaContainer $jsonApiSchemaContainer
+	) {
+		$this->jsonApiSchemaContainer = $jsonApiSchemaContainer;
+
+		$this->hydrators = new SplObjectStorage();
+	}
+
+	/**
+	 * @param JsonAPIDocument\IDocument $document
+	 *
+	 * @return Hydrator|null
+	 *
+	 * @phpstan-return Hydrator|null
+	 */
+	public function findHydrator(JsonAPIDocument\IDocument $document): ?Hydrator
+	{
+		$this->hydrators->rewind();
+
+		foreach ($this->hydrators as $hydrator) {
+			$schema = $this->jsonApiSchemaContainer->getSchemaByClassName($hydrator->getEntityName());
+
+			if ($schema->getType() === $document->getResource()->getType()) {
+				return $hydrator;
+			}
+		}
+
+		return null;
+	}
+
+	/**
+	 * @param Hydrator $hydrator
+	 *
+	 * @return void
+	 *
+	 * @phpstan-param Hydrator $hydrator
+	 */
+	public function add(Hydrator $hydrator): void
+	{
+		if (!$this->hydrators->contains($hydrator)) {
+			$this->hydrators->attach($hydrator);
+		}
+	}
+
+}

src/JsonApi/JsonApiSchemaContainer.php

@@ -15,6 +15,7 @@
 
 namespace FastyBird\JsonApi\JsonApi;
 
+use FastyBird\JsonApi\Exceptions;
 use FastyBird\JsonApi\Schemas;
 use Neomerx\JsonApi;
 
@@ -52,6 +53,22 @@ public function add(Schemas\IJsonApiSchema $schema): void
 		$this->setCreatedProvider($schema->getEntityClass(), $schema);
 	}
 
+	/**
+	 * @param string $resourceType
+	 *
+	 * @return Schemas\IJsonApiSchema
+	 */
+	public function getSchemaByClassName(string $resourceType): Schemas\IJsonApiSchema
+	{
+		$schema = $this->getSchemaByType($resourceType);
+
+		if ($schema instanceof Schemas\IJsonApiSchema) {
+			return $schema;
+		}
+
+		throw new Exceptions\InvalidStateException('');
+	}
+
 	/**
 	 * {@inheritDoc}
 	 */