Skip to content

Commit 64d2b6f

Browse files
tatevikg1tatevikg1
committed
ISSUE-345: refactor
1 parent 84aebe1 commit 64d2b6f

14 files changed

Lines changed: 143 additions & 126 deletions

‎src/Identity/Controller/AdminAttributeDefinitionController.php‎

Lines changed: 9 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
use Symfony\Component\HttpFoundation\Response;
2121
use Symfony\Component\Routing\Attribute\Route;
2222

23-
#[Route('/administrators/attributes')]
23+
#[Route('/administrators/attributes', name: 'admin_attribute_definition_')]
2424
class AdminAttributeDefinitionController extends BaseController
2525
{
2626
private AdminAttributeDefinitionManager $definitionManager;
@@ -40,25 +40,15 @@ public function __construct(
4040
$this->paginatedDataProvider = $paginatedDataProvider;
4141
}
4242

43-
#[Route('', name: 'create_admin_attribute_definition', methods: ['POST'])]
43+
#[Route('', name: 'create', methods: ['POST'])]
4444
#[OA\Post(
4545
path: '/administrators/attributes',
4646
description: 'Returns created admin attribute definition.',
4747
summary: 'Create an admin attribute definition.',
4848
requestBody: new OA\RequestBody(
4949
description: 'Pass parameters to create admin attribute.',
5050
required: true,
51-
content: new OA\JsonContent(
52-
required: ['name'],
53-
properties: [
54-
new OA\Property(property: 'name', type: 'string', format: 'string', example: 'Country'),
55-
new OA\Property(property: 'type', type: 'string', example: 'checkbox'),
56-
new OA\Property(property: 'order', type: 'number', example: 12),
57-
new OA\Property(property: 'default_value', type: 'string', example: 'United States'),
58-
new OA\Property(property: 'required', type: 'boolean', example: true),
59-
new OA\Property(property: 'table_name', type: 'string', example: 'list_attributes'),
60-
]
61-
)
51+
content: new OA\JsonContent(ref: '#/components/schemas/CreateAdminAttributeDefinitionRequest')
6252
),
6353
tags: ['admin-attributes'],
6454
parameters: [
@@ -103,25 +93,15 @@ public function create(Request $request): JsonResponse
10393
return $this->json($json, Response::HTTP_CREATED);
10494
}
10595

106-
#[Route('/{definitionId}', name: 'update_admin_attribute_definition', methods: ['PUT'])]
96+
#[Route('/{definitionId}', name: 'update', requirements: ['definitionId' => '\d+'], methods: ['PUT'])]
10797
#[OA\Put(
10898
path: '/administrators/attributes/{definitionId}',
10999
description: 'Returns updated admin attribute definition.',
110100
summary: 'Update an admin attribute definition.',
111101
requestBody: new OA\RequestBody(
112102
description: 'Pass parameters to update admin attribute.',
113103
required: true,
114-
content: new OA\JsonContent(
115-
required: ['name'],
116-
properties: [
117-
new OA\Property(property: 'name', type: 'string', format: 'string', example: 'Country'),
118-
new OA\Property(property: 'type', type: 'string', example: 'checkbox'),
119-
new OA\Property(property: 'order', type: 'number', example: 12),
120-
new OA\Property(property: 'default_value', type: 'string', example: 'United States'),
121-
new OA\Property(property: 'required', type: 'boolean', example: true),
122-
new OA\Property(property: 'table_name', type: 'string', example: 'list_attributes'),
123-
]
124-
)
104+
content: new OA\JsonContent(ref: '#/components/schemas/CreateAdminAttributeDefinitionRequest')
125105
),
126106
tags: ['admin-attributes'],
127107
parameters: [
@@ -179,7 +159,7 @@ public function update(
179159
return $this->json($json, Response::HTTP_OK);
180160
}
181161

182-
#[Route('/{definitionId}', name: 'delete_admin_attribute_definition', methods: ['DELETE'])]
162+
#[Route('/{definitionId}', name: 'delete', requirements: ['definitionId' => '\d+'], methods: ['DELETE'])]
183163
#[OA\Delete(
184164
path: '/administrators/attributes/{definitionId}',
185165
description: 'Deletes a single admin attribute definition.',
@@ -232,11 +212,11 @@ public function delete(
232212
return $this->json(null, Response::HTTP_NO_CONTENT);
233213
}
234214

235-
#[Route('', name: 'get_admin_attribute_definitions', methods: ['GET'])]
215+
#[Route('', name: 'get_lists', methods: ['GET'])]
236216
#[OA\Get(
237217
path: '/administrators/attributes',
238218
description: 'Returns a JSON list of all admin attribute definitions.',
239-
summary: 'Gets a list of all DMIN attribute definitions.',
219+
summary: 'Gets a list of all admin attribute definitions.',
240220
tags: ['admin-attributes'],
241221
parameters: [
242222
new OA\Parameter(
@@ -300,7 +280,7 @@ public function getPaginated(Request $request): JsonResponse
300280
);
301281
}
302282

303-
#[Route('/{definitionId}', name: 'get_admin_attribute_definition', methods: ['GET'])]
283+
#[Route('/{definitionId}', name: 'get_one', requirements: ['definitionId' => '\d+'], methods: ['GET'])]
304284
#[OA\Get(
305285
path: '/administrators/attributes/{definitionId}',
306286
description: 'Returns a single attribute with specified ID.',

‎src/Identity/Controller/AdminAttributeValueController.php‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
use Symfony\Component\HttpFoundation\Response;
2222
use Symfony\Component\Routing\Attribute\Route;
2323

24-
#[Route('/administrators/attribute-values')]
24+
#[Route('/administrators/attribute-values', name: 'admin_attribute_value_')]
2525
class AdminAttributeValueController extends BaseController
2626
{
2727
private AdminAttributeManager $attributeManager;
@@ -41,7 +41,12 @@ public function __construct(
4141
$this->paginatedDataProvider = $paginatedDataProvider;
4242
}
4343

44-
#[Route('/{adminId}/{definitionId}', name: 'create_admin_attribute_value', methods: ['POST', 'PUT'])]
44+
#[Route(
45+
path: '/{adminId}/{definitionId}',
46+
name: 'create',
47+
requirements: ['adminId' => '\d+', 'definitionId' => '\d+'],
48+
methods: ['POST', 'PUT'],
49+
)]
4550
#[OA\Post(
4651
path: '/administrators/attribute-values/{adminId}/{definitionId}',
4752
description: 'Returns created/updated admin attribute.',
@@ -121,7 +126,12 @@ public function createOrUpdate(
121126
return $this->json($json, Response::HTTP_CREATED);
122127
}
123128

124-
#[Route('/{adminId}/{definitionId}', name: 'delete_admin_attribute', methods: ['DELETE'])]
129+
#[Route(
130+
path: '/{adminId}/{definitionId}',
131+
name: 'delete',
132+
requirements: ['adminId' => '\d+', 'definitionId' => '\d+'],
133+
methods: ['DELETE'],
134+
)]
125135
#[OA\Delete(
126136
path: '/administrators/attribute-values/{adminId}/{definitionId}',
127137
description: 'Deletes a single admin attribute.',
@@ -185,7 +195,7 @@ public function delete(
185195
return $this->json(null, Response::HTTP_NO_CONTENT);
186196
}
187197

188-
#[Route('/{adminId}', name: 'get_admin_attribute_list', methods: ['GET'])]
198+
#[Route('/{adminId}', name: 'get__list', requirements: ['adminId' => '\d+'], methods: ['GET'])]
189199
#[OA\Get(
190200
path: '/administrators/attribute-values/{adminId}',
191201
description: 'Returns a JSON list of all admin attributes.',
@@ -266,7 +276,7 @@ public function getPaginated(
266276
);
267277
}
268278

269-
#[Route('/{adminId}/{definitionId}', name: 'get_admin_attribute', methods: ['GET'])]
279+
#[Route('/{adminId}/{definitionId}', name: 'get_one', methods: ['GET'])]
270280
#[OA\Get(
271281
path: '/administrators/attribute-values/{adminId}/{definitionId}',
272282
description: 'Returns a single attribute.',

‎src/Identity/Controller/AdministratorController.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
/**
2424
* This controller provides CRUD operations for Administrator entities.
2525
*/
26-
#[Route('/administrators')]
26+
#[Route('/administrators', name: 'admin_')]
2727
class AdministratorController extends BaseController
2828
{
2929
private AdministratorManager $administratorManager;
@@ -43,7 +43,7 @@ public function __construct(
4343
$this->paginatedProvider = $paginatedProvider;
4444
}
4545

46-
#[Route('', name: 'get_administrators', methods: ['GET'])]
46+
#[Route('', name: 'get_list', methods: ['GET'])]
4747
#[OA\Get(
4848
path: '/administrators',
4949
description: 'Get list of administrators.',
@@ -106,7 +106,7 @@ public function getAdministrators(Request $request): JsonResponse
106106
);
107107
}
108108

109-
#[Route('', name: 'create_administrator', methods: ['POST'])]
109+
#[Route('', name: 'create', methods: ['POST'])]
110110
#[OA\Post(
111111
path: '/administrators',
112112
description: 'Create a new administrator.',
@@ -145,7 +145,7 @@ public function createAdministrator(
145145
return $this->json($json, Response::HTTP_CREATED);
146146
}
147147

148-
#[Route('/{administratorId}', name: 'get_administrator', methods: ['GET'])]
148+
#[Route('/{administratorId}', name: 'get_one', requirements: ['administratorId' => '\d+'], methods: ['GET'])]
149149
#[OA\Get(
150150
path: '/administrators/{administratorId}',
151151
description: 'Get administrator by ID.',
@@ -186,7 +186,7 @@ public function getAdministrator(
186186
return $this->json($json, Response::HTTP_OK);
187187
}
188188

189-
#[Route('/{administratorId}', name: 'update_administrator', methods: ['PUT'])]
189+
#[Route('/{administratorId}', name: 'update', requirements: ['administratorId' => '\d+'], methods: ['PUT'])]
190190
#[OA\Put(
191191
path: '/administrators/{administratorId}',
192192
description: 'Update an administrator.',
@@ -233,7 +233,7 @@ public function updateAdministrator(
233233
return $this->json($this->normalizer->normalize($administrator), Response::HTTP_OK);
234234
}
235235

236-
#[Route('/{administratorId}', name: 'delete_administrator', methods: ['DELETE'])]
236+
#[Route('/{administratorId}', name: 'delete', requirements: ['administratorId' => '\d+'], methods: ['DELETE'])]
237237
#[OA\Delete(
238238
path: '/administrators/{administratorId}',
239239
description: 'Delete an administrator.',

‎src/Identity/Controller/SessionController.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
* @author Oliver Klee <oliver@phplist.com>
2626
* @author Tatevik Grigoryan <tatevik@phplist.com>
2727
*/
28-
#[Route('/sessions')]
28+
#[Route('/sessions', name: 'session_')]
2929
class SessionController extends BaseController
3030
{
3131
private SessionManager $sessionManager;
@@ -40,7 +40,7 @@ public function __construct(
4040
$this->sessionManager = $sessionManager;
4141
}
4242

43-
#[Route('', name: 'create_session', methods: ['POST'])]
43+
#[Route('', name: 'create', methods: ['POST'])]
4444
#[OA\Post(
4545
path: '/sessions',
4646
description: 'Given valid login data, this will generate a login token that will be valid for 1 hour.',
@@ -92,8 +92,8 @@ public function createSession(
9292
/** @var CreateSessionRequest $createSessionRequest */
9393
$createSessionRequest = $this->validator->validate($request, CreateSessionRequest::class);
9494
$token = $this->sessionManager->createSession(
95-
$createSessionRequest->loginName,
96-
$createSessionRequest->password
95+
loginName:$createSessionRequest->loginName,
96+
password: $createSessionRequest->password
9797
);
9898

9999
$json = $normalizer->normalize($token, 'json');
@@ -108,7 +108,7 @@ public function createSession(
108108
*
109109
* @throws AccessDeniedHttpException
110110
*/
111-
#[Route('/{sessionId}', name: 'delete_session', methods: ['DELETE'])]
111+
#[Route('/{sessionId}', name: 'delete', requirements: ['sessionId' => '\d+'], methods: ['DELETE'])]
112112
#[OA\Delete(
113113
path: '/sessions/{sessionId}',
114114
description: 'Delete the session passed as a parameter.',

‎src/Identity/OpenApi/SwaggerSchemasRequest.php‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,19 @@
7171
],
7272
type: 'object'
7373
)]
74+
#[OA\Schema(
75+
schema: 'CreateAdminAttributeDefinitionRequest',
76+
required: ['name'],
77+
properties: [
78+
new OA\Property(property: 'name', type: 'string', format: 'string', example: 'Country'),
79+
new OA\Property(property: 'type', type: 'string', example: 'checkbox'),
80+
new OA\Property(property: 'order', type: 'number', example: 12),
81+
new OA\Property(property: 'default_value', type: 'string', example: 'United States'),
82+
new OA\Property(property: 'required', type: 'boolean', example: true),
83+
new OA\Property(property: 'table_name', type: 'string', example: 'list_attributes'),
84+
],
85+
type: 'object'
86+
)]
7487
class SwaggerSchemasRequest
7588
{
7689
}

‎src/Messaging/Controller/CampaignController.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
*
2727
* @author Tatevik Grigoryan <tatevik@phplist.com>
2828
*/
29-
#[Route('/campaigns')]
29+
#[Route('/campaigns', name: 'campaign_')]
3030
class CampaignController extends BaseController
3131
{
3232
private MessageNormalizer $normalizer;
@@ -46,7 +46,7 @@ public function __construct(
4646
$this->paginatedProvider = $paginatedProvider;
4747
}
4848

49-
#[Route('', name: 'get_campaigns', methods: ['GET'])]
49+
#[Route('', name: 'get_list', methods: ['GET'])]
5050
#[OA\Get(
5151
path: '/campaigns',
5252
description: 'Returns a JSON list of all campaigns/messages.',
@@ -112,7 +112,7 @@ public function getMessages(Request $request): JsonResponse
112112
);
113113
}
114114

115-
#[Route('/{messageId}', name: 'get_campaign', methods: ['GET'])]
115+
#[Route('/{messageId}', name: 'get_one', requirements: ['messageId' => '\d+'], methods: ['GET'])]
116116
#[OA\Get(
117117
path: '/campaigns/{messageId}',
118118
description: 'Returns campaign/message by id.',
@@ -162,7 +162,7 @@ public function getMessage(
162162
return $this->json($this->normalizer->normalize($message), Response::HTTP_OK);
163163
}
164164

165-
#[Route('', name: 'create_message', methods: ['POST'])]
165+
#[Route('', name: 'create', methods: ['POST'])]
166166
#[OA\Post(
167167
path: '/campaigns',
168168
description: 'Returns created message.',
@@ -224,7 +224,7 @@ public function createMessage(Request $request, MessageNormalizer $normalizer):
224224
return $this->json($normalizer->normalize($data), Response::HTTP_CREATED);
225225
}
226226

227-
#[Route('/{messageId}', name: 'update_campaign', methods: ['PUT'])]
227+
#[Route('/{messageId}', name: 'update', requirements: ['messageId' => '\d+'], methods: ['PUT'])]
228228
#[OA\Put(
229229
path: '/campaigns/{messageId}',
230230
description: 'Updates campaign/message by id.',
@@ -297,7 +297,7 @@ public function updateMessage(
297297
return $this->json($this->normalizer->normalize($data), Response::HTTP_OK);
298298
}
299299

300-
#[Route('/{messageId}', name: 'delete_campaign', methods: ['DELETE'])]
300+
#[Route('/{messageId}', name: 'delete', requirements: ['messageId' => '\d+'], methods: ['DELETE'])]
301301
#[OA\Delete(
302302
path: '/campaigns/{messageId}',
303303
description: 'Delete campaign/message by id.',

‎src/Messaging/Controller/TemplateController.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
*
2525
* @author Tatevik Grigoryan <tatevik@phplist.com>
2626
*/
27-
#[Route('/templates')]
27+
#[Route('/templates', name: 'template_')]
2828
class TemplateController extends BaseController
2929
{
3030
private TemplateNormalizer $normalizer;
@@ -44,7 +44,7 @@ public function __construct(
4444
$this->paginatedDataProvider = $paginatedDataProvider;
4545
}
4646

47-
#[Route('', name: 'get_templates', methods: ['GET'])]
47+
#[Route('', name: 'get_list', methods: ['GET'])]
4848
#[OA\Get(
4949
path: '/templates',
5050
description: 'Returns a JSON list of all templates.',
@@ -112,7 +112,7 @@ public function getTemplates(Request $request): JsonResponse
112112
);
113113
}
114114

115-
#[Route('/{templateId}', name: 'get_template', methods: ['GET'])]
115+
#[Route('/{templateId}', name: 'get_one', requirements: ['templateId' => '\d+'], methods: ['GET'])]
116116
#[OA\Get(
117117
path: '/templates/{templateId}',
118118
description: 'Returns template by id.',
@@ -167,7 +167,7 @@ public function getTemplate(
167167
return $this->json($this->normalizer->normalize($template), Response::HTTP_OK);
168168
}
169169

170-
#[Route('', name: 'create_template', methods: ['POST'])]
170+
#[Route('', name: 'create', methods: ['POST'])]
171171
#[OA\Post(
172172
path: '/templates',
173173
description: 'Returns a JSON response of created template.',
@@ -270,7 +270,7 @@ public function createTemplates(Request $request): JsonResponse
270270
);
271271
}
272272

273-
#[Route('/{templateId}', name: 'delete_template', methods: ['DELETE'])]
273+
#[Route('/{templateId}', name: 'delete', requirements: ['templateId' => '\d+'], methods: ['DELETE'])]
274274
#[OA\Delete(
275275
path: '/templates/{templateId}',
276276
description: 'Deletes template by id.',

‎src/Subscription/Controller/ListMembersController.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
use Symfony\Component\HttpFoundation\Response;
2020
use Symfony\Component\Routing\Attribute\Route;
2121

22-
#[Route('/lists')]
22+
#[Route('/lists', name: 'list_members_')]
2323
class ListMembersController extends BaseController
2424
{
2525
private SubscriberNormalizer $subscriberNormalizer;
@@ -36,7 +36,7 @@ public function __construct(
3636
$this->paginatedProvider = $paginatedProvider;
3737
}
3838

39-
#[Route('/{listId}/subscribers', name: 'get_subscriber_from_list', methods: ['GET'])]
39+
#[Route('/{listId}/subscribers', name: 'get_list', requirements: ['listId' => '\d+'], methods: ['GET'])]
4040
#[OA\Get(
4141
path: '/lists/{listId}/subscribers',
4242
description: 'Returns a JSON list of all subscribers for a subscriber list.',
@@ -121,7 +121,7 @@ public function getListMembers(
121121
);
122122
}
123123

124-
#[Route('/{listId}/subscribers/count', name: 'get_subscribers_count_from_list', methods: ['GET'])]
124+
#[Route('/{listId}/subscribers/count', name: 'get_count', requirements: ['listId' => '\d+'], methods: ['GET'])]
125125
#[OA\Get(
126126
path: '/lists/{listId}/count',
127127
description: 'Returns a count of all subscribers in a given list.',

0 commit comments

Comments
 (0)