<?php

namespace App\Enumerations;

use App\Scopes\CommonModel;

class InvoiceType extends CommonModel {
    public const INVOICE_TYPE_TRAVELLING = 'travelling';

    public const INVOICE_TYPE_PROGRAM = 'program';

    public const INVOICE_TYPE_OTHER = 'other';

    public const INVOICE_TYPE_ACCOMMODATION = 'accommodation';

    public const INVOICE_TYPE_CATERING = 'catering';

    public const INVOICE_TYPE_LOGSTIC = 'logistic';

    public const INVOICE_TYPE_TECHNICAL = 'technical';

    public const INVOICE_TYPE_MANAGEMENT = 'management';

    /**
     * Erstattung eines Teilnahmebeitrags. Entsteht ausschließlich aus einem bestätigten
     * Erstattungsvorgang und ist deshalb nicht von Hand wählbar ({@see self::selectable()}).
     */
    public const INVOICE_TYPE_PARTICIPATION_REFUND = 'participation_refund';

    protected $fillable = [
        'slug',
        'name',
        'sort_order',
        'selectable',
        'counts_as_expense',
    ];

    protected $casts = [
        'sort_order' => 'integer',
        'selectable' => 'boolean',
        'counts_as_expense' => 'boolean',
    ];

    /**
     * Die Typen, die in einem Formular zur Auswahl stehen dürfen -- nach Sortierung.
     *
     * Automatisch vergebene Typen bleiben außen vor: Ihre Abrechnungen entstehen aus einem Vorgang, der
     * die Daten mitbringt; von Hand gewählt stünde ein leerer Rahmen ohne diesen Vorgang da.
     *
     * @return \Illuminate\Database\Eloquent\Collection<int, self>
     */
    public static function selectable(): \Illuminate\Database\Eloquent\Collection
    {
        return self::where('selectable', true)->orderBy('sort_order')->get();
    }

    /**
     * Die Typen, die in der Ausgabenrechnung einer Veranstaltung zählen -- nach Sortierung.
     *
     * Ausgenommen ist, was fachlich keine Ausgabe ist, sondern die Rücknahme einer Einnahme: Eine
     * Beitragserstattung mindert bereits die Einnahmenseite, weil der abgemeldete Teili dort herausfällt.
     * Als Ausgabe gezählt, ginge derselbe Vorgang ein zweites Mal in die Bilanz.
     *
     * @return \Illuminate\Database\Eloquent\Collection<int, self>
     */
    public static function countingAsExpense(): \Illuminate\Database\Eloquent\Collection
    {
        return self::where('counts_as_expense', true)->orderBy('sort_order')->get();
    }
}