Mirrors/koel
2
0
Fork 0
mirror of https://github.com/koel/koel synced 2024-09-20 06:11:53 +00:00
Code Issues Projects Releases Packages Wiki Activity

refactor: better repository method naming and usage

Browse source
This commit is contained in:
Phan An 2024-01-01 21:38:41 +01:00
parent 5f0eaf228d
commit d8282557d7
12 changed files with 28 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
app/Http/Controllers/API/AlbumController.php
View file

@ -20,6 +20,6 @@ class AlbumController extends Controller
public function show(Album $album)
{
return AlbumResource::make($this->repository->getOne($album->id));
return AlbumResource::make($album);
}
}

2
app/Http/Controllers/API/ArtistController.php
View file

@ -20,6 +20,6 @@ class ArtistController extends Controller
public function show(Artist $artist)
{
return ArtistResource::make($this->repository->getOne($artist->id));
return ArtistResource::make($artist);
}
}

4
app/Http/Controllers/API/PlaylistController.php
View file

@ -38,7 +38,7 @@ class PlaylistController extends Controller
if ($request->folder_id) {
/** @var PlaylistFolder $folder */
$folder = $this->folderRepository->getOneById($request->folder_id);
$folder = $this->folderRepository->getOne($request->folder_id);
$this->authorize('own', $folder);
}
@ -65,7 +65,7 @@ class PlaylistController extends Controller
if ($request->folder_id) {
/** @var PlaylistFolder $folder */
$folder = $this->folderRepository->getOneById($request->folder_id);
$folder = $this->folderRepository->getOne($request->folder_id);
$this->authorize('own', $folder);
}

4
app/Http/Controllers/API/SongController.php
View file

@ -53,9 +53,9 @@ class SongController extends Controller
$this->authorize('admin', $this->user);
$updatedSongs = $this->songService->updateSongs($request->songs, SongUpdateData::fromRequest($request));
$albums = $this->albumRepository->getByIds($updatedSongs->pluck('album_id')->toArray());
$albums = $this->albumRepository->getMany($updatedSongs->pluck('album_id')->toArray());
$artists = $this->artistRepository->getByIds(
$artists = $this->artistRepository->getMany(
array_merge(
$updatedSongs->pluck('artist_id')->all(),
$updatedSongs->pluck('album_artist_id')->all()

2
app/Http/Controllers/Download/SongController.php
View file

@ -15,7 +15,7 @@ class SongController extends Controller
public function show(SongRequest $request)
{
$songs = $this->songRepository->getByIds($request->songs);
$songs = $this->songRepository->getMany($request->songs);
return response()->download($this->downloadService->from($songs));
}

5
app/Repositories/AlbumRepository.php
View file

@ -14,11 +14,6 @@ class AlbumRepository extends Repository
{
use Searchable;
public function getOne(int $id): Album
{
return Album::query()->find($id);
}
/** @return Collection|array<array-key, Album> */
public function getRecentlyAdded(int $count = 6): Collection
{

7
app/Repositories/ArtistRepository.php
View file

@ -37,13 +37,8 @@ class ArtistRepository extends Repository
->get('artists.*');
}
public function getOne(int $id): Artist
{
return Artist::query()->find($id);
}
/** @return Collection|array<array-key, Artist> */
public function getByIds(array $ids, bool $inThatOrder = false): Collection
public function getMany(array $ids, bool $inThatOrder = false): Collection
{
$artists = Artist::query()
->isStandard()

13
app/Repositories/Repository.php
View file

@ -27,20 +27,25 @@ abstract class Repository implements RepositoryInterface
return preg_replace('/(.+)\\\\Repositories\\\\(.+)Repository$/m', '$1\Models\\\$2', static::class);
}
public function getOneById($id): ?Model
public function getOne($id): Model
{
return $this->model->findOrFail($id);
}
public function findOne($id): ?Model
{
return $this->model->find($id);
}
/** @return Collection|array<Model> */
public function getByIds(array $ids, bool $inThatOrder = false): Collection
/** @return Collection|array<array-key, Model> */
public function getMany(array $ids, bool $inThatOrder = false): Collection
{
$models = $this->model::query()->find($ids);
return $inThatOrder ? $models->orderByArray($ids) : $models;
}
/** @return Collection|array<Model> */
/** @return Collection|array<array-key, Model> */
public function getAll(): Collection
{
return $this->model->all();

6
app/Repositories/RepositoryInterface.php
View file

@ -7,10 +7,12 @@ use Illuminate\Support\Collection;
interface RepositoryInterface
{
public function getOneById($id): ?Model;
public function getOne($id): Model;
public function findOne($id): ?Model;
/** @return Collection|array<Model> */
public function getByIds(array $ids, bool $inThatOrder = false): Collection;
public function getMany(array $ids, bool $inThatOrder = false): Collection;
/** @return Collection|array<Model> */
public function getAll(): Collection;

6
app/Repositories/SongRepository.php
View file

@ -175,7 +175,7 @@ class SongRepository extends Repository
}
/** @return Collection|array<array-key, Song> */
public function getByIds(array $ids, bool $inThatOrder = false, ?User $scopedUser = null): Collection
public function getMany(array $ids, bool $inThatOrder = false, ?User $scopedUser = null): Collection
{
$songs = Song::query()
->withMeta($scopedUser ?? $this->auth->user())
@ -185,12 +185,12 @@ class SongRepository extends Repository
return $inThatOrder ? $songs->orderByArray($ids) : $songs;
}
public function getOne(string $id, ?User $scopedUser = null): Song
public function getOne($id, ?User $scopedUser = null): Song
{
return Song::query()->withMeta($scopedUser ?? $this->auth->user())->findOrFail($id);
}
public function findOne(string $id, ?User $scopedUser = null): ?Song
public function findOne($id, ?User $scopedUser = null): ?Song
{
return Song::query()->withMeta($scopedUser ?? $this->auth->user())->find($id);
}

2
app/Services/QueueService.php
View file

@ -25,7 +25,7 @@ class QueueService
$currentSong = $state->current_song_id ? $this->songRepository->findOne($state->current_song_id, $user) : null;
return QueueStateDTO::create(
$this->songRepository->getByIds(ids: $state->song_ids, inThatOrder: true, scopedUser: $user),
$this->songRepository->getMany(ids: $state->song_ids, inThatOrder: true, scopedUser: $user),
$currentSong,
$state->playback_position ?? 0
);

6
app/Services/SearchService.php
View file

@ -33,13 +33,13 @@ class SearchService
$scopedUser ??= auth()->user();
return ExcerptSearchResult::make(
$this->songRepository->getByIds(
$this->songRepository->getMany(
ids: Song::search($keywords)->get()->take($count)->pluck('id')->all(),
inThatOrder: true,
scopedUser: $scopedUser
),
$this->artistRepository->getByIds(Artist::search($keywords)->get()->take($count)->pluck('id')->all(), true),
$this->albumRepository->getByIds(Album::search($keywords)->get()->take($count)->pluck('id')->all(), true),
$this->artistRepository->getMany(Artist::search($keywords)->get()->take($count)->pluck('id')->all(), true),
$this->albumRepository->getMany(Album::search($keywords)->get()->take($count)->pluck('id')->all(), true),
);
}