hipanel\modules\finance\models\Price

Complexity

Total Complexity

24

Size/Duplication

Total Lines	213
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	9

Test Coverage

Coverage

0%

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	rules()	0	18	1
A	attributeLabels()	0	13	1
A	getTypeOptions()	0	8	1
A	getUnitOptions()	0	51	2
A	isQuantityPredefined()	0	10	4
A	isShared()	0	4	1
A	getUnitLabel()	0	4	1
A	getCurrencyOptions()	0	4	1
A	getObject()	0	4	1
A	getPlan()	0	4	1
A	tableName()	0	4	1
A	isOveruse()	0	4	1
A	isServer95Traf()	0	4	1
A	getSubtype()	0	6	1
A	instantiate()	0	7	1
A	formulaLines()	0	8	2
A	getMoney()	0	6	1
A	getFormulaLines()	0	4	1
A	find()	0	6	1

<?php
/**
 * Finance module for HiPanel
 *
 * @link      https://github.com/hiqdev/hipanel-module-finance
 * @package   hipanel-module-finance
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\finance\models;

use hipanel\base\Model;
use hipanel\base\ModelTrait;
use hipanel\models\Ref;
use hipanel\modules\finance\models\factories\PriceModelFactory;
use hipanel\modules\finance\models\query\PriceQuery;
use Money\Money;
use Money\MoneyParser;
use Yii;
use yii\helpers\Inflector;
use yii\helpers\StringHelper;

/**
 * Class Price.
 *
 * @property int $id
 * @property int $plan_id
 * @property string|int $object_id
 * @property string|float $price
 * @property string $currency
 * @property string|int $main_object_id
 * @property string $main_object_name
 * @property string $unit
 * @property string $type
 * @property string $quantity
 * @property string $formula
 * @property int|null parent_id
 *
 * @property TargetObject $object
 * @property Plan $plan
 * @property array|null $formula_lines
 *
 * @author Dmytro Naumenko <d.naumenko.a@gmail.com>
 */
class Price extends Model
{
    use ModelTrait;

    const SCENARIO_CREATE = 'create';
    const SCENARIO_UPDATE = 'update';
    const SCENARIO_DELETE = 'delete';

    public function rules()
    {
        return array_merge(parent::rules(), [
            [['id', 'parent_id', 'plan_id', 'object_id', 'type_id', 'unit_id', 'currency_id', 'main_object_id'], 'integer'],
            [['type', 'type_label', 'plan_name', 'unit', 'currency', 'note', 'data', 'main_object_name'], 'string'],
            [['quantity', 'price'], 'number'],
            [['formula_lines'], 'safe'],
            [['class'], 'string'], // todo: probably, refactor is needed

            [['plan_id', 'type', 'price', 'currency'], 'required', 'on' => ['create', 'update']],
            [['id'], 'required', 'on' => ['update', 'set-note', 'delete']],
            [['class'], 'default', 'value' => function ($model) {

The parameter $model is not used and could be removed.

                return (new \ReflectionClass($this))->getShortName();
            }],
            [['class'], 'string'],
            [['formula'], 'string', 'on' => ['create', 'update']], // TODO syn check
        ]);
    }

    public function attributeLabels()
    {
        return [
            'plan_id' => Yii::t('hipanel:finance', 'Tariff plan'),
            'plan' => Yii::t('hipanel:finance', 'Tariff plan'),
            'quantity' => Yii::t('hipanel:finance', 'Prepaid'),
            'unit' => Yii::t('hipanel:finance', 'Unit'),
            'price' => Yii::t('hipanel:finance', 'Price'),
            'formula' => Yii::t('hipanel.finance.price', 'Formula'),
            'note' => Yii::t('hipanel', 'Note'),
            'type' => Yii::t('hipanel', 'Type'),
        ];
    }

    public function getTypeOptions()
    {
        return Ref::getList('type,bill', null, [
            'select' => 'name',
            'pnames' => 'monthly,overuse',
            'with_recursive' => 1,
        ]);
    }

    /**
     * Returns array of unit option, that are available for this price
     * depending on price type.
     *
     * @return array
     */
    public function getUnitOptions()
    {
        $unitGroup = [
            'hour'  => ['hour'],
            'items' => ['items'],
            'speed' => ['bps', 'kbps', 'mbps', 'gbps', 'tbps'],
            'size'  => ['mb', 'mb10', 'mb100', 'gb', 'tb'],
        ];

        $type2group = [
            'overuse,ip_num'                    => 'items',
            'overuse,support_time'              => 'hour',
            'overuse,backup_du'                 => 'size',
            'overuse,server_traf_max'           => 'size',
            'overuse,server_traf95_max'         => 'speed',
            'overuse,cdn_traf_max'              => 'size',
            'overuse,cdn_traf95_max'            => 'speed',
            'overuse,cdn_cache'                 => 'size',
            'overuse,storage_du'                => 'size',
            'overuse,server_du'                 => 'size',
            'overuse,server_ssd'                => 'size',
            'overuse,server_sata'               => 'size',
            'overuse,backup_traf'               => 'size',
            'overuse,domain_traf'               => 'size',
            'overuse,domain_num'                => 'items',
            'overuse,ip_traf_max'               => 'size',
            'overuse,account_traf'              => 'size',
            'overuse,account_du'                => 'size',
            'overuse,mail_num'                  => 'items',
            'overuse,mail_du'                   => 'size',
            'overuse,db_num'                    => 'items',
            'overuse,storage_du95'              => 'size',
            'overuse,volume_du'                 => 'size',
            'overuse,snapshot_du'               => 'size',
            'overuse,private_cloud_backup_du'   => 'size',
        ];

        foreach ($type2group as $type => $group) {
            $availableUnitsByPriceType[$type] = $unitGroup[$group];

$availableUnitsByPriceType was never initialized. Although not strictly required by PHP, it is generally a good practice to add $availableUnitsByPriceType = array(); before regardless.

        }

        $units = Ref::getList('type,unit', 'hipanel.finance.units', [
            'with_recursive' => 1,
            'select' => 'oname_label',
            'mapOptions' => ['from' => 'oname'],
        ]);

        $possibleTypes = $availableUnitsByPriceType[$this->type] ?? [];

        return array_intersect_key($units, array_combine($possibleTypes, $possibleTypes));
    }

    /**
     * Method checks, whether current price quantity is predefined and is not a result
     * of sophisticated calculation on server side.
     * @return bool
     */
    public function isQuantityPredefined(): bool
    {
        if (!$this->isOveruse()
            && ($this->isShared() || $this->getSubtype() === 'rack_unit')
        ) {
            return false;
        }

        return true;
    }

    /**
     * @return bool Whether this price is shared
     */
    public function isShared(): bool
    {
        return $this->object_id === null;
    }

    public function getUnitLabel()
    {
        return $this->getUnitOptions()[$this->unit] ?? null;
    }

    public function getCurrencyOptions()
    {
        return Ref::getList('type,currency');
    }

    public function getObject()
    {
        return $this->hasOne(TargetObject::class, ['id' => 'id']);
    }

    public function getPlan()
    {
        return $this->hasOne(Plan::class, ['id' => 'plan_id']);
    }

    public static function tableName()
    {
        return Inflector::camel2id(StringHelper::basename(__CLASS__), '-');
    }

    public function isOveruse()
    {
        return strpos($this->type, 'overuse,') === 0;
    }

    public function isServer95Traf()
    {
        return false;
    }

    public function getSubtype()
    {
        [, $subtype] = explode(',', $this->type);

The variable $subtype does not exist. Did you forget to declare it?

        return $subtype;
    }

    /**
     * {@inheritdoc}
     */
    public static function instantiate($row)
    {
        /** @var PriceModelFactory $factory */
        $factory = Yii::$container->get(PriceModelFactory::class);

        return $factory->build($row['class'] ?? 'SinglePrice', $row['type']);
    }

    public function formulaLines(): array
    {
        if (strlen($this->formula) === 0) {
            return [];
        }

        return explode("\n", $this->formula);
    }

    public function getMoney(): Money
    {
        // TODO: decide how to get MoneyParser correctly
        return Yii::$container->get(MoneyParser::class)
            ->parse((string)$this->price, strtoupper($this->currency));
    }

    public function getFormulaLines(): array
    {
        return $this->formula_lines ?? [];
    }

    public static function find(array $options = []): PriceQuery
    {
        return new PriceQuery(get_called_class(), [
            'options' => $options,
        ]);
    }
}