$songs * @property bool $has_image If the artist has a (non-default) image * @property string|null $image_path Absolute path to the artist's image * @property float|string $length Total length of the artist's songs in seconds (dynamically calculated) * @property string|int $play_count Total number of times the artist has been played (dynamically calculated) * @property string|int $song_count Total number of songs by the artist (dynamically calculated) * @property string|int $album_count Total number of albums by the artist (dynamically calculated) * @property Carbon $created_at * @property Collection $albums */ class Artist extends Model { use HasFactory; use Searchable; use SupportsDeleteWhereValueNotIn; public const UNKNOWN_ID = 1; public const UNKNOWN_NAME = 'Unknown Artist'; public const VARIOUS_ID = 2; public const VARIOUS_NAME = 'Various Artists'; protected $guarded = ['id']; protected $hidden = ['created_at', 'updated_at']; public static function query(): ArtistBuilder { return parent::query(); } public function newEloquentBuilder($query): ArtistBuilder { return new ArtistBuilder($query); } /** * Get an Artist object from their name. * If such is not found, a new artist will be created. */ public static function getOrCreate(?string $name = null): self { // Remove the BOM from UTF-8/16/32, as it will mess up the database constraints. $encoding = Util::detectUTFEncoding($name); if ($encoding) { $name = mb_convert_encoding($name, 'UTF-8', $encoding); } return static::query()->firstOrCreate(['name' => trim($name) ?: self::UNKNOWN_NAME]); } public function albums(): HasMany { return $this->hasMany(Album::class); } public function songs(): HasMany { return $this->hasMany(Song::class); } protected function isUnknown(): Attribute { return Attribute::get(fn (): bool => $this->id === self::UNKNOWN_ID); } protected function isVarious(): Attribute { return Attribute::get(fn (): bool => $this->id === self::VARIOUS_ID); } /** * Sometimes the tags extracted from getID3 are HTML entity encoded. * This makes sure they are always sane. */ protected function name(): Attribute { return Attribute::get(static fn (string $value): string => html_entity_decode($value) ?: self::UNKNOWN_NAME) ->shouldCache(); } /** * Turn the image name into its absolute URL. */ protected function image(): Attribute { return Attribute::get(static fn (?string $value): ?string => artist_image_url($value))->shouldCache(); } protected function imagePath(): Attribute { return Attribute::get(fn (): ?string => artist_image_path(Arr::get($this->attributes, 'image'))) ->shouldCache(); } protected function hasImage(): Attribute { return Attribute::get(function (): bool { $image = Arr::get($this->attributes, 'image'); return $image && (app()->runningUnitTests() || File::exists(artist_image_path($image))); })->shouldCache(); } /** @return array */ public function toSearchableArray(): array { return [ 'id' => $this->id, 'name' => $this->name, ]; } }