Files
mareike/app/Models/Invoice.php
T

131 lines
4.1 KiB
PHP

<?php
namespace App\Models;
use App\Enumerations\InvoiceStatus;
use App\Enumerations\InvoiceType;
use App\Scopes\InstancedModel;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
/**
* @property string $tenant
* @property string $cost_unit_id
* @property string $invoice_number
* @property string $status
* @property string $type
* @property string $type_other
* @property boolean $donation
* @property string $user_id
* @property string $contact_name
* @property string $contact_email
* @property string $contact_phone
* @property string $contact_bank_owner
* @property string $contact_bank_iban
* @property float $amount
* @property integer $distance
* @property string $comment
* @property string $changes
* @property string $travel_direction
* @property boolean $passengers
* @property boolean $transportation
* @property string $document_filename
* @property string $approved_by
* @property string $approved_at
* @property boolean $upload_required
* @property string $denied_by
* @property string $denied_at
* @property string $denied_reason
*/
class Invoice extends InstancedModel
{
protected $fillable = [
'tenant',
'cost_unit_id',
'invoice_number',
'status',
'type',
'type_other',
'donation',
'user_id',
'contact_name',
'contact_email',
'contact_phone',
'contact_bank_owner',
'contact_bank_iban',
'payment_purpose',
'amount',
'donation',
'distance',
'comment',
'changes',
'travel_direction',
'travel_reason',
'passengers',
'transportation',
'document_filename',
'approved_by',
'approved_at',
'upload_required',
'denied_by',
'denied_at',
'denied_reason',
];
/**
* Der Verwendungszweck für Überweisung, Buchungstext und Anzeige.
*
* Der Freitext gewinnt, wenn einer erfasst wurde. Sonst benennt der Text den Vorgang: eine
* Beitragserstattung ist keine Auslage des Teilis, sondern die Rücknahme seiner Zahlung -- auf dem
* Kontoauszug muss der Unterschied erkennbar sein. Genannt wird die Abrechnungsnummer, und zwar als
* Belegnummer: unter "Rechnungsnummer" gibt es sie nirgends.
*/
public function paymentPurposeText() : string {
if ($this->payment_purpose !== null) {
return $this->payment_purpose;
}
$subject = $this->type === InvoiceType::INVOICE_TYPE_PARTICIPATION_REFUND
? 'Beitragserstattung'
: 'Auslagenerstattung';
return $subject . ' Belegnummer ' . $this->invoice_number;
}
/**
* 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.
*
* Ältere Belege und Beitragserstattungen haben nichts davon gesetzt; dann 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];
$parts = array_map(fn ($part) => trim((string) $part), $parts);
return implode(' — ', array_filter($parts, fn ($part) => $part !== ''));
}
public function costUnit() : BelongsTo{
return $this->belongsTo(CostUnit::class);
}
public function status() : BelongsTo {
return $this->belongsTo(InvoiceStatus::class, 'status')->first();
}
public function invoiceType() : InvoiceType {
return $this->belongsTo(InvoiceType::class, 'type', 'slug')->first();
}
public function approvedBy() : ?User {
return $this->belongsTo(User::class, 'approved_by')->first();
}
}