Skip to content

Commit b2a59c1

Browse files
thorstenthorsten
committed
refactor: added missing translations, improved route information
1 parent f2a6455 commit b2a59c1

13 files changed

+92
-78
lines changed

‎phpmyfaq/src/phpMyFAQ/Controller/Administration/Api/AttachmentController.php

+16-7
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ class AttachmentController extends AbstractController
3636
/**
3737
* @throws \Exception
3838
*/
39-
#[Route('./admin/api/content/attachments')]
39+
#[Route('./admin/api/content/attachments', name: 'admin.api.content.attachments', methods: ['GET'])]
4040
public function delete(Request $request): JsonResponse
4141
{
4242
$this->userHasPermission(PermissionType::ATTACHMENT_DELETE);
@@ -65,7 +65,11 @@ public function delete(Request $request): JsonResponse
6565
/**
6666
* @throws \Exception
6767
*/
68-
#[Route('./admin/api/content/attachments/refresh')]
68+
#[Route(
69+
'./admin/api/content/attachments/refresh',
70+
name: 'admin.api.content.attachments.refresh',
71+
methods: ['POST']
72+
)]
6973
public function refresh(Request $request): JsonResponse
7074
{
7175
$this->userHasPermission(PermissionType::ATTACHMENT_DELETE);
@@ -97,16 +101,17 @@ public function refresh(Request $request): JsonResponse
97101
* @throws AttachmentException
98102
* @throws FileException
99103
* @throws Exception
104+
* @throws \Exception
100105
*/
101-
#[Route('./admin/api/content/attachments/upload')]
106+
#[Route('./admin/api/content/attachments/upload', name: 'admin.api.content.attachments.upload', methods: ['POST'])]
102107
public function upload(Request $request): JsonResponse
103108
{
104109
$this->userHasPermission(PermissionType::ATTACHMENT_ADD);
105110

106111
$files = $request->files->get('filesToUpload');
107112

108113
if (!$files) {
109-
return $this->json(['error' => 'No files to upload.'], Response::HTTP_BAD_REQUEST);
114+
return $this->json(['error' => Translation::get('msgNoImagesForUpload')], Response::HTTP_BAD_REQUEST);
110115
}
111116

112117
$uploadedFiles = [];
@@ -122,9 +127,13 @@ public function upload(Request $request): JsonResponse
122127
$attachment->setRecordLang($request->request->get('record_lang'));
123128
try {
124129
if (!$attachment->save($file->getPathname(), $file->getClientOriginalName())) {
125-
return $this->json(['error' => 'something went wrong'], Response::HTTP_INTERNAL_SERVER_ERROR);
130+
return $this->json(
131+
['error' => Translation::get('msgImageCouldNotBeUploaded')],
132+
Response::HTTP_INTERNAL_SERVER_ERROR
133+
);
126134
}
127-
} catch (AttachmentException | FileException | FileNotFoundException) {
135+
} catch (AttachmentException | FileException | FileNotFoundException $exception) {
136+
return $this->json(['error' => $exception->getMessage()], Response::HTTP_INTERNAL_SERVER_ERROR);
128137
}
129138

130139
$uploadedFiles[] = [
@@ -134,7 +143,7 @@ public function upload(Request $request): JsonResponse
134143
'faqLanguage' => $request->request->get('record_lang')
135144
];
136145
} else {
137-
return $this->json(['error' => 'The image is too large.'], Response::HTTP_BAD_REQUEST);
146+
return $this->json(['error' => Translation::get('msgImageTooLarge')], Response::HTTP_BAD_REQUEST);
138147
}
139148
}
140149

‎phpmyfaq/src/phpMyFAQ/Controller/Administration/Api/CategoryController.php

+13-24
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@
1818
namespace phpMyFAQ\Controller\Administration\Api;
1919

2020
use phpMyFAQ\Category;
21-
use phpMyFAQ\Category\Image;
22-
use phpMyFAQ\Category\Order;
2321
use phpMyFAQ\Category\Permission;
2422
use phpMyFAQ\Category\Relation;
2523
use phpMyFAQ\Controller\AbstractController;
@@ -38,35 +36,34 @@ class CategoryController extends AbstractController
3836
{
3937
/**
4038
* @throws Exception
39+
* @throws \Exception
4140
*/
42-
#[Route('admin/api/category/delete')]
41+
#[Route('admin/api/category/delete', name: 'admin.api.category.delete', methods: ['DELETE'])]
4342
public function delete(Request $request): JsonResponse
4443
{
4544
$this->userHasPermission(PermissionType::CATEGORY_DELETE);
4645

47-
$currentUser = CurrentUser::getCurrentUser($this->configuration);
48-
4946
$data = json_decode($request->getContent());
5047

5148
if (!Token::getInstance($this->container->get('session'))->verifyToken('category', $data->csrfToken)) {
5249
return $this->json(['error' => Translation::get('msgNoPermission')], Response::HTTP_UNAUTHORIZED);
5350
}
5451

55-
[ $currentAdminUser, $currentAdminGroups ] = CurrentUser::getCurrentUserGroupId($currentUser);
52+
[ $currentAdminUser, $currentAdminGroups ] = CurrentUser::getCurrentUserGroupId($this->currentUser);
5653

5754
$category = new Category($this->configuration, [], false);
5855
$category->setUser($currentAdminUser);
5956
$category->setGroups($currentAdminGroups);
6057

6158
$categoryRelation = new Relation($this->configuration, $category);
6259

63-
$categoryImage = new Image($this->configuration);
60+
$categoryImage = $this->container->get('phpmyfaq.category.image');
6461
$categoryImage->setFileName($category->getCategoryData($data->categoryId)->getImage());
6562

66-
$categoryOrder = new Order($this->configuration);
63+
$categoryOrder = $this->container->get('phpmyfaq.category.order');
6764
$categoryOrder->remove($data->categoryId);
6865

69-
$categoryPermission = new Permission($this->configuration);
66+
$categoryPermission = $this->container->get('phpmyfaq.category.permission');
7067

7168
if (
7269
(
@@ -92,15 +89,12 @@ public function delete(Request $request): JsonResponse
9289
}
9390
}
9491

95-
/**
96-
* @throws Exception
97-
*/
98-
#[Route('admin/api/category/permissions', methods: ['GET'])]
92+
#[Route('admin/api/category/permissions', name: 'admin.api.category.permissions', methods: ['GET'])]
9993
public function permissions(Request $request): JsonResponse
10094
{
10195
$this->userIsAuthenticated();
10296

103-
$categoryPermission = new Permission($this->configuration);
97+
$categoryPermission = $this->container->get('phpmyfaq.category.permission');
10498

10599
$categoryData = $request->get('categories');
106100

@@ -123,10 +117,7 @@ public function permissions(Request $request): JsonResponse
123117
);
124118
}
125119

126-
/**
127-
* @throws Exception
128-
*/
129-
#[Route('admin/api/category/translations')]
120+
#[Route('admin/api/category/translations', name: 'admin.api.category.translations', methods: ['GET'])]
130121
public function translations(Request $request): JsonResponse
131122
{
132123
$this->userIsAuthenticated();
@@ -141,9 +132,9 @@ public function translations(Request $request): JsonResponse
141132
}
142133

143134
/**
144-
* @throws Exception
135+
* @throws \Exception
145136
*/
146-
#[Route('admin/api/category/update-order')]
137+
#[Route('admin/api/category/update-order', name: 'admin.api.category.update-order', methods: ['POST'])]
147138
public function updateOrder(Request $request): JsonResponse
148139
{
149140
$this->userHasPermission(PermissionType::CATEGORY_EDIT);
@@ -154,11 +145,9 @@ public function updateOrder(Request $request): JsonResponse
154145
return $this->json(['error' => Translation::get('msgNoPermission')], Response::HTTP_UNAUTHORIZED);
155146
}
156147

157-
$user = CurrentUser::getCurrentUser($this->configuration);
158-
159-
[ $currentAdminUser, $currentAdminGroups ] = CurrentUser::getCurrentUserGroupId($user);
148+
[ $currentAdminUser, $currentAdminGroups ] = CurrentUser::getCurrentUserGroupId($this->currentUser);
160149

161-
$categoryOrder = new Order($this->configuration);
150+
$categoryOrder = $this->container->get('phpmyfaq.category.order');
162151
$categoryOrder->setCategoryTree($data->categoryTree);
163152

164153
$parentId = $categoryOrder->getParentId($data->categoryTree, (int)$data->categoryId);

‎phpmyfaq/src/phpMyFAQ/Controller/Administration/Api/CommentController.php

+2-4
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@
1717

1818
namespace phpMyFAQ\Controller\Administration\Api;
1919

20-
use phpMyFAQ\Comments;
2120
use phpMyFAQ\Controller\AbstractController;
22-
use phpMyFAQ\Core\Exception;
2321
use phpMyFAQ\Enums\PermissionType;
2422
use phpMyFAQ\Session\Token;
2523
use phpMyFAQ\Translation;
@@ -31,7 +29,7 @@
3129
class CommentController extends AbstractController
3230
{
3331
/**
34-
* @throws Exception
32+
* @throws \Exception
3533
*/
3634
#[Route('admin/api/content/comments')]
3735
public function delete(Request $request): JsonResponse
@@ -47,7 +45,7 @@ public function delete(Request $request): JsonResponse
4745
return $this->json(['error' => Translation::get('msgNoPermission')], Response::HTTP_UNAUTHORIZED);
4846
}
4947

50-
$comments = new Comments($this->configuration);
48+
$comments = $this->container->get('phpmyfaq.comments');
5149
$commentIds = $data->data->{'comments[]'} ?? [];
5250

5351
$result = false;

‎phpmyfaq/src/phpMyFAQ/Controller/Administration/Api/ConfigurationController.php

+11-4
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
use phpMyFAQ\Controller\AbstractController;
2121
use phpMyFAQ\Core\Exception;
2222
use phpMyFAQ\Enums\PermissionType;
23-
use phpMyFAQ\Mail;
2423
use phpMyFAQ\Session\Token;
2524
use phpMyFAQ\Translation;
2625
use Symfony\Component\HttpFoundation\JsonResponse;
@@ -34,7 +33,11 @@ class ConfigurationController extends AbstractController
3433
/**
3534
* @throws Exception|\Exception
3635
*/
37-
#[Route('admin/api/configuration/send-test-mail')]
36+
#[Route(
37+
'admin/api/configuration/send-test-mail',
38+
name: 'admin.api.configuration.send-test-mail',
39+
methods: ['POST']
40+
)]
3841
public function sendTestMail(Request $request): JsonResponse
3942
{
4043
$this->userHasPermission(PermissionType::CONFIGURATION_EDIT);
@@ -46,7 +49,7 @@ public function sendTestMail(Request $request): JsonResponse
4649
}
4750

4851
try {
49-
$mail = new Mail($this->configuration);
52+
$mail = $this->container->get('phpmyfaq.mail');
5053
$mail->addTo($this->configuration->getAdminEmail());
5154
$mail->setReplyTo($this->configuration->getNoReplyEmail());
5255
$mail->subject = $this->configuration->getTitle() . ': Mail test successful.';
@@ -62,7 +65,11 @@ public function sendTestMail(Request $request): JsonResponse
6265
/**
6366
* @throws \Exception
6467
*/
65-
#[Route('admin/api/configuration/activate-maintenance-mode')]
68+
#[Route(
69+
'admin/api/configuration/activate-maintenance-mode',
70+
name: 'admin.api.configuration.activate-maintenance-mode',
71+
methods: ['POST']
72+
)]
6673
public function activateMaintenanceMode(Request $request): JsonResponse
6774
{
6875
$this->userHasPermission(PermissionType::CONFIGURATION_EDIT);

‎phpmyfaq/src/phpMyFAQ/Controller/Administration/Api/ConfigurationTabController.php

+4-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
use phpMyFAQ\Helper\PermissionHelper;
2727
use phpMyFAQ\Session\Token;
2828
use phpMyFAQ\Strings;
29-
use phpMyFAQ\System;
3029
use phpMyFAQ\Template\TemplateException;
3130
use phpMyFAQ\Translation;
3231
use Symfony\Component\HttpFoundation\Exception\BadRequestException;
@@ -187,13 +186,16 @@ public function translations(): Response
187186
return $response->setContent('<option value="language_en.php">English</option>');
188187
}
189188

189+
/**
190+
* @throws \Exception
191+
*/
190192
#[Route('admin/api/configuration/templates', name: 'admin.api.configuration.templates', methods: ['GET'])]
191193
public function templates(): Response
192194
{
193195
$this->userIsAuthenticated();
194196

195197
$response = new Response();
196-
$faqSystem = new System();
198+
$faqSystem = $this->container->get('phpmyfaq.system');
197199
$templates = $faqSystem->getAvailableTemplates();
198200
$htmlString = '';
199201

‎phpmyfaq/src/phpMyFAQ/Controller/Administration/Api/DashboardController.php

+9-9
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@
1717

1818
namespace phpMyFAQ\Controller\Administration\Api;
1919

20+
use Exception;
21+
use JsonException;
2022
use phpMyFAQ\Administration\Api;
2123
use phpMyFAQ\Controller\AbstractController;
22-
use phpMyFAQ\Core\Exception;
2324
use phpMyFAQ\Faq;
2425
use phpMyFAQ\System;
2526
use phpMyFAQ\Translation;
@@ -33,10 +34,9 @@
3334
class DashboardController extends AbstractController
3435
{
3536
/**
36-
* @throws Exception
37-
* @throws \JsonException
37+
* @throws JsonException
3838
*/
39-
#[Route('admin/api/dashboard/verify')]
39+
#[Route('admin/api/dashboard/verify', name: 'admin.api.dashboard.verify', methods: ['POST'])]
4040
public function verify(Request $request): JsonResponse
4141
{
4242
$this->userIsAuthenticated();
@@ -50,7 +50,7 @@ public function verify(Request $request): JsonResponse
5050
/**
5151
* @throws Exception
5252
*/
53-
#[Route('admin/api/dashboard/versions')]
53+
#[Route('admin/api/dashboard/versions', name: 'admin.api.dashboard.versions', methods: ['GET'])]
5454
public function versions(): JsonResponse
5555
{
5656
$this->userIsAuthenticated();
@@ -69,15 +69,15 @@ public function versions(): JsonResponse
6969
return $this->json($info);
7070
} catch (DecodingExceptionInterface | TransportExceptionInterface $e) {
7171
return $this->json(['error' => $e->getMessage()], Response::HTTP_BAD_REQUEST);
72-
} catch (\Exception $e) {
72+
} catch (Exception $e) {
7373
return $this->json(['error' => $e->getMessage()], Response::HTTP_BAD_REQUEST);
7474
}
7575
}
7676

7777
/**
78-
* @throws \Exception
78+
* @throws Exception
7979
*/
80-
#[Route('admin/api/dashboard/visits')]
80+
#[Route('admin/api/dashboard/visits', name: 'admin.api.dashboard.visits', methods: ['GET'])]
8181
public function visits(Request $request): JsonResponse
8282
{
8383
$this->userIsAuthenticated();
@@ -94,7 +94,7 @@ public function visits(Request $request): JsonResponse
9494
/**
9595
* @throws Exception
9696
*/
97-
#[Route('admin/api/dashboard/topten')]
97+
#[Route('admin/api/dashboard/topten', name: 'admin.api.dashboard.topten', methods: ['GET'])]
9898
public function topTen(): JsonResponse
9999
{
100100
$this->userIsAuthenticated();

‎phpmyfaq/src/phpMyFAQ/Controller/Administration/Api/ElasticsearchController.php

+8-12
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
use phpMyFAQ\Controller\AbstractController;
2323
use phpMyFAQ\Core\Exception;
2424
use phpMyFAQ\Enums\PermissionType;
25-
use phpMyFAQ\Faq;
2625
use phpMyFAQ\Instance\Elasticsearch;
2726
use phpMyFAQ\Translation;
2827
use Symfony\Component\HttpFoundation\JsonResponse;
@@ -31,10 +30,7 @@
3130

3231
class ElasticsearchController extends AbstractController
3332
{
34-
/**
35-
* @throws Exception
36-
*/
37-
#[Route('./admin/api/elasticsearch/create')]
33+
#[Route('./admin/api/elasticsearch/create', name: 'admin.api.elasticsearch.create', methods: ['POST'])]
3834
public function create(): JsonResponse
3935
{
4036
$this->userHasPermission(PermissionType::CONFIGURATION_EDIT);
@@ -55,7 +51,7 @@ public function create(): JsonResponse
5551
/**
5652
* @throws Exception
5753
*/
58-
#[Route('./admin/api/elasticsearch/drop')]
54+
#[Route('./admin/api/elasticsearch/drop', name: 'admin.api.elasticsearch.drop', methods: ['DELETE'])]
5955
public function drop(): JsonResponse
6056
{
6157
$this->userHasPermission(PermissionType::CONFIGURATION_EDIT);
@@ -74,15 +70,15 @@ public function drop(): JsonResponse
7470
}
7571

7672
/**
77-
* @throws Exception
73+
* @throws \Exception
7874
*/
79-
#[Route('./admin/api/elasticsearch/import')]
75+
#[Route('./admin/api/elasticsearch/import', name: 'admin.api.elasticsearch.import', methods: ['POST'])]
8076
public function import(): JsonResponse
8177
{
8278
$this->userHasPermission(PermissionType::CONFIGURATION_EDIT);
8379

8480
$elasticsearch = new Elasticsearch($this->configuration);
85-
$faq = new Faq($this->configuration);
81+
$faq = $this->container->get('phpmyfaq.faq');
8682
$faq->getAllFaqs();
8783

8884
$bulkIndexResult = $elasticsearch->bulkIndex($faq->faqRecords);
@@ -96,14 +92,14 @@ public function import(): JsonResponse
9692
/**
9793
* @throws Exception
9894
*/
99-
#[Route('./admin/api/elasticsearch/statistics')]
95+
#[Route('./admin/api/elasticsearch/statistics', name: 'admin.api.elasticsearch.statistics', methods: ['GET'])]
10096
public function statistics(): JsonResponse
10197
{
10298
$this->userIsAuthenticated();
10399

104-
$elasticsearchConfiguration = $this->configuration->getElasticsearchConfig();
100+
$elasticsearchConfig = $this->configuration->getElasticsearchConfig();
105101

106-
$indexName = $elasticsearchConfiguration->getIndex();
102+
$indexName = $elasticsearchConfig->getIndex();
107103
try {
108104
return $this->json(
109105
[

0 commit comments

Comments
 (0)