phpcs

opengento · Aug 6, 2024 · 02e6cff · 02e6cff
1 parent 671b4df
commit 02e6cff
Show file tree

Hide file tree

Showing 45 changed files with 359 additions and 168 deletions.
diff --git a/Api/RequestLoginRepositoryInterface.php b/Api/RequestLoginRepositoryInterface.php
@@ -12,30 +12,40 @@
 interface RequestLoginRepositoryInterface
 {
     /**
+     * Get Login Request
+     *
      * @param string $email
      * @return LoginRequest
      */
     public function get(string $email): LoginRequest;
 
     /**
+     * Get Login Request By Id
+     *
      * @param string $id
      * @return LoginRequest
      */
     public function getById(string $id): LoginRequest;
 
     /**
+     * Save Login Request
+     *
      * @param \Opengento\Hoodoor\Model\LoginRequest $model
      * @return bool
      */
     public function save(LoginRequest $model): bool;
 
     /**
+     * Delete Login Request
+     *
      * @param \Opengento\Hoodoor\Model\LoginRequest $model
      * @return bool
      */
     public function delete(LoginRequest $model): bool;
 
     /**
+     * Lock Login Request
+     *
      * @param \Opengento\Hoodoor\Model\LoginRequest $model
      * @return bool
      */

diff --git a/Block/Adminhtml/System/Config/Button.php b/Block/Adminhtml/System/Config/Button.php
@@ -15,6 +15,8 @@
 class Button extends Field
 {
     /**
+     * Create Element Html (Button + Script)
+     *
      * @param \Magento\Framework\Data\Form\Element\AbstractElement $element
      * @return string
      * @throws \Magento\Framework\Exception\LocalizedException
@@ -28,21 +30,26 @@ protected function _getElementHtml(AbstractElement $element): string
     }
 
     /**
+     * Create Button Block
+     *
+     * @return string
      * @throws \Magento\Framework\Exception\LocalizedException
      */
-    protected function getButtonHtml()
+    protected function getButtonHtml(): string
     {
         $button = $this->getLayout()->createBlock(WidgetButton::class)
-            ->setData(array(
+            ->setData([
                 'id' => 'generate_secret_key',
                 'label' => __('Generate Secret Key'),
                 'class' => 'generate-secret-key-button'
-            ));
+            ]);
 
         return $button->toHtml();
     }
 
     /**
+     * Generate Secret Key Script
+     *
      * @param \Magento\Framework\Data\Form\Element\AbstractElement $element
      * @return string
      */

diff --git a/Controller/Account/CreatePost.php b/Controller/Account/CreatePost.php
@@ -68,14 +68,15 @@ class CreatePost extends CoreCreatePost implements CsrfAwareActionInterface, Htt
      * @param \Magento\Customer\Api\CustomerRepositoryInterface $customerRepository
      * @param \Magento\Framework\Data\Form\FormKey\Validator|null $formKeyValidator
      */
-    public function __construct(
+    public function __construct( //phpcs:ignore
         protected readonly Password $passwordService,
         Context $context,
         Session $customerSession,
         ScopeConfigInterface $scopeConfig,
         StoreManagerInterface $storeManager,
         AccountManagementInterface $accountManagement,
-        Address $addressHelper, UrlFactory $urlFactory,
+        Address $addressHelper,
+        UrlFactory $urlFactory,
         FormFactory $formFactory,
         SubscriberFactory $subscriberFactory,
         RegionInterfaceFactory $regionDataFactory,
@@ -115,12 +116,14 @@ public function __construct(
     }
 
     /**
+     * Execute
+     *
      * @throws \Magento\Framework\Exception\NotFoundException
      * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function execute()
     {
-        if(!$this->password) {
+        if (!$this->password) {
             $this->password = $this->passwordService->generate();
         }
         $this->getRequest()->setParams([

diff --git a/Controller/Account/Edit.php b/Controller/Account/Edit.php
@@ -10,6 +10,8 @@
 class Edit extends \Magento\Customer\Controller\Account\Edit
 {
     /**
+     * Execute
+     *
      * @return \Magento\Framework\App\ResponseInterface|\Magento\Framework\View\Result\Page
      */
     public function execute()

diff --git a/Controller/Account/ForgotPassword.php b/Controller/Account/ForgotPassword.php
@@ -17,6 +17,6 @@ class ForgotPassword extends \Magento\Customer\Controller\Account\ForgotPassword
     public function execute()
     {
         $this->messageManager->addErrorMessage(__('Access denied.'));
-        return $this->_redirect('customer/account/login');
+        return $this->_redirect('customer/account');
     }
 }
diff --git a/Controller/Adminhtml/Pwl/ProcessLogin.php b/Controller/Adminhtml/Pwl/ProcessLogin.php
@@ -29,7 +29,7 @@ class ProcessLogin implements HttpGetActionInterface
      * @param \Magento\Framework\Message\Manager $messageManager
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
      */
-    public function __construct(
+    public function __construct( //phpcs:ignore
         protected readonly RequestLoginRepositoryInterface $loginRequestRepository,
         protected readonly LoginService $adminLoginService,
         protected readonly EncryptionService $encryptionService,
@@ -41,9 +41,11 @@ public function __construct(
     }
 
     /**
+     * Execute
+     *
      * @return \Magento\Framework\Controller\Result\Redirect
      */
-    public function execute()
+    public function execute() // phpcs:ignore Generic.Metrics.NestingLevel.TooHigh
     {
         $redirect = $this->redirectFactory->create();
         $params = $this->request->getParams();
@@ -59,21 +61,29 @@ public function execute()
                         $loginRequest = $this->loginRequestRepository->get($params['email']);
                         if ($loginRequest->getToken() === $params['token']) {
                             if ($loginRequest->hasBeenUsed() || $loginRequest->hasExpired()) {
-                                $this->messageManager->addErrorMessage(__('Unable to execute request. Please try again.'));
+                                $this->messageManager->addErrorMessage(
+                                    __('Unable to execute request. Please try again.')
+                                );
                                 return $redirect->setPath('*');
                             }
                             $this->loginRequestRepository->lock($loginRequest);
                             $this->request->setParams(['email' => $params['email']]);
                             $this->adminLoginService->perform($this->request);
                             $this->loginRequestRepository->delete($loginRequest);
                         } else {
-                            throw new RequestException(_('Invalid request. Please try again.'));
+                            throw new RequestException(
+                                _('Invalid request. Please try again.') // phpcs:ignore
+                            );
                         }
                     } else {
-                        throw new RequestException(_('Invalid request. Please try again.'));
+                        throw new RequestException(
+                            _('Invalid request. Please try again.') // phpcs:ignore
+                        );
                     }
                 } else {
-                    throw new RequestException(_('Invalid request. Please try again.'));
+                    throw new RequestException(
+                        _('Invalid request. Please try again.') // phpcs:ignore
+                    );
                 }
             } catch (\Exception $e) {
                 $this->messageManager->addErrorMessage($e->getMessage());

diff --git a/Controller/Adminhtml/Pwl/RequestLogin.php b/Controller/Adminhtml/Pwl/RequestLogin.php
@@ -23,7 +23,7 @@ class RequestLogin implements HttpPostActionInterface
      * @param \Magento\Backend\Block\Admin\Formkey $formKey
      * @param \Opengento\Hoodoor\Service\Queue $queueService
      */
-    public function __construct(
+    public function __construct( //phpcs:ignore
         protected readonly RequestInterface $request,
         protected readonly RedirectFactory $redirectFactory,
         protected readonly MessageManager $messageManager,
@@ -33,6 +33,8 @@ public function __construct(
     }
 
     /**
+     * Execute
+     *
      * @return \Magento\Framework\Controller\Result\Redirect
      */
     public function execute()
@@ -47,12 +49,16 @@ public function execute()
                 return $redirect->setPath('*/*');
             }
             if (!isset($params['login']['username'])) {
-                $this->messageManager->addErrorMessage(__('You must enter a valid email address.'));
+                $this->messageManager->addErrorMessage(
+                    __('You must enter a valid email address.')
+                );
                 return $redirect->setPath('*/*');
             } else {
                 try {
                     $this->queueService->add($params, 'admin');
-                    $this->messageManager->addSuccessMessage(__('If an account exists, you will receive an email to proceed with your request.'));
+                    $this->messageManager->addSuccessMessage(
+                        __('If an account exists, you will receive an email to proceed with your request.')
+                    );
                 } catch (\Exception $e) {
                     $this->messageManager->addErrorMessage($e->getMessage());
                     return $redirect->setPath('*/*');

diff --git a/Controller/Pwl/ProcessLogin.php b/Controller/Pwl/ProcessLogin.php
@@ -29,7 +29,7 @@ class ProcessLogin implements HttpGetActionInterface
      * @param \Magento\Framework\Message\Manager $messageManager
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
      */
-    public function __construct(
+    public function __construct( //phpcs:ignore
         protected readonly RequestLoginRepositoryInterface $loginRequestRepository,
         protected readonly LoginService $loginService,
         protected readonly EncryptionService $encryptionService,
@@ -41,9 +41,11 @@ public function __construct(
     }
 
     /**
+     * Execute
+     *
      * @return \Magento\Framework\Controller\Result\Redirect
      */
-    public function execute()
+    public function execute() // phpcs:ignore Generic.Metrics.NestingLevel.TooHigh
     {
         $redirect = $this->redirectFactory->create();
         $params = $this->request->getParams();
@@ -59,20 +61,22 @@ public function execute()
                         $request = $this->loginRequestRepository->get($params['email']);
                         if ($request->getToken() === $params['token']) {
                             if ($request->hasBeenUsed() || $request->hasExpired()) {
-                                $this->messageManager->addErrorMessage(__('Unable to execute request. Please try again.'));
+                                $this->messageManager->addErrorMessage(
+                                    __('Unable to execute request. Please try again.')
+                                );
                                 return $redirect->setPath('*/account/login');
                             }
                             $this->loginRequestRepository->lock($request);
                             $this->loginService->perform($params);
                             $this->loginRequestRepository->delete($request);
                         } else {
-                            throw new RequestException(_('Invalid request. Please try again.'));
+                            throw new RequestException(_('Invalid request. Please try again.')); //phpcs:ignore
                         }
                     } else {
-                        throw new RequestException(_('Invalid request. Please try again.'));
+                        throw new RequestException(_('Invalid request. Please try again.')); //phpcs:ignore
                     }
                 } else {
-                    throw new RequestException(_('Invalid request. Please try again.'));
+                    throw new RequestException(_('Invalid request. Please try again.')); //phpcs:ignore
                 }
             } catch (\Exception $e) {
                 $this->messageManager->addErrorMessage($e->getMessage());

diff --git a/Controller/Pwl/RequestLogin.php b/Controller/Pwl/RequestLogin.php
@@ -25,7 +25,7 @@ class RequestLogin implements HttpPostActionInterface
      * @param \Opengento\Hoodoor\Service\Request $requestService
      * @param \Opengento\Hoodoor\Service\Queue $queueService
      */
-    public function __construct(
+    public function __construct( //phpcs:ignore
         protected readonly RequestInterface $request,
         protected readonly RedirectFactory $redirectFactory,
         protected readonly MessageManager $messageManager,
@@ -36,6 +36,8 @@ public function __construct(
     }
 
     /**
+     * Execute
+     *
      * @return \Magento\Framework\Controller\Result\Redirect
      */
     public function execute()
@@ -46,16 +48,22 @@ public function execute()
         if ($params) {
             $isFormKey = $this->formKey->isPresent();
             if (!$isFormKey) {
-                $this->messageManager->addErrorMessage(__('Invalid Form Key. Please refresh the page.'));
+                $this->messageManager->addErrorMessage(
+                    __('Invalid Form Key. Please refresh the page.')
+                );
                 return $redirect->setPath('*/*/login');
             }
             if (!isset($params['login']['username'])) {
-                $this->messageManager->addErrorMessage(__('You must enter a valid email address.'));
+                $this->messageManager->addErrorMessage(
+                    __('You must enter a valid email address.')
+                );
                 return $redirect->setPath('*/*/login');
             } else {
                 try {
                     $this->queueService->add($params, 'customer');
-                    $this->messageManager->addSuccessMessage(__('If a customer account exists, you will receive an email to proceed with your request.'));
+                    $this->messageManager->addSuccessMessage(
+                        __('If a customer account exists, you will receive an email to proceed with your request.')
+                    );
                 } catch (\Exception $e) {
                     $this->messageManager->addErrorMessage($e->getMessage());
                     return $redirect->setPath('*/*/login');

diff --git a/Model/Admin/User.php b/Model/Admin/User.php
@@ -9,12 +9,16 @@
 
 use Magento\Framework\App\DeploymentConfig;
 use Magento\Framework\Serialize\Serializer\Json;
+use Magento\Framework\Serialize\SerializerInterface;
 use Magento\User\Model\Spi\NotificatorInterface;
 use Magento\User\Model\UserValidationRules;
 
 class User extends \Magento\User\Model\User
 {
-    protected $serializer;
+    /**
+     * @var \Magento\Framework\Serialize\SerializerInterface
+     */
+    protected SerializerInterface $serializer;
 
     /**
      * @param \Opengento\Hoodoor\Model\ResourceModel\Admin\User $resourceModel
@@ -75,6 +79,10 @@ public function __construct(
     }
 
     /**
+     * Load Admin User By Email
+     *
+     * @param string $email
+     * @return $this
      * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function loadByEmail(string $email): static