oms-BusinessExpenses/Models/Expense.php

<?php
/**
 * Jingga
 *
 * PHP Version 8.2
 *
 * @package   Modules\BusinessExpenses\Models
 * @copyright Dennis Eichhorn
 * @license   OMS License 2.0
 * @version   1.0.0
 * @link      https://jingga.app
 */
declare(strict_types=1);

namespace Modules\BusinessExpenses\Models;

use Modules\Admin\Models\Account;
use phpOMS\Localization\BaseStringL11nType;
use phpOMS\Localization\ISO3166TwoEnum;
use phpOMS\Stdlib\Base\FloatInt;

/**
 *  Expense class.
 *
 * @package Modules\BusinessExpenses\Models
 * @license OMS License 2.0
 * @link    https://jingga.app
 * @since   1.0.0
 */
class Expense
{
    public int $id = 0;

    public Account $from;

    public ?Account $approvedBy = null;

    public int $status = ExpenseStatus::DRAFT;

    public BaseStringL11nType $type;

    public string $description = '';

    public bool $approved = false;

    public bool $paid = false;

    /**
     * Elements/costs
     *
     * @var ExpenseElement[]
     * @since 1.0.0
     */
    public array $elements = [];

    public FloatInt $net;

    public FloatInt $gross;

    public FloatInt $taxP;

    public \DateTime $start;

    public \DateTime $end;

    public \DateTimeImmutable $createdAt;

    public string $country = ISO3166TwoEnum::_USA;

    /**
     * Constructor.
     *
     * @since 1.0.0
     */
    public function __construct()
    {
        $this->type      = new BaseStringL11nType();
        $this->start     = new \DateTime('now');
        $this->end       = new \DateTime('now');
        $this->createdAt = new \DateTimeImmutable('now');
        $this->from      = new Account();

        $this->net   = new FloatInt();
        $this->gross = new FloatInt();
        $this->taxP  = new FloatInt();
    }

    /**
     * Recalculate the expenses
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function recalculate() : void
    {
        $net   = 0;
        $gross = 0;

        foreach ($this->elements as $element) {
            $net   += $element->net->value;
            $gross += $element->gross->value;
        }

        $this->net->value   = $net;
        $this->gross->value = $gross;
    }

    use \Modules\Media\Models\MediaListTrait;
    use \Modules\Editor\Models\EditorDocListTrait;
}