<?php

namespace App\Models;

use App\Traits\CreatedByRelationship;
use App\Traits\UpdatedByRelationship;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
use App\Scopes\OrganisationScope;
use Spatie\Activitylog\Traits\LogsActivity;
use Spatie\Activitylog\LogOptions;


/**
 * SaleReturn
 */
class SaleReturn extends Model
{
    use CreatedByRelationship, UpdatedByRelationship;

    /**
     * fillable
     *
     * @var array
     */
    protected $fillable = [
        'organisation_id',
        'invoice_id',
        'return_date',
        'return_note',
        'return_total_amount',
        'items_info',
        'created_by',
        'updated_by'
    ];

    use LogsActivity;

    public function getActivitylogOptions(): LogOptions
    {
        return LogOptions::defaults()
            ->logAll()
            ->useLogName('Sale returns')
            ->logOnlyDirty()
            ->setDescriptionForEvent(fn(string $eventName) => "Sales returned 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;
            }
        });
    }

    /**
     * invoice
     *
     * @return BelongsTo
     */
    public function invoice(): BelongsTo
    {
        return $this->belongsTo(Invoice::class);
    }

    /**
     * saleReturnItems
     *
     * @return HasMany
     */
    public function saleReturnItems(): HasMany
    {
        return $this->hasMany(SaleReturnItems::class, 'sale_return_id', 'id');
    }

    /**
     * Make the invoice ID 8 digits by padding it with leading zeros.
     *
     * @param  int $id
     * @return string
     */
    public function make8digits($id)
    {
        return str_pad($id, 8, '0', STR_PAD_LEFT);
    }