Skip to content

refactor(api): HttpStatus single-source for HTTP codes #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
biz87 wants to merge 2 commits into
base: beta
Choose a base branch
from
Open

refactor(api): HttpStatus single-source for HTTP codes #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9af467
refactor(api): HttpStatus and Response::HTTP_* instead of numeric codes
Ibochkarev Apr 21, 2026
7ae99d9
refactor(api): single-source HttpStatus, drop Response::HTTP_* re-exp…
TolkIT-team Apr 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions core/components/minishop3/config/routes/manager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@

use MiniShop3\Router\Middleware\AuthMiddleware;
use MiniShop3\Router\Middleware\PermissionMiddleware;
use MiniShop3\Router\HttpStatus;
use MiniShop3\Router\Response;

$router->group('/api/mgr', function($router) use ($modx) {
Expand All @@ -38,7 +39,7 @@

$router->get('/user/info', function() use ($modx) {
if (!$modx->user || !$modx->user->isAuthenticated('mgr')) {
return Response::error('Unauthorized', 401);
return Response::error('Unauthorized', HttpStatus::UNAUTHORIZED);
}

return Response::success([
Expand Down Expand Up @@ -85,7 +86,7 @@
$alias = $params['alias'] ?? '';

if (empty($alias)) {
return Response::error('Model alias is required', 400);
return Response::error('Model alias is required', HttpStatus::BAD_REQUEST);
}

try {
Expand All @@ -95,7 +96,7 @@
$modelClass = $fieldConfigManager->getModelClassByAlias($alias);

if (!$modelClass) {
return Response::error("Model alias not found: {$alias}", 404);
return Response::error("Model alias not found: {$alias}", HttpStatus::NOT_FOUND);
}

$fields = $fieldConfigManager->getModelFields($modelClass);
Expand All @@ -107,7 +108,7 @@
]);
} catch (\Exception $e) {
$modx->log(\MODX\Revolution\modX::LOG_LEVEL_ERROR, '[FieldConfigManager] ' . $e->getMessage());
return Response::error('Failed to load model fields: ' . $e->getMessage(), 500);
return Response::error('Failed to load model fields: ' . $e->getMessage(), HttpStatus::INTERNAL_SERVER_ERROR);
}
});

Expand Down Expand Up @@ -177,20 +178,20 @@
]);
} catch (\Exception $e) {
$modx->log(\MODX\Revolution\modX::LOG_LEVEL_ERROR, '[ExtraFields API] ' . $e->getMessage());
return Response::error('Failed to load extra fields: ' . $e->getMessage(), 500);
return Response::error('Failed to load extra fields: ' . $e->getMessage(), HttpStatus::INTERNAL_SERVER_ERROR);
}
});
$router->get('/{id}', function($params) use ($modx) {
$id = (int)($params['id'] ?? 0);

if (!$id) {
return Response::error('Field ID is required', 400);
return Response::error('Field ID is required', HttpStatus::BAD_REQUEST);
}

$field = $modx->getObject(\MiniShop3\Model\msExtraField::class, $id);

if (!$field) {
return Response::error('Field not found', 404);
return Response::error('Field not found', HttpStatus::NOT_FOUND);
}

$data = $field->toArray();
Expand All @@ -205,7 +206,7 @@
$data = json_decode(file_get_contents('php://input'), true);

if (empty($data)) {
return Response::error('Request body is empty', 400);
return Response::error('Request body is empty', HttpStatus::BAD_REQUEST);
}

/** @var \MiniShop3\Services\ExtraFieldsService $service */
Expand All @@ -214,7 +215,7 @@
$result = $service->createField($data);

if (!$result['success']) {
return Response::error($result['message'], 400);
return Response::error($result['message'], HttpStatus::BAD_REQUEST);
}

return Response::success([
Expand All @@ -224,21 +225,21 @@
]);
} catch (\Exception $e) {
$modx->log(\MODX\Revolution\modX::LOG_LEVEL_ERROR, '[ExtraFields API] ' . $e->getMessage());
return Response::error('Failed to create field: ' . $e->getMessage(), 500);
return Response::error('Failed to create field: ' . $e->getMessage(), HttpStatus::INTERNAL_SERVER_ERROR);
}
});
$router->put('/{id}', function($params) use ($modx) {
$id = (int)($params['id'] ?? 0);

if (!$id) {
return Response::error('Field ID is required', 400);
return Response::error('Field ID is required', HttpStatus::BAD_REQUEST);
}

try {
$data = json_decode(file_get_contents('php://input'), true);

if (empty($data)) {
return Response::error('Request body is empty', 400);
return Response::error('Request body is empty', HttpStatus::BAD_REQUEST);
}

/** @var \MiniShop3\Services\ExtraFieldsService $service */
Expand All @@ -247,7 +248,7 @@
$result = $service->updateField($id, $data);

if (!$result['success']) {
return Response::error($result['message'], 400);
return Response::error($result['message'], HttpStatus::BAD_REQUEST);
}

return Response::success([
Expand All @@ -256,14 +257,14 @@
]);
} catch (\Exception $e) {
$modx->log(\MODX\Revolution\modX::LOG_LEVEL_ERROR, '[ExtraFields API] ' . $e->getMessage());
return Response::error('Failed to update field: ' . $e->getMessage(), 500);
return Response::error('Failed to update field: ' . $e->getMessage(), HttpStatus::INTERNAL_SERVER_ERROR);
}
});
$router->delete('/{id}', function($params) use ($modx) {
$id = (int)($params['id'] ?? 0);

if (!$id) {
return Response::error('Field ID is required', 400);
return Response::error('Field ID is required', HttpStatus::BAD_REQUEST);
}

try {
Expand All @@ -273,7 +274,7 @@
$result = $service->deleteField($id);

if (!$result['success']) {
return Response::error($result['message'], 400);
return Response::error($result['message'], HttpStatus::BAD_REQUEST);
}

return Response::success([
Expand All @@ -282,7 +283,7 @@
]);
} catch (\Exception $e) {
$modx->log(\MODX\Revolution\modX::LOG_LEVEL_ERROR, '[ExtraFields API] ' . $e->getMessage());
return Response::error('Failed to delete field: ' . $e->getMessage(), 500);
return Response::error('Failed to delete field: ' . $e->getMessage(), HttpStatus::INTERNAL_SERVER_ERROR);
}
});

Expand Down
5 changes: 3 additions & 2 deletions core/components/minishop3/config/routes/web.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
* @version 1.0.0
*/

use MiniShop3\Router\HttpStatus;
use MiniShop3\Router\Response;
use MiniShop3\Middleware\TokenMiddleware;
use MiniShop3\Middleware\CorsMiddleware;
Expand Down Expand Up @@ -149,7 +150,7 @@
);

if ($response->isError()) {
return Response::error($response->getMessage(), 400);
return Response::error($response->getMessage(), HttpStatus::BAD_REQUEST);
}

return Response::success($response->getObject(), $response->getMessage());
Expand Down Expand Up @@ -178,7 +179,7 @@
);

if ($response->isError()) {
return Response::error($response->getMessage(), 400);
return Response::error($response->getMessage(), HttpStatus::BAD_REQUEST);
}

return Response::success($response->getObject(), $response->getMessage());
Expand Down
3 changes: 2 additions & 1 deletion core/components/minishop3/config/routes_manager.custom.example.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

use MiniShop3\Router\Middleware\AuthMiddleware;
use MiniShop3\Router\Middleware\PermissionMiddleware;
use MiniShop3\Router\HttpStatus;
use MiniShop3\Router\Response;
// $router->get('/api/mgr/my-custom-route', function() use ($modx) {
// return Response::success(['message' => 'Custom Manager route works!']);
Expand Down Expand Up @@ -55,7 +56,7 @@
//
// $resource = $modx->getObject('modResource', $id);
// if (!$resource) {
// return Response::error('Resource not found', 404);
// return Response::error('Resource not found', HttpStatus::NOT_FOUND);
// }
//
// return Response::success(['resource' => $resource->toArray()]);
Expand Down
41 changes: 21 additions & 20 deletions core/components/minishop3/src/Controllers/Api/ConfigController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace MiniShop3\Controllers\Api;

use MiniShop3\Router\HttpStatus;
use MiniShop3\Router\Response;

/**
Expand All @@ -21,7 +22,7 @@ public function getPageFields(array $params): Response
$pageKey = $params['page_key'] ?? '';

if (empty($pageKey)) {
return Response::error('Page key is required', 400);
return Response::error('Page key is required', HttpStatus::BAD_REQUEST);
}

try {
Expand All @@ -33,7 +34,7 @@ public function getPageFields(array $params): Response
return Response::success($config);
} catch (\Exception $e) {
$this->modx->log(\MODX\Revolution\modX::LOG_LEVEL_ERROR, '[ConfigController] ' . $e->getMessage());
return Response::error('Failed to load config: ' . $e->getMessage(), 500);
return Response::error('Failed to load config: ' . $e->getMessage(), HttpStatus::INTERNAL_SERVER_ERROR);
}
}

Expand All @@ -49,7 +50,7 @@ public function getAllPageFields(array $params): Response
$pageKey = $params['page_key'] ?? '';

if (empty($pageKey)) {
return Response::error('Page key is required', 400);
return Response::error('Page key is required', HttpStatus::BAD_REQUEST);
}

try {
Expand All @@ -61,7 +62,7 @@ public function getAllPageFields(array $params): Response
return Response::success($result);
} catch (\Exception $e) {
$this->modx->log(\MODX\Revolution\modX::LOG_LEVEL_ERROR, '[ConfigController] ' . $e->getMessage());
return Response::error('Failed to load fields: ' . $e->getMessage(), 500);
return Response::error('Failed to load fields: ' . $e->getMessage(), HttpStatus::INTERNAL_SERVER_ERROR);
}
}

Expand All @@ -77,13 +78,13 @@ public function updatePageFields(array $params): Response
$pageKey = $params['page_key'] ?? '';

if (empty($pageKey)) {
return Response::error('Page key is required', 400);
return Response::error('Page key is required', HttpStatus::BAD_REQUEST);
}

$data = $this->getRequestData();

if (!isset($data['fields']) || !is_array($data['fields'])) {
return Response::error('Fields array is required', 400);
return Response::error('Fields array is required', HttpStatus::BAD_REQUEST);
}

try {
Expand All @@ -97,11 +98,11 @@ public function updatePageFields(array $params): Response
'message' => 'Configuration saved successfully',
]);
} else{
return Response::error('Failed to save configuration', 500);
return Response::error('Failed to save configuration', HttpStatus::INTERNAL_SERVER_ERROR);
}
} catch (\Exception $e) {
$this->modx->log(\MODX\Revolution\modX::LOG_LEVEL_ERROR, '[ConfigController] ' . $e->getMessage());
return Response::error('Failed to save config: ' . $e->getMessage(), 500);
return Response::error('Failed to save config: ' . $e->getMessage(), HttpStatus::INTERNAL_SERVER_ERROR);
}
}

Expand All @@ -119,7 +120,7 @@ public function deleteFieldOverride(array $params): Response
$fieldName = $params['field_name'] ?? '';

if (empty($pageKey) || empty($fieldName)) {
return Response::error('Page key and field name are required', 400);
return Response::error('Page key and field name are required', HttpStatus::BAD_REQUEST);
}

try {
Expand All @@ -133,11 +134,11 @@ public function deleteFieldOverride(array $params): Response
'message' => 'Override removed successfully',
]);
} else {
return Response::error('Failed to remove override', 500);
return Response::error('Failed to remove override', HttpStatus::INTERNAL_SERVER_ERROR);
}
} catch (\Exception $e) {
$this->modx->log(\MODX\Revolution\modX::LOG_LEVEL_ERROR, '[ConfigController] ' . $e->getMessage());
return Response::error('Failed to remove override: ' . $e->getMessage(), 500);
return Response::error('Failed to remove override: ' . $e->getMessage(), HttpStatus::INTERNAL_SERVER_ERROR);
}
}

Expand All @@ -153,7 +154,7 @@ public function getSections(array $params): Response
$pageKey = $params['page_key'] ?? '';

if (empty($pageKey)) {
return Response::error('Page key is required', 400);
return Response::error('Page key is required', HttpStatus::BAD_REQUEST);
}

try {
Expand All @@ -167,7 +168,7 @@ public function getSections(array $params): Response
]);
} catch (\Exception $e) {
$this->modx->log(\MODX\Revolution\modX::LOG_LEVEL_ERROR, '[ConfigController] ' . $e->getMessage());
return Response::error('Failed to load sections: ' . $e->getMessage(), 500);
return Response::error('Failed to load sections: ' . $e->getMessage(), HttpStatus::INTERNAL_SERVER_ERROR);
}
}

Expand All @@ -183,13 +184,13 @@ public function updateSections(array $params): Response
$pageKey = $params['page_key'] ?? '';

if (empty($pageKey)) {
return Response::error('Page key is required', 400);
return Response::error('Page key is required', HttpStatus::BAD_REQUEST);
}

$data = $this->getRequestData();

if (!isset($data['sections']) || !is_array($data['sections'])) {
return Response::error('Sections array is required', 400);
return Response::error('Sections array is required', HttpStatus::BAD_REQUEST);
}

try {
Expand All @@ -203,11 +204,11 @@ public function updateSections(array $params): Response
'message' => 'Sections saved successfully',
]);
} else {
return Response::error('Failed to save sections', 500);
return Response::error('Failed to save sections', HttpStatus::INTERNAL_SERVER_ERROR);
}
} catch (\Exception $e) {
$this->modx->log(\MODX\Revolution\modX::LOG_LEVEL_ERROR, '[ConfigController] ' . $e->getMessage());
return Response::error('Failed to save sections: ' . $e->getMessage(), 500);
return Response::error('Failed to save sections: ' . $e->getMessage(), HttpStatus::INTERNAL_SERVER_ERROR);
}
}

Expand All @@ -224,7 +225,7 @@ public function deleteSection(array $params): Response
$sectionKey = $params['section_key'] ?? '';

if (empty($pageKey) || empty($sectionKey)) {
return Response::error('Page key and section key are required', 400);
return Response::error('Page key and section key are required', HttpStatus::BAD_REQUEST);
}

try {
Expand All @@ -238,11 +239,11 @@ public function deleteSection(array $params): Response
'message' => 'Section deleted successfully',
]);
} else {
return Response::error('Failed to delete section (base sections cannot be deleted)', 400);
return Response::error('Failed to delete section (base sections cannot be deleted)', HttpStatus::BAD_REQUEST);
}
} catch (\Exception $e) {
$this->modx->log(\MODX\Revolution\modX::LOG_LEVEL_ERROR, '[ConfigController] ' . $e->getMessage());
return Response::error('Failed to delete section: ' . $e->getMessage(), 500);
return Response::error('Failed to delete section: ' . $e->getMessage(), HttpStatus::INTERNAL_SERVER_ERROR);
}
}
}
Loading