animethemes-server/app/Models/Wiki/Song/Performance.php

<?php

declare(strict_types=1);

namespace App\Models\Wiki\Song;

use App\Concerns\Models\SoftDeletes;
use App\Concerns\Models\Submitable;
use App\Contracts\Models\SoftDeletable;
use App\Events\Wiki\Song\Performance\PerformanceCreated;
use App\Events\Wiki\Song\Performance\PerformanceDeleted;
use App\Events\Wiki\Song\Performance\PerformanceDeleting;
use App\Events\Wiki\Song\Performance\PerformanceRestored;
use App\Events\Wiki\Song\Performance\PerformanceUpdated;
use App\Models\BaseModel;
use App\Models\Wiki\Artist;
use App\Models\Wiki\Song;
use Database\Factories\Wiki\Song\PerformanceFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\MorphTo;
use Illuminate\Database\Eloquent\Relations\Relation;
use OwenIt\Auditing\Auditable as HasAudits;
use OwenIt\Auditing\Contracts\Auditable;

/**
 * @property int $performance_id
 * @property string|null $alias
 * @property string|null $as
 * @property string $artist_type
 * @property int $artist_id
 * @property Artist|Membership $artist
 * @property int|null $relevance
 * @property Song $song
 *
 * @method static PerformanceFactory factory(...$parameters)
 */
class Performance extends BaseModel implements Auditable, SoftDeletable
{
    use HasAudits;
    use HasFactory;
    use SoftDeletes;
    use Submitable;

    final public const string TABLE = 'performances';

    final public const string ATTRIBUTE_ID = 'performance_id';
    final public const string ATTRIBUTE_SONG = 'song_id';
    final public const string ATTRIBUTE_ARTIST_TYPE = 'artist_type';
    final public const string ATTRIBUTE_ARTIST_ID = 'artist_id';
    final public const string ATTRIBUTE_ARTIST = 'artist';
    final public const string ATTRIBUTE_ALIAS = 'alias';
    final public const string ATTRIBUTE_AS = 'as';
    final public const string ATTRIBUTE_RELEVANCE = 'relevance';

    final public const string RELATION_ARTIST = 'artist';
    final public const string RELATION_MEMBERSHIP = self::RELATION_ARTIST;
    final public const string RELATION_SONG = 'song';

    /**
     * The table associated with the model.
     *
     * @var string
     */
    protected $table = Performance::TABLE;

    /**
     * The primary key associated with the table.
     *
     * @var string
     */
    protected $primaryKey = Performance::ATTRIBUTE_ID;

    /**
     * The event map for the model.
     *
     * Allows for object-based events for native Eloquent events.
     *
     * @var array<string, class-string>
     */
    protected $dispatchesEvents = [
        'created' => PerformanceCreated::class,
        'deleted' => PerformanceDeleted::class,
        'deleting' => PerformanceDeleting::class,
        'restored' => PerformanceRestored::class,
        'updated' => PerformanceUpdated::class,
    ];

    /**
     * The attributes that are mass assignable.
     *
     * @var list<string>
     */
    protected $fillable = [
        Performance::ATTRIBUTE_SONG,
        Performance::ATTRIBUTE_ARTIST_TYPE,
        Performance::ATTRIBUTE_ARTIST_ID,
        Performance::ATTRIBUTE_ALIAS,
        Performance::ATTRIBUTE_AS,
        Performance::ATTRIBUTE_RELEVANCE,
    ];

    public function getName(): string
    {
        return strval($this->getKey());
    }

    public function getSubtitle(): string
    {
        return $this->song->getName();
    }

    public function isMembership(): bool
    {
        return $this->artist_type === Relation::getMorphAlias(Membership::class);
    }

    /**
     * @return BelongsTo<Song, $this>
     */
    public function song(): BelongsTo
    {
        return $this->belongsTo(Song::class, Song::ATTRIBUTE_ID);
    }

    public function artist(): MorphTo
    {
        return $this->morphTo();
    }

    /**
     * Alias of artist().
     */
    public function membership(): MorphTo
    {
        return $this->artist();
    }
}