<?php

namespace Alexr\Models;

use Evavel\Models\Model;

/**
 * Ledger of every movement against a voucher's balance. The voucher's
 * remaining_amount is the running total; this table explains it and is the
 * audit trail (who redeemed, when, against which booking).
 */
class VoucherRedemption extends Model
{
	public static $table_name = 'voucher_redemptions';
	public static $table_meta = false;
	public static $pivot_tenant_field = 'restaurant_id';

	// Movement types. `amount` is the value applied to the balance in cents:
	//   redeem      -> value consumed (balance decreases)
	//   refund      -> value restored on cancellation (balance increases)
	//   adjustment  -> manual staff correction (+/-)
	const TYPE_REDEEM     = 'redeem';
	const TYPE_REFUND     = 'refund';
	const TYPE_ADJUSTMENT = 'adjustment';

	protected $casts = [
		'id'            => 'int',
		'restaurant_id' => 'int',
		'voucher_id'    => 'int',
		'booking_id'    => 'int',
		'user_id'       => 'int',
		'amount'        => 'int',
		'settings'      => 'array',
	];

	public function voucher()
	{
		return $this->belongsTo(Voucher::class);
	}

	public function restaurant()
	{
		return $this->belongsTo(Restaurant::class);
	}
}