Skip to content

496 remove response param in templates #497

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

Merged
armanist merged 8 commits into from
May 4, 2026
Merged

496 remove response param in templates #497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4e66d0d
[#496] Refactor template controllers to use response() helper
armanist May 1, 2026
1cdaaa8
[#496] Refactor template middleware helpers to remove Response arg pl…
armanist May 1, 2026
b6e8ba0
[#496] Clean template docblocks and inline redundant response locals
armanist May 1, 2026
d7778de
[#496] Remove UTF-8 BOM from module template PHP files
armanist May 1, 2026
a9d0897
[#496] Fix template response regressions and signature spacing
armanist May 1, 2026
11f8c04
[#496] Fix middleware error-response return propagation
armanist May 1, 2026
2402dbb
[#496] Tighten Toolkit middleware response contract
armanist May 4, 2026
9b93179
[#496] Fix missing validateRequest return in DemoWeb Password template
armanist May 4, 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
8 changes: 3 additions & 5 deletions src/Module/Templates/DefaultApi/src/Controllers/MainController.php.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,15 @@ class MainController

/**
* CSRF verification
* @var bool
*/
public bool $csrfVerification = false;

/**
* Action - success response
* @param Response $response
*/
public function index(Response $response): Response
public function index(): Response
{
return $response->json([
return response()->json([
'status' => 'success',
'message' => '{{MODULE_NAME}} module.'
]);
Expand Down
4 changes: 2 additions & 2 deletions src/Module/Templates/DefaultApi/src/Controllers/OpenApi/OpenApiMainController.php.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ use Quantum\Http\Response;
*/
abstract class OpenApiMainController extends OpenApiController
{

/**
* @OA\Get(
* path="/{{MODULE_NAME}}",
Expand All @@ -40,6 +40,6 @@ abstract class OpenApiMainController extends OpenApiController
* )
* )
*/
abstract public function index(Response $response);
abstract public function index();

}
13 changes: 5 additions & 8 deletions src/Module/Templates/DefaultWeb/src/Controllers/MainController.php.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ class MainController

/**
* Works before an action
* @param ViewFactory $view
*/
public function __before(ViewFactory $view)
{
Expand All @@ -41,18 +40,16 @@ class MainController
new Asset(Asset::CSS, '{{MODULE_NAME}}/css/custom.css')
]);
}

/**
* Action - display home page
* @param Response $response
* @param ViewFactory $view
*/
public function index(Response $response, ViewFactory $view): Response
{
public function index(ViewFactory $view): Response
{
$view->setParams([
'title' => config()->get('app.name'),
]);
return $response->html($view->render('index'));

return response()->html($view->render('index'));
}
Comment thread
armanist marked this conversation as resolved.
}
25 changes: 8 additions & 17 deletions src/Module/Templates/DemoApi/src/Controllers/AccountController.php.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,8 @@ class AccountController extends BaseController
{
/**
* Auth service
* @var AuthService
*/
public AuthService $authService;

/**
* Works before an action
*/

public function __before()
{
Expand All @@ -43,10 +38,8 @@ class AccountController extends BaseController

/**
* Action - update user info
* @param Request $request
* @param Response $response
*/
public function update(Request $request, Response $response): Response
public function update(Request $request): Response
{
try {
$firstname = $request->get('firstname');
Expand All @@ -59,12 +52,12 @@ class AccountController extends BaseController

auth()->refreshUser(auth()->user()->uuid);

return $response->json([
return response()->json([
'status' => self::STATUS_SUCCESS,
'message' => t('common.updated_successfully')
]);
} catch (AuthException $e) {
return $response->json([
return response()->json([
'status' => self::STATUS_ERROR,
'message' => $e->getMessage()
]);
Expand All @@ -73,26 +66,24 @@ class AccountController extends BaseController

/**
* Action - update password
* @param Request $request
* @param Response $response
*/
public function updatePassword(Request $request, Response $response): Response
public function updatePassword(Request $request): Response
{
try {
$hasher = new Hasher();

$newPassword = $request->get('new_password');

$this->authService->update('uuid', auth()->user()->uuid, [
'password' => $hasher->hash($newPassword)
]);

return $response->json([
return response()->json([
'status' => self::STATUS_SUCCESS,
'message' => t('common.updated_successfully')
]);
} catch (AuthException $e) {
return $response->json([
return response()->json([
'status' => self::STATUS_ERROR,
'message' => $e->getMessage()
]);
Expand Down
68 changes: 22 additions & 46 deletions src/Module/Templates/DemoApi/src/Controllers/AuthController.php.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* @author Arman Ag. <arman.ag@softberg.org>
* @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
* @link http://quantum.softberg.org/
* @since 2.9.9
* @since 3.0.0
*/

namespace {{MODULE_NAMESPACE}}\Controllers;
Expand All @@ -27,15 +27,12 @@ use Quantum\Http\Request;
*/
class AuthController extends BaseController
{

/**
* Action - sign in
* @param Request $request
* @param Response $response
* @return Response
*/
public function signin(Request $request, Response $response): Response
public function signin(Request $request): Response
{
$response = response();
try {
$code = auth()->signin($request->get('email'), $request->get('password'));

Expand All @@ -56,12 +53,10 @@ class AuthController extends BaseController

/**
* Action - me
* @param Response $response
* @return Response
*/
public function me(Response $response): Response
public function me(): Response
{
return $response->json([
return response()->json([
'status' => self::STATUS_SUCCESS,
'data' => [
'firstname' => auth()->user()->firstname,
Expand All @@ -73,17 +68,15 @@ class AuthController extends BaseController

/**
* Action - sign out
* @param Response $response
* @return Response
*/
public function signout(Response $response): Response
public function signout(): Response
{
if (auth()->signout()) {
return $response->json([
return response()->json([
'status' => self::STATUS_SUCCESS
]);
} else {
return $response->json([
return response()->json([
'status' => self::STATUS_ERROR,
'message' => t('validation.unauthorizedRequest')
], StatusCode::UNAUTHORIZED);
Expand All @@ -92,85 +85,70 @@ class AuthController extends BaseController

/**
* Action - sign up
* @param Request $request
* @param Response $response
* @return Response
*/
public function signup(Request $request, Response $response): Response
public function signup(Request $request): Response
{
$userDto = UserDTO::fromRequest($request, Role::EDITOR, uuid_ordered());

auth()->signup($userDto->toArray());

return $response->json([
return response()->json([
'status' => self::STATUS_SUCCESS,
'message' => t('common.successfully_signed_up')
]);
}

/**
* Action - activate
* @param Request $request
* @param Response $response
* @return Response
*/
public function activate(Request $request, Response $response): Response
public function activate(Request $request): Response
{
auth()->activate($request->get('activation_token'));

return $response->json([
return response()->json([
'status' => self::STATUS_SUCCESS,
'message' => t('common.account_activated')
]);
}

/**
* Action - forget
* @param Request $request
* @param Response $response
* @return Response
*/
public function forget(Request $request, Response $response): Response
public function forget(Request $request): Response
{
auth()->forget($request->get('email'));

return $response->json([
return response()->json([
'status' => self::STATUS_SUCCESS,
'message' => t('common.check_email')
]);
}

/**
* Action - reset
* @param Request $request
* @param Response $response
* @return Response
*/
public function reset(Request $request, Response $response): Response
public function reset(Request $request): Response
{
auth()->reset($request->get('reset_token'), $request->get('password'));

return $response->json([
return response()->json([
'status' => self::STATUS_SUCCESS
]);
}

/**
* Action - Verify OTP
* @param Request $request
* @param Response $response
* @return Response
*/
public function verify(Request $request, Response $response): Response
public function verify(Request $request): Response
{
try {
auth()->verifyOtp((int)$request->get('otp'), $request->get('code'));

return $response->json([
return response()->json([
'status' => self::STATUS_SUCCESS
]);
} catch (AuthException $e) {
return $response->json([
return response()->json([
'status' => self::STATUS_ERROR,
'message' => $e->getMessage()
], StatusCode::UNAUTHORIZED);
Expand All @@ -179,18 +157,16 @@ class AuthController extends BaseController

/**
* Action - Resend OTP
* @param Response $response
* @return Response
*/
public function resend(Response $response): Response
public function resend(): Response
{
try {
return $response->json([
return response()->json([
'status' => self::STATUS_SUCCESS,
'code' => auth()->resendOtp(route_param('code'))
]);
} catch (AuthException $e) {
return $response->json([
return response()->json([
'status' => self::STATUS_ERROR,
'message' => $e->getMessage()
], StatusCode::UNAUTHORIZED);
Expand Down
1 change: 0 additions & 1 deletion src/Module/Templates/DemoApi/src/Controllers/BaseController.php.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ abstract class BaseController

/**
* CSRF verification
* @var bool
*/
public bool $csrfVerification = false;
}
19 changes: 4 additions & 15 deletions src/Module/Templates/DemoApi/src/Controllers/CommentController.php.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,6 @@ use Quantum\Http\Request;
*/
class CommentController extends BaseController
{

/**
* @var CommentService
*/
public CommentService $commentService;

public function __before()
Expand All @@ -38,18 +34,14 @@ class CommentController extends BaseController

/**
* Action - create comment
* @param Request $request
* @param Response $response
* @param string|null $lang
* @param string $uuid
*/
public function create(Request $request, Response $response, ?string $lang, string $uuid): Response
public function create(Request $request, ?string $lang, string $uuid): Response
{
$commentDto = CommentDTO::fromRequest($request, $uuid, auth()->user()->uuid);

$comment = $this->commentService->addComment($commentDto);

return $response->json([
return response()->json([
'status' => 'success',
'message' => t('common.created_successfully'),
'data' => $comment
Expand All @@ -58,15 +50,12 @@ class CommentController extends BaseController

/**
* Action - delete comment
* @param Response $response
* @param string|null $lang
* @param string $uuid
*/
public function delete(Response $response, ?string $lang, string $uuid): Response
public function delete(?string $lang, string $uuid): Response
{
$this->commentService->deleteComment($uuid);

return $response->json([
return response()->json([
'status' => 'success',
'message' => t('common.deleted_successfully'),
]);
Expand Down
Loading
Loading