SubscribePageCreateRequest

Author: tatevikg1

composer.json

@@ -36,7 +36,7 @@
     },
     "require": {
         "php": "^8.1",
-        "phplist/core": "dev-dev",
+        "phplist/core": "dev-subscribepage",
         "friendsofsymfony/rest-bundle": "*",
         "symfony/test-pack": "^1.0",
         "symfony/process": "^6.4",

src/Subscription/Controller/SubscribePageController.php

@@ -6,11 +6,14 @@
 
 use OpenApi\Attributes as OA;
 use PhpList\Core\Domain\Identity\Model\PrivilegeFlag;
+use PhpList\Core\Domain\Subscription\Model\SubscribePage;
 use PhpList\Core\Domain\Subscription\Service\Manager\SubscribePageManager;
 use PhpList\Core\Security\Authentication;
 use PhpList\RestBundle\Common\Controller\BaseController;
 use PhpList\RestBundle\Common\Validator\RequestValidator;
+use PhpList\RestBundle\Subscription\Request\SubscribePageRequest;
 use PhpList\RestBundle\Subscription\Serializer\SubscribePageNormalizer;
+use Symfony\Bridge\Doctrine\Attribute\MapEntity;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -54,14 +57,7 @@ public function __construct(
             new OA\Response(
                 response: 200,
                 description: 'Success',
-                content: new OA\JsonContent(
-                    properties: [
-                        new OA\Property(property: 'id', type: 'integer'),
-                        new OA\Property(property: 'title', type: 'string'),
-                        new OA\Property(property: 'active', type: 'boolean'),
-                        new OA\Property(property: 'owner_id', type: 'integer', nullable: true),
-                    ]
-                ),
+                content: new OA\JsonContent(ref: '#/components/schemas/SubscribePage'),
             ),
             new OA\Response(
                 response: 403,
@@ -75,14 +71,18 @@ public function __construct(
             ),
         ]
     )]
-    public function getPage(Request $request, int $id): JsonResponse
-    {
+    public function getPage(
+        Request $request,
+        #[MapEntity(mapping: ['id' => 'id'])] ?SubscribePage $page = null
+    ): JsonResponse {
         $admin = $this->requireAuthentication($request);
         if (!$admin->getPrivileges()->has(PrivilegeFlag::Subscribers)) {
             throw $this->createAccessDeniedException('You are not allowed to view subscribe pages.');
         }
 
-        $page = $this->subscribePageManager->getPage($id);
+        if (!$page) {
+            throw $this->createNotFoundException('Subscribe page not found');
+        }
 
         return $this->json($this->normalizer->normalize($page), Response::HTTP_OK);
     }
@@ -115,14 +115,7 @@ public function getPage(Request $request, int $id): JsonResponse
             new OA\Response(
                 response: 201,
                 description: 'Created',
-                content: new OA\JsonContent(
-                    properties: [
-                        new OA\Property(property: 'id', type: 'integer'),
-                        new OA\Property(property: 'title', type: 'string'),
-                        new OA\Property(property: 'active', type: 'boolean'),
-                        new OA\Property(property: 'owner_id', type: 'integer', nullable: true),
-                    ]
-                )
+                content: new OA\JsonContent(ref: '#/components/schemas/SubscribePage')
             ),
             new OA\Response(
                 response: 403,
@@ -143,19 +136,10 @@ public function createPage(Request $request): JsonResponse
             throw $this->createAccessDeniedException('You are not allowed to create subscribe pages.');
         }
 
-        $data = json_decode($request->getContent(), true) ?: [];
-        $title = isset($data['title']) ? trim((string)$data['title']) : '';
-        $active = isset($data['active']) ? (bool)$data['active'] : false;
-
-        if ($title === '') {
-            return $this->json([
-                'errors' => [
-                    ['field' => 'title', 'message' => 'This field is required.']
-                ]
-            ], Response::HTTP_UNPROCESSABLE_ENTITY);
-        }
+        /** @var SubscribePageRequest $createRequest */
+        $createRequest = $this->validator->validate($request, SubscribePageRequest::class);
 
-        $page = $this->subscribePageManager->createPage($title, $active, $admin);
+        $page = $this->subscribePageManager->createPage($createRequest->title, $createRequest->active, $admin);
 
         return $this->json($this->normalizer->normalize($page), Response::HTTP_CREATED);
     }

src/Subscription/OpenApi/SwaggerSchemasResponse.php

@@ -142,6 +142,15 @@
         ),
     ],
 )]
+#[OA\Schema(
+    schema: 'SubscribePage',
+    properties: [
+        new OA\Property(property: 'id', type: 'integer', example: 1),
+        new OA\Property(property: 'title', type: 'string', example: 'Subscribe to our newsletter'),
+        new OA\Property(property: 'active', type: 'boolean', example: true),
+        new OA\Property(property: 'owner', ref: '#/components/schemas/Administrator'),
+    ],
+)]
 class SwaggerSchemasResponse
 {
 }

src/Subscription/Request/SubscribePageRequest.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Subscription\Request;
+
+use PhpList\RestBundle\Common\Request\RequestInterface;
+use Symfony\Component\Validator\Constraints as Assert;
+
+class SubscribePageRequest implements RequestInterface
+{
+    #[Assert\NotBlank]
+    #[Assert\Email]
+    public string $title;
+
+    #[Assert\Type(type: 'bool')]
+    public ?bool $active = false;
+
+    public function getDto(): SubscribePageRequest
+    {
+        return $this;
+    }
+}