HP-2419 extended functional of BillingRegistry for easier use

src/product/Application/BillingRegistryService.php

@@ -0,0 +1,166 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product\Application;
+
+use hiqdev\php\billing\product\AggregateInterface;
+use hiqdev\php\billing\product\behavior\BehaviorInterface;
+use hiqdev\php\billing\product\behavior\BehaviorNotFoundException;
+use hiqdev\php\billing\product\behavior\InvalidBehaviorException;
+use hiqdev\php\billing\product\BillingRegistryInterface;
+use hiqdev\php\billing\product\Exception\AggregateNotFoundException;
+use hiqdev\php\billing\product\Exception\TariffTypeDefinitionNotFoundException;
+use hiqdev\php\billing\product\invoice\InvalidRepresentationException;
+use hiqdev\php\billing\product\invoice\RepresentationInterface;
+use hiqdev\php\billing\product\price\PriceTypeDefinitionInterface;
+use hiqdev\php\billing\product\quantity\FractionQuantityData;
+use hiqdev\php\billing\product\quantity\QuantityFormatterInterface;
+use hiqdev\php\billing\product\quantity\QuantityFormatterNotFoundException;
+use hiqdev\php\billing\product\TariffTypeDefinitionInterface;
+use hiqdev\php\billing\type\Type;
+use hiqdev\php\billing\type\TypeInterface;
+
+final class BillingRegistryService implements BillingRegistryServiceInterface
+{
+    public function __construct(private readonly BillingRegistryInterface $registry)
+    {
+    }
+
+    public function getRepresentationsByType(string $representationClass): array
+    {
+        if (!class_exists($representationClass)) {
+            throw new InvalidRepresentationException("Class '$representationClass' does not exist");
+        }
+
+        if (!is_subclass_of($representationClass, RepresentationInterface::class)) {
+            throw new InvalidBehaviorException(
+                sprintf('Representation class "%s" does not implement RepresentationInterface', $representationClass)
+            );
+        }
+
+        $representations = [];
+        foreach ($this->registry->priceTypes() as $priceTypeDefinition) {
+            foreach ($priceTypeDefinition->documentRepresentation() as $representation) {
+                if ($representation instanceof $representationClass) {
+                    $representations[] = $representation;
+                }
+            }
+        }
+
+        return $representations;
+    }
+
+    public function createQuantityFormatter(string $type, FractionQuantityData $data): QuantityFormatterInterface {
+        $type = $this->convertStringTypeToType($type);
+
+        foreach ($this->registry->priceTypes() as $priceTypeDefinition) {
+            if ($priceTypeDefinition->hasType($type)) {
+                return $priceTypeDefinition->createQuantityFormatter($data);
+            }
+        }
+
+        throw new QuantityFormatterNotFoundException('Quantity formatter not found');
+    }
+
+    private function convertStringTypeToType(string $type): TypeInterface
+    {
+        return Type::anyId($type);
+    }
+
+    public function getBehavior(string $type, string $behaviorClassWrapper): BehaviorInterface
+    {
+        if (!class_exists($behaviorClassWrapper)) {
+            throw new InvalidBehaviorException(
+                sprintf('Behavior class "%s" does not exist', $behaviorClassWrapper)
+            );
+        }
+
+        if (!is_subclass_of($behaviorClassWrapper, BehaviorInterface::class)) {
+            throw new InvalidBehaviorException(
+                sprintf('Behavior class "%s" does not implement BehaviorInterface', $behaviorClassWrapper)
+            );
+        }
+
+        $billingType = $this->convertStringTypeToType($type);
+
+        foreach ($this->registry->priceTypes() as $priceTypeDefinition) {
+            if ($priceTypeDefinition->hasType($billingType)) {
+                $behavior = $this->findBehaviorInPriceType($priceTypeDefinition, $behaviorClassWrapper);
+
+                if ($behavior) {
+                    return $behavior;
+                }
+            }
+        }
+
+        throw new BehaviorNotFoundException(
+            sprintf('Behavior of class "%s" not found for type "%s"', $behaviorClassWrapper, $type),
+        );
+    }
+
+    private function findBehaviorInPriceType(
+        PriceTypeDefinitionInterface $priceTypeDefinition,
+        string $behaviorClassWrapper
+    ): ?BehaviorInterface {
+        foreach ($priceTypeDefinition->withBehaviors() as $behavior) {
+            if ($behavior instanceof $behaviorClassWrapper) {
+                return $behavior;
+            }
+        }
+
+        return null;
+    }
+
+    public function getBehaviors(string $behaviorClassWrapper): \Generator
+    {
+        foreach ($this->registry->getTariffTypeDefinitions() as $tariffTypeDefinition) {
+            foreach ($tariffTypeDefinition->withBehaviors() as $behavior) {
+                if ($behavior instanceof $behaviorClassWrapper) {
+                    yield $behavior;
+                }
+            }
+        }
+
+        foreach ($this->registry->priceTypes() as $priceTypeDefinition) {
+            foreach ($priceTypeDefinition->withBehaviors() as $behavior) {
+                if ($behavior instanceof $behaviorClassWrapper) {
+                    yield $behavior;
+                }
+            }
+        }
+    }
+
+    public function getAggregate(string $type): AggregateInterface
+    {
+        $type = $this->convertStringTypeToType($type);
+
+        foreach ($this->registry->priceTypes() as $priceTypeDefinition) {
+            if ($priceTypeDefinition->hasType($type)) {
+                return $priceTypeDefinition->getAggregate();
+            }
+        }
+
+        throw new AggregateNotFoundException('Aggregate was not found');
+    }
+
+    public function findTariffTypeDefinitionByBehavior(BehaviorInterface $behavior): TariffTypeDefinitionInterface
+    {
+        $tariffType = $behavior->getTariffType();
+
+        foreach ($this->registry->getTariffTypeDefinitions() as $tariffTypeDefinition) {
+            if ($tariffTypeDefinition->belongToTariffType($tariffType)) {
+                return $tariffTypeDefinition;
+            }
+        }
+
+        throw new TariffTypeDefinitionNotFoundException('Tariff type definition was not found');
+    }
+
+    public function findPriceTypeDefinitionsByBehavior(string $behaviorClassWrapper): \Generator
+    {
+        foreach ($this->registry->priceTypes() as $priceTypeDefinition) {
+            if ($priceTypeDefinition->hasBehavior($behaviorClassWrapper)) {
+                yield $priceTypeDefinition;
+            }
+        }
+    }
+}

src/product/Application/BillingRegistryServiceInterface.php

@@ -0,0 +1,54 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product\Application;
+
+use Generator;
+use hiqdev\php\billing\product\AggregateInterface;
+use hiqdev\php\billing\product\behavior\BehaviorInterface;
+use hiqdev\php\billing\product\behavior\BehaviorNotFoundException;
+use hiqdev\php\billing\product\behavior\InvalidBehaviorException;
+use hiqdev\php\billing\product\invoice\RepresentationInterface;
+use hiqdev\php\billing\product\price\PriceTypeDefinitionInterface;
+use hiqdev\php\billing\product\quantity\FractionQuantityData;
+use hiqdev\php\billing\product\quantity\QuantityFormatterInterface;
+use hiqdev\php\billing\product\TariffTypeDefinitionInterface;
+
+interface BillingRegistryServiceInterface
+{
+    /**
+     * @param string $representationClass
+     * @return RepresentationInterface[]
+     */
+    public function getRepresentationsByType(string $representationClass): array;
+
+    public function createQuantityFormatter(string $type, FractionQuantityData $data): QuantityFormatterInterface;
+
+    /**
+     * @param string $type - full type like 'overuse,lb_capacity_unit'
+     * @param string $behaviorClassWrapper
+     * @return BehaviorInterface
+     * @throws BehaviorNotFoundException
+     * @throws InvalidBehaviorException
+     */
+    public function getBehavior(string $type, string $behaviorClassWrapper): BehaviorInterface;
+
+    /**
+     * Find all behaviors attached to any TariffType or PriceType by specified Behavior class.
+     *
+     * @param string $behaviorClassWrapper
+     * @return Generator<BehaviorInterface>
+     */
+    public function getBehaviors(string $behaviorClassWrapper): Generator;
+
+    public function getAggregate(string $type): AggregateInterface;
+
+    public function findTariffTypeDefinitionByBehavior(BehaviorInterface $behavior): TariffTypeDefinitionInterface;
+
+    /**
+     * Find all PriceTypeDefinition in registry by specified Behavior class.
+     *
+     * @param string $behaviorClassWrapper
+     * @return Generator<PriceTypeDefinitionInterface>
+     */
+    public function findPriceTypeDefinitionsByBehavior(string $behaviorClassWrapper): Generator;
+}

src/product/BillingRegistry.php

@@ -2,27 +2,14 @@
 
 namespace hiqdev\php\billing\product;
 
-use hiqdev\php\billing\product\behavior\InvalidBehaviorException;
-use hiqdev\php\billing\product\Exception\AggregateNotFoundException;
-use hiqdev\php\billing\product\invoice\InvalidRepresentationException;
-use hiqdev\php\billing\product\invoice\RepresentationInterface;
-use hiqdev\php\billing\product\price\PriceTypeDefinition;
-use hiqdev\php\billing\product\quantity\QuantityFormatterInterface;
-use hiqdev\php\billing\product\quantity\QuantityFormatterNotFoundException;
-use hiqdev\php\billing\product\quantity\FractionQuantityData;
-use hiqdev\php\billing\product\behavior\BehaviorInterface;
-use hiqdev\php\billing\product\behavior\BehaviorNotFoundException;
 use hiqdev\php\billing\product\trait\HasLock;
-use hiqdev\php\billing\type\Type;
-use hiqdev\php\billing\type\TypeInterface;
 
 class BillingRegistry implements BillingRegistryInterface
 {
     use HasLock;
 
     /** @var TariffTypeDefinitionInterface[] */
     private array $tariffTypeDefinitions = [];
-    private bool $locked = false;
 
     public function addTariffType(TariffTypeDefinitionInterface $tariffTypeDefinition): void
     {
@@ -31,140 +18,18 @@ public function addTariffType(TariffTypeDefinitionInterface $tariffTypeDefinitio
         $this->tariffTypeDefinitions[] = $tariffTypeDefinition;
     }
 
-    public function priceTypes(): \Generator
-    {
-        foreach ($this->tariffTypeDefinitions as $tariffTypeDefinition) {
-            foreach ($tariffTypeDefinition->withPrices() as $priceTypeDefinition) {
-                yield $priceTypeDefinition;
-            }
-        }
-    }
-
-    public function getRepresentationsByType(string $representationClass): array
-    {
-        if (!class_exists($representationClass)) {
-            throw new InvalidRepresentationException("Class '$representationClass' does not exist");
-        }
-
-        if (!is_subclass_of($representationClass, RepresentationInterface::class)) {
-            throw new InvalidBehaviorException(
-                sprintf('Representation class "%s" does not implement RepresentationInterface', $representationClass)
-            );
-        }
-
-        $representations = [];
-        foreach ($this->priceTypes() as $priceTypeDefinition) {
-            foreach ($priceTypeDefinition->documentRepresentation() as $representation) {
-                if ($representation instanceof $representationClass) {
-                    $representations[] = $representation;
-                }
-            }
-        }
-
-        return $representations;
-    }
-
-    public function createQuantityFormatter(
-        string $type,
-        FractionQuantityData $data,
-    ): QuantityFormatterInterface {
-        $type = $this->convertStringTypeToType($type);
-
-        foreach ($this->priceTypes() as $priceTypeDefinition) {
-            if ($priceTypeDefinition->hasType($type)) {
-                return $priceTypeDefinition->createQuantityFormatter($data);
-            }
-        }
-
-        throw new QuantityFormatterNotFoundException('Quantity formatter not found');
-    }
-
-    private function convertStringTypeToType(string $type): TypeInterface
-    {
-        return Type::anyId($type);
-    }
-
-    public function getBehavior(string $type, string $behaviorClassWrapper): BehaviorInterface
-    {
-        if (!class_exists($behaviorClassWrapper)) {
-            throw new InvalidBehaviorException(
-                sprintf('Behavior class "%s" does not exist', $behaviorClassWrapper)
-            );
-        }
-
-        if (!is_subclass_of($behaviorClassWrapper, BehaviorInterface::class)) {
-            throw new InvalidBehaviorException(
-                sprintf('Behavior class "%s" does not implement BehaviorInterface', $behaviorClassWrapper)
-            );
-        }
-
-        $billingType = $this->convertStringTypeToType($type);
-
-        foreach ($this->priceTypes() as $priceTypeDefinition) {
-            if ($priceTypeDefinition->hasType($billingType)) {
-                $behavior = $this->findBehaviorInPriceType($priceTypeDefinition, $behaviorClassWrapper);
-
-                if ($behavior) {
-                    return $behavior;
-                }
-            }
-        }
-
-        throw new BehaviorNotFoundException(
-            sprintf('Behavior of class "%s" not found for type "%s"', $behaviorClassWrapper, $type),
-        );
-    }
-
-    private function findBehaviorInPriceType(
-        PriceTypeDefinition $priceTypeDefinition,
-        string $behaviorClassWrapper
-    ): ?BehaviorInterface {
-        foreach ($priceTypeDefinition->withBehaviors() as $behavior) {
-            if ($behavior instanceof $behaviorClassWrapper) {
-                return $behavior;
-            }
-        }
-
-        return null;
-    }
-
-    public function getBehaviors(string $behaviorClassWrapper): \Generator
+    public function getTariffTypeDefinitions(): array
     {
-        foreach ($this->tariffTypeDefinitions as $tariffTypeDefinition) {
-            foreach ($tariffTypeDefinition->withBehaviors() as $behavior) {
-                if ($behavior instanceof $behaviorClassWrapper) {
-                    yield $behavior;
-                }
-            }
-        }
-
-        foreach ($this->priceTypes() as $priceTypeDefinition) {
-            foreach ($priceTypeDefinition->withBehaviors() as $behavior) {
-                if ($behavior instanceof $behaviorClassWrapper) {
-                    yield $behavior;
-                }
-            }
-        }
+        return $this->tariffTypeDefinitions;
     }
 
-    public function getAggregate(string $type): AggregateInterface
+    public function priceTypes(): \Generator
     {
-        $type = $this->convertStringTypeToType($type);
-
-        foreach ($this->priceTypes() as $priceTypeDefinition) {
-            if ($priceTypeDefinition->hasType($type)) {
-                return $priceTypeDefinition->getAggregate();
+        foreach ($this->getTariffTypeDefinitions() as $tariffTypeDefinition) {
+            foreach ($tariffTypeDefinition->withPrices() as $priceTypeDefinition) {
+                yield $priceTypeDefinition;
             }
         }
-
-        throw new AggregateNotFoundException('Aggregate was not found');
-    }
-
-    public function getTariffTypeDefinitions(): \Generator
-    {
-        foreach ($this->tariffTypeDefinitions as $tariffTypeDefinition) {
-            yield $tariffTypeDefinition;
-        }
     }
 
     protected function afterLock(): void