diff --git a/src/Module/Templates/DefaultApi/src/Controllers/MainController.php.tpl b/src/Module/Templates/DefaultApi/src/Controllers/MainController.php.tpl index 1040b5cf..ca2623e0 100644 --- a/src/Module/Templates/DefaultApi/src/Controllers/MainController.php.tpl +++ b/src/Module/Templates/DefaultApi/src/Controllers/MainController.php.tpl @@ -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.' ]); diff --git a/src/Module/Templates/DefaultApi/src/Controllers/OpenApi/OpenApiMainController.php.tpl b/src/Module/Templates/DefaultApi/src/Controllers/OpenApi/OpenApiMainController.php.tpl index 7653c7a7..21bcda20 100644 --- a/src/Module/Templates/DefaultApi/src/Controllers/OpenApi/OpenApiMainController.php.tpl +++ b/src/Module/Templates/DefaultApi/src/Controllers/OpenApi/OpenApiMainController.php.tpl @@ -22,7 +22,7 @@ use Quantum\Http\Response; */ abstract class OpenApiMainController extends OpenApiController { - + /** * @OA\Get( * path="/{{MODULE_NAME}}", @@ -40,6 +40,6 @@ abstract class OpenApiMainController extends OpenApiController * ) * ) */ - abstract public function index(Response $response); + abstract public function index(); } diff --git a/src/Module/Templates/DefaultWeb/src/Controllers/MainController.php.tpl b/src/Module/Templates/DefaultWeb/src/Controllers/MainController.php.tpl index 869fc18d..372e2866 100644 --- a/src/Module/Templates/DefaultWeb/src/Controllers/MainController.php.tpl +++ b/src/Module/Templates/DefaultWeb/src/Controllers/MainController.php.tpl @@ -32,7 +32,6 @@ class MainController /** * Works before an action - * @param ViewFactory $view */ public function __before(ViewFactory $view) { @@ -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')); } } diff --git a/src/Module/Templates/DemoApi/src/Controllers/AccountController.php.tpl b/src/Module/Templates/DemoApi/src/Controllers/AccountController.php.tpl index 44d56212..34904b65 100644 --- a/src/Module/Templates/DemoApi/src/Controllers/AccountController.php.tpl +++ b/src/Module/Templates/DemoApi/src/Controllers/AccountController.php.tpl @@ -28,13 +28,8 @@ class AccountController extends BaseController { /** * Auth service - * @var AuthService */ public AuthService $authService; - - /** - * Works before an action - */ public function __before() { @@ -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'); @@ -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() ]); @@ -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() ]); diff --git a/src/Module/Templates/DemoApi/src/Controllers/AuthController.php.tpl b/src/Module/Templates/DemoApi/src/Controllers/AuthController.php.tpl index 76f6a022..624904d3 100644 --- a/src/Module/Templates/DemoApi/src/Controllers/AuthController.php.tpl +++ b/src/Module/Templates/DemoApi/src/Controllers/AuthController.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @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; @@ -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')); @@ -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, @@ -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); @@ -92,17 +85,14 @@ 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') ]); @@ -110,15 +100,12 @@ class AuthController extends BaseController /** * 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') ]); @@ -126,15 +113,12 @@ class AuthController extends BaseController /** * 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') ]); @@ -142,35 +126,29 @@ class AuthController extends BaseController /** * 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); @@ -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); diff --git a/src/Module/Templates/DemoApi/src/Controllers/BaseController.php.tpl b/src/Module/Templates/DemoApi/src/Controllers/BaseController.php.tpl index eea9bb3a..3fc59dbb 100644 --- a/src/Module/Templates/DemoApi/src/Controllers/BaseController.php.tpl +++ b/src/Module/Templates/DemoApi/src/Controllers/BaseController.php.tpl @@ -33,7 +33,6 @@ abstract class BaseController /** * CSRF verification - * @var bool */ public bool $csrfVerification = false; } diff --git a/src/Module/Templates/DemoApi/src/Controllers/CommentController.php.tpl b/src/Module/Templates/DemoApi/src/Controllers/CommentController.php.tpl index f1d0b030..2ebaf76b 100644 --- a/src/Module/Templates/DemoApi/src/Controllers/CommentController.php.tpl +++ b/src/Module/Templates/DemoApi/src/Controllers/CommentController.php.tpl @@ -25,10 +25,6 @@ use Quantum\Http\Request; */ class CommentController extends BaseController { - - /** - * @var CommentService - */ public CommentService $commentService; public function __before() @@ -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 @@ -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'), ]); diff --git a/src/Module/Templates/DemoApi/src/Controllers/OpenApi/OpenApiAuthController.php.tpl b/src/Module/Templates/DemoApi/src/Controllers/OpenApi/OpenApiAuthController.php.tpl index fc5b829e..e7295440 100644 --- a/src/Module/Templates/DemoApi/src/Controllers/OpenApi/OpenApiAuthController.php.tpl +++ b/src/Module/Templates/DemoApi/src/Controllers/OpenApi/OpenApiAuthController.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Controllers\OpenApi; @@ -63,10 +63,8 @@ abstract class OpenApiAuthController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Request $request - * @param Response $response */ - abstract public function signin(Request $request, Response $response); + abstract public function signin(Request $request); /** * Gets the logged-in user data @@ -94,9 +92,8 @@ abstract class OpenApiAuthController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Response $response */ - abstract public function me(Response $response); + abstract public function me(); /** * Sign out action @@ -134,9 +131,8 @@ abstract class OpenApiAuthController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Response $response */ - abstract public function signout(Response $response); + abstract public function signout(); /** * Sign up action @@ -185,10 +181,8 @@ abstract class OpenApiAuthController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Request $request - * @param Response $response */ - abstract public function signup(Request $request, Response $response); + abstract public function signup(Request $request); /** * Activate action @@ -222,10 +216,8 @@ abstract class OpenApiAuthController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Request $request - * @param Response $response */ - abstract public function activate(Request $request, Response $response); + abstract public function activate(Request $request); /** * Forget action @@ -262,10 +254,8 @@ abstract class OpenApiAuthController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Request $request - * @param Response $response */ - abstract public function forget(Request $request, Response $response); + abstract public function forget(Request $request); /** * Reset action @@ -315,10 +305,8 @@ abstract class OpenApiAuthController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Request $request - * @param Response $response */ - abstract public function reset(Request $request, Response $response); + abstract public function reset(Request $request); /** * Verify action @@ -355,10 +343,8 @@ abstract class OpenApiAuthController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Request $request - * @param Response $response */ - abstract public function verify(Request $request, Response $response); + abstract public function verify(Request $request); /** * Resend action @@ -392,7 +378,6 @@ abstract class OpenApiAuthController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Response $response */ - abstract public function resend(Response $response); + abstract public function resend(); } diff --git a/src/Module/Templates/DemoApi/src/Controllers/OpenApi/OpenApiPostController.php.tpl b/src/Module/Templates/DemoApi/src/Controllers/OpenApi/OpenApiPostController.php.tpl index 19a6bfd9..bc9a7cde 100644 --- a/src/Module/Templates/DemoApi/src/Controllers/OpenApi/OpenApiPostController.php.tpl +++ b/src/Module/Templates/DemoApi/src/Controllers/OpenApi/OpenApiPostController.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Controllers\OpenApi; @@ -43,10 +43,8 @@ abstract class OpenApiPostController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Request $request - * @param Response $response */ - abstract public function posts(Request $request, Response $response); + abstract public function posts(Request $request); /** * Get post action @@ -80,11 +78,8 @@ abstract class OpenApiPostController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param string|null $lang - * @param string $postId - * @param Response $response */ - abstract public function post(?string $lang, string $postId, Response $response); + abstract public function post(?string $lang, string $postId); /** * Get my posts action @@ -112,9 +107,8 @@ abstract class OpenApiPostController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Response $response */ - abstract public function myPosts(Response $response); + abstract public function myPosts(); /** * Create post action @@ -167,10 +161,8 @@ abstract class OpenApiPostController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Request $request - * @param Response $response */ - abstract public function create(Request $request, Response $response); + abstract public function create(Request $request); /** * Amend post action @@ -232,12 +224,8 @@ abstract class OpenApiPostController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Request $request - * @param Response $response - * @param string|null $lang - * @param string $postId */ - abstract public function amend(Request $request, Response $response, ?string $lang, string $postId); + abstract public function amend(Request $request, ?string $lang, string $postId); /** * Delete post action @@ -278,11 +266,8 @@ abstract class OpenApiPostController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Response $response - * @param string|null $lang - * @param string $postId */ - abstract public function delete(Response $response, ?string $lang, string $postId); + abstract public function delete(?string $lang, string $postId); /** * Delete post image action @@ -323,10 +308,7 @@ abstract class OpenApiPostController extends OpenApiController * description="Internal Server Error" * ) * ) - * @param Response $response - * @param string|null $lang - * @param string $postId */ - abstract public function deleteImage(Response $response, ?string $lang, string $postId); + abstract public function deleteImage(?string $lang, string $postId); } diff --git a/src/Module/Templates/DemoApi/src/Controllers/PostController.php.tpl b/src/Module/Templates/DemoApi/src/Controllers/PostController.php.tpl index cf51e13b..e426fe0c 100644 --- a/src/Module/Templates/DemoApi/src/Controllers/PostController.php.tpl +++ b/src/Module/Templates/DemoApi/src/Controllers/PostController.php.tpl @@ -41,7 +41,6 @@ class PostController extends BaseController /** * Post service - * @var PostService */ public PostService $postService; @@ -52,11 +51,8 @@ class PostController extends BaseController /** * Action - get posts list - * @param Request $request - * @param Response $response - * @return Response */ - public function posts(Request $request, Response $response): Response + public function posts(Request $request): Response { $perPage = $request->get('per_page', (string) self::POSTS_PER_PAGE); $currentPage = $request->get('page', (string) self::CURRENT_PAGE); @@ -64,7 +60,7 @@ class PostController extends BaseController $paginatedPosts = $this->postService->getPosts($perPage, $currentPage, $search); - return $response->json([ + return response()->json([ 'status' => 'success', 'data' => $this->postService->transformData($paginatedPosts->data()->all()), 'pagination' => [ @@ -78,17 +74,13 @@ class PostController extends BaseController /** * Action - get single post - * @param Response $response - * @param string|null $lang - * @param string $postUuid - * @return Response */ - public function post(Response $response, ?string $lang, string $postUuid): Response + public function post(?string $lang, string $postUuid): Response { $post = $this->postService->getPost($postUuid); if ($post->isEmpty()) { - return $response->json([ + return response()->json([ 'status' => 'error', 'message' => t('common.post_not_found') ], StatusCode::NOT_FOUND); @@ -104,7 +96,7 @@ class PostController extends BaseController $postData['comments'] = $commentsData; - return $response->json([ + return response()->json([ 'status' => 'success', 'data' => $postData, ]); diff --git a/src/Module/Templates/DemoApi/src/Controllers/PostManagementController.php.tpl b/src/Module/Templates/DemoApi/src/Controllers/PostManagementController.php.tpl index 1b0cb16c..9f3463e7 100644 --- a/src/Module/Templates/DemoApi/src/Controllers/PostManagementController.php.tpl +++ b/src/Module/Templates/DemoApi/src/Controllers/PostManagementController.php.tpl @@ -31,7 +31,6 @@ class PostManagementController extends BaseController /** * Post service - * @var PostService */ public PostService $postService; @@ -42,14 +41,12 @@ class PostManagementController extends BaseController /** * Action - get my posts - * @param Response $response - * @return Response */ - public function myPosts(Response $response): Response + public function myPosts(): Response { $myPosts = $this->postService->getMyPosts(auth()->user()->uuid); - - return $response->json([ + + return response()->json([ 'status' => 'success', 'data' => $this->postService->transformData($myPosts->all()) ]); @@ -57,11 +54,8 @@ class PostManagementController extends BaseController /** * Action - create post - * @param Request $request - * @param Response $response - * @return Response */ - public function create(Request $request, Response $response): Response + public function create(Request $request): Response { $imageName = ''; @@ -77,7 +71,7 @@ class PostManagementController extends BaseController $post = $this->postService->addPost($postDto); - return $response->json([ + return response()->json([ 'status' => 'success', 'message' => t('common.created_successfully'), 'data' => current($this->postService->transformData([$post])) @@ -85,14 +79,9 @@ class PostManagementController extends BaseController } /** - * Action - amend post - * @param Request $request - * @param Response $response - * @param string|null $lang - * @param string $postUuid - * @return Response + * Action - amend post */ - public function amend(Request $request, Response $response, ?string $lang, string $postUuid): Response + public function amend(Request $request, ?string $lang, string $postUuid): Response { $post = $this->postService->getPost($postUuid); @@ -114,7 +103,7 @@ class PostManagementController extends BaseController $post = $this->postService->updatePost($postUuid, $postDto); - return $response->json([ + return response()->json([ 'status' => 'success', 'message' => t('common.updated_successfully'), 'data' => current($this->postService->transformData([$post])) @@ -123,12 +112,8 @@ class PostManagementController extends BaseController /** * Action - delete post - * @param Response $response - * @param string|null $lang - * @param string $postUuid - * @return Response */ - public function delete(Response $response, ?string $lang, string $postUuid): Response + public function delete(?string $lang, string $postUuid): Response { $post = $this->postService->getPost($postUuid); @@ -138,7 +123,7 @@ class PostManagementController extends BaseController $this->postService->deletePost($postUuid); - return $response->json([ + return response()->json([ 'status' => 'success', 'message' => t('common.deleted_successfully') ]); @@ -146,12 +131,8 @@ class PostManagementController extends BaseController /** * Action - delete image of the post - * @param Response $response - * @param string|null $lang - * @param string $postUuid - * @return Response */ - public function deleteImage(Response $response, ?string $lang, string $postUuid): Response + public function deleteImage(?string $lang, string $postUuid): Response { $post = $this->postService->getPost($postUuid); @@ -168,7 +149,7 @@ class PostManagementController extends BaseController $this->postService->updatePost($postUuid, $postDto); - return $response->json([ + return response()->json([ 'status' => 'success', 'message' => t('common.deleted_successfully') ]); diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Activate.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Activate.php.tpl index e2d2eb32..d1e9f53b 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/Activate.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/Activate.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -26,21 +26,13 @@ use Closure; */ class Activate extends BaseMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); $token = (string)route_param('token'); $request->set('token', $token); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Auth.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Auth.php.tpl index 7e4218f2..4f5805db 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/Auth.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/Auth.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -25,20 +25,10 @@ use Closure; */ class Auth extends BaseMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); if (!auth()->check()) { - $this->respondWithError( - $request, - $response, + $this->respondWithError($request, t('validation.unauthorizedRequest'), StatusCode::UNAUTHORIZED ); diff --git a/src/Module/Templates/DemoApi/src/Middlewares/BaseMiddleware.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/BaseMiddleware.php.tpl index cdbea3d0..58e9e391 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/BaseMiddleware.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/BaseMiddleware.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -27,15 +27,10 @@ use Closure; */ abstract class BaseMiddleware extends QtMiddleware { - - /** - * @var Validator - */ protected $validator; /** * BaseMiddleware constructor. - * @param Request $request */ public function __construct(Request $request) { @@ -46,7 +41,6 @@ abstract class BaseMiddleware extends QtMiddleware /** * Define validation rules specific to middleware. - * @param Request $request */ protected function defineValidationRules(Request $request) { @@ -55,14 +49,12 @@ abstract class BaseMiddleware extends QtMiddleware /** * Validate the request and respond with error if invalid. - * @param Request $request - * @param Response $response * @return Response|null */ - protected function validateRequest(Request $request, Response $response): ?Response + protected function validateRequest(Request $request): ?Response { if (!$this->validator->isValid($request->all())) { - return $this->respondWithError($request, $response, $this->validator->getErrors()); + return $this->respondWithError($request, $this->validator->getErrors()); } return null; @@ -70,20 +62,13 @@ abstract class BaseMiddleware extends QtMiddleware /** * Handles error response logic. - * @param Request $request - * @param Response $response - * @param mixed $message - * @param int $status - * @return Response */ - protected function respondWithError( - Request $request, - Response $response, + protected function respondWithError(Request $request, $message, int $status = StatusCode::UNPROCESSABLE_ENTITY ): Response { - return $response->json([ + return response()->json([ 'status' => 'error', 'message' => $message, ], $status); diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Comment.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Comment.php.tpl index d8b4a09b..abd87ab0 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/Comment.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/Comment.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @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}}\Middlewares; @@ -25,16 +25,9 @@ use Closure; */ class Comment extends BaseMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - */ public function apply(Request $request, Closure $next): Response { - $response = response(); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } diff --git a/src/Module/Templates/DemoApi/src/Middlewares/CommentOwner.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/CommentOwner.php.tpl index bdcdc58b..f3121cf4 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/CommentOwner.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/CommentOwner.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @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}}\Middlewares; @@ -26,21 +26,13 @@ use Closure; */ class CommentOwner extends BaseMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); $uuid = (string)route_param('uuid'); $request->set('uuid', $uuid); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Editor.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Editor.php.tpl index 06d34fd3..18a1f93e 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/Editor.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/Editor.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -42,26 +42,17 @@ class Editor extends BaseMiddleware */ private const ALLOWED_IMAGE_EXTENSIONS = ['jpeg', 'jpg', 'png']; - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); if (!in_array(auth()->user()->role, self::ROLES)) { - return $this->respondWithError( - $request, - $response, + return $this->respondWithError($request, t('validation.unauthorizedRequest'), StatusCode::UNAUTHORIZED ); } if ($request->isMethod('post') || $request->isMethod('put')) { - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } } diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Forget.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Forget.php.tpl index bea4c628..ef1cc1a8 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/Forget.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/Forget.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -26,19 +26,10 @@ use Closure; */ class Forget extends BaseMiddleware { - - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); if ($request->isMethod('post')) { - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } } diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Password.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Password.php.tpl index e202988f..3dc1683f 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/Password.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/Password.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @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}}\Middlewares; @@ -27,17 +27,10 @@ use Closure; */ class Password extends BaseMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - */ public function apply(Request $request, Closure $next): Response { - $response = response(); if ($request->isMethod('post')) { - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } } @@ -70,7 +63,6 @@ class Password extends BaseMiddleware /** * Registers custom validation rules - * @param Request $request */ private function registerCustomRules(Request $request) { diff --git a/src/Module/Templates/DemoApi/src/Middlewares/PostOwner.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/PostOwner.php.tpl index c0597c1d..a772a4eb 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/PostOwner.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/PostOwner.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @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}}\Middlewares; @@ -26,21 +26,13 @@ use Closure; */ class PostOwner extends BaseMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); $uuid = (string)route_param('uuid'); $request->set('uuid', $uuid); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Resend.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Resend.php.tpl index 7c630acf..9d899481 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/Resend.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/Resend.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -25,22 +25,13 @@ use Closure; */ class Resend extends BaseMiddleware { - - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); $code = (string) route_param('code'); $request->set('code', $code); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Reset.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Reset.php.tpl index f52ca4eb..45446eb8 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/Reset.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/Reset.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -26,21 +26,13 @@ use Closure; */ class Reset extends BaseMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); $token = (string) route_param('token'); $request->set('token', $token); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Signout.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Signout.php.tpl index 6c9a295a..8e8e24c6 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/Signout.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/Signout.php.tpl @@ -9,9 +9,9 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ - + namespace {{MODULE_NAMESPACE}}\Middlewares; use Quantum\Http\Response; @@ -24,20 +24,10 @@ use Closure; */ class Signout extends BaseMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); if (!$request->hasHeader('refresh_token')) { - $this->respondWithError( - $request, - $response, + return $this->respondWithError($request, [t('validation.nonExistingRecord', 'token')] ); } diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Signup.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Signup.php.tpl index 19dd2669..746ca6b4 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/Signup.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/Signup.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -26,18 +26,9 @@ use Closure; */ class Signup extends BaseMiddleware { - - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Update.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Update.php.tpl index afadb9d4..20c78f78 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/Update.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/Update.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -25,18 +25,10 @@ use Closure; */ class Update extends BaseMiddleware { - - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - */ public function apply(Request $request, Closure $next): Response { - $response = response(); if ($request->isMethod('post')) { - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } } diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Verify.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Verify.php.tpl index 96e457a0..a6214374 100644 --- a/src/Module/Templates/DemoApi/src/Middlewares/Verify.php.tpl +++ b/src/Module/Templates/DemoApi/src/Middlewares/Verify.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -26,19 +26,10 @@ use Closure; class Verify extends BaseMiddleware { - - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); if ($request->isMethod('post')) { - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } } diff --git a/src/Module/Templates/DemoWeb/src/Controllers/AccountController.php.tpl b/src/Module/Templates/DemoWeb/src/Controllers/AccountController.php.tpl index 7a51a07f..b21d8044 100644 --- a/src/Module/Templates/DemoWeb/src/Controllers/AccountController.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Controllers/AccountController.php.tpl @@ -32,7 +32,6 @@ class AccountController extends BaseController /** * Account service - * @var AuthService */ public AuthService $authService; @@ -44,22 +43,18 @@ class AccountController extends BaseController /** * Action - show user info - * @param Response $response - * @return Response */ - public function form(Response $response): Response + public function form(): Response { $this->view->setParams([ 'title' => t('common.account_settings') . ' | ' . config()->get('app.name'), ]); - return $response->html($this->view->render('account/form')); + return response()->html($this->view->render('account/form')); } /** * Action - update user info - * @param Request $request - * @return Response */ public function update(Request $request): Response { @@ -78,15 +73,13 @@ class AccountController extends BaseController /** * Action - update password - * @param Request $request - * @return Response */ public function updatePassword(Request $request): Response { $hasher = new Hasher(); $newPassword = $request->get('new_password', null); - + $this->authService->update('uuid', auth()->user()->uuid, [ 'password' => $hasher->hash($newPassword) ]); diff --git a/src/Module/Templates/DemoWeb/src/Controllers/AuthController.php.tpl b/src/Module/Templates/DemoWeb/src/Controllers/AuthController.php.tpl index 69992534..59e3e7e1 100644 --- a/src/Module/Templates/DemoWeb/src/Controllers/AuthController.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Controllers/AuthController.php.tpl @@ -26,7 +26,6 @@ use Quantum\Http\Request; */ class AuthController extends BaseController { - /** * Main layout */ @@ -59,11 +58,8 @@ 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 { if ($request->isMethod('post')) { try { @@ -83,13 +79,12 @@ class AuthController extends BaseController 'title' => t('common.signin') . ' | ' . config()->get('app.name'), ]); - return $response->html($this->view->render(self::VIEW_SIGNIN)); + return response()->html($this->view->render(self::VIEW_SIGNIN)); } } /** * Action - sign out - * @return Response */ public function signout(): Response { @@ -99,11 +94,8 @@ 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 { if ($request->isMethod('post')) { $userDto = UserDTO::fromRequest($request, Role::EDITOR, uuid_ordered()); @@ -118,14 +110,12 @@ class AuthController extends BaseController 'title' => t('common.signup') . ' | ' . config()->get('app.name'), ]); - return $response->html($this->view->render(self::VIEW_SIGNUP)); + return response()->html($this->view->render(self::VIEW_SIGNUP)); } } /** * Action - activate - * @param Request $request - * @return Response */ public function activate(Request $request): Response { @@ -135,11 +125,8 @@ class AuthController extends BaseController /** * Action - forget - * @param Request $request - * @param Response $response - * @return Response */ - public function forget(Request $request, Response $response): Response + public function forget(Request $request): Response { if ($request->isMethod('post')) { auth()->forget($request->get('email')); @@ -150,17 +137,14 @@ class AuthController extends BaseController 'title' => t('common.forget_password') . ' | ' . config()->get('app.name'), ]); - return $response->html($this->view->render(self::VIEW_FORGET)); + return response()->html($this->view->render(self::VIEW_FORGET)); } } /** * Action - reset - * @param Request $request - * @param Response $response - * @return Response */ - public function reset(Request $request, Response $response): Response + public function reset(Request $request): Response { if ($request->isMethod('post')) { auth()->reset($request->get('reset_token'), $request->get('password')); @@ -171,17 +155,14 @@ class AuthController extends BaseController 'reset_token' => $request->get('reset_token') ]); - return $response->html($this->view->render(self::VIEW_RESET)); + return response()->html($this->view->render(self::VIEW_RESET)); } } /** * 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 { if ($request->isMethod('post')) { try { @@ -197,13 +178,12 @@ class AuthController extends BaseController 'code' => route_param('code') ]); - return $response->html($this->view->render(self::VIEW_VERIFY)); + return response()->html($this->view->render(self::VIEW_VERIFY)); } } /** * Action - Resend OTP - * @return Response */ public function resend(): Response { diff --git a/src/Module/Templates/DemoWeb/src/Controllers/BaseController.php.tpl b/src/Module/Templates/DemoWeb/src/Controllers/BaseController.php.tpl index 85bd60b6..da517c6d 100644 --- a/src/Module/Templates/DemoWeb/src/Controllers/BaseController.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Controllers/BaseController.php.tpl @@ -24,10 +24,6 @@ use Quantum\View\View; */ abstract class BaseController { - - /** - * @var View - */ protected View $view; public function __before() diff --git a/src/Module/Templates/DemoWeb/src/Controllers/CommentController.php.tpl b/src/Module/Templates/DemoWeb/src/Controllers/CommentController.php.tpl index 5f0f8dd6..ecdc0f0f 100644 --- a/src/Module/Templates/DemoWeb/src/Controllers/CommentController.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Controllers/CommentController.php.tpl @@ -24,19 +24,8 @@ use Quantum\Http\Request; */ class CommentController extends BaseController { - - /** - * @var CommentService - */ public CommentService $commentService; - /** - * @return void - * @throws ReflectionException - * @throws \Quantum\App\Exceptions\BaseException - * @throws \Quantum\Di\Exceptions\DiException - * @throws \Quantum\Service\Exceptions\ServiceException - */ public function __before() { $this->commentService = service(CommentService::class); @@ -45,10 +34,6 @@ class CommentController extends BaseController /** * Action - create comment - * @param Request $request - * @param string|null $lang - * @param string $uuid - * @return Response */ public function create(Request $request, ?string $lang, string $uuid): Response { @@ -62,9 +47,6 @@ class CommentController extends BaseController /** * Action - delete comment - * @param string|null $lang - * @param string $uuid - * @return Response */ public function delete(?string $lang, string $uuid): Response { diff --git a/src/Module/Templates/DemoWeb/src/Controllers/PageController.php.tpl b/src/Module/Templates/DemoWeb/src/Controllers/PageController.php.tpl index 505679a3..ecb4e2e4 100644 --- a/src/Module/Templates/DemoWeb/src/Controllers/PageController.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Controllers/PageController.php.tpl @@ -30,23 +30,21 @@ class PageController extends BaseController protected const LAYOUT = 'layouts/main'; /** - * Action - display home page - * @param Response $response + * Action - display home page */ - public function home(Response $response): Response + public function home(): Response { $this->view->setParams([ 'title' => config()->get('app.name'), ]); - return $response->html($this->view->render('pages/index')); + return response()->html($this->view->render('pages/index')); } /** - * Action - display about page - * @param Response $response + * Action - display about page */ - public function about(Response $response): Response + public function about(): Response { $this->view->setParams([ 'title' => t('common.about') . ' | ' . config()->get('app.name'), @@ -54,6 +52,6 @@ class PageController extends BaseController $commands = service(CommandService::class)->getAllCommands(); - return $response->html($this->view->render('pages/about', ['commands' => $commands])); + return response()->html($this->view->render('pages/about', ['commands' => $commands])); } } diff --git a/src/Module/Templates/DemoWeb/src/Controllers/PostController.php.tpl b/src/Module/Templates/DemoWeb/src/Controllers/PostController.php.tpl index c0a45b2c..4ec6df68 100644 --- a/src/Module/Templates/DemoWeb/src/Controllers/PostController.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Controllers/PostController.php.tpl @@ -27,7 +27,6 @@ use Quantum\Http\Request; */ class PostController extends BaseController { - /** * Posts per page */ @@ -37,15 +36,14 @@ class PostController extends BaseController * Current page */ protected const CURRENT_PAGE = 1; - + /** * Main layout */ protected const LAYOUT = 'layouts/main'; - + /** * Post service - * @var PostService */ public PostService $postService; @@ -57,11 +55,8 @@ class PostController extends BaseController /** * Action - get posts list - * @param Request $request - * @param Response $response - * @return Response */ - public function posts(Request $request, Response $response): Response + public function posts(Request $request): Response { $perPage = $request->get('per_page', (string) self::POSTS_PER_PAGE); $currentPage = $request->get('page', (string) self::CURRENT_PAGE); @@ -76,25 +71,20 @@ class PostController extends BaseController 'referer' => nav_ref_encode(request()->getQuery()) ]); - return $response->html($this->view->render('post/post')); + return response()->html($this->view->render('post/post')); } /** * Action - get single post - * @param Request $request - * @param Response $response - * @param string|null $lang - * @param string $postUuid - * @return Response */ - public function post(Request $request, Response $response, ?string $lang, string $postUuid): Response + public function post(Request $request, ?string $lang, string $postUuid): Response { $ref = $request->get('ref', 'posts'); - + $post = $this->postService->getPost($postUuid); - + if ($post->isEmpty()) { - return $response->html(partial('errors/404'), StatusCode::NOT_FOUND); + return response()->html(partial('errors/404'), StatusCode::NOT_FOUND); } $commentService = service(CommentService::class); @@ -110,6 +100,6 @@ class PostController extends BaseController 'referer' => nav_ref_decode($ref), ]); - return $response->html($this->view->render('post/single')); + return response()->html($this->view->render('post/single')); } } diff --git a/src/Module/Templates/DemoWeb/src/Controllers/PostManagementController.php.tpl b/src/Module/Templates/DemoWeb/src/Controllers/PostManagementController.php.tpl index a773d1f1..2a9767a3 100644 --- a/src/Module/Templates/DemoWeb/src/Controllers/PostManagementController.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Controllers/PostManagementController.php.tpl @@ -25,15 +25,13 @@ use Quantum\Http\Request; */ class PostManagementController extends BaseController { - /** * Main layout */ protected const LAYOUT = 'layouts/main'; - + /** * Post service - * @var PostService */ public PostService $postService; @@ -45,11 +43,8 @@ class PostManagementController extends BaseController /** * Action - get my posts - * @param Request $request - * @param Response $response - * @return Response */ - public function myPosts(Request $request, Response $response): Response + public function myPosts(Request $request): Response { $myPosts = $this->postService->getMyPosts(auth()->user()->uuid); @@ -58,16 +53,13 @@ class PostManagementController extends BaseController 'posts' => $this->postService->transformData($myPosts->all()) ]); - return $response->html($this->view->render('post/my-posts')); + return response()->html($this->view->render('post/my-posts')); } /** * Action - display form for creating a post - * @param Request $request - * @param Response $response - * @return Response */ - public function createFrom(Request $request, Response $response): Response + public function createFrom(Request $request): Response { $ref = $request->get('ref', 'posts'); @@ -76,13 +68,11 @@ class PostManagementController extends BaseController 'referer' => $ref ]); - return $response->html($this->view->render('post/form')); + return response()->html($this->view->render('post/form')); } /** * Action - create post - * @param Request $request - * @return Response */ public function create(Request $request): Response { @@ -104,14 +94,9 @@ class PostManagementController extends BaseController } /** - * Action - display form for amend the post - * @param Request $request - * @param Response $response - * @param string|null $lang - * @param string $postUuid - * @return Response + * Action - display form for amend the post */ - public function amendForm(Request $request, Response $response, ?string $lang, string $postUuid): Response + public function amendForm(Request $request, ?string $lang, string $postUuid): Response { $ref = $request->get('ref', 'posts'); @@ -123,15 +108,11 @@ class PostManagementController extends BaseController 'referer' => nav_ref_decode($ref) ]); - return $response->html($this->view->render('post/form')); + return response()->html($this->view->render('post/form')); } /** - * Action - amend post - * @param Request $request - * @param string|null $lang - * @param string $postUuid - * @return Response + * Action - amend post */ public function amend(Request $request, ?string $lang, string $postUuid): Response { @@ -160,9 +141,6 @@ class PostManagementController extends BaseController /** * Action - delete post - * @param string|null $lang - * @param string $postUuid - * @return Response */ public function delete(?string $lang, string $postUuid): Response { @@ -179,9 +157,6 @@ class PostManagementController extends BaseController /** * Action - delete image of the post - * @param string|null $lang - * @param string $postUuid - * @return Response */ public function deleteImage(?string $lang, string $postUuid): Response { diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Activate.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Activate.php.tpl index 402c0ee7..5b49131e 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/Activate.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/Activate.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -27,21 +27,13 @@ use Closure; */ class Activate extends BaseMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); $token = (string)route_param('token'); $request->set('token', $token); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } @@ -66,8 +58,8 @@ class Activate extends BaseMiddleware /** * @inheritDoc */ - protected function respondWithError(Request $request, Response $response, $message): Response + protected function respondWithError(Request $request, $message): Response { - return $response->html(partial('errors/404'), StatusCode::NOT_FOUND); + return response()->html(partial('errors/404'), StatusCode::NOT_FOUND); } } diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Auth.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Auth.php.tpl index 781db573..5c2fe08a 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/Auth.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/Auth.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -25,13 +25,6 @@ use Closure; */ class Auth extends QtMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { if (!auth()->check()) { diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/BaseMiddleware.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/BaseMiddleware.php.tpl index a26b27fb..bd2e6657 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/BaseMiddleware.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/BaseMiddleware.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @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}}\Middlewares; @@ -25,15 +25,10 @@ use Quantum\Http\Request; */ abstract class BaseMiddleware extends QtMiddleware { - - /** - * @var Validator - */ protected $validator; /** * Initialize Validator and define rules. - * @param Request $request */ public function __construct(Request $request) { @@ -43,14 +38,12 @@ abstract class BaseMiddleware extends QtMiddleware } /** - * @param Request $request - * @param Response $response * @return Response|null */ - protected function validateRequest(Request $request, Response $response): ?Response + protected function validateRequest(Request $request): ?Response { if (!$this->validator->isValid($request->all())) { - return $this->respondWithError($request, $response, $this->validator->getErrors()); + return $this->respondWithError($request, $this->validator->getErrors()); } return null; @@ -58,7 +51,6 @@ abstract class BaseMiddleware extends QtMiddleware /** * Define validation rules specific to middleware. - * @param Request $request */ protected function defineValidationRules(Request $request) { @@ -67,14 +59,10 @@ abstract class BaseMiddleware extends QtMiddleware /** * Handles error response logic. - * @param Request $request - * @param Response $response - * @param mixed $message - * @return Response */ - protected function respondWithError(Request $request, Response $response, $message): Response + protected function respondWithError(Request $request, $message): Response { // default no-op: subclasses override if needed - return $response; + return response(); } } diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Comment.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Comment.php.tpl index 3818da5c..703bba01 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/Comment.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/Comment.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @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}}\Middlewares; @@ -25,16 +25,9 @@ use Closure; */ class Comment extends BaseMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - */ public function apply(Request $request, Closure $next): Response { - $response = response(); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } @@ -58,9 +51,7 @@ class Comment extends BaseMiddleware /** * @inheritDoc */ - protected function respondWithError( - Request $request, - Response $response, + protected function respondWithError(Request $request, $message ): Response { diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/CommentOwner.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/CommentOwner.php.tpl index bdcdc58b..f3121cf4 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/CommentOwner.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/CommentOwner.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @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}}\Middlewares; @@ -26,21 +26,13 @@ use Closure; */ class CommentOwner extends BaseMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); $uuid = (string)route_param('uuid'); $request->set('uuid', $uuid); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Editor.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Editor.php.tpl index 6e426c36..2f3c362a 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/Editor.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/Editor.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -41,21 +41,14 @@ class Editor extends BaseMiddleware */ private const ALLOWED_IMAGE_EXTENSIONS = ['jpeg', 'jpg', 'png']; - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); if (!in_array(auth()->user()->role, self::ROLES)) { return redirect(base_url(true) . '/' . current_lang()); } if ($request->isMethod('post') || $request->isMethod('put')) { - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } } @@ -94,7 +87,7 @@ class Editor extends BaseMiddleware /** * @inheritDoc */ - protected function respondWithError(Request $request, Response $response, $message): Response + protected function respondWithError(Request $request, $message): Response { $data = $request->all(); diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Forget.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Forget.php.tpl index f626cd97..f213b104 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/Forget.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/Forget.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -26,19 +26,10 @@ use Closure; */ class Forget extends BaseMiddleware { - - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); if ($request->isMethod('post')) { - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } } @@ -48,7 +39,6 @@ class Forget extends BaseMiddleware /** * Define validation rules - * @param Request $request */ protected function defineValidationRules(Request $request) { @@ -64,9 +54,7 @@ class Forget extends BaseMiddleware /** * @inheritDoc */ - protected function respondWithError( - Request $request, - Response $response, + protected function respondWithError(Request $request, $message ): Response { diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Guest.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Guest.php.tpl index 565312b2..14ba069c 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/Guest.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/Guest.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -25,13 +25,6 @@ use Closure; */ class Guest extends QtMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { if (auth()->check()) { diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Password.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Password.php.tpl index 3470c8e6..37d41614 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/Password.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/Password.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @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}}\Middlewares; @@ -27,18 +27,12 @@ use Closure; */ class Password extends BaseMiddleware { - - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - */ public function apply(Request $request, Closure $next): Response { - $response = response(); if ($request->isMethod('post')) { - $this->validateRequest($request, $response); + if ($errorResponse = $this->validateRequest($request)) { + return $errorResponse; + } } return $next($request); @@ -70,7 +64,7 @@ class Password extends BaseMiddleware /** * @inheritDoc */ - protected function respondWithError(Request $request, Response $response, $message) + protected function respondWithError(Request $request, $message) { session()->setFlash('error', $message); redirectWith(base_url(true) . '/' . current_lang() . '/account-settings#account_password', $request->all()); diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/PostOwner.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/PostOwner.php.tpl index e16b75ed..5347a80c 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/PostOwner.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/PostOwner.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @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}}\Middlewares; @@ -27,22 +27,13 @@ use Closure; */ class PostOwner extends BaseMiddleware { - - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); $uuid = (string)route_param('uuid'); $request->set('uuid', $uuid); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } @@ -67,9 +58,9 @@ class PostOwner extends BaseMiddleware /** * @inheritDoc */ - protected function respondWithError(Request $request, Response $response, $message = null): Response + protected function respondWithError(Request $request, $message = null): Response { - return $response->html(partial('errors/404'), StatusCode::NOT_FOUND); + return response()->html(partial('errors/404'), StatusCode::NOT_FOUND); } /** diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Resend.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Resend.php.tpl index a71b8350..350a5aba 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/Resend.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/Resend.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -25,22 +25,13 @@ use Closure; */ class Resend extends BaseMiddleware { - - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); $code = (string) route_param('code'); $request->set('code', $code); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } @@ -62,9 +53,7 @@ class Resend extends BaseMiddleware /** * @inheritDoc */ - protected function respondWithError( - Request $request, - Response $response, + protected function respondWithError(Request $request, $message, ): Response { session()->setFlash('error', $message); diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Reset.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Reset.php.tpl index 690f4a86..ab443c5e 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/Reset.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/Reset.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -27,21 +27,13 @@ use Closure; */ class Reset extends BaseMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); $token = (string) route_param('token'); $request->set('token', $token); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } @@ -80,10 +72,10 @@ class Reset extends BaseMiddleware /** * @inheritDoc */ - protected function respondWithError(Request $request, Response $response, $message): Response + protected function respondWithError(Request $request, $message): Response { if ($request->isMethod('get') && isset($message['token'])) { - return $response->html(partial('errors/404'), StatusCode::NOT_FOUND); + return response()->html(partial('errors/404'), StatusCode::NOT_FOUND); } session()->setFlash('error', $message); diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Signup.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Signup.php.tpl index 54d1aee2..7886aa78 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/Signup.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/Signup.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -26,16 +26,8 @@ use Closure; */ class Signup extends BaseMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); if ($request->isMethod('post')) { $captchaName = captcha()->getName(); @@ -44,7 +36,7 @@ class Signup extends BaseMiddleware $request->delete($captchaName . '-response'); } - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } @@ -85,7 +77,7 @@ class Signup extends BaseMiddleware /** * @inheritDoc */ - protected function respondWithError(Request $request, Response $response, $message): Response + protected function respondWithError(Request $request, $message): Response { session()->setFlash('error', $message); return redirectWith(base_url(true) . '/' . current_lang() . '/signup', $request->all()); diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Update.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Update.php.tpl index 07bf2f1c..40bf6c2f 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/Update.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/Update.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -25,18 +25,10 @@ use Closure; */ class Update extends BaseMiddleware { - - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - */ public function apply(Request $request, Closure $next): Response { - $response = response(); if ($request->isMethod('post')) { - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } } @@ -62,9 +54,7 @@ class Update extends BaseMiddleware /** * @inheritDoc */ - protected function respondWithError( - Request $request, - Response $response, + protected function respondWithError(Request $request, $message ): Response { diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Verify.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Verify.php.tpl index 276956be..0a0dd16c 100644 --- a/src/Module/Templates/DemoWeb/src/Middlewares/Verify.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Middlewares/Verify.php.tpl @@ -9,7 +9,7 @@ * @author Arman Ag. * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) * @link http://quantum.softberg.org/ - * @since 2.9.8 + * @since 3.0.0 */ namespace {{MODULE_NAMESPACE}}\Middlewares; @@ -27,21 +27,13 @@ use Closure; */ class Verify extends BaseMiddleware { - - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); $code = (string) route_param('code'); $request->set('code', $code); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } @@ -67,10 +59,10 @@ class Verify extends BaseMiddleware /** * @inheritDoc */ - protected function respondWithError(Request $request, Response $response, $message): Response + protected function respondWithError(Request $request, $message): Response { if ($request->isMethod('get') && isset($message['code'])) { - return $response->html(partial('errors/404'), StatusCode::NOT_FOUND); + return response()->html(partial('errors/404'), StatusCode::NOT_FOUND); } session()->setFlash('error', $message); diff --git a/src/Module/Templates/Toolkit/src/Controllers/BaseController.php.tpl b/src/Module/Templates/Toolkit/src/Controllers/BaseController.php.tpl index 953eb26c..3658c5b8 100644 --- a/src/Module/Templates/Toolkit/src/Controllers/BaseController.php.tpl +++ b/src/Module/Templates/Toolkit/src/Controllers/BaseController.php.tpl @@ -39,14 +39,8 @@ class BaseController */ protected const CURRENT_PAGE = 1; - /** - * @var View - */ protected View $view; - /** - * Works before an action - */ public function __before() { $this->view = ViewFactory::get(); diff --git a/src/Module/Templates/Toolkit/src/Controllers/DashboardController.php.tpl b/src/Module/Templates/Toolkit/src/Controllers/DashboardController.php.tpl index 0cbee3db..bf87f55e 100644 --- a/src/Module/Templates/Toolkit/src/Controllers/DashboardController.php.tpl +++ b/src/Module/Templates/Toolkit/src/Controllers/DashboardController.php.tpl @@ -28,14 +28,8 @@ use ReflectionException; */ class DashboardController extends BaseController { - /** - * @var DashboardService - */ public DashboardService $dashboardService; - /** - * Works before an action - */ public function __before() { $this->dashboardService = service(DashboardService::class); @@ -43,16 +37,12 @@ class DashboardController extends BaseController parent::__before(); } - /** - * @param Request $request - * @param Response $response - */ - public function index(Request $request, Response $response): Response + public function index(Request $request): Response { $this->view->setParams([ 'title' => 'Dashboard', ]); - return $response->html($this->view->render('pages/dashboard/index')); + return response()->html($this->view->render('pages/dashboard/index')); } } diff --git a/src/Module/Templates/Toolkit/src/Controllers/DatabaseController.php.tpl b/src/Module/Templates/Toolkit/src/Controllers/DatabaseController.php.tpl index 68a45200..6c802cfb 100644 --- a/src/Module/Templates/Toolkit/src/Controllers/DatabaseController.php.tpl +++ b/src/Module/Templates/Toolkit/src/Controllers/DatabaseController.php.tpl @@ -25,9 +25,6 @@ use Quantum\Http\Request; */ class DatabaseController extends BaseController { - /** - * @var DatabaseService - */ private DatabaseService $databaseService; /** @@ -40,11 +37,7 @@ class DatabaseController extends BaseController parent::__before(); } - /** - * @param Response $response - * @return Response - */ - public function list(Response $response): Response + public function list(): Response { $tables = $this->databaseService->getTables(); @@ -53,15 +46,13 @@ class DatabaseController extends BaseController 'tables' => $tables, ]); - return $response->html($this->view->render('pages/database/index')); + return response()->html($this->view->render('pages/database/index')); } /** - * @param Request $request - * @param Response $response * @throws DatabaseException */ - public function single(Request $request, Response $response): Response + public function single(Request $request): Response { $tableName = $request->get('table'); $perPage = $request->get('per_page', self::ITEMS_PER_PAGE); @@ -79,13 +70,9 @@ class DatabaseController extends BaseController 'pagination' => $tableData['pagination'], ]); - return $response->html($this->view->render('pages/database/table')); + return response()->html($this->view->render('pages/database/table')); } - /** - * @param Request $request - * @return Response - */ public function create(Request $request): Response { $tableName = $request->get('table'); @@ -97,10 +84,6 @@ class DatabaseController extends BaseController return redirect(get_referrer() ?? base_url()); } - /** - * @param Request $request - * @return Response - */ public function update(Request $request): Response { $tableName = $request->get('table'); @@ -112,10 +95,6 @@ class DatabaseController extends BaseController return redirect(base_url(true) . '/database/view?table=' . $tableName); } - /** - * @param Request $request - * @return Response - */ public function delete(Request $request): Response { $tableName = $request->get('tableName'); diff --git a/src/Module/Templates/Toolkit/src/Controllers/EmailsController.php.tpl b/src/Module/Templates/Toolkit/src/Controllers/EmailsController.php.tpl index 3076e2d8..4b8013fe 100644 --- a/src/Module/Templates/Toolkit/src/Controllers/EmailsController.php.tpl +++ b/src/Module/Templates/Toolkit/src/Controllers/EmailsController.php.tpl @@ -28,14 +28,8 @@ use ReflectionException; */ class EmailsController extends BaseController { - /** - * @var EmailService - */ public EmailService $emailService; - /** - * Works before an action - */ public function __before() { $this->emailService = service(EmailService::class); @@ -43,11 +37,7 @@ class EmailsController extends BaseController parent::__before(); } - /** - * @param Request $request - * @param Response $response - */ - public function list(Request $request, Response $response): Response + public function list(Request $request): Response { $perPage = $request->get('per_page', self::ITEMS_PER_PAGE); $currentPage = $request->get('page', self::CURRENT_PAGE); @@ -60,23 +50,16 @@ class EmailsController extends BaseController 'pagination' => $data ]); - return $response->html($this->view->render('pages/email/index')); + return response()->html($this->view->render('pages/email/index')); } - /** - * @param Response $response - * @param string $emailId - */ - public function single(Response $response, string $emailId): Response + public function single(string $emailId): Response { $email = $this->emailService->getEmail($emailId); - return $response->html(quoted_printable_decode($email->getParsedBody())); + return response()->html(quoted_printable_decode($email->getParsedBody())); } - /** - * @param string $emailId - */ public function delete(string $emailId): Response { $this->emailService->deleteEmail($emailId); diff --git a/src/Module/Templates/Toolkit/src/Controllers/LogsController.php.tpl b/src/Module/Templates/Toolkit/src/Controllers/LogsController.php.tpl index 8383bec7..0bcf2edf 100644 --- a/src/Module/Templates/Toolkit/src/Controllers/LogsController.php.tpl +++ b/src/Module/Templates/Toolkit/src/Controllers/LogsController.php.tpl @@ -28,14 +28,8 @@ use ReflectionException; */ class LogsController extends BaseController { - /** - * @var LogsService - */ public LogsService $logsService; - /** - * Works before an action - */ public function __before() { $this->logsService = service(LogsService::class); @@ -43,10 +37,7 @@ class LogsController extends BaseController parent::__before(); } - /** - * @param Response $response - */ - public function list(Response $response): Response + public function list(): Response { $filteredLogFiles = $this->logsService->getLogFiles(); @@ -55,14 +46,10 @@ class LogsController extends BaseController 'logFiles' => $filteredLogFiles, ]); - return $response->html($this->view->render('pages/logs/index')); + return response()->html($this->view->render('pages/logs/index')); } - /** - * @param Request $request - * @param Response $response - */ - public function single(Request $request, Response $response): Response + public function single(Request $request): Response { $logFile = $request->get('logFile'); $perPage = $request->get('per_page', self::ITEMS_PER_PAGE); @@ -78,6 +65,6 @@ class LogsController extends BaseController 'pagination' => $parsedLogs, ]); - return $response->html($this->view->render('pages/logs/log')); + return response()->html($this->view->render('pages/logs/log')); } } diff --git a/src/Module/Templates/Toolkit/src/Middlewares/BaseMiddleware.php.tpl b/src/Module/Templates/Toolkit/src/Middlewares/BaseMiddleware.php.tpl index 0b3a2388..c4c671dc 100644 --- a/src/Module/Templates/Toolkit/src/Middlewares/BaseMiddleware.php.tpl +++ b/src/Module/Templates/Toolkit/src/Middlewares/BaseMiddleware.php.tpl @@ -14,8 +14,8 @@ namespace Modules\Toolkit\Middlewares; -use Quantum\Validation\Validator; use Quantum\Middleware\QtMiddleware; +use Quantum\Validation\Validator; use Quantum\Http\Response; use Quantum\Http\Request; @@ -25,14 +25,10 @@ use Quantum\Http\Request; */ abstract class BaseMiddleware extends QtMiddleware { - /** - * @var Validator - */ protected Validator $validator; /** * Initialize Validator and define rules. - * @param Request $request */ public function __construct(Request $request) { @@ -41,20 +37,17 @@ abstract class BaseMiddleware extends QtMiddleware $this->defineValidationRules($request); } - /** - * @param Request $request - * @param Response $response - */ - protected function validateRequest(Request $request, Response $response) + protected function validateRequest(Request $request): ?Response { if (!$this->validator->isValid($request->all())) { - $this->respondWithError($request, $response, $this->validator->getErrors()); + return $this->respondWithError($request, $this->validator->getErrors()); } + + return null; } /** * Define validation rules specific to middleware. - * @param Request $request */ protected function defineValidationRules(Request $request) { @@ -63,12 +56,6 @@ abstract class BaseMiddleware extends QtMiddleware /** * Handles error response logic. - * @param Request $request - * @param Response $response - * @param mixed $message */ - protected function respondWithError(Request $request, Response $response, $message) - { - // default no-op: subclasses override if needed - } + abstract protected function respondWithError(Request $request, $message): Response; } diff --git a/src/Module/Templates/Toolkit/src/Middlewares/BasicAuth.php.tpl b/src/Module/Templates/Toolkit/src/Middlewares/BasicAuth.php.tpl index 767813eb..19e2b8d9 100644 --- a/src/Module/Templates/Toolkit/src/Middlewares/BasicAuth.php.tpl +++ b/src/Module/Templates/Toolkit/src/Middlewares/BasicAuth.php.tpl @@ -26,28 +26,17 @@ use Closure; */ class BasicAuth extends QtMiddleware { - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); $userCredentials = $request->getBasicAuthCredentials(); if (!$userCredentials || !$this->isValidCredentials($userCredentials)) { - return $this->unauthorizedResponse($response); + return $this->unauthorizedResponse(); } return $next($request); } - /** - * @param array $credentials - * @return bool - */ private function isValidCredentials(array $credentials): bool { if (!config()->has('basic_auth')) { @@ -60,13 +49,10 @@ class BasicAuth extends QtMiddleware && $credentials['password'] === $configCredentials['password']; } - /** - * @param Response $response - * @return Response - */ - private function unauthorizedResponse(Response $response): Response + private function unauthorizedResponse(): Response { - $response->setHeader('WWW-Authenticate', 'Basic realm="Quantum Toolkit"'); - return $response->html(partial('errors' . DS . '401'), 401); + return response() + ->setHeader('WWW-Authenticate', 'Basic realm="Quantum Toolkit"') + ->html(partial('errors' . DS . '401'), 401); } } diff --git a/src/Module/Templates/Toolkit/src/Middlewares/CreateTable.php.tpl b/src/Module/Templates/Toolkit/src/Middlewares/CreateTable.php.tpl index b6b89e71..bb65afb7 100644 --- a/src/Module/Templates/Toolkit/src/Middlewares/CreateTable.php.tpl +++ b/src/Module/Templates/Toolkit/src/Middlewares/CreateTable.php.tpl @@ -27,16 +27,9 @@ use Closure; */ class CreateTable extends BaseMiddleware { - /** - * @param Request $request - * @param Response $response - * @param Closure $next - * @return Response - */ public function apply(Request $request, Closure $next): Response { - $response = response(); - if ($errorResponse = $this->validateRequest($request, $response)) { + if ($errorResponse = $this->validateRequest($request)) { return $errorResponse; } @@ -68,7 +61,7 @@ class CreateTable extends BaseMiddleware /** * @inheritDoc */ - protected function respondWithError(Request $request, Response $response, $message): Response + protected function respondWithError(Request $request, $message): Response { session()->setFlash('error', $message); return redirect(get_referrer() ?? base_url());