<?php

namespace App\Models;

use App\Traits\CreatedByRelationship;
use App\Traits\CreatedUpdatedBy;
use App\Traits\UpdatedByRelationship;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use App\Scopes\OrganisationScope;
use Spatie\Activitylog\Traits\LogsActivity;
use Spatie\Activitylog\LogOptions;

/**
 * PurchaseReturn
 */
class PurchaseReturn extends Model
{
    use HasFactory, CreatedUpdatedBy, CreatedByRelationship, UpdatedByRelationship;

    /**
     * fillable
     *
     * @var array
     */
    protected $fillable = [
        'organisation_id',
        'purchase_id',
        'return_date',
        'note',
        'total',
        'created_by',
        'updated_by',
    ];

    use LogsActivity;

    public function getActivitylogOptions(): LogOptions
    {
        return LogOptions::defaults()
            ->logAll()
            ->useLogName('purchase')
            ->logOnlyDirty()
            ->setDescriptionForEvent(fn(string $eventName) => "Purchase return ID #{$this->id} has been {$eventName}")
            ->dontSubmitEmptyLogs();
    }

    protected static function booted()
    {
        static::addGlobalScope(new OrganisationScope);

        // Automatically set the organisation_id before creating the model
        static::creating(function ($model) {
            if (auth()->check()) {
                $model->organisation_id = auth()->user()->organisation_id;
            }
        });
    }
    /**
     * purchase
     *
     * @return void
     */
    public function purchase()
    {
        return $this->belongsTo(Purchase::class);
    }

    /**
     * purchaseReturnItems
     *
     * @return void
     */
    public function purchaseReturnItems()
    {
        return $this->hasMany(PurchaseReturnItem::class);
    }