src/Controller/Api/Magazine/Admin/MagazineAddModeratorsApi.php
<?php
// SPDX-FileCopyrightText: 2023 /kbin contributors <https://kbin.pub/>
//
// SPDX-License-Identifier: AGPL-3.0-only
declare(strict_types=1);
namespace App\Controller\Api\Magazine\Admin;
use App\Controller\Api\Magazine\MagazineBaseApi;
use App\Entity\Magazine;
use App\Entity\Moderator;
use App\Entity\User;
use App\Kbin\Magazine\DTO\MagazineModeratorDto;
use App\Kbin\Magazine\DTO\MagazineResponseDto;
use App\Kbin\Magazine\Factory\MagazineFactory;
use App\Kbin\Magazine\Moderator\MagazineModeratorAdd;
use Nelmio\ApiDocBundle\Annotation\Model;
use Nelmio\ApiDocBundle\Annotation\Security;
use OpenApi\Attributes as OA;
use Symfony\Bridge\Doctrine\Attribute\MapEntity;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Symfony\Component\RateLimiter\RateLimiterFactory;
use Symfony\Component\Security\Http\Attribute\IsGranted;
class MagazineAddModeratorsApi extends MagazineBaseApi
{
#[OA\Response(
response: 200,
description: 'Moderator added',
content: new Model(type: MagazineResponseDto::class),
headers: [
new OA\Header(
header: 'X-RateLimit-Remaining',
schema: new OA\Schema(type: 'integer'),
description: 'Number of requests left until you will be rate limited'
),
new OA\Header(
header: 'X-RateLimit-Retry-After',
schema: new OA\Schema(type: 'integer'),
description: 'Unix timestamp to retry the request after'
),
new OA\Header(
header: 'X-RateLimit-Limit',
schema: new OA\Schema(type: 'integer'),
description: 'Number of requests available'
),
]
)]
#[OA\Response(
response: 400,
description: 'User is already a moderator of this magazine',
content: new OA\JsonContent(ref: new Model(type: \App\Schema\Errors\BadRequestErrorSchema::class))
)]
#[OA\Response(
response: 401,
description: 'Permission denied due to missing or expired token',
content: new OA\JsonContent(ref: new Model(type: \App\Schema\Errors\UnauthorizedErrorSchema::class))
)]
#[OA\Response(
response: 403,
description: 'You do not have permission to update this magazine',
content: new OA\JsonContent(ref: new Model(type: \App\Schema\Errors\ForbiddenErrorSchema::class))
)]
#[OA\Response(
response: 404,
description: 'Magazine not found',
content: new OA\JsonContent(ref: new Model(type: \App\Schema\Errors\NotFoundErrorSchema::class))
)]
#[OA\Response(
response: 429,
description: 'You are being rate limited',
content: new OA\JsonContent(ref: new Model(type: \App\Schema\Errors\TooManyRequestsErrorSchema::class)),
headers: [
new OA\Header(
header: 'X-RateLimit-Remaining',
schema: new OA\Schema(type: 'integer'),
description: 'Number of requests left until you will be rate limited'
),
new OA\Header(
header: 'X-RateLimit-Retry-After',
schema: new OA\Schema(type: 'integer'),
description: 'Unix timestamp to retry the request after'
),
new OA\Header(
header: 'X-RateLimit-Limit',
schema: new OA\Schema(type: 'integer'),
description: 'Number of requests available'
),
]
)]
#[OA\Parameter(
name: 'magazine_id',
in: 'path',
description: 'The id of the magazine to update',
schema: new OA\Schema(type: 'integer'),
)]
#[OA\Parameter(
name: 'user_id',
in: 'path',
description: 'The id of the user to add as moderator',
schema: new OA\Schema(type: 'integer'),
)]
#[OA\Tag(name: 'moderation/magazine/owner')]
#[Security(name: 'oauth2', scopes: ['moderate:magazine_admin:moderators'])]
#[IsGranted('ROLE_OAUTH2_MODERATE:MAGAZINE_ADMIN:MODERATORS')]
#[IsGranted('edit', subject: 'magazine')]
/**
* Add a user as a moderator of the magazine.
*/
public function __invoke(
#[MapEntity(id: 'magazine_id')]
Magazine $magazine,
#[MapEntity(id: 'user_id')]
User $user,
MagazineModeratorAdd $magazineModeratorAdd,
MagazineFactory $factory,
RateLimiterFactory $apiModerateLimiter
): JsonResponse {
$headers = $this->rateLimit($apiModerateLimiter);
$moderator = $magazine->moderators->findFirst(
fn (int $index, Moderator $moderator) => $moderator->user->getId() === $user->getId()
);
if (null !== $moderator) {
throw new BadRequestHttpException('The user is already a moderator of this magazine');
}
$dto = new MagazineModeratorDto($magazine);
$dto->user = $user;
$magazineModeratorAdd($dto);
return new JsonResponse(
$this->serializeMagazine($factory->createDto($magazine)),
headers: $headers
);
}
}