<?php

namespace App\Domains\Event\Actions\CreateIncomeSurplusStatement;

use App\ValueObjects\Amount;

class CreateIncomeSurplusStatementResponse
{
    public bool $success = false;

    public string $filename = '';

    public string $pdfContent = '';

    public ?string $message = null;

    /**
     * Die Zahlen, aus denen das PDF entsteht -- Einnahmen-Kategorien, Ausgaben-Gruppen und das Ergebnis.
     *
     * Sie stehen hier, weil sie das eigentliche Ergebnis der Action sind; das PDF ist nur ihre Darstellung.
     * So lässt sich die Rechnung prüfen, ohne ein PDF zerlegen zu müssen.
     *
     * @var array{categories: array<int, array{name: string, total: Amount, entries: array<int, array{name: string, amount: Amount}>}>, total: Amount}|array{}
     */
    public array $income = [];

    /**
     * @var array{groups: array<int, array{name: string, sum: Amount, rows: array<int, array<string, mixed>>}>, total: Amount}|array{}
     */
    public array $expenses = [];

    /**
     * Die gespendeten Auslagen, gegliedert wie die Ausgaben -- die Gegenbuchung zur Zeile „Spenden".
     *
     * @var array{groups: array<int, array{name: string, sum: Amount, rows: array<int, array<string, mixed>>}>, total: Amount}|array{}
     */
    public array $donations = [];

    public ?Amount $result = null;
}