HP-1751 added description to TariffTypeBehaviorRegistry class

Author: VadymHrechukha

src/product/TariffTypeDefinition.php

@@ -79,7 +79,7 @@ public function withBehaviors(): BehaviorTariffTypeCollection
     {
         $this->ensureNotLocked();
 
-        return $this->tariffTypeBehaviorRegistry->withBehaviors();
+        return $this->tariffTypeBehaviorRegistry->getBehaviors();
     }
 
     public function hasBehavior(string $behaviorClassName): bool

src/product/behavior/TariffTypeBehaviorRegistry.php

@@ -5,23 +5,40 @@
 use hiqdev\php\billing\product\Domain\Model\TariffTypeInterface;
 use hiqdev\php\billing\product\TariffTypeDefinitionInterface;
 
+/**
+ * class TariffTypeBehaviorRegistry
+ *
+ * This class acts as a registry for tariff behaviors, encapsulating
+ * the BehaviorTariffTypeCollection to provide structured access
+ * and behavior lookup functionalities.
+ *
+ *  Purpose:
+ *  - Stores a collection of behaviors associated with a TariffType.
+ *  - Provides access to the behavior collection via getBehaviors().
+ *  - Allows checking for the existence of a specific behavior using hasBehavior().
+ *
+ *  Why this class was created:
+ *  - To avoid code duplication of behavior-related methods in multiple classes.
+ *  - To separate concerns by handling behavior-related logic in a dedicated class.
+ *  - To improve maintainability and testability of tariff behavior handling.
+ */
 final class TariffTypeBehaviorRegistry
 {
-    private BehaviorTariffTypeCollection $behaviorCollection;
+    private BehaviorTariffTypeCollection $behaviors;
 
     public function __construct(TariffTypeDefinitionInterface $tariffTypeDefinition, TariffTypeInterface $tariffType)
     {
-        $this->behaviorCollection = new BehaviorTariffTypeCollection($tariffTypeDefinition, $tariffType);
+        $this->behaviors = new BehaviorTariffTypeCollection($tariffTypeDefinition, $tariffType);
     }
 
-    public function withBehaviors(): BehaviorTariffTypeCollection
+    public function getBehaviors(): BehaviorTariffTypeCollection
     {
-        return $this->behaviorCollection;
+        return $this->behaviors;
     }
 
     public function hasBehavior(string $behaviorClassName): bool
     {
-        foreach ($this->behaviorCollection as $behavior) {
+        foreach ($this->behaviors as $behavior) {
             if ($behavior instanceof $behaviorClassName) {
                 return true;
             }

tests/unit/product/behavior/TariffTypeBehaviorRegistryTest.php

@@ -21,7 +21,7 @@ protected function setUp(): void
 
     public function testWithBehaviorsReturnsBehaviorCollection(): void
     {
-        $this->assertInstanceOf(BehaviorTariffTypeCollection::class, $this->manager->withBehaviors());
+        $this->assertInstanceOf(BehaviorTariffTypeCollection::class, $this->manager->getBehaviors());
     }
 
     public function testHasBehaviorReturnsFalseWhenBehaviorNotPresent(): void
@@ -32,7 +32,7 @@ public function testHasBehaviorReturnsFalseWhenBehaviorNotPresent(): void
     public function testHasBehaviorReturnsTrueWhenBehaviorPresent(): void
     {
         $behavior = $this->createMock(TestBehavior::class);
-        $behaviorCollection = $this->manager->withBehaviors();
+        $behaviorCollection = $this->manager->getBehaviors();
         $behaviorCollection->attach($behavior);
 
         $this->assertTrue($this->manager->hasBehavior(TestBehavior::class));