Zahlungszwecke

app/Models/Invoice.php

@@ -4,6 +4,7 @@ namespace App\Models;
 
 use App\Enumerations\InvoiceStatus;
 use App\Enumerations\InvoiceType;
+use App\Enumerations\TravelReason;
 use App\Scopes\InstancedModel;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
@@ -14,6 +15,7 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo;
  * @property string $status
  * @property string $type
  * @property string $type_other
+ * @property string $purpose
  * @property boolean $donation
  * @property string $user_id
  * @property string $contact_name
@@ -26,8 +28,8 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo;
  * @property string $comment
  * @property string $changes
  * @property string $travel_direction
- * @property boolean $passengers
- * @property boolean $transportation
+ * @property boolean $passengers Nicht mehr erfasst -- siehe Hinweis unten
+ * @property boolean $transportation Nicht mehr erfasst -- siehe Hinweis unten
  * @property string $document_filename
  * @property string $approved_by
  * @property string $approved_at
@@ -35,6 +37,13 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo;
  * @property string $denied_by
  * @property string $denied_at
  * @property string $denied_reason
+ *
+ * `passengers` ("Ich habe Personen mitgenommen") und `transportation` ("Ich habe Material transportiert")
+ * werden seit dem Ausbau des Reisekosten-Formulars nicht mehr erfasst: Sie waren reine Ja/Nein-Angaben
+ * ohne Wirkung auf den Betrag -- eine Kostenstelle führt genau eine Kilometerpauschale, es gibt also
+ * keinen zweiten Satz, auf den sie umschalten könnten. Wer gereist ist, steht jetzt im `purpose`.
+ * Die Spalten bleiben für die Altdaten stehen; sollen sie je wiederkommen, dann als Angaben, die in die
+ * Berechnung eingehen (Mitnahmeentschädigung: eine Anzahl, kein Häkchen).
  */
 class Invoice extends InstancedModel
 {
@@ -45,6 +54,7 @@ class Invoice extends InstancedModel
         'status',
         'type',
         'type_other',
+        'purpose',
         'donation',
         'user_id',
         'contact_name',
@@ -94,19 +104,42 @@ class Invoice extends InstancedModel
     /**
      * Wofür der Beleg steht -- der "Zahlungsgrund" der Beleglisten und der "Zweck" der EüR-Anlage.
      *
-     * `type_other` ("Was wurde eingekauft") trägt seit der Pflichtangabe zu jeder Abrechnung den Zweck.
-     * Bei Fahrtkosten bleibt das Feld leer: dort schreibt der Einreiche-Flow die Strecke nach
-     * `travel_direction`. Den Zweck trägt dann der Reisegrund, ergänzt um den Namen der reisenden
-     * Person -- bei einer Fahrt ist "wer" Teil der Begründung, nicht bloß Kontaktangabe.
+     * Erfasst wird er beim Anlegen und steht danach in der eigenen Spalte: eine Angabe, keine Ableitung.
+     * Nur so lässt er sich korrigieren, ohne dass ihn der nächste Vorgang wieder überschreibt.
      *
-     * Ältere Belege und Beitragserstattungen haben nichts davon gesetzt; dann bleibt der Text leer.
-     * Ein "--" würde in einer Belegliste nur Platz kosten.
+     * Bestandsbelege haben die Spalte leer -- für sie wird weiter abgeleitet, bei Fahrtkosten aus
+     * Reisegrund und `contact_name`, weil es die Frage "wer ist gefahren" damals nicht gab. Bleibt auch
+     * dabei nichts übrig, bleibt der Text leer; ein "--" würde in einer Belegliste nur Platz kosten.
      */
     public function purposeText() : string {
-        $parts = $this->type === InvoiceType::INVOICE_TYPE_TRAVELLING
-            ? [$this->travel_reason, $this->contact_name]
-            : [$this->type_other];
+        if (trim((string) $this->purpose) !== '') {
+            return $this->purpose;
+        }
 
+        return self::joinPurposeParts(
+            $this->type === InvoiceType::INVOICE_TYPE_TRAVELLING
+                ? [$this->travelReasonText(), $this->contact_name]
+                : [$this->type_other]
+        );
+    }
+
+    /**
+     * Der Reisegrund als lesbarer Text.
+     *
+     * Der Name des gewählten Grundes -- oder der Wert selbst, wenn er zu keinem passt. Der ist dann der
+     * Freitext von "Anderer Grund" oder stammt aus der Zeit vor der Auswahl.
+     */
+    public function travelReasonText() : string {
+        return TravelReason::text($this->travel_reason);
+    }
+
+    /**
+     * Setzt einen Zahlungsgrund aus seinen Teilen zusammen: leere fallen weg, damit kein " — " führt
+     * oder hängt.
+     *
+     * @param array<int, ?string> $parts
+     */
+    public static function joinPurposeParts(array $parts) : string {
         $parts = array_map(fn ($part) => trim((string) $part), $parts);
 
         return implode(' — ', array_filter($parts, fn ($part) => $part !== ''));