mirror of
https://github.com/HolgerHatGarKeineNode/einundzwanzig-app.git
synced 2026-06-17 16:40:31 +00:00
🧪 Add API tests and update controllers for detailed course and lecturer data
- 🚀 Introduced feature tests for courses and lecturers, covering pagination limits, detailed data retrieval, and 404 responses. - ✏️ Updated `CourseController` to support `withDetails` for courses, including lecturer and next event data. - ✏️ Updated `LecturerController` to support `withDetails` for lecturers, including future events count. - ⚙️ Expanded routes to include `show` endpoints for courses and lecturers.
This commit is contained in:
@@ -5,6 +5,8 @@ namespace App\Http\Controllers\Api;
|
||||
use App\Http\Controllers\Api\Concerns\FiltersNumericIds;
|
||||
use App\Http\Controllers\Controller;
|
||||
use App\Models\Course;
|
||||
use App\Models\CourseEvent;
|
||||
use App\Models\Lecturer;
|
||||
use Dedoc\Scramble\Attributes\ExcludeRouteFromDocs;
|
||||
use Dedoc\Scramble\Attributes\Group;
|
||||
use Dedoc\Scramble\Attributes\QueryParameter;
|
||||
@@ -24,16 +26,25 @@ class CourseController extends Controller
|
||||
*
|
||||
* Öffentlicher Endpunkt; liefert id und name, alphabetisch sortiert. Ohne den Parameter
|
||||
* 'selected' wird das Ergebnis auf 10 Einträge begrenzt. Jeder Kurs enthält zusätzlich
|
||||
* ein 'image' (Logo-Thumbnail-URL).
|
||||
* ein 'image' (Logo-Thumbnail-URL). Mit 'withDetails' entfällt das Limit und jeder Kurs
|
||||
* enthält zusätzlich description, lecturer (id, name, subtitle, image) und next_event
|
||||
* (Beginn des nächsten zukünftigen Kurs-Events oder null).
|
||||
*/
|
||||
#[QueryParameter(name: 'search', description: 'Teilstring-Suche im Namen des Kurses.', required: false, type: 'string')]
|
||||
#[QueryParameter(name: 'user_id', description: 'Filtert die Kurse nach ihrem Ersteller.', required: false, type: 'integer')]
|
||||
#[QueryParameter(name: 'selected', description: 'Lädt gezielt die angegebenen Kurs-IDs.', required: false, type: 'array')]
|
||||
#[QueryParameter(name: 'withDetails', description: 'Presence-Flag: liefert description, lecturer und next_event mit und hebt das 10-Einträge-Limit auf.', required: false, type: 'string')]
|
||||
public function index(Request $request)
|
||||
{
|
||||
$withDetails = $request->exists('withDetails');
|
||||
|
||||
return Course::query()
|
||||
->select('id', 'name')
|
||||
->select($withDetails ? ['id', 'name', 'description', 'lecturer_id'] : ['id', 'name'])
|
||||
->with('media')
|
||||
->orderBy('name')
|
||||
->when($withDetails, fn (Builder $query) => $query
|
||||
->with('lecturer.media')
|
||||
->withMin(['courseEvents as next_event' => fn (Builder $events) => $events->where('from', '>=', now())], 'from'))
|
||||
->when($request->has('user_id'),
|
||||
fn (Builder $query) => $query->where('created_by', $request->integer('user_id')))
|
||||
->when(
|
||||
@@ -44,17 +55,47 @@ class CourseController extends Controller
|
||||
->when(
|
||||
$request->exists('selected'),
|
||||
fn (Builder $query) => $query->whereIn('id', $this->numericIds($request)),
|
||||
fn (Builder $query) => $query->limit(10)
|
||||
fn (Builder $query) => $withDetails ? $query : $query->limit(10)
|
||||
)
|
||||
->get()
|
||||
->map(function (Course $course) {
|
||||
->map(function (Course $course) use ($withDetails) {
|
||||
$course->image = $course->getFirstMediaUrl('logo',
|
||||
'thumb');
|
||||
|
||||
return $course;
|
||||
if (! $withDetails) {
|
||||
return $course;
|
||||
}
|
||||
|
||||
return [
|
||||
'id' => $course->id,
|
||||
'name' => $course->name,
|
||||
'image' => $course->image,
|
||||
'description' => $course->description,
|
||||
'next_event' => $course->next_event,
|
||||
'lecturer' => $this->lecturerSummary($course->lecturer),
|
||||
];
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Referenten-Kurzinfo für Kurs-Antworten (Liste und Detail).
|
||||
*
|
||||
* @return array<string, mixed>|null
|
||||
*/
|
||||
private function lecturerSummary(?Lecturer $lecturer): ?array
|
||||
{
|
||||
if ($lecturer === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return [
|
||||
'id' => $lecturer->id,
|
||||
'name' => $lecturer->name,
|
||||
'subtitle' => $lecturer->subtitle,
|
||||
'image' => $lecturer->getFirstMediaUrl('avatar', 'thumb'),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Kurs anlegen
|
||||
*
|
||||
@@ -76,10 +117,59 @@ class CourseController extends Controller
|
||||
return response()->json($course->fresh(), Response::HTTP_CREATED);
|
||||
}
|
||||
|
||||
#[ExcludeRouteFromDocs]
|
||||
public function show(Course $course)
|
||||
/**
|
||||
* Kurs anzeigen
|
||||
*
|
||||
* Öffentlicher Endpunkt; liefert einen Kurs mit Beschreibung, Logo, Referent
|
||||
* und allen kommenden Kurs-Events (inkl. Veranstaltungsort und Stadt),
|
||||
* aufsteigend nach Beginn sortiert.
|
||||
*
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
public function show(Course $course): array
|
||||
{
|
||||
//
|
||||
$course->load([
|
||||
'lecturer.media',
|
||||
'media',
|
||||
'courseEvents' => fn ($query) => $query
|
||||
->where('from', '>=', now())
|
||||
->orderBy('from')
|
||||
->with('venue.city.country'),
|
||||
]);
|
||||
|
||||
return [
|
||||
'id' => $course->id,
|
||||
'name' => $course->name,
|
||||
'description' => $course->description,
|
||||
'image' => $course->getFirstMediaUrl('logo', 'preview'),
|
||||
'portalLink' => url()->route('courses.landingpage', [
|
||||
'country' => config('app.domain_country'),
|
||||
'course' => $course,
|
||||
]),
|
||||
'lecturer' => $this->lecturerSummary($course->lecturer),
|
||||
'events' => $course->courseEvents->map(fn (CourseEvent $event) => [
|
||||
'id' => $event->id,
|
||||
'course_id' => $event->course_id,
|
||||
'venue_id' => $event->venue_id,
|
||||
'from' => $event->from,
|
||||
'to' => $event->to,
|
||||
'link' => $event->link,
|
||||
'venue' => [
|
||||
'id' => $event->venue->id,
|
||||
'name' => $event->venue->name,
|
||||
'city' => [
|
||||
'id' => $event->venue->city->id,
|
||||
'name' => $event->venue->city->name,
|
||||
'country_id' => $event->venue->city->country_id,
|
||||
'country' => [
|
||||
'id' => $event->venue->city->country->id,
|
||||
'name' => $event->venue->city->country->name,
|
||||
'code' => $event->venue->city->country->code,
|
||||
],
|
||||
],
|
||||
],
|
||||
])->all(),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user