hiqdev / hipanel-module-finance

src/models/Bill.php

<?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\modules\finance\behaviors\BillNegation;
use Yii;

/**
 * Class Bill.
 *
 * @author Dmytro Naumenko <d.naumenko.a@gmail.com>
 *
 * @property string $type
 * @property string $unit
 * @property string $quantity
 * @property Charge[] charges
 */
class Bill extends \hipanel\base\Model
{
    use \hipanel\base\ModelTrait;

    public $time_from;
    public $time_till;

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

    public static $i18nDictionary = 'hipanel:finance';

    public function behaviors()
    {
        return [
            [
                'class' => BillNegation::class,
                'negativeTypes' => static::negativeTypes(),
            ],
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function rules()
    {
        return [
            [['client_id', 'seller_id', 'id'], 'integer'],
            [['object_id', 'tariff_id'], 'integer'],
            [['client', 'seller', 'bill', 'unit'], 'safe'],
            [['domain', 'server'], 'safe'],
            [['sum', 'balance', 'quantity'], 'number'],
            [['currency', 'label', 'descr'], 'safe'],
            [['object', 'domains', 'tariff'], 'safe'],
            [['type', 'gtype', 'class', 'ftype'], 'safe'],
            [['class_label'], 'safe'],
            [['type_label', 'gtype_label'], 'safe'],
            [['time'], 'date', 'format' => 'php:Y-m-d H:i:s'],

            [['id'], 'required', 'on' => [self::SCENARIO_UPDATE, self::SCENARIO_DELETE]],
            [['client_id'], 'integer', 'on' => [self::SCENARIO_CREATE]],
            [['currency', 'sum', 'type', 'label'], 'required', 'on' => [self::SCENARIO_CREATE, self::SCENARIO_UPDATE]],
            ['sum', function ($attribute, $params, $validator) {

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

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

                if ($this->{$attribute} < 0 && in_array($this->type, static::negativeTypes(), true)) {
                    $this->addError($attribute, Yii::t('hipanel:finance', 'The entered value for the selected payment type can not be negative.'));
                }
            }, 'on' => [self::SCENARIO_CREATE, self::SCENARIO_UPDATE]],
            [['client_id', 'sum', 'time'], 'required', 'on' => [self::SCENARIO_CREATE]],
            [['client'], 'safe', 'on' => [self::SCENARIO_CREATE]],
            [['no'], 'safe'],
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function attributeLabels()
    {
        return $this->mergeAttributeLabels([
            'object' => Yii::t('hipanel', 'Object'),
            'client' => Yii::t('hipanel', 'Client'),
            'time' => Yii::t('hipanel', 'Time'),
            'currency' => Yii::t('hipanel', 'Currency'),
            'quantity' => Yii::t('hipanel', 'Quantity'),
            'balance' => Yii::t('hipanel', 'Balance'),
            'gtype' => Yii::t('hipanel', 'Type'),
            'gtype_label' => Yii::t('hipanel', 'Type'),
            'sum' => Yii::t('hipanel:finance', 'Sum'),
            'tariff' => Yii::t('hipanel:finance', 'Tariff'),
            'tariff_id' => Yii::t('hipanel:finance', 'Tariff'),
        ]);
    }

    public function getCharges()
    {
        return $this->hasMany(Charge::class, ['bill_id' => 'id'])->inverseOf('bill');
    }

    public static function negativeTypes()
    {
        return [
            'correction,negative',
            'overuse,backup_du',
            'overuse,backup_traf',
            'overuse,domain_num',
            'overuse,ip_num',
            'overuse,isp5',
            'overuse,server_traf',
            'overuse,server_traf95',
            'overuse,server_traf95_in',
            'overuse,server_traf95_max',
            'overuse,server_du',
            'overuse,server_traf_in',
            'overuse,server_traf_max',
            'overuse,support_time',
        ];
    }
}