magento · engcom-Kilo · Feb 18, 2020 · Feb 18, 2020 · Feb 18, 2020 · Feb 18, 2020
diff --git a/Notifier/Command/SendMessage.php b/Notifier/Command/SendMessage.php
@@ -15,6 +15,9 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * @inheritdoc
+ */
 class SendMessage extends Command
 {
     /**
@@ -24,6 +27,7 @@ class SendMessage extends Command
 
     /**
      * SendMessage constructor.
+     *
      * @param ObjectManagerInterface $sendMessage
      */
     public function __construct(
@@ -49,7 +53,6 @@ protected function configure()
 
     /**
      * @inheritdoc
-     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {

diff --git a/Notifier/Model/Channel.php b/Notifier/Model/Channel.php
@@ -13,7 +13,7 @@
 use Magento\NotifierApi\Api\Data\ChannelInterface;
 
 /**
- * @SuppressWarnings(PHPMD.CamelCaseMethodName)
+ * @inheritdoc
  */
 class Channel extends AbstractExtensibleModel implements ChannelInterface
 {

diff --git a/Notifier/Model/Channel/Command/GetList.php b/Notifier/Model/Channel/Command/GetList.php
@@ -46,7 +46,6 @@ class GetList implements GetListInterface
      * @param ChannelSearchResultsInterfaceFactory $searchResultsFactory
      * @param SearchCriteriaBuilder $searchCriteriaBuilder
      * @param CollectionProcessorInterface $collectionProcessor
-     * @SuppressWarnings(PHPMD.LongVariable)
      */
     public function __construct(
         CollectionFactory $collectionFactory,

diff --git a/Notifier/Model/Channel/Command/GetListInterface.php b/Notifier/Model/Channel/Command/GetListInterface.php
@@ -25,6 +25,7 @@ interface GetListInterface
 {
     /**
      * Find Channel by given SearchCriteria
+     *
      * SearchCriteria is not required because load all sources is useful case
      *
      * @param SearchCriteriaInterface|null $searchCriteria

diff --git a/Notifier/Model/Channel/Validator/ValidateAdapter.php b/Notifier/Model/Channel/Validator/ValidateAdapter.php
@@ -15,6 +15,9 @@
 use Magento\NotifierApi\Model\Channel\Validator\ValidateChannelInterface;
 use Magento\NotifierApi\Model\SerializerInterface;
 
+/**
+ * @inheritdoc
+ */
 class ValidateAdapter implements ValidateChannelInterface
 {
     /**
@@ -41,7 +44,7 @@ public function __construct(
     }
 
     /**
-     * @inheritDoc
+     * @inheritdoc
      */
     public function execute(ChannelInterface $channel): void
     {

diff --git a/Notifier/Model/Channel/Validator/ValidateCode.php b/Notifier/Model/Channel/Validator/ValidateCode.php
@@ -12,10 +12,13 @@
 use Magento\NotifierApi\Api\Data\ChannelInterface;
 use Magento\NotifierApi\Model\Channel\Validator\ValidateChannelInterface;
 
+/**
+ * @inheritdoc
+ */
 class ValidateCode implements ValidateChannelInterface
 {
     /**
-     * @inheritDoc
+     * @inheritdoc
      */
     public function execute(ChannelInterface $channel): void
     {

diff --git a/Notifier/Model/Channel/Validator/ValidateName.php b/Notifier/Model/Channel/Validator/ValidateName.php
@@ -12,10 +12,13 @@
 use Magento\NotifierApi\Api\Data\ChannelInterface;
 use Magento\NotifierApi\Model\Channel\Validator\ValidateChannelInterface;
 
+/**
+ * @inheritdoc
+ */
 class ValidateName implements ValidateChannelInterface
 {
     /**
-     * @inheritDoc
+     * @inheritdoc
      */
     public function execute(ChannelInterface $channel): void
     {

diff --git a/Notifier/Model/ChannelRepository.php b/Notifier/Model/ChannelRepository.php
@@ -19,8 +19,7 @@
 use Magento\NotifierApi\Api\Data\ChannelInterface;
 
 /**
- * @SuppressWarnings(PHPMD.LongVariable)
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @inheritdoc
  */
 class ChannelRepository implements ChannelRepositoryInterface
 {

diff --git a/Notifier/Model/ChannelSearchResults.php b/Notifier/Model/ChannelSearchResults.php
@@ -10,6 +10,9 @@
 
 use Magento\Framework\Api\SearchResults;
 
+/**
+ * @inheritdoc
+ */
 class ChannelSearchResults extends SearchResults implements
     \Magento\NotifierApi\Api\ChannelSearchResultsInterface
 {

diff --git a/Notifier/Model/IsEnabled.php b/Notifier/Model/IsEnabled.php
@@ -11,6 +11,9 @@
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\NotifierApi\Api\IsEnabledInterface;
 
+/**
+ * @inheritdoc
+ */
 class IsEnabled implements IsEnabledInterface
 {
     /**
@@ -25,6 +28,7 @@ class IsEnabled implements IsEnabledInterface
 
     /**
      * IsEnabled constructor.
+     *
      * @param ScopeConfigInterface $scopeConfig
      */
     public function __construct(
@@ -35,6 +39,7 @@ public function __construct(
 
     /**
      * Return true if module is enabled
+     *
      * @return bool
      */
     public function execute(): bool

diff --git a/Notifier/Model/ResourceModel/Channel.php b/Notifier/Model/ResourceModel/Channel.php
@@ -12,7 +12,7 @@
 use Magento\NotifierApi\Api\Data\ChannelInterface;
 
 /**
- * @SuppressWarnings(PHPMD.CamelCaseMethodName)
+ * @inheritdoc
  */
 class Channel extends AbstractDb
 {

diff --git a/Notifier/Model/ResourceModel/Channel/Collection.php b/Notifier/Model/ResourceModel/Channel/Collection.php
@@ -12,7 +12,7 @@
 use Magento\Notifier\Model\ResourceModel\Channel;
 
 /**
- * @SuppressWarnings(PHPMD.CamelCaseMethodName)
+ * @inheritdoc
  */
 class Collection extends AbstractCollection
 {

diff --git a/Notifier/Model/SendMessage.php b/Notifier/Model/SendMessage.php
@@ -14,6 +14,9 @@
 use Magento\NotifierApi\Model\SendMessageInterface;
 use Magento\NotifierApi\Model\SerializerInterface;
 
+/**
+ * @inheritdoc
+ */
 class SendMessage implements SendMessageInterface
 {
     /**

diff --git a/Notifier/Model/Serializer.php b/Notifier/Model/Serializer.php
@@ -11,6 +11,9 @@
 use Magento\Framework\Serialize\SerializerInterface as FrameworkSerializerInterface;
 use Magento\NotifierApi\Model\SerializerInterface;
 
+/**
+ * @inheritdoc
+ */
 class Serializer implements SerializerInterface
 {
     /**
@@ -29,6 +32,7 @@ public function __construct(
 
     /**
      * Serialize value
+     *
      * @param array $value
      * @return string
      * @throws \InvalidArgumentException
@@ -40,6 +44,7 @@ public function serialize(array $value): string
 
     /**
      * Unserialize value
+     *
      * @param string $value
      * @return array
      * @throws \InvalidArgumentException

diff --git a/Notifier/Test/Integration/Channel/Validator/ValidateAdapterTest.php b/Notifier/Test/Integration/Channel/Validator/ValidateAdapterTest.php
@@ -31,7 +31,7 @@ class ValidateAdapterTest extends TestCase
     private $objectManager;
 
     /**
-     * @inheritDoc
+     * @inheritdoc
      */
     protected function setUp()
     {

diff --git a/Notifier/Test/Integration/Channel/Validator/ValidateCodeTest.php b/Notifier/Test/Integration/Channel/Validator/ValidateCodeTest.php
@@ -30,7 +30,7 @@ class ValidateCodeTest extends TestCase
     private $objectManager;
 
     /**
-     * @inheritDoc
+     * @inheritdoc
      */
     protected function setUp()
     {

diff --git a/Notifier/Test/Integration/Channel/Validator/ValidateNameTest.php b/Notifier/Test/Integration/Channel/Validator/ValidateNameTest.php
@@ -30,7 +30,7 @@ class ValidateNameTest extends TestCase
     private $objectManager;
 
     /**
-     * @inheritDoc
+     * @inheritdoc
      */
     protected function setUp()
     {

diff --git a/Notifier/Test/Integration/ChannelRepositoryTest.php b/Notifier/Test/Integration/ChannelRepositoryTest.php
@@ -29,7 +29,7 @@ class ChannelRepositoryTest extends TestCase
     private $objectManager;
 
     /**
-     * @inheritDoc
+     * @inheritdoc
      */
     protected function setUp()
     {

diff --git a/Notifier/Test/Integration/IsEnabledTest.php b/Notifier/Test/Integration/IsEnabledTest.php
@@ -26,7 +26,7 @@ class IsEnabledTest extends TestCase
     private $objectManager;
 
     /**
-     * @inheritDoc
+     * @inheritdoc
      */
     protected function setUp()
     {

diff --git a/Notifier/Test/Integration/Mock/FakeAdapterEngine.php b/Notifier/Test/Integration/Mock/FakeAdapterEngine.php
@@ -13,8 +13,7 @@
 class FakeAdapterEngine implements AdapterEngineInterface
 {
     /**
-     * @inheritDoc
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @inheritdoc
      */
     public function execute(string $message, array $configParams = [], array $params = []): bool
     {

diff --git a/Notifier/Test/Integration/SendMessageTest.php b/Notifier/Test/Integration/SendMessageTest.php
@@ -27,7 +27,7 @@ class SendMessageTest extends TestCase
     private $objectManager;
 
     /**
-     * @inheritDoc
+     * @inheritdoc
      */
     protected function setUp()
     {

diff --git a/NotifierAdminUi/Controller/Adminhtml/Channel/Delete.php b/NotifierAdminUi/Controller/Adminhtml/Channel/Delete.php
@@ -14,6 +14,9 @@
 use Magento\NotifierApi\Api\ChannelRepositoryInterface;
 use Magento\NotifierApi\Api\Data\ChannelInterface;
 
+/**
+ * @inheritdoc
+ */
 class Delete extends Action implements HttpGetActionInterface
 {
     /**
@@ -28,6 +31,7 @@ class Delete extends Action implements HttpGetActionInterface
 
     /**
      * Delete constructor.
+     *
      * @param Action\Context $context
      * @param ChannelRepositoryInterface $channelRepository
      */

diff --git a/NotifierAdminUi/Controller/Adminhtml/Channel/Edit.php b/NotifierAdminUi/Controller/Adminhtml/Channel/Edit.php
@@ -16,6 +16,9 @@
 use Magento\NotifierApi\Api\ChannelRepositoryInterface;
 use Magento\NotifierApi\Api\Data\ChannelInterface;
 
+/**
+ * @inheritdoc
+ */
 class Edit extends Action implements HttpGetActionInterface
 {
     /**
@@ -30,6 +33,7 @@ class Edit extends Action implements HttpGetActionInterface
 
     /**
      * Edit constructor.
+     *
      * @param Action\Context $context
      * @param ChannelRepositoryInterface $channelRepository
      */

diff --git a/NotifierAdminUi/Controller/Adminhtml/Channel/Save.php b/NotifierAdminUi/Controller/Adminhtml/Channel/Save.php
@@ -17,6 +17,9 @@
 use Magento\NotifierApi\Api\ChannelRepositoryInterface;
 use Magento\NotifierApi\Api\Data\ChannelInterface;
 
+/**
+ * @inheritdoc
+ */
 class Save extends Action implements HttpPostActionInterface
 {
     /**
@@ -46,12 +49,12 @@ class Save extends Action implements HttpPostActionInterface
 
     /**
      * Save constructor.
+     *
      * @param Action\Context $context
      * @param ChannelRepositoryInterface $channelRepository
      * @param SerializerInterface $channelParamsSerializer
      * @param ChannelFactory $channelFactory
      * @param DataObjectHelper $dataObjectHelper
-     * @SuppressWarnings(PHPMD.LongVariable)
      */
     public function __construct(
         Action\Context $context,
@@ -100,6 +103,7 @@ public function execute(): ResultInterface
 
     /**
      * Save channel
+     *
      * @param int $channelId
      * @param array $data
      * @return ChannelInterface
@@ -131,6 +135,7 @@ private function save(int $channelId, array $data): ChannelInterface
 
     /**
      * Return a redirect result
+     *
      * @param int $channelId
      * @return ResultInterface
      */
@@ -149,6 +154,7 @@ private function redirectAfterFailure(int $channelId): ResultInterface
 
     /**
      * Return a redirect result after a successful save
+     *
      * @return ResultInterface
      */
     private function redirectAfterSave(): ResultInterface

diff --git a/NotifierAdminUi/Model/Channel/ModifierInterface.php b/NotifierAdminUi/Model/Channel/ModifierInterface.php
@@ -15,6 +15,7 @@ interface ModifierInterface extends \Magento\Ui\DataProvider\Modifier\ModifierIn
 {
     /**
      * Return adapter code for this modifier
+     *
      * @return string
      */
     public function getAdapterCode(): string;

diff --git a/NotifierAdminUi/Model/Source/Channel/Adapter.php b/NotifierAdminUi/Model/Source/Channel/Adapter.php
@@ -11,6 +11,9 @@
 use Magento\Framework\Data\OptionSourceInterface;
 use Magento\NotifierApi\Api\AdaptersPoolInterface;
 
+/**
+ * @inheritdoc
+ */
 class Adapter implements OptionSourceInterface
 {
     /**

diff --git a/NotifierAdminUi/Model/Source/Channel/Enabled.php b/NotifierAdminUi/Model/Source/Channel/Enabled.php
@@ -10,6 +10,9 @@
 
 use Magento\Framework\Data\OptionSourceInterface;
 
+/**
+ * @inheritdoc
+ */
 class Enabled implements OptionSourceInterface
 {
     /**

diff --git a/NotifierAdminUi/Ui/Component/Form/Channel/BackButton.php b/NotifierAdminUi/Ui/Component/Form/Channel/BackButton.php
@@ -11,6 +11,9 @@
 use Magento\Cms\Block\Adminhtml\Page\Edit\GenericButton;
 use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;
 
+/**
+ * @inheritdoc
+ */
 class BackButton extends GenericButton implements ButtonProviderInterface
 {
     /**

diff --git a/NotifierAdminUi/Ui/Component/Form/Channel/SaveButton.php b/NotifierAdminUi/Ui/Component/Form/Channel/SaveButton.php
@@ -11,6 +11,9 @@
 use Magento\Cms\Block\Adminhtml\Page\Edit\GenericButton;
 use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;
 
+/**
+ * @inheritdoc
+ */
 class SaveButton extends GenericButton implements ButtonProviderInterface
 {
     /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,6 +25,7 @@ interface GetListInterface @@
     {
         /**
          * Find Channel by given SearchCriteria
+         *
          * SearchCriteria is not required because load all sources is useful case
          *
          * @param SearchCriteriaInterface|null $searchCriteria
@@ Expand Down @@