docs: added generics notation for eloquent relationships (#745)

AnimeThemes · Sep 12, 2024 · 326f828 · 326f828
1 parent 84a0281
commit 326f828
Show file tree

Hide file tree

Showing 36 changed files with 92 additions and 92 deletions.
diff --git a/app/Models/Admin/ActionLog.php b/app/Models/Admin/ActionLog.php
@@ -145,7 +145,7 @@ public function actionable(): MorphTo
     /**
      * Get the user that initiated the action.
      *
-     * @return BelongsTo
+     * @return BelongsTo<User, ActionLog>
      */
     public function user(): BelongsTo
     {

diff --git a/app/Models/Admin/FeaturedTheme.php b/app/Models/Admin/FeaturedTheme.php
@@ -134,7 +134,7 @@ public function getSubtitle(): string
     /**
      * Get the user that recommended the featured theme.
      *
-     * @return BelongsTo
+     * @return BelongsTo<User, FeaturedTheme>
      */
     public function user(): BelongsTo
     {
@@ -144,7 +144,7 @@ public function user(): BelongsTo
     /**
      * Get the entry for the featured video.
      *
-     * @return BelongsTo
+     * @return BelongsTo<AnimeThemeEntry, FeaturedTheme>
      */
     public function animethemeentry(): BelongsTo
     {
@@ -154,7 +154,7 @@ public function animethemeentry(): BelongsTo
     /**
      * Get the video to feature.
      *
-     * @return BelongsTo
+     * @return BelongsTo<Video, FeaturedTheme>
      */
     public function video(): BelongsTo
     {

diff --git a/app/Models/Auth/User.php b/app/Models/Auth/User.php
@@ -221,7 +221,7 @@ public function getFilamentAvatarUrl(): string
     /**
      * Get the playlists that belong to the user.
      *
-     * @return HasMany
+     * @return HasMany<Playlist>
      */
     public function playlists(): HasMany
     {
@@ -231,7 +231,7 @@ public function playlists(): HasMany
     /**
      * Get the playlists that belong to the user.
      *
-     * @return HasMany
+     * @return HasMany<ExternalProfile>
      */
     public function externalprofiles(): HasMany
     {
@@ -241,7 +241,7 @@ public function externalprofiles(): HasMany
     /**
      * Get the action logs that the user has executed.
      *
-     * @return HasMany
+     * @return HasMany<ActionLog>
      */
     public function actionlogs(): HasMany
     {

diff --git a/app/Models/Discord/DiscordThread.php b/app/Models/Discord/DiscordThread.php
@@ -105,7 +105,7 @@ public function getSubtitle(): string
     /**
      * Gets the anime that the thread uses.
      *
-     * @return BelongsTo
+     * @return BelongsTo<Anime, DiscordThread>
      */
     public function anime(): BelongsTo
     {

diff --git a/app/Models/List/External/ExternalEntry.php b/app/Models/List/External/ExternalEntry.php
@@ -133,7 +133,7 @@ public function getRouteKeyName(): string
     /**
      * Get the anime that owns the user external entry.
      *
-     * @return BelongsTo
+     * @return BelongsTo<Anime, ExternalEntry>
      */
     public function anime(): BelongsTo
     {
@@ -143,7 +143,7 @@ public function anime(): BelongsTo
     /**
      * Get the user profile that owns the user profile.
      *
-     * @return BelongsTo
+     * @return BelongsTo<ExternalProfile, ExternalEntry>
      */
     public function externalprofile(): BelongsTo
     {

diff --git a/app/Models/List/External/ExternalToken.php b/app/Models/List/External/ExternalToken.php
@@ -118,7 +118,7 @@ public function getRouteKeyName(): string
     /**
      * Get the external profile that owns the external token.
      *
-     * @return BelongsTo
+     * @return BelongsTo<ExternalProfile, ExternalToken>
      */
     public function externalprofile(): BelongsTo
     {

diff --git a/app/Models/List/ExternalProfile.php b/app/Models/List/ExternalProfile.php
@@ -180,7 +180,7 @@ public function isClaimed(): bool
     /**
      * Get the entries for the profile.
      *
-     * @return HasMany
+     * @return HasMany<ExternalEntry>
      */
     public function externalentries(): HasMany
     {
@@ -190,7 +190,7 @@ public function externalentries(): HasMany
     /**
      * Get the user that owns the profile.
      *
-     * @return BelongsTo
+     * @return BelongsTo<User, ExternalProfile>
      */
     public function user(): BelongsTo
     {
@@ -200,7 +200,7 @@ public function user(): BelongsTo
     /**
      * Get the external token that the external profile owns.
      *
-     * @return HasOne
+     * @return HasOne<ExternalToken>
      */
     public function externaltoken(): HasOne
     {

diff --git a/app/Models/List/Playlist.php b/app/Models/List/Playlist.php
@@ -175,7 +175,7 @@ public function shouldBeSearchable(): bool
     /**
      * Get the user that owns the playlist.
      *
-     * @return BelongsTo
+     * @return BelongsTo<User, Playlist>
      */
     public function user(): BelongsTo
     {
@@ -185,7 +185,7 @@ public function user(): BelongsTo
     /**
      * Get the first track of the playlist.
      *
-     * @return BelongsTo
+     * @return BelongsTo<PlaylistTrack, Playlist>
      */
     public function first(): BelongsTo
     {
@@ -195,7 +195,7 @@ public function first(): BelongsTo
     /**
      * Get the last track of the playlist.
      *
-     * @return BelongsTo
+     * @return BelongsTo<PlaylistTrack, Playlist>
      */
     public function last(): BelongsTo
     {
@@ -205,7 +205,7 @@ public function last(): BelongsTo
     /**
      * Get the images for the playlist.
      *
-     * @return BelongsToMany
+     * @return BelongsToMany<Image>
      */
     public function images(): BelongsToMany
     {
@@ -218,7 +218,7 @@ public function images(): BelongsToMany
     /**
      * Get the tracks that comprise the playlist.
      *
-     * @return HasMany
+     * @return HasMany<PlaylistTrack>
      */
     public function tracks(): HasMany
     {

diff --git a/app/Models/List/Playlist/PlaylistTrack.php b/app/Models/List/Playlist/PlaylistTrack.php
@@ -156,7 +156,7 @@ public function getSubtitle(): string
     /**
      * Get the entry of the track.
      *
-     * @return BelongsTo
+     * @return BelongsTo<AnimeThemeEntry, PlaylistTrack>
      */
     public function animethemeentry(): BelongsTo
     {
@@ -166,7 +166,7 @@ public function animethemeentry(): BelongsTo
     /**
      * Get the playlist the track belongs to.
      *
-     * @return BelongsTo
+     * @return BelongsTo<Playlist, PlaylistTrack>
      */
     public function playlist(): BelongsTo
     {
@@ -176,7 +176,7 @@ public function playlist(): BelongsTo
     /**
      * Get the previous track.
      *
-     * @return BelongsTo
+     * @return BelongsTo<PlaylistTrack, PlaylistTrack>
      */
     public function previous(): BelongsTo
     {
@@ -186,7 +186,7 @@ public function previous(): BelongsTo
     /**
      * Get the next track.
      *
-     * @return BelongsTo
+     * @return BelongsTo<PlaylistTrack, PlaylistTrack>
      */
     public function next(): BelongsTo
     {
@@ -196,7 +196,7 @@ public function next(): BelongsTo
     /**
      * Get the video of the track.
      *
-     * @return BelongsTo
+     * @return BelongsTo<Video, PlaylistTrack>
      */
     public function video(): BelongsTo
     {

diff --git a/app/Models/Wiki/Anime.php b/app/Models/Wiki/Anime.php
@@ -199,7 +199,7 @@ public function getSubtitle(): string
     /**
      * Get the synonyms for the anime.
      *
-     * @return HasMany
+     * @return HasMany<AnimeSynonym>
      */
     public function animesynonyms(): HasMany
     {
@@ -209,7 +209,7 @@ public function animesynonyms(): HasMany
     /**
      * Get the discord thread that the anime owns.
      *
-     * @return HasOne
+     * @return HasOne<DiscordThread>
      */
     public function discordthread(): HasOne
     {
@@ -219,7 +219,7 @@ public function discordthread(): HasOne
     /**
      * Get the series the anime is included in.
      *
-     * @return BelongsToMany
+     * @return BelongsToMany<Series>
      */
     public function series(): BelongsToMany
     {
@@ -232,7 +232,7 @@ public function series(): BelongsToMany
     /**
      * Get the themes for the anime.
      *
-     * @return HasMany
+     * @return HasMany<AnimeTheme>
      */
     public function animethemes(): HasMany
     {
@@ -242,7 +242,7 @@ public function animethemes(): HasMany
     /**
      * Get the resources for the anime.
      *
-     * @return BelongsToMany
+     * @return BelongsToMany<ExternalResource>
      */
     public function resources(): BelongsToMany
     {
@@ -256,7 +256,7 @@ public function resources(): BelongsToMany
     /**
      * Get the images for the anime.
      *
-     * @return BelongsToMany
+     * @return BelongsToMany<Image>
      */
     public function images(): BelongsToMany
     {
@@ -269,7 +269,7 @@ public function images(): BelongsToMany
     /**
      * Get the studios that produced the anime.
      *
-     * @return BelongsToMany
+     * @return BelongsToMany<Studio>
      */
     public function studios(): BelongsToMany
     {
@@ -282,7 +282,7 @@ public function studios(): BelongsToMany
     /**
      * Get the entries for the anime.
      *
-     * @return HasMany
+     * @return HasMany<ExternalEntry>
      */
     public function externalentries(): HasMany
     {

diff --git a/app/Models/Wiki/Anime/AnimeSynonym.php b/app/Models/Wiki/Anime/AnimeSynonym.php
@@ -114,7 +114,7 @@ public function getSubtitle(): string
     /**
      * Gets the anime that owns the synonym.
      *
-     * @return BelongsTo
+     * @return BelongsTo<Anime, AnimeSynonym>
      */
     public function anime(): BelongsTo
     {

diff --git a/app/Models/Wiki/Anime/AnimeTheme.php b/app/Models/Wiki/Anime/AnimeTheme.php
@@ -178,7 +178,7 @@ public function getSubtitle(): string
     /**
      * Gets the anime that owns the theme.
      *
-     * @return BelongsTo
+     * @return BelongsTo<Anime, AnimeTheme>
      */
     public function anime(): BelongsTo
     {
@@ -188,7 +188,7 @@ public function anime(): BelongsTo
     /**
      * Gets the group that the theme uses.
      *
-     * @return BelongsTo
+     * @return BelongsTo<Group, AnimeTheme>
      */
     public function group(): BelongsTo
     {
@@ -198,7 +198,7 @@ public function group(): BelongsTo
     /**
      * Gets the song that the theme uses.
      *
-     * @return BelongsTo
+     * @return BelongsTo<Song, AnimeTheme>
      */
     public function song(): BelongsTo
     {
@@ -208,7 +208,7 @@ public function song(): BelongsTo
     /**
      * Get the entries for the theme.
      *
-     * @return HasMany
+     * @return HasMany<AnimeThemeEntry>
      */
     public function animethemeentries(): HasMany
     {

diff --git a/app/Models/Wiki/Anime/Theme/AnimeThemeEntry.php b/app/Models/Wiki/Anime/Theme/AnimeThemeEntry.php
@@ -178,7 +178,7 @@ public function getSubtitle(): string
     /**
      * Get the theme that owns the entry.
      *
-     * @return BelongsTo
+     * @return BelongsTo<AnimeTheme, AnimeThemeEntry>
      */
     public function animetheme(): BelongsTo
     {
@@ -188,7 +188,7 @@ public function animetheme(): BelongsTo
     /**
      * Get the videos linked in the theme entry.
      *
-     * @return BelongsToMany
+     * @return BelongsToMany<Video>
      */
     public function videos(): BelongsToMany
     {

diff --git a/app/Models/Wiki/Artist.php b/app/Models/Wiki/Artist.php
@@ -153,7 +153,7 @@ public function getSubtitle(): string
     /**
      * Get the songs the artist has performed in.
      *
-     * @return BelongsToMany
+     * @return BelongsToMany<Song>
      */
     public function songs(): BelongsToMany
     {
@@ -167,7 +167,7 @@ public function songs(): BelongsToMany
     /**
      * Get the resources for the artist.
      *
-     * @return BelongsToMany
+     * @return BelongsToMany<ExternalResource>
      */
     public function resources(): BelongsToMany
     {
@@ -181,7 +181,7 @@ public function resources(): BelongsToMany
     /**
      * Get the members that comprise this group.
      *
-     * @return BelongsToMany
+     * @return BelongsToMany<Artist>
      */
     public function members(): BelongsToMany
     {
@@ -195,7 +195,7 @@ public function members(): BelongsToMany
     /**
      * Get the groups the artist has performed in.
      *
-     * @return BelongsToMany
+     * @return BelongsToMany<Artist>
      */
     public function groups(): BelongsToMany
     {
@@ -209,7 +209,7 @@ public function groups(): BelongsToMany
     /**
      * Get the images for the artist.
      *
-     * @return BelongsToMany
+     * @return BelongsToMany<Image>
      */
     public function images(): BelongsToMany
     {