atol-online/src/Entities/Vat.php

<?php

/*
 * Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
 *
 * This code is licensed under MIT.
 * Этот код распространяется по лицензии MIT.
 * https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
 */

declare(strict_types=1);

namespace AtolOnline\Entities;

use AtolOnline\Enums\VatType;
use AtolOnline\Helpers;
use JetBrains\PhpStorm\{
    ArrayShape,
    Pure};

/**
 * Класс, описывающий ставку НДС
 *
 * @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 25, 31
 */
final class Vat extends Entity
{
    /**
     * Конструктор
     *
     * @param VatType $type Тип ставки НДС (1199, 1105, 1104, 1103, 1102, 1107, 1106)
     * @param float $sum Исходная сумма в рублях, от которой нужно расчитать размер НДС
     */
    public function __construct(
        protected VatType $type,
        protected float $sum,
    ) {
        $this->setType($type)->setSum($sum);
    }

    /**
     * Устанавливает тип ставки НДС
     * Автоматически пересчитывает итоговый размер НДС от исходной суммы.
     *
     * @param VatType $type Тип ставки НДС
     * @return $this
     */
    public function setType(VatType $type): self
    {
        $this->type = $type;
        return $this;
    }

    /**
     * Возвращает тип ставки НДС
     *
     * @return VatType
     */
    public function getType(): VatType
    {
        return $this->type;
    }

    /**
     * Возвращает исходную сумму, от которой расчитывается размер налога
     *
     * @return float
     */
    public function getSum(): float
    {
        return $this->sum;
    }

    /**
     * Устанавливает исходную сумму, от которой будет расчитываться итоговый размер НДС.
     * Автоматически пересчитывает итоговый размер НДС от исходной суммы.
     *
     * @param float $rubles Сумма в рублях за предмет расчёта, из которой высчитывается размер НДС
     * @return $this
     */
    public function setSum(float $rubles): self
    {
        $this->sum = round($rubles, 2);
        return $this;
    }

    /**
     * Возвращает расчитанный итоговый размер ставки НДС в рублях
     *
     * @return float
     * @see https://nalog-nalog.ru/nds/nalogovaya_baza_nds/kak-schitat-nds-pravilno-vychislyaem-20-ot-summy-primer-algoritm/
     * @see  https://glavkniga.ru/situations/k500734
     * @see https://www.b-kontur.ru/nds-kalkuljator-online
     */
    #[Pure]
    public function getCalculated(): float
    {
        return Helpers::toRub(
            match ($this->getType()) {
                VatType::VAT10 => Helpers::toKop($this->sum) * 10 / 100,
                VatType::VAT18 => Helpers::toKop($this->sum) * 18 / 100,
                VatType::VAT20 => Helpers::toKop($this->sum) * 20 / 100,
                VatType::VAT110 => Helpers::toKop($this->sum) * 10 / 110,
                VatType::VAT118 => Helpers::toKop($this->sum) * 18 / 118,
                VatType::VAT120 => Helpers::toKop($this->sum) * 20 / 120,
                default => 0,
            }
        );
    }

    /**
     * Прибавляет указанную сумму к исходной
     *
     * @param float $rubles
     * @return $this
     */
    public function addSum(float $rubles): self
    {
        $this->sum += $rubles;
        return $this;
    }

    /**
     * @inheritDoc
     */
    #[Pure]
    #[ArrayShape(['type' => 'string', 'sum' => 'float'])]
    public function jsonSerialize(): array
    {
        return [
            'type' => $this->getType(),
            'sum' => $this->getCalculated(),
        ];
    }
}