Skip to content

Commit f73931a

Browse files
larskemperlarskemper
committed
refactor: unify controller annoations
1 parent 901656a commit f73931a

File tree

5 files changed

+78
-38
lines changed

5 files changed

+78
-38
lines changed

‎src/Controller/DataProviderController.php‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@
1919
use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
2020
use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
2121
use Shopware\Core\Framework\Log\Package;
22+
use Shopware\Core\Framework\Routing\ApiRouteScope;
2223
use Shopware\Core\Framework\Routing\RoutingException;
24+
use Shopware\Core\PlatformRequest;
2325
use SwagMigrationAssistant\DataProvider\Provider\ProviderRegistryInterface;
2426
use SwagMigrationAssistant\DataProvider\Service\EnvironmentServiceInterface;
2527
use SwagMigrationAssistant\Exception\MigrationException;
@@ -32,7 +34,7 @@
3234
use Symfony\Component\HttpFoundation\StreamedResponse;
3335
use Symfony\Component\Routing\Attribute\Route;
3436

35-
#[Route(defaults: ['_routeScope' => ['api']])]
37+
#[Route(defaults: [PlatformRequest::ATTRIBUTE_ROUTE_SCOPE => [ApiRouteScope::ID]])]
3638
#[Package('fundamentals@after-sales')]
3739
class DataProviderController extends AbstractController
3840
{
@@ -54,7 +56,7 @@ public function __construct(
5456
#[Route(
5557
path: '/api/_action/data-provider/get-environment',
5658
name: 'api.admin.data-provider.get-environment',
57-
defaults: ['_acl' => ['admin']],
59+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['admin']],
5860
methods: [Request::METHOD_GET]
5961
)]
6062
public function getEnvironment(Context $context): JsonResponse
@@ -67,7 +69,7 @@ public function getEnvironment(Context $context): JsonResponse
6769
#[Route(
6870
path: '/api/_action/data-provider/get-data',
6971
name: 'api.admin.data-provider.get-data',
70-
defaults: ['_acl' => ['admin']],
72+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['admin']],
7173
methods: [Request::METHOD_GET]
7274
)]
7375
public function getData(Request $request, Context $context): JsonResponse
@@ -89,7 +91,7 @@ public function getData(Request $request, Context $context): JsonResponse
8991
#[Route(
9092
path: '/api/_action/data-provider/get-total',
9193
name: 'api.admin.data-provider.get-total',
92-
defaults: ['_acl' => ['admin']],
94+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['admin']],
9395
methods: [Request::METHOD_GET]
9496
)]
9597
public function getTotal(Request $request, Context $context): JsonResponse
@@ -107,7 +109,7 @@ public function getTotal(Request $request, Context $context): JsonResponse
107109
#[Route(
108110
path: '/api/_action/data-provider/get-table',
109111
name: 'api.admin.data-provider.get-table',
110-
defaults: ['_acl' => ['admin']],
112+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['admin']],
111113
methods: [Request::METHOD_GET]
112114
)]
113115
public function getTable(Request $request, Context $context): JsonResponse
@@ -127,7 +129,7 @@ public function getTable(Request $request, Context $context): JsonResponse
127129
#[Route(
128130
path: '/api/_action/data-provider/generate-document',
129131
name: 'api.admin.data-provider.generate-document',
130-
defaults: ['_acl' => ['admin']],
132+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['admin']],
131133
methods: [Request::METHOD_GET]
132134
)]
133135
public function generateDocument(Request $request, Context $context): JsonResponse
@@ -154,7 +156,7 @@ public function generateDocument(Request $request, Context $context): JsonRespon
154156
#[Route(
155157
path: '/api/_action/data-provider/download-private-file/{file}',
156158
name: 'api.admin.data-provider.download-private-file',
157-
defaults: ['_acl' => ['admin']],
159+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['admin']],
158160
methods: [Request::METHOD_GET]
159161
)]
160162
public function downloadPrivateFile(Request $request, Context $context): StreamedResponse|RedirectResponse

‎src/Controller/ErrorResolutionController.php‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010
use Shopware\Core\Framework\Context;
1111
use Shopware\Core\Framework\DataAbstractionLayer\DefinitionInstanceRegistry;
1212
use Shopware\Core\Framework\Log\Package;
13+
use Shopware\Core\Framework\Routing\ApiRouteScope;
1314
use Shopware\Core\Framework\Validation\WriteConstraintViolationException;
15+
use Shopware\Core\PlatformRequest;
1416
use SwagMigrationAssistant\Exception\MigrationException;
1517
use SwagMigrationAssistant\Migration\ErrorResolution\MigrationFieldExampleGenerator;
1618
use SwagMigrationAssistant\Migration\Validation\MigrationFieldValidationService;
@@ -19,7 +21,7 @@
1921
use Symfony\Component\HttpFoundation\Request;
2022
use Symfony\Component\Routing\Attribute\Route;
2123

22-
#[Route(defaults: ['_routeScope' => ['api']])]
24+
#[Route(defaults: [PlatformRequest::ATTRIBUTE_ROUTE_SCOPE => [ApiRouteScope::ID]])]
2325
#[Package('fundamentals@after-sales')]
2426
class ErrorResolutionController extends AbstractController
2527
{
@@ -35,7 +37,7 @@ public function __construct(
3537
#[Route(
3638
path: '/api/_action/migration/error-resolution/validate',
3739
name: 'api.admin.migration.error-resolution.validate',
38-
defaults: ['_acl' => ['swag_migration.viewer']],
40+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['swag_migration.viewer']],
3941
methods: [Request::METHOD_POST]
4042
)]
4143
public function validateResolution(Request $request, Context $context): JsonResponse
@@ -85,7 +87,7 @@ public function validateResolution(Request $request, Context $context): JsonResp
8587
#[Route(
8688
path: '/api/_action/migration/error-resolution/example-field-structure',
8789
name: 'api.admin.migration.error-resolution.example-field-structure',
88-
defaults: ['_acl' => ['swag_migration.viewer']],
90+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['swag_migration.viewer']],
8991
methods: [Request::METHOD_POST]
9092
)]
9193
public function getExampleFieldStructure(Request $request): JsonResponse

‎src/Controller/HistoryController.php‎

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99

1010
use Shopware\Core\Framework\Context;
1111
use Shopware\Core\Framework\Log\Package;
12+
use Shopware\Core\Framework\Routing\ApiRouteScope;
1213
use Shopware\Core\Framework\Routing\RoutingException;
14+
use Shopware\Core\PlatformRequest;
1315
use SwagMigrationAssistant\Exception\MigrationException;
1416
use SwagMigrationAssistant\Migration\History\HistoryServiceInterface;
1517
use SwagMigrationAssistant\Migration\History\LogGroupingService;
@@ -22,7 +24,7 @@
2224
use Symfony\Component\Routing\Attribute\Route;
2325
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
2426

25-
#[Route(defaults: ['_routeScope' => ['api']])]
27+
#[Route(defaults: [PlatformRequest::ATTRIBUTE_ROUTE_SCOPE => [ApiRouteScope::ID]])]
2628
#[Package('fundamentals@after-sales')]
2729
class HistoryController extends AbstractController
2830
{
@@ -35,7 +37,12 @@ public function __construct(
3537
) {
3638
}
3739

38-
#[Route(path: '/api/_action/migration/get-grouped-logs-of-run', name: 'api.admin.migration.get-grouped-logs-of-run', methods: ['GET'], defaults: ['_acl' => ['swag_migration.viewer']])]
40+
#[Route(
41+
path: '/api/_action/migration/get-grouped-logs-of-run',
42+
name: 'api.admin.migration.get-grouped-logs-of-run',
43+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['swag_migration.viewer']],
44+
methods: [Request::METHOD_GET],
45+
)]
3946
public function getGroupedLogsOfRun(Request $request, Context $context): JsonResponse
4047
{
4148
$runUuid = $request->query->getAlnum('runUuid');
@@ -60,7 +67,12 @@ public function getGroupedLogsOfRun(Request $request, Context $context): JsonRes
6067
]);
6168
}
6269

63-
#[Route(path: '/api/_action/migration/download-logs-of-run', name: 'api.admin.migration.download-logs-of-run', methods: ['POST'], defaults: ['auth_required' => false, '_acl' => ['swag_migration.viewer']])]
70+
#[Route(
71+
path: '/api/_action/migration/download-logs-of-run',
72+
name: 'api.admin.migration.download-logs-of-run',
73+
defaults: ['auth_required' => false, PlatformRequest::ATTRIBUTE_ACL => ['swag_migration.viewer']],
74+
methods: [Request::METHOD_POST],
75+
)]
6476
public function downloadLogsOfRun(Request $request, Context $context): StreamedResponse
6577
{
6678
$runUuid = $request->request->getAlnum('runUuid');
@@ -86,7 +98,12 @@ public function downloadLogsOfRun(Request $request, Context $context): StreamedR
8698
return $response;
8799
}
88100

89-
#[Route(path: '/api/_action/migration/clear-data-of-run', name: 'api.admin.migration.clear-data-of-run', methods: ['POST'], defaults: ['_acl' => ['swag_migration.deleter']])]
101+
#[Route(
102+
path: '/api/_action/migration/clear-data-of-run',
103+
name: 'api.admin.migration.clear-data-of-run',
104+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['swag_migration.deleter']],
105+
methods: [Request::METHOD_POST],
106+
)]
90107
public function clearDataOfRun(Request $request, Context $context): Response
91108
{
92109
$runUuid = $request->request->getAlnum('runUuid');
@@ -104,7 +121,12 @@ public function clearDataOfRun(Request $request, Context $context): Response
104121
return new Response();
105122
}
106123

107-
#[Route(path: '/api/_action/migration/is-media-processing', name: 'api.admin.migration.is-media-processing', methods: ['GET'], defaults: ['_acl' => ['swag_migration_history:read']])]
124+
#[Route(
125+
path: '/api/_action/migration/is-media-processing',
126+
name: 'api.admin.migration.is-media-processing',
127+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['swag_migration_history:read']],
128+
methods: [Request::METHOD_GET],
129+
)]
108130
public function isMediaProcessing(): JsonResponse
109131
{
110132
$result = $this->historyService->isMediaProcessing();
@@ -115,8 +137,8 @@ public function isMediaProcessing(): JsonResponse
115137
#[Route(
116138
path: '/api/_action/migration/get-log-groups',
117139
name: 'api.admin.migration.get-log-groups',
118-
methods: ['GET'],
119-
defaults: ['_acl' => ['swag_migration.viewer']]
140+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['swag_migration.viewer']],
141+
methods: [Request::METHOD_GET],
120142
)]
121143
public function getLogGroups(Request $request, Context $context): JsonResponse
122144
{
@@ -166,8 +188,8 @@ public function getLogGroups(Request $request, Context $context): JsonResponse
166188
#[Route(
167189
path: '/api/_action/migration/get-all-log-ids',
168190
name: 'api.admin.migration.get-all-log-ids',
169-
methods: ['POST'],
170-
defaults: ['_acl' => ['swag_migration.viewer']]
191+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['swag_migration.viewer']],
192+
methods: [Request::METHOD_POST],
171193
)]
172194
public function getAllLogIds(Request $request): JsonResponse
173195
{

‎src/Controller/PremappingController.php‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99

1010
use Shopware\Core\Framework\Context;
1111
use Shopware\Core\Framework\Log\Package;
12+
use Shopware\Core\Framework\Routing\ApiRouteScope;
1213
use Shopware\Core\Framework\Routing\RoutingException;
14+
use Shopware\Core\PlatformRequest;
1315
use SwagMigrationAssistant\Migration\MigrationContextFactoryInterface;
1416
use SwagMigrationAssistant\Migration\Service\PremappingServiceInterface;
1517
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
@@ -18,7 +20,7 @@
1820
use Symfony\Component\HttpFoundation\Response;
1921
use Symfony\Component\Routing\Attribute\Route;
2022

21-
#[Route(defaults: ['_routeScope' => ['api']])]
23+
#[Route(defaults: [PlatformRequest::ATTRIBUTE_ROUTE_SCOPE => [ApiRouteScope::ID]])]
2224
#[Package('fundamentals@after-sales')]
2325
class PremappingController extends AbstractController
2426
{
@@ -31,7 +33,12 @@ public function __construct(
3133
) {
3234
}
3335

34-
#[Route(path: '/api/_action/migration/generate-premapping', name: 'api.admin.migration.generate-premapping', methods: ['POST'], defaults: ['_acl' => ['swag_migration.editor']])]
36+
#[Route(
37+
path: '/api/_action/migration/generate-premapping',
38+
name: 'api.admin.migration.generate-premapping',
39+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['swag_migration.editor']],
40+
methods: [Request::METHOD_POST],
41+
)]
3542
public function generatePremapping(Request $request, Context $context): JsonResponse
3643
{
3744
$dataSelectionIds = $request->request->all('dataSelectionIds');
@@ -44,7 +51,12 @@ public function generatePremapping(Request $request, Context $context): JsonResp
4451
return new JsonResponse($this->premappingService->generatePremapping($context, $migrationContext, $dataSelectionIds));
4552
}
4653

47-
#[Route(path: '/api/_action/migration/write-premapping', name: 'api.admin.migration.write-premapping', methods: ['POST'], defaults: ['_acl' => ['swag_migration.editor']])]
54+
#[Route(
55+
path: '/api/_action/migration/write-premapping',
56+
name: 'api.admin.migration.write-premapping',
57+
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['swag_migration.editor']],
58+
methods: [Request::METHOD_POST],
59+
)]
4860
public function writePremapping(Request $request, Context $context): Response
4961
{
5062
$premapping = $request->request->all('premapping');

0 commit comments

Comments
 (0)