HP-2419 implemented Service for BillingRegistry and allow client code to communicate only through it

Author: VadymHrechukha

src/product/BillingRegistryService.php …t/Application/BillingRegistryService.phpsrc/product/BillingRegistryService.php renamed to src/product/Application/BillingRegistryService.php src/product/BillingRegistryService.php renamed to src/product/Application/BillingRegistryService.php

@@ -1,24 +1,27 @@
 <?php declare(strict_types=1);
 
-namespace hiqdev\php\billing\product;
+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\PriceTypeDefinition;
+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;
 
-class BillingRegistryService
+final class BillingRegistryService implements BillingRegistryServiceInterface
 {
-    public function __construct(private readonly BillingRegistry $registry)
+    public function __construct(private readonly BillingRegistryInterface $registry)
     {
     }
 
@@ -46,10 +49,7 @@ public function getRepresentationsByType(string $representationClass): array
         return $representations;
     }
 
-    public function createQuantityFormatter(
-        string $type,
-        FractionQuantityData $data,
-    ): QuantityFormatterInterface {
+    public function createQuantityFormatter(string $type, FractionQuantityData $data): QuantityFormatterInterface {
         $type = $this->convertStringTypeToType($type);
 
         foreach ($this->registry->priceTypes() as $priceTypeDefinition) {
@@ -98,7 +98,7 @@ public function getBehavior(string $type, string $behaviorClassWrapper): Behavio
     }
 
     private function findBehaviorInPriceType(
-        PriceTypeDefinition $priceTypeDefinition,
+        PriceTypeDefinitionInterface $priceTypeDefinition,
         string $behaviorClassWrapper
     ): ?BehaviorInterface {
         foreach ($priceTypeDefinition->withBehaviors() as $behavior) {
@@ -110,9 +110,6 @@ private function findBehaviorInPriceType(
         return null;
     }
 
-    /**
-     * @inerhitDoc
-     */
     public function getBehaviors(string $behaviorClassWrapper): \Generator
     {
         foreach ($this->registry->getTariffTypeDefinitions() as $tariffTypeDefinition) {

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,9 +2,6 @@
 
 namespace hiqdev\php\billing\product;
 
-use hiqdev\php\billing\product\quantity\QuantityFormatterInterface;
-use hiqdev\php\billing\product\quantity\FractionQuantityData;
-use hiqdev\php\billing\product\behavior\BehaviorInterface;
 use hiqdev\php\billing\product\trait\HasLock;
 
 class BillingRegistry implements BillingRegistryInterface
@@ -14,13 +11,6 @@ class BillingRegistry implements BillingRegistryInterface
     /** @var TariffTypeDefinitionInterface[] */
     private array $tariffTypeDefinitions = [];
 
-    private BillingRegistryService $service;
-
-    public function __construct()
-    {
-        $this->service = new BillingRegistryService($this);
-    }
-
     public function addTariffType(TariffTypeDefinitionInterface $tariffTypeDefinition): void
     {
         $this->ensureNotLocked();
@@ -42,46 +32,6 @@ public function priceTypes(): \Generator
         }
     }
 
-    public function getRepresentationsByType(string $representationClass): array
-    {
-        return $this->service->getRepresentationsByType($representationClass);
-    }
-
-    public function createQuantityFormatter(
-        string $type,
-        FractionQuantityData $data,
-    ): QuantityFormatterInterface {
-        return $this->service->createQuantityFormatter($type, $data);
-    }
-
-    public function getBehavior(string $type, string $behaviorClassWrapper): BehaviorInterface
-    {
-        return $this->service->getBehavior($type, $behaviorClassWrapper);
-    }
-
-    /**
-     * @inerhitDoc
-     */
-    public function getBehaviors(string $behaviorClassWrapper): \Generator
-    {
-        return $this->service->getBehaviors($behaviorClassWrapper);
-    }
-
-    public function getAggregate(string $type): AggregateInterface
-    {
-        return $this->service->getAggregate($type);
-    }
-
-    public function findTariffTypeDefinitionByBehavior(BehaviorInterface $behavior): TariffTypeDefinitionInterface
-    {
-        return $this->service->findTariffTypeDefinitionByBehavior($behavior);
-    }
-
-    public function findPriceTypeDefinitionsByBehavior(string $behaviorClassWrapper): \Generator
-    {
-        return $this->service->findPriceTypeDefinitionsByBehavior($behaviorClassWrapper);
-    }
-
     protected function afterLock(): void
     {
         $this->lockItems($this->tariffTypeDefinitions);

src/product/BillingRegistryInterface.php

@@ -3,13 +3,7 @@
 namespace hiqdev\php\billing\product;
 
 use Generator;
-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\trait\HasLockInterface;
 
 interface BillingRegistryInterface extends HasLockInterface
@@ -22,41 +16,4 @@ public function priceTypes(): Generator;
     public function getTariffTypeDefinitions(): array;
 
     public function addTariffType(TariffTypeDefinitionInterface $tariffTypeDefinition): void;
-
-    /**
-     * @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 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;
-
-    public function getAggregate(string $type): AggregateInterface;
 }