279 lines
8.1 KiB
PHP
279 lines
8.1 KiB
PHP
<?php
|
|
|
|
namespace App\Models;
|
|
|
|
use App\Enums\BookingStatus;
|
|
use App\Enums\ReferralSource;
|
|
use App\Models\Concerns\BelongsToTenant;
|
|
use App\Models\Concerns\HasChannelProvenance;
|
|
use App\Observers\BookingObserver;
|
|
use Carbon\CarbonInterface;
|
|
use Database\Factories\BookingFactory;
|
|
use Illuminate\Database\Eloquent\Attributes\Fillable;
|
|
use Illuminate\Database\Eloquent\Attributes\ObservedBy;
|
|
use Illuminate\Database\Eloquent\Attributes\Scope;
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
use Illuminate\Database\Eloquent\Relations\HasOne;
|
|
|
|
/**
|
|
* A reservation or booking. arrival is the first night, departure the day the guest leaves,
|
|
* so a departure and the next arrival on the same day do not collide.
|
|
*/
|
|
#[ObservedBy(BookingObserver::class)]
|
|
#[Fillable([
|
|
'property_id',
|
|
'guest_id',
|
|
'status',
|
|
'source',
|
|
'import_channel_id',
|
|
'origin_channel_id',
|
|
'referral_source',
|
|
'utm_source',
|
|
'utm_medium',
|
|
'utm_campaign',
|
|
'arrival',
|
|
'departure',
|
|
'guests',
|
|
'extras',
|
|
'promo_code',
|
|
'price_adjustment',
|
|
'price_adjustment_label',
|
|
'quote',
|
|
'total',
|
|
'deposit',
|
|
'deposit_due_on',
|
|
'balance_due_on',
|
|
'contract_path',
|
|
'hold_expires_at',
|
|
'offer_version',
|
|
'offer_sent_at',
|
|
'offer_message',
|
|
'offer_path',
|
|
'message',
|
|
'internal_notes',
|
|
'confirmed_at',
|
|
'accepted_at',
|
|
'acceptance',
|
|
'declined_by',
|
|
'cancelled_at',
|
|
'review_requested_at',
|
|
'deposit_reminded_at',
|
|
'balance_requested_at',
|
|
'balance_reminded_at',
|
|
'arrival_info_sent_at',
|
|
])]
|
|
class Booking extends Model
|
|
{
|
|
/** @use HasFactory<BookingFactory> */
|
|
use BelongsToTenant, HasChannelProvenance, HasFactory;
|
|
|
|
public const DIRECT_SOURCES = ['website', 'manual', 'phone', 'direct', 'email'];
|
|
|
|
public function isDirect(): bool
|
|
{
|
|
return $this->import_channel_id === null && $this->origin_channel_id === null && in_array($this->source, self::DIRECT_SOURCES, true);
|
|
}
|
|
|
|
protected static function booted(): void
|
|
{
|
|
static::created(function (Booking $booking): void {
|
|
$booking->forceFill(['reference' => $booking->nextReference()])->saveQuietly();
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Next booking number of this landlord in the year of creation, continuing after the highest
|
|
* number already issued. Existing numbers are never rewritten.
|
|
*/
|
|
public function nextReference(): string
|
|
{
|
|
$year = $this->created_at->format('Y');
|
|
|
|
$references = static::withoutGlobalScope('tenant')
|
|
->where('tenant_id', $this->tenant_id)
|
|
->where('reference', 'like', $year.'-%')
|
|
->whereKeyNot($this->id)
|
|
->lockForUpdate()
|
|
->pluck('reference');
|
|
|
|
$number = 1;
|
|
|
|
foreach ($references as $reference) {
|
|
if (is_string($reference) && preg_match('/-(\d+)$/', $reference, $match) === 1) {
|
|
$number = max($number, ((int) $match[1]) + 1);
|
|
}
|
|
}
|
|
|
|
return $year.'-'.str_pad((string) $number, 4, '0', STR_PAD_LEFT);
|
|
}
|
|
|
|
/**
|
|
* Get the attributes that should be cast.
|
|
*
|
|
* @return array<string, string>
|
|
*/
|
|
protected function casts(): array
|
|
{
|
|
return [
|
|
'status' => BookingStatus::class,
|
|
'referral_source' => ReferralSource::class,
|
|
'arrival' => 'immutable_date',
|
|
'departure' => 'immutable_date',
|
|
'extras' => 'array',
|
|
'quote' => 'array',
|
|
'deposit_due_on' => 'immutable_date',
|
|
'balance_due_on' => 'immutable_date',
|
|
'hold_expires_at' => 'immutable_datetime',
|
|
'confirmed_at' => 'immutable_datetime',
|
|
'offer_sent_at' => 'immutable_datetime',
|
|
'accepted_at' => 'immutable_datetime',
|
|
'acceptance' => 'array',
|
|
'cancelled_at' => 'immutable_datetime',
|
|
'review_requested_at' => 'immutable_datetime',
|
|
'deposit_reminded_at' => 'immutable_datetime',
|
|
'balance_requested_at' => 'immutable_datetime',
|
|
'balance_reminded_at' => 'immutable_datetime',
|
|
'arrival_info_sent_at' => 'immutable_datetime',
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @return BelongsTo<Property, $this>
|
|
*/
|
|
public function property(): BelongsTo
|
|
{
|
|
return $this->belongsTo(Property::class);
|
|
}
|
|
|
|
/**
|
|
* @return BelongsTo<Guest, $this>
|
|
*/
|
|
public function guest(): BelongsTo
|
|
{
|
|
return $this->belongsTo(Guest::class);
|
|
}
|
|
|
|
/** @return BelongsTo<Channel, $this> */
|
|
public function originChannel(): BelongsTo
|
|
{
|
|
return $this->belongsTo(Channel::class, 'origin_channel_id');
|
|
}
|
|
|
|
/** @return BelongsTo<Channel, $this> */
|
|
public function importChannel(): BelongsTo
|
|
{
|
|
return $this->belongsTo(Channel::class, 'import_channel_id');
|
|
}
|
|
|
|
/** @return HasMany<BlockedPeriod, $this> */
|
|
public function channelRepresentations(): HasMany
|
|
{
|
|
return $this->hasMany(BlockedPeriod::class, 'linked_booking_id');
|
|
}
|
|
|
|
public function bookingChannelLabel(): string
|
|
{
|
|
return $this->originChannel?->name ?? $this->importChannel?->name ?? match ($this->source) {
|
|
'website' => 'Eigene Webseite',
|
|
'manual' => 'Manuell / direkt',
|
|
'phone' => 'Telefon',
|
|
'email' => 'E-Mail',
|
|
'direct' => 'Direkt',
|
|
default => $this->source,
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Bookings that currently occupy their dates: confirmed ones and requests/offers whose hold has not expired.
|
|
*
|
|
* @param Builder<Booking> $query
|
|
* @return Builder<Booking>
|
|
*/
|
|
#[Scope]
|
|
protected function occupying(Builder $query): Builder
|
|
{
|
|
return $query->where(fn (Builder $query) => $query
|
|
->whereIn('status', BookingStatus::occupying())
|
|
->orWhere(fn (Builder $query) => $query
|
|
->whereIn('status', BookingStatus::holding())
|
|
->where('hold_expires_at', '>', now())));
|
|
}
|
|
|
|
/**
|
|
* @param Builder<Booking> $query
|
|
* @return Builder<Booking>
|
|
*/
|
|
#[Scope]
|
|
protected function overlapping(Builder $query, CarbonInterface $from, CarbonInterface $until): Builder
|
|
{
|
|
return $query
|
|
->whereDate('arrival', '<', $until)
|
|
->whereDate('departure', '>', $from);
|
|
}
|
|
|
|
/**
|
|
* @return HasOne<Review, $this>
|
|
*/
|
|
public function review(): HasOne
|
|
{
|
|
return $this->hasOne(Review::class);
|
|
}
|
|
|
|
/**
|
|
* @return HasMany<Payment, $this>
|
|
*/
|
|
public function payments(): HasMany
|
|
{
|
|
return $this->hasMany(Payment::class)->orderBy('paid_on');
|
|
}
|
|
|
|
/**
|
|
* Sum of all payments in cents (refunds are negative).
|
|
*/
|
|
public function paidAmount(): int
|
|
{
|
|
return (int) ($this->relationLoaded('payments') ? $this->payments->sum('amount') : $this->payments()->sum('amount'));
|
|
}
|
|
|
|
public function openAmount(): int
|
|
{
|
|
return max(0, $this->total - $this->paidAmount());
|
|
}
|
|
|
|
public function openDeposit(): int
|
|
{
|
|
return max(0, $this->deposit - $this->paidAmount());
|
|
}
|
|
|
|
/**
|
|
* When the balance is already due at confirmation (short-term booking), the guest pays everything at once.
|
|
*/
|
|
public function requiresFullPayment(): bool
|
|
{
|
|
return $this->deposit_due_on !== null && $this->balance_due_on->lessThanOrEqualTo($this->deposit_due_on);
|
|
}
|
|
|
|
public function nights(): int
|
|
{
|
|
return (int) $this->arrival->diffInDays($this->departure);
|
|
}
|
|
|
|
public function isHoldActive(): bool
|
|
{
|
|
return in_array($this->status, BookingStatus::holding(), true) && $this->hold_expires_at?->isFuture();
|
|
}
|
|
|
|
/**
|
|
* The website this stay belongs to, regardless of which landlord is current.
|
|
*/
|
|
public function website(): ?Site
|
|
{
|
|
return $this->property()->withoutGlobalScope('tenant')->first()
|
|
?->site()->withoutGlobalScope('tenant')->first();
|
|
}
|
|
}
|