HP-1751 created PriceTypeDefinitionInterface

Author: VadymHrechukha

src/product/behavior/BehaviorCollection.php

@@ -4,7 +4,7 @@
 
 use hiqdev\php\billing\product\Domain\Model\TariffTypeInterface;
 
-class BehaviorCollection implements BehaviorCollectionInterface
+abstract class BehaviorCollection implements BehaviorCollectionInterface
 {
     /** @var BehaviorInterface[] */
     private array $behaviors = [];

src/product/behavior/BehaviorCollectionInterface.php

@@ -10,4 +10,6 @@ interface BehaviorCollectionInterface extends \IteratorAggregate
     public function getIterator(): \Traversable;
 
     public function attach(BehaviorInterface $behavior): self;
+
+    public function end();
 }

src/product/behavior/BehaviorPriceTypeDefinitionCollection.php

@@ -3,16 +3,16 @@
 namespace hiqdev\php\billing\product\behavior;
 
 use hiqdev\php\billing\product\Domain\Model\TariffTypeInterface;
-use hiqdev\php\billing\product\price\PriceTypeDefinition;
+use hiqdev\php\billing\product\price\PriceTypeDefinitionInterface;
 
 class BehaviorPriceTypeDefinitionCollection extends BehaviorCollection
 {
-    public function __construct(private readonly PriceTypeDefinition $parent, TariffTypeInterface $tariffType)
+    public function __construct(private readonly PriceTypeDefinitionInterface $parent, TariffTypeInterface $tariffType)
     {
         parent::__construct($tariffType);
     }
 
-    public function end(): PriceTypeDefinition
+    public function end(): PriceTypeDefinitionInterface
     {
         return $this->parent;
     }

src/product/behavior/BehaviorTariffTypeCollection.php

@@ -3,16 +3,16 @@
 namespace hiqdev\php\billing\product\behavior;
 
 use hiqdev\php\billing\product\Domain\Model\TariffTypeInterface;
-use hiqdev\php\billing\product\TariffTypeDefinition;
+use hiqdev\php\billing\product\TariffTypeDefinitionInterface;
 
 class BehaviorTariffTypeCollection extends BehaviorCollection
 {
-    public function __construct(private readonly TariffTypeDefinition $parent, TariffTypeInterface $tariffType)
+    public function __construct(private readonly TariffTypeDefinitionInterface $parent, TariffTypeInterface $tariffType)
     {
         parent::__construct($tariffType);
     }
 
-    public function end(): TariffTypeDefinition
+    public function end(): TariffTypeDefinitionInterface
     {
         return $this->parent;
     }

src/product/price/PriceTypeDefinition.php

@@ -6,7 +6,6 @@
 use hiqdev\php\billing\product\Exception\AggregateNotDefinedException;
 use hiqdev\php\billing\product\behavior\BehaviorPriceTypeDefinitionCollection;
 use hiqdev\php\billing\product\invoice\InvoiceRepresentationCollection;
-use hiqdev\php\billing\product\behavior\HasBehaviorsInterface;
 use hiqdev\php\billing\product\quantity\InvalidQuantityFormatterException;
 use hiqdev\php\billing\product\quantity\QuantityFormatterDefinition;
 use hiqdev\php\billing\product\quantity\QuantityFormatterFactory;
@@ -21,7 +20,7 @@
  * @template T of PriceTypeDefinitionCollectionInterface
  * @psalm-consistent-templates
  */
-class PriceTypeDefinition implements HasBehaviorsInterface
+class PriceTypeDefinition implements PriceTypeDefinitionInterface
 {
     private UnitInterface $unit;
 
@@ -90,9 +89,8 @@ public function quantityFormatter(string $formatterClass, $fractionUnit = null):
         return $this;
     }
 
-    public function createQuantityFormatter(
-        FractionQuantityData $data,
-    ): QuantityFormatterInterface {
+    public function createQuantityFormatter(FractionQuantityData $data): QuantityFormatterInterface
+    {
         return QuantityFormatterFactory::create(
             $this->getUnit()->createExternalUnit(),
             $this->quantityFormatterDefinition,
@@ -154,11 +152,7 @@ public function hasBehavior(string $behaviorClassName): bool
     }
 
     /**
-     * це параметер визначає агрегатну функцію яка застосовується для щоденно записаних ресурсів щоб визнизначти
-     * місячне споживання за яке потрібно пробілити клієнта
-     *
-     * @param AggregateInterface $aggregate
-     * @return self
+     * @inerhitDoc
      */
     public function aggregation(AggregateInterface $aggregate): self
     {

src/product/price/PriceTypeDefinitionCollection.php

@@ -26,14 +26,14 @@ public function __construct(
     }
 
     /**
-     * @return PriceTypeDefinition[]
+     * @inerhitDoc
      */
     public function getIterator(): \Traversable
     {
         return new \ArrayIterator($this->storage->getAll());
     }
 
-    public function priceType(TypeInterface $type): PriceTypeDefinition
+    public function priceType(TypeInterface $type): PriceTypeDefinitionInterface
     {
         $priceType = $this->factory->create($this->collectionInstance, $type, $this->parent->tariffType());
         $this->storage->add($type, $priceType);

src/product/price/PriceTypeDefinitionCollectionInterface.php

@@ -8,11 +8,11 @@
 interface PriceTypeDefinitionCollectionInterface extends \IteratorAggregate, \Countable
 {
     /**
-     * @return PriceTypeDefinition[]
+     * @return PriceTypeDefinitionInterface[]
      */
     public function getIterator(): \Traversable;
 
-    public function priceType(TypeInterface $type): PriceTypeDefinition;
+    public function priceType(TypeInterface $type): PriceTypeDefinitionInterface;
 
     public function end(): TariffTypeDefinitionInterface;
 }

src/product/price/PriceTypeDefinitionFactory.php

@@ -11,7 +11,7 @@ public function create(
         PriceTypeDefinitionCollectionInterface $parent,
         TypeInterface $type,
         TariffTypeInterface $tariffType,
-    ): PriceTypeDefinition {
+    ): PriceTypeDefinitionInterface {
         return new PriceTypeDefinition($parent, $type, $tariffType);
     }
 }

src/product/price/PriceTypeDefinitionFactoryInterface.php

@@ -11,5 +11,5 @@ public function create(
         PriceTypeDefinitionCollectionInterface $parent,
         TypeInterface $type,
         TariffTypeInterface $tariffType,
-    ): PriceTypeDefinition;
+    ): PriceTypeDefinitionInterface;
 }

src/product/price/PriceTypeDefinitionInterface.php

@@ -0,0 +1,48 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product\price;
+
+use hiqdev\php\billing\product\AggregateInterface;
+use hiqdev\php\billing\product\behavior\HasBehaviorsInterface;
+use hiqdev\php\billing\product\Domain\Model\Unit\UnitInterface;
+use hiqdev\php\billing\product\invoice\InvoiceRepresentationCollection;
+use hiqdev\php\billing\product\quantity\FractionQuantityData;
+use hiqdev\php\billing\product\quantity\QuantityFormatterInterface;
+use hiqdev\php\billing\type\TypeInterface;
+
+interface PriceTypeDefinitionInterface extends HasBehaviorsInterface
+{
+    public function unit(UnitInterface $unit): self;
+
+    public function description(string $description): self;
+
+    public function getDescription(): string;
+
+    public function quantityFormatter(string $formatterClass, $fractionUnit = null): self;
+
+    public function createQuantityFormatter(FractionQuantityData $data): QuantityFormatterInterface;
+
+    public function end(): PriceTypeDefinitionCollectionInterface;
+
+    public function documentRepresentation(): InvoiceRepresentationCollection;
+
+    // TODO: Not sure if it will be needed at all
+    public function measuredWith(\hiqdev\billing\registry\measure\RcpTrafCollector $param): self;
+
+    public function type(): TypeInterface;
+
+    public function hasType(TypeInterface $type): bool;
+
+    public function getUnit(): UnitInterface;
+
+    /**
+     * це параметер визначає агрегатну функцію яка застосовується для щоденно записаних ресурсів щоб визнизначти
+     * місячне споживання за яке потрібно пробілити клієнта
+     *
+     * @param AggregateInterface $aggregate
+     * @return self
+     */
+    public function aggregation(AggregateInterface $aggregate): self;
+
+    public function getAggregate(): AggregateInterface;
+}