ENGCOM-4676: Partial docs fixes in Newsletter module #20848

Author: sidolov

app/code/Magento/Newsletter/Block/Adminhtml/Problem.php

@@ -41,7 +41,7 @@ public function __construct(
     }
 
     /**
-     * @return void
+     * @inheritDoc
      * @SuppressWarnings(PHPMD.UnusedLocalVariable)
      */
     protected function _construct()
@@ -83,7 +83,7 @@ protected function _prepareLayout()
     /**
      * Get the html element for unsubscribe button
      *
-     * @return $string
+     * @return string
      */
     public function getUnsubscribeButtonHtml()
     {
@@ -93,7 +93,7 @@ public function getUnsubscribeButtonHtml()
     /**
      * Get the html element for delete button
      *
-     * @return $string
+     * @return string
      */
     public function getDeleteButtonHtml()
     {

app/code/Magento/Newsletter/Controller/Adminhtml/Subscriber/MassDelete.php

@@ -6,22 +6,27 @@
  */
 namespace Magento\Newsletter\Controller\Adminhtml\Subscriber;
 
-use Magento\Newsletter\Controller\Adminhtml\Subscriber;
 use Magento\Backend\App\Action\Context;
+use Magento\Framework\App\Action\HttpPostActionInterface;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\App\Response\Http\FileFactory;
+use Magento\Newsletter\Controller\Adminhtml\Subscriber;
 use Magento\Newsletter\Model\SubscriberFactory;
-use Magento\Framework\App\ObjectManager;
 
-class MassDelete extends Subscriber
+/**
+ * Subscriber mass delete controller.
+ */
+class MassDelete extends Subscriber implements HttpPostActionInterface
 {
     /**
      * @var SubscriberFactory
      */
     private $subscriberFactory;
-    
+
     /**
      * @param Context $context
      * @param FileFactory $fileFactory
+     * @param SubscriberFactory|null $subscriberFactory
      */
     public function __construct(
         Context $context,
@@ -31,7 +36,7 @@ public function __construct(
         $this->subscriberFactory = $subscriberFactory ?: ObjectManager::getInstance()->get(SubscriberFactory::class);
         parent::__construct($context, $fileFactory);
     }
-    
+
     /**
      * Delete one or more subscribers action
      *

app/code/Magento/Newsletter/Controller/Manage/Save.php

@@ -3,11 +3,12 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Newsletter\Controller\Manage;
 
 use Magento\Customer\Api\CustomerRepositoryInterface as CustomerRepository;
-use Magento\Customer\Model\Customer;
+use Magento\Customer\Api\Data\CustomerInterface;
 use Magento\Framework\App\Action\HttpGetActionInterface;
 use Magento\Framework\App\Action\HttpPostActionInterface;
 use Magento\Newsletter\Model\Subscriber;
@@ -65,7 +66,7 @@ public function __construct(
     /**
      * Save newsletter subscription preference action
      *
-     * @return void|null
+     * @return \Magento\Framework\App\ResponseInterface
      */
     public function execute()
     {
@@ -110,16 +111,16 @@ public function execute()
                 $this->messageManager->addError(__('Something went wrong while saving your subscription.'));
             }
         }
-        $this->_redirect('customer/account/');
+        return $this->_redirect('customer/account/');
     }
 
     /**
      * Set ignore_validation_flag to skip unnecessary address and customer validation
      *
-     * @param Customer $customer
+     * @param CustomerInterface $customer
      * @return void
      */
-    private function setIgnoreValidationFlag($customer)
+    private function setIgnoreValidationFlag(CustomerInterface $customer): void
     {
         $customer->setData('ignore_validation_flag', true);
     }

app/code/Magento/Newsletter/Controller/Subscriber/Confirm.php

@@ -4,6 +4,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Newsletter\Controller\Subscriber;
 

app/code/Magento/Newsletter/Model/Subscriber.php

@@ -7,11 +7,11 @@
 
 use Magento\Customer\Api\AccountManagementInterface;
 use Magento\Customer\Api\CustomerRepositoryInterface;
-use Magento\Framework\Exception\MailException;
-use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Customer\Api\Data\CustomerInterfaceFactory;
 use Magento\Framework\Api\DataObjectHelper;
 use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Exception\MailException;
+use Magento\Framework\Exception\NoSuchEntityException;
 
 /**
  * Subscriber model
@@ -31,6 +31,7 @@
  * @method int getSubscriberId()
  * @method Subscriber setSubscriberId(int $value)
  *
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  * @SuppressWarnings(PHPMD.CyclomaticComplexity)
  *
@@ -402,6 +403,7 @@ public function loadByCustomerId($customerId)
                 $this->setSubscriberConfirmCode($this->randomSequence());
                 $this->save();
             }
+            // phpcs:ignore Magento2.CodeAnalysis.EmptyBlock
         } catch (NoSuchEntityException $e) {
         }
         return $this;
@@ -493,7 +495,9 @@ public function subscribe($email)
                 $this->sendConfirmationSuccessEmail();
             }
             return $this->getStatus();
+            // phpcs:ignore Magento2.Exceptions.ThrowCatch
         } catch (\Exception $e) {
+            // phpcs:ignore Magento2.Exceptions.DirectThrow
             throw new \Exception($e->getMessage());
         }
     }
@@ -559,7 +563,7 @@ public function updateSubscription($customerId)
      *
      * @param int $customerId
      * @param bool $subscribe indicates whether the customer should be subscribed or unsubscribed
-     * @return  $this
+     * @return $this
      *
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      * @SuppressWarnings(PHPMD.NPathComplexity)
@@ -686,7 +690,7 @@ public function confirm($code)
      * Mark receiving subscriber of queue newsletter
      *
      * @param  \Magento\Newsletter\Model\Queue $queue
-     * @return boolean
+     * @return Subscriber
      */
     public function received(\Magento\Newsletter\Model\Queue $queue)
     {