mirror of
https://github.com/HolgerHatGarKeineNode/einundzwanzig-app.git
synced 2026-06-11 14:50:30 +00:00
HolgerHatGarKeineNode
351dd87fa9
- 🌐 Added API documentation annotations for multiple controllers (Meetups, Cities, Countries, Courses, Highscores, Venues), improving public and developer-facing endpoint clarity. - ➕ Integrated and configured the `dedoc/scramble` package for automated OpenAPI documentation generation. - 🔒 Excluded internal routes and actions from API documentation using `ExcludeRouteFromDocs` attributes. - 🌍 Added new localization keys for API Token features across multiple languages (`lv`, `es`, etc.). - 🛠️ Introduced `Group`, `Response`, and `QueryParameter` attributes for better request descriptions and structured documentation. - 🚀 Enhanced functionality for listing operations in controllers with filters and query parameters like `search` and `selected`.
91 lines
3.4 KiB
PHP
91 lines
3.4 KiB
PHP
<?php
|
|
|
|
namespace App\Http\Controllers\Api;
|
|
|
|
use App\Http\Controllers\Controller;
|
|
use App\Models\CourseEvent;
|
|
use Dedoc\Scramble\Attributes\Group;
|
|
use Dedoc\Scramble\Attributes\QueryParameter;
|
|
use Dedoc\Scramble\Attributes\Response as ResponseAttribute;
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
use Illuminate\Database\Eloquent\Collection;
|
|
use Illuminate\Http\JsonResponse;
|
|
use Illuminate\Http\Request;
|
|
use Symfony\Component\HttpFoundation\Response;
|
|
|
|
#[Group(name: 'Kurs-Events', weight: 2)]
|
|
class CourseEventController extends Controller
|
|
{
|
|
/**
|
|
* Eigene Kurs-Events auflisten
|
|
*
|
|
* Liefert alle vom authentifizierten Nutzer erstellten Kurs-Events (inkl. zugehörigem
|
|
* Kurs und Veranstaltungsort), absteigend nach Startdatum. Ideal für idempotente
|
|
* Synchronisierung durch externe Clients.
|
|
*
|
|
* @return Collection<int, CourseEvent>
|
|
*/
|
|
#[QueryParameter(name: 'course_id', description: 'Filtert die Kurs-Events auf einen bestimmten Kurs.', required: false, type: 'integer')]
|
|
public function index(Request $request): Collection
|
|
{
|
|
return CourseEvent::query()
|
|
->with(['course:id,name', 'venue:id,name'])
|
|
->where('created_by', $request->user()->id)
|
|
->when(
|
|
$request->filled('course_id'),
|
|
fn (Builder $query) => $query->where('course_id', $request->integer('course_id'))
|
|
)
|
|
->orderByDesc('from')
|
|
->get();
|
|
}
|
|
|
|
/**
|
|
* Kurs-Event anlegen
|
|
*
|
|
* Erlaubt einem authentifizierten Referenten, ein datiertes Kurs-Event programmatisch anzulegen.
|
|
*/
|
|
#[ResponseAttribute(status: 403, description: 'Nur Referenten (is_lecturer) dürfen Kurs-Events anlegen.')]
|
|
public function store(Request $request): JsonResponse
|
|
{
|
|
abort_unless((bool) $request->user()->is_lecturer, Response::HTTP_FORBIDDEN);
|
|
|
|
$validated = $request->validate([
|
|
'course_id' => ['required', 'integer', 'exists:courses,id'],
|
|
'venue_id' => ['required', 'integer', 'exists:venues,id'],
|
|
'from' => ['required', 'date'],
|
|
'to' => ['required', 'date', 'after_or_equal:from'],
|
|
'link' => ['required', 'url', 'max:255'],
|
|
]);
|
|
|
|
$courseEvent = CourseEvent::create($validated);
|
|
|
|
return response()->json($courseEvent->fresh(), Response::HTTP_CREATED);
|
|
}
|
|
|
|
/**
|
|
* Kurs-Event aktualisieren
|
|
*
|
|
* Aktualisiert ein Kurs-Event; nur für den Ersteller oder einen Super-Admin.
|
|
*/
|
|
#[ResponseAttribute(status: 403, description: 'Nur der Ersteller des Kurs-Events oder ein Super-Admin darf es ändern.')]
|
|
public function update(Request $request, CourseEvent $courseEvent): JsonResponse
|
|
{
|
|
abort_unless(
|
|
(int) $courseEvent->created_by === $request->user()->id || $request->user()->hasRole('super-admin'),
|
|
Response::HTTP_FORBIDDEN
|
|
);
|
|
|
|
$validated = $request->validate([
|
|
'course_id' => ['sometimes', 'required', 'integer', 'exists:courses,id'],
|
|
'venue_id' => ['sometimes', 'required', 'integer', 'exists:venues,id'],
|
|
'from' => ['sometimes', 'required', 'date'],
|
|
'to' => ['sometimes', 'required', 'date', 'after_or_equal:from'],
|
|
'link' => ['sometimes', 'required', 'url', 'max:255'],
|
|
]);
|
|
|
|
$courseEvent->update($validated);
|
|
|
|
return response()->json($courseEvent->fresh());
|
|
}
|
|
}
|