HP-1751 Create configurations for billing types

composer.json

@@ -50,7 +50,8 @@
         "hiqdev/hipanel-module-client": "dev-master",
         "tuck/sort": "^0.1.0",
         "moneyphp/money": "*",
-        "hiqdev/php-units": "*"
+        "hiqdev/php-units": "*",
+        "advancedhosters/billing-registry": "dev-master"
     },
     "require-dev": {
         "hiqdev/hidev-php": "dev-master",

config/web.php

@@ -141,87 +141,6 @@
             \hipanel\modules\finance\helpers\ConsumptionConfigurator::class => [
                 'class' => \hipanel\modules\finance\helpers\ConsumptionConfigurator::class,
                 'configurations' => [
-                    'anycastcdn' => [
-                        'label' => ['hipanel:finance', 'Anycast CDN'],
-                        'columns' => [
-                            'cdn_traf_plain',
-                            'cdn_traf_ssl',
-                            'cdn_traf',
-                            'cdn_traf_max',
-                            'cdn_traf95',
-                            'cdn_traf95_max',
-                            'cdn_cache',
-                            'cdn_cache95',
-                        ],
-                        'groups' => [],
-                        'model' => Target::class,
-                        'resourceModel' => TargetResource::class,
-                    ],
-                    'videocdn' => [
-                        'label' => ['hipanel:finance', 'VideoCDN'],
-                        'columns' => [
-                            'server_traf',
-                            'server_traf_in',
-                            'server_traf95',
-                            'server_traf95_in',
-                            'server_du',
-                            'server_files',
-                            'server_ssd',
-                            'server_sata',
-                        ],
-                        'groups' => [['server_traf', 'server_traf_in'], ['server_traf95', 'server_traf95_in']],
-                        'model' => Target::class,
-                        'resourceModel' => TargetResource::class,
-                    ],
-                    'vps' => [
-                        'label' => ['hipanel:finance', 'VPS'],
-                        'columns' => ['vps_traf', 'vps_traf_in', 'vps_traf_max', 'cloud_ip_anycast', 'cloud_ip_public'],
-                        'groups' => [['vps_traf', 'vps_traf_in', 'cloud_ip_anycast', 'cloud_ip_public']],
-                        'model' => Target::class,
-                        'resourceModel' => TargetResource::class,
-                    ],
-                    'snapshot' => [
-                        'label' => ['hipanel:finance', 'Snapshot'],
-                        'columns' => ['snapshot_du'],
-                        'groups' => [],
-                        'model' => Target::class,
-                        'resourceModel' => TargetResource::class,
-                    ],
-                    'volume' => [
-                        'label' => ['hipanel:finance', 'Volume'],
-                        'columns' => ['volume_du'],
-                        'groups' => [],
-                        'model' => Target::class,
-                        'resourceModel' => TargetResource::class,
-                    ],
-                    'storage' => [
-                        'label' => ['hipanel:finance', 'Storage'],
-                        'columns' => ['storage_du', 'storage_du95'],
-                        'groups' => [],
-                        'model' => Target::class,
-                        'resourceModel' => TargetResource::class,
-                    ],
-                    'private_cloud' => [
-                        'label' => ['hipanel:finance', 'Private cloud'],
-                        'columns' => [],
-                        'groups' => [],
-                        'model' => Target::class,
-                        'resourceModel' => TargetResource::class,
-                    ],
-                    'private_cloud_backup' => [
-                        'label' => ['hipanel:finance', 'Private cloud backup'],
-                        'columns' => ['private_cloud_backup_du'],
-                        'groups' => [],
-                        'model' => Target::class,
-                        'resourceModel' => TargetResource::class,
-                    ],
-                    'load_balancer' => [
-                        'label' => ['hipanel:finance', 'Load balancer'],
-                        'columns' => ['lb_capacity_unit', 'lb_ha_capacity_unit'],
-                        'groups' => [],
-                        'model' => Target::class,
-                        'resourceModel' => TargetResource::class,
-                    ],
                     'tariff' => [
                         'label' => ['hipanel:finance', 'Tariff resources'],
                         'columns' => ['server_traf95_max', 'server_traf95', 'server_traf95_in'],
@@ -290,6 +209,9 @@
             },
             \Money\MoneyParser::class => \Money\Parser\DecimalMoneyParser::class,
 //            \hipanel\modules\finance\helpers\ConsumptionConfigurator::class => \hipanel\modules\finance\helpers\ConsumptionConfigurator::class,
+            \hiqdev\php\billing\product\BillingRegistryInterface::class => static function () {
+                return \hiqdev\billing\registry\TariffConfiguration::buildRegistry();
+            },
         ],
     ],
 ];

src/helpers/ConsumptionConfigurator.php

@@ -9,19 +9,25 @@
 use hipanel\modules\finance\models\decorators\ResourceDecoratorInterface;
 use hipanel\modules\finance\models\Target;
 use hipanel\modules\finance\models\TargetResource;
+use hiqdev\billing\registry\behavior\ConsumptionConfigurationBehaviour;
+use hiqdev\php\billing\product\BillingRegistryInterface;
 use yii\db\ActiveRecordInterface;
 use Yii;
 
 final class ConsumptionConfigurator
 {
     public array $configurations = [];
 
+    public function __construct(private readonly BillingRegistryInterface $billingRegistry)
+    {
+    }
+
     public function getColumns(string $class): array
     {
         return $this->getConfigurationByClass($class)['columns'];
     }
 
-    public function getGroups(string $class): array
+    private function getGroups(string $class): array
     {
         $groups = [];
         $columns = $this->getColumns($class);
@@ -97,7 +103,7 @@ public function getAllPossibleColumnsWithLabels(): array
         return $result;
     }
 
-    public function getDecorator(string $class, string $type): ResourceDecoratorInterface
+    private function getDecorator(string $class, string $type): ResourceDecoratorInterface
     {
         $config = $this->getConfigurationByClass($class);
         $config['resourceModel']->type = $type;
@@ -138,29 +144,36 @@ public function getFirstAvailableClass(): string
      * @param string $class
      * @return array{label: string, columns: array, group: array, model: ActiveRecordInterface, resourceModel: ActiveRecordInterface}
      */
-    private function getConfigurationByClass(string $class): array
+    public function getConfigurationByClass(string $class): array
     {
         $fallback = [
             'label' => ['hipanel:finance', $class],
             'columns' => [],
             'groups' => [],
-            'model' => Target::class,
-            'resourceModel' => TargetResource::class,
+            'model' => $this->createObject(Target::class),
+            'resourceModel' => $this->createObject(TargetResource::class),
         ];
 
         return $this->getConfigurations()[$class] ?? $fallback;
     }
 
     public function getConfigurations(): array
     {
-        return array_map(function (array $config): array {
-            [$dictionary, $label] = $config['label'];
-            $config['label'] = Yii::t($dictionary, $label);
-            $config['model'] = $this->createObject($config['model']);
-            $config['resourceModel'] = $this->createObject($config['resourceModel']);
-
-            return $config;
-        }, $this->configurations);
+        $configurations = [];
+        /** @var ConsumptionConfigurationBehaviour $behavior */
+        foreach ($this->billingRegistry->getBehaviors(ConsumptionConfigurationBehaviour::class) as $behavior) {
+            $tariffType = $behavior->getTariffType();
+
+            $configurations[$tariffType->name()] = [
+                'label' => $behavior->getLabel(),
+                'columns' => $behavior->columns,
+                'groups' => $behavior->groups,
+                'model' => $this->createObject($behavior->getModel() ?? Target::class),
+                'resourceModel' => $this->createObject($behavior->getResourceModel() ?? TargetResource::class),
+            ];
+        }
+
+        return $configurations;
     }
 
     private function createObject(string $className, array $params = []): object

src/logic/bill/QuantityFormatterFactory.php

@@ -64,7 +64,11 @@ final class QuantityFormatterFactory implements QuantityFormatterFactoryInterfac
         'overuse,snapshot_du' => [FractionQuantityFormatter::class, FractionUnit::SIZE],
     ];
 
-    public function __construct(private readonly IntlFormatter $intlFormatter, private readonly BillTypesProvider $billTypesProvider)
+    public function __construct(
+        private readonly IntlFormatter $intlFormatter,
+        private readonly BillTypesProvider $billTypesProvider,
+        private readonly BillingRegistryInterface $BillingRegistry,
+    )
     {
     }
 

src/models/ClientResource.php

@@ -1,19 +1,10 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace hipanel\modules\finance\models;
 
-use hipanel\modules\finance\models\decorators\client\ClientResourceDecoratorFactory;
 use hipanel\modules\finance\models\decorators\DecoratedInterface;
-use hipanel\modules\finance\models\decorators\ResourceDecoratorInterface;
 
 class ClientResource extends Resource implements DecoratedInterface
 {
-    public function decorator(): ResourceDecoratorInterface
-    {
-        if (empty($this->decorator)) {
-            $this->decorator = ClientResourceDecoratorFactory::createFromResource($this);
-        }
-
-        return $this->decorator;
-    }
+    use HasDecorator;
 }

src/models/HasDecorator.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types=1);
+
+namespace hipanel\modules\finance\models;
+
+use hipanel\modules\finance\models\decorators\ResourceDecoratorFactory;
+use hipanel\modules\finance\models\decorators\ResourceDecoratorInterface;
+
+trait HasDecorator
+{
+    private ResourceDecoratorInterface $decorator;
+
+    public function decorator(): ResourceDecoratorInterface
+    {
+        if (empty($this->decorator)) {
+            $this->decorator = ResourceDecoratorFactory::createFromResource($this);
+        }
+
+        return $this->decorator;
+    }
+}

src/models/ServerResource.php

@@ -12,11 +12,7 @@
 
 use hipanel\base\ModelTrait;
 use hipanel\modules\finance\models\decorators\DecoratedInterface;
-use hipanel\modules\finance\models\decorators\ResourceDecoratorInterface;
-use hipanel\modules\finance\models\decorators\server\AbstractServerResourceDecorator;
-use hipanel\modules\finance\models\decorators\server\ServerResourceDecoratorFactory;
 use Yii;
-use yii\base\InvalidConfigException;
 
 /**
  * Class ServerResource.
@@ -29,6 +25,8 @@ class ServerResource extends Resource implements DecoratedInterface
 {
     use ModelTrait;
 
+    use HasDecorator;
+
     public static function tableName()
     {
         return 'resource';
@@ -116,15 +114,6 @@ public function getMinimumQuantity()
         return isset($types[$this->type]) ? $types[$this->type] : 0.01;
     }
 
-    public function decorator(): ResourceDecoratorInterface
-    {
-        if (empty($this->decorator)) {
-            $this->decorator = ServerResourceDecoratorFactory::createFromResource($this);
-        }
-
-        return $this->decorator;
-    }
-
     public function realObjectId()
     {
         if (!$this->isPeriodic()) {

src/models/TargetResource.php

@@ -1,19 +1,10 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace hipanel\modules\finance\models;
 
 use hipanel\modules\finance\models\decorators\DecoratedInterface;
-use hipanel\modules\finance\models\decorators\ResourceDecoratorInterface;
-use hipanel\modules\finance\models\decorators\target\TargetResourceDecoratorFactory;
 
 class TargetResource extends Resource implements DecoratedInterface
 {
-    public function decorator(): ResourceDecoratorInterface
-    {
-        if (empty($this->decorator)) {
-            $this->decorator = TargetResourceDecoratorFactory::createFromResource($this);
-        }
-
-        return $this->decorator;
-    }
+    use HasDecorator;
 }

src/models/decorators/ResourceDecoratorFactory.php

@@ -1,16 +1,15 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace hipanel\modules\finance\models\decorators;
 
+use hiqdev\billing\registry\behavior\ResourceDecoratorBehavior;
+use hiqdev\billing\registry\ResourceDecorator\ResourceDecoratorData;
+use hiqdev\billing\registry\TariffConfiguration;
+use hiqdev\php\billing\product\BehaviorNotFoundException;
 use yii\base\InvalidConfigException;
 
 class ResourceDecoratorFactory
 {
-    protected static function typeMap(): array
-    {
-        return [];
-    }
-
     /**
      * @param $resource
      * @return ResourceDecoratorInterface
@@ -19,12 +18,22 @@ protected static function typeMap(): array
     public static function createFromResource($resource): ResourceDecoratorInterface
     {
         $type = $resource->model_type ?? $resource->type;
-        $map = static::typeMap();
 
-        if (!isset($map[$type])) {
+        $registry = TariffConfiguration::buildRegistry();
+
+        try {
+            /** @var ResourceDecoratorBehavior $behavior */
+            $behavior = $registry->getBehavior($type, ResourceDecoratorBehavior::class);
+
+            return $behavior->createDecorator(new ResourceDecoratorData(
+                $resource->quantity,
+                $resource->price,
+                $resource->unit,
+                $resource->currency,
+                $resource->partno,
+            ));
+        } catch (BehaviorNotFoundException) {
             throw new InvalidConfigException('No representative decoration class found for type "' . $type . '"');
         }
-
-        return new $map[$type]($resource);
     }
 }