[PSR-2 Compliance] Fix magento#8612: Hundreds of PHPCS-based static t…

…ests violations in mainline - apply manual fixes to make PHPCS and PHPMD happy - some phtml templates marked as ignored for now as PHPCS 1.5.3 version produces false-positives on them (PHPCS 2.8.0 treats them fine)
orlangur · Feb 26, 2017 · 74fbb73 · 74fbb73
1 parent 0dcab3b
commit 74fbb73
Show file tree

Hide file tree

Showing 61 changed files with 190 additions and 91 deletions.
diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Store.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Store.php
@@ -12,6 +12,7 @@
 class Store extends \Magento\Backend\Block\Widget\Grid\Column\Filter\AbstractFilter
 {
     const ALL_STORE_VIEWS = '0';
+
     /**
      * @var \Magento\Store\Model\System\Store
      */

diff --git a/app/code/Magento/Backend/Model/View/Layout/Reader/Block.php b/app/code/Magento/Backend/Model/View/Layout/Reader/Block.php
@@ -13,6 +13,13 @@
  */
 class Block extends Layout\Reader\Block
 {
+    /**
+     * @param Layout\ScheduledStructure\Helper $helper
+     * @param Layout\Argument\Parser $argumentParser
+     * @param Layout\ReaderPool $readerPool
+     * @param InterpreterInterface $argumentInterpreter
+     * @param null $scopeType
+     */
     public function __construct(
         Layout\ScheduledStructure\Helper $helper,
         Layout\Argument\Parser $argumentParser,

diff --git a/app/code/Magento/Braintree/Block/Customer/PayPal/VaultTokenRenderer.php b/app/code/Magento/Braintree/Block/Customer/PayPal/VaultTokenRenderer.php
@@ -21,6 +21,11 @@ class VaultTokenRenderer extends AbstractTokenRenderer
      */
     private $config;
 
+    /**
+     * @param Template\Context $context
+     * @param Config $config
+     * @param array $data
+     */
     public function __construct(
         Template\Context $context,
         Config $config,

diff --git a/app/code/Magento/Braintree/Gateway/Config/PayPal/Config.php b/app/code/Magento/Braintree/Gateway/Config/PayPal/Config.php
@@ -35,6 +35,12 @@ class Config extends \Magento\Payment\Gateway\Config\Config
      */
     private $icon = [];
 
+    /**
+     * @param ScopeConfigInterface $scopeConfig
+     * @param CcConfig $ccConfig
+     * @param null $methodCode
+     * @param string $pathPattern
+     */
     public function __construct(
         ScopeConfigInterface $scopeConfig,
         CcConfig $ccConfig,

diff --git a/app/code/Magento/Braintree/Model/Ui/PayPal/ConfigProvider.php b/app/code/Magento/Braintree/Model/Ui/PayPal/ConfigProvider.php
@@ -28,12 +28,19 @@ class ConfigProvider implements ConfigProviderInterface
      */
     private $resolver;
 
+    /**
+     * @param Config $config
+     * @param ResolverInterface $resolver
+     */
     public function __construct(Config $config, ResolverInterface $resolver)
     {
         $this->config = $config;
         $this->resolver = $resolver;
     }
 
+    /**
+     * @return array
+     */
     public function getConfig()
     {
         return [

diff --git a/app/code/Magento/Braintree/Test/Unit/Ui/Component/Report/Filters/Type/DateRangeTest.php b/app/code/Magento/Braintree/Test/Unit/Ui/Component/Report/Filters/Type/DateRangeTest.php
@@ -81,6 +81,7 @@ protected function setUp()
      * @param array|null $expectedCondition
      * @dataProvider getPrepareDataProvider
      * @return void
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     public function testPrepare($name, $filterData, $expectedCondition)
     {

diff --git a/app/code/Magento/Braintree/view/frontend/templates/paypal/vault_token.phtml b/app/code/Magento/Braintree/view/frontend/templates/paypal/vault_token.phtml
@@ -39,7 +39,8 @@ $payerEmail = $block->escapeHtml($block->getPayerEmail());
                                         "modalClass": "my-credit-cards-popup",
                                         "toggleEvent": "click",
                                         "title": "<?php echo $block->escapeHtml(__('Delete')); ?>",
-                                        "content": "Are you sure you want to delete this PayPal account: <?php /* @noEscape */ echo $payerEmail; ?>?"
+                                        "content": "Are you sure you want to delete this PayPal account:
+                                            <?php /* @noEscape */ echo $payerEmail; ?>?"
                                     }
                                 }'>
                 <span><?php echo $block->escapeHtml(__('Delete')); ?></span>

diff --git a/app/code/Magento/Catalog/Model/Layer/Filter/Dynamic/Improved.php b/app/code/Magento/Catalog/Model/Layer/Filter/Dynamic/Improved.php
@@ -35,6 +35,7 @@ class Improved implements AlgorithmInterface
      * @var Render
      */
     private $render;
+
     /**
      * @var IntervalFactory
      */

diff --git a/app/code/Magento/CatalogImportExport/Model/Import/Product/StoreResolver.php b/app/code/Magento/CatalogImportExport/Model/Import/Product/StoreResolver.php
@@ -27,6 +27,7 @@ class StoreResolver
      * @var array
      */
     protected $websiteCodeToStoreIds = [];
+
     /**
      * All stores code-ID pairs.
      *

diff --git a/app/code/Magento/CatalogSearch/Model/Adapter/Mysql/Field/Resolver.php b/app/code/Magento/CatalogSearch/Model/Adapter/Mysql/Field/Resolver.php
@@ -16,6 +16,7 @@ class Resolver implements ResolverInterface
      * @var AttributeCollection
      */
     private $attributeCollection;
+
     /**
      * @var FieldFactory
      */

diff --git a/app/code/Magento/CatalogSearch/Model/Search/FilterMapper/FilterContext.php b/app/code/Magento/CatalogSearch/Model/Search/FilterMapper/FilterContext.php
@@ -14,6 +14,7 @@
 /**
  * FilterContext represents a Context of the Strategy pattern
  * Its responsibility is to choose appropriate strategy to apply passed filter to the Select
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class FilterContext implements FilterStrategyInterface
 {

diff --git a/app/code/Magento/Checkout/view/frontend/templates/cart/noItems.phtml b/app/code/Magento/Checkout/view/frontend/templates/cart/noItems.phtml
@@ -3,7 +3,7 @@
  * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
+// @codingStandardsIgnoreFile
 /**  @var $block \Magento\Checkout\Block\Cart */
 ?>
 <div class="cart-empty">

diff --git a/app/code/Magento/Customer/CustomerData/Plugin/SessionChecker.php b/app/code/Magento/Customer/CustomerData/Plugin/SessionChecker.php
@@ -37,6 +37,7 @@ public function __construct(
      * Delete frontend session cookie if customer session is expired
      *
      * @param SessionManager $sessionManager
+     * @return void
      */
     public function beforeStart(SessionManager $sessionManager)
     {

diff --git a/app/code/Magento/Customer/Model/Context.php b/app/code/Magento/Customer/Model/Context.php
@@ -11,6 +11,7 @@ class Context
      * Customer group cache context
      */
     const CONTEXT_GROUP = 'customer_group';
+
     /**
      * Customer authorization cache context
      */

diff --git a/app/code/Magento/Customer/Model/Plugin/CustomerNotification.php b/app/code/Magento/Customer/Model/Plugin/CustomerNotification.php
@@ -37,11 +37,10 @@ class CustomerNotification
     private $state;
 
     /**
-     * CustomerNotification constructor.
-     * 
      * @param Session $session
      * @param NotificationStorage $notificationStorage
      * @param State $state
+     * @param CustomerRepositoryInterface $customerRepository
      */
     public function __construct(
         Session $session,

diff --git a/app/code/Magento/GroupedProduct/view/adminhtml/templates/product/grouped/list.phtml b/app/code/Magento/GroupedProduct/view/adminhtml/templates/product/grouped/list.phtml
@@ -3,6 +3,7 @@
  * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+// @codingStandardsIgnoreFile
 /* @var $block \Magento\GroupedProduct\Block\Product\Grouped\AssociatedProducts\ListAssociatedProducts */
 ?>
 <script type="text/x-magento-template" id="group-product-template">

diff --git a/app/code/Magento/Paypal/Model/Payflow/Service/Response/Validator/AVSResponse.php b/app/code/Magento/Paypal/Model/Payflow/Service/Response/Validator/AVSResponse.php
@@ -38,19 +38,19 @@ class AVSResponse implements ValidatorInterface
      */
     const IAVS = 'iavs';
 
-    /** Values of the response */
+    /**#@+ Values of the response */
     const RESPONSE_YES = 'y';
 
     const RESPONSE_NO = 'n';
 
     const RESPONSE_NOT_SUPPORTED = 'x';
-    /**  */
+    /**#@-*/
 
-    /** Values of the validation settings payments */
+    /**#@+ Values of the validation settings payments */
     const CONFIG_ON = 1;
 
     const CONFIG_OFF = 0;
-    /**  */
+    /**#@-*/
 
     /**
      * @var array

diff --git a/app/code/Magento/Paypal/Model/Payflow/Service/Response/Validator/CVV2Match.php b/app/code/Magento/Paypal/Model/Payflow/Service/Response/Validator/CVV2Match.php
@@ -30,21 +30,21 @@ class CVV2Match implements ValidatorInterface
      */
     const ERROR_MESSAGE = 'Card security code does not match.';
 
-    /** Values of the response */
+    /**#@+ Values of the response */
     const RESPONSE_YES = 'y';
 
     const RESPONSE_NO = 'n';
 
     const RESPONSE_NOT_SUPPORTED = 'x';
-    /**  */
+    /**#@-*/
 
-    /** Validation settings payments */
+    /**#@+ Validation settings payments */
     const CONFIG_ON = 1;
 
     const CONFIG_OFF = 0;
 
     const CONFIG_NAME = 'avs_security_code';
-    /**  */
+    /**#@-*/
 
     /**
      * Validate data

diff --git a/app/code/Magento/Paypal/view/frontend/templates/hss/info.phtml b/app/code/Magento/Paypal/view/frontend/templates/hss/info.phtml
@@ -3,9 +3,7 @@
  * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
-
-
+// @codingStandardsIgnoreFile
 /**
  * @var \Magento\Paypal\Block\Payflow\Link\Info $block
  * @see \Magento\Paypal\Block\Payflow\Link\Info

diff --git a/app/code/Magento/ProductVideo/Helper/Media.php b/app/code/Magento/ProductVideo/Helper/Media.php
@@ -33,6 +33,7 @@ class Media extends \Magento\Framework\App\Helper\AbstractHelper
      * Configuration path for show related
      */
     const XML_PATH_SHOW_RELATED = 'catalog/product_video/show_related';
+
     /**
      * Configuration path for video auto restart
      */

diff --git a/app/code/Magento/Quote/Observer/Frontend/Quote/Address/CollectTotalsObserver.php b/app/code/Magento/Quote/Observer/Frontend/Quote/Address/CollectTotalsObserver.php
@@ -47,13 +47,13 @@ class CollectTotalsObserver implements ObserverInterface
     protected $groupManagement;
 
     /**
-     * Initialize dependencies.
-     *
      * @param \Magento\Customer\Helper\Address $customerAddressHelper
      * @param \Magento\Customer\Model\Vat $customerVat
      * @param VatValidator $vatValidator
      * @param \Magento\Customer\Api\Data\CustomerInterfaceFactory $customerDataFactory
      * @param \Magento\Customer\Api\GroupManagementInterface $groupManagement
+     * @param \Magento\Customer\Api\AddressRepositoryInterface $addressRepository
+     * @param \Magento\Customer\Model\Session $customerSession
      */
     public function __construct(
         \Magento\Customer\Helper\Address $customerAddressHelper,
@@ -78,6 +78,7 @@ public function __construct(
      *
      * @param \Magento\Framework\Event\Observer $observer
      * @return void
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     public function execute(\Magento\Framework\Event\Observer $observer)
     {

diff --git a/app/code/Magento/Reports/view/adminhtml/templates/report/grid/container.phtml b/app/code/Magento/Reports/view/adminhtml/templates/report/grid/container.phtml
@@ -33,7 +33,9 @@ require([
         }
 
         if (jQuery('#filter_form').valid()) {
-            setLocation('<?php /* @escapeNotVerified */ echo $block->getFilterUrl(); ?>filter/'+Base64.encode(Form.serializeElements(elements))+'/');
+            setLocation('<?php /* @escapeNotVerified */ echo $block->getFilterUrl();?>filter/'+
+                Base64.encode(Form.serializeElements(elements))+'/'
+            );
         }
     }
 //]]>
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,6 +12,7 @@ @@
     class Store extends \Magento\Backend\Block\Widget\Grid\Column\Filter\AbstractFilter
     {
         const ALL_STORE_VIEWS = '0';
         /**
          * @var \Magento\Store\Model\System\Store
          */
@@ Expand Down @@