magento-engcom/magento2ce#2445: Fixed code style issues

Stanislav Idolov · Stanislav Idolov · commit 4762727b9e37 · 2019-01-03T21:41:36.000-06:00
diff --git a/app/code/Magento/SalesRule/Controller/Adminhtml/Promo/Quote/Generate.php b/app/code/Magento/SalesRule/Controller/Adminhtml/Promo/Quote/Generate.php
@@ -1,14 +1,17 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\SalesRule\Controller\Adminhtml\Promo\Quote;
 
+use Magento\Framework\App\Action\HttpPostActionInterface;
 use Magento\SalesRule\Model\CouponGenerator;
 
-class Generate extends \Magento\SalesRule\Controller\Adminhtml\Promo\Quote
+/**
+ * Generate promo quote
+ */
+class Generate extends \Magento\SalesRule\Controller\Adminhtml\Promo\Quote implements HttpPostActionInterface
 {
     /**
      * @var CouponGenerator
diff --git a/app/code/Magento/SalesRule/Model/Coupon.php b/app/code/Magento/SalesRule/Model/Coupon.php
@@ -190,6 +190,8 @@ public function getTimesUsed()
     }
 
     /**
+     * Set Times Used
+     *
      * @param int $timesUsed
      * @return $this
      */
@@ -273,6 +275,8 @@ public function getType()
     }
 
     /**
+     * Set type
+     *
      * @param int $type
      * @return $this
      */
diff --git a/app/code/Magento/SalesRule/Model/Data/Rule.php b/app/code/Magento/SalesRule/Model/Data/Rule.php
@@ -270,6 +270,8 @@ public function getIsAdvanced()
     }
 
     /**
+     * Set Is Advanced
+     *
      * @param bool $isAdvanced
      * @return $this
      */
@@ -373,6 +375,8 @@ public function getSortOrder()
     }
 
     /**
+     * Set Sort Order
+     *
      * @param int $sortOrder
      * @return $this
      */
@@ -616,7 +620,7 @@ public function setSimpleFreeShipping($simpleFreeShipping)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      *
      * @return \Magento\SalesRule\Api\Data\RuleExtensionInterface|null
      */
@@ -626,7 +630,7 @@ public function getExtensionAttributes()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      *
      * @param \Magento\SalesRule\Api\Data\RuleExtensionInterface $extensionAttributes
      * @return $this
diff --git a/app/code/Magento/SalesRule/Model/Plugin/QuoteConfigProductAttributes.php b/app/code/Magento/SalesRule/Model/Plugin/QuoteConfigProductAttributes.php
@@ -7,6 +7,9 @@
 
 use Magento\SalesRule\Model\ResourceModel\Rule as RuleResource;
 
+/**
+ * Quote Config Product Attributes Class
+ */
 class QuoteConfigProductAttributes
 {
     /**
diff --git a/app/code/Magento/SalesRule/Model/ResourceModel/ReadHandler.php b/app/code/Magento/SalesRule/Model/ResourceModel/ReadHandler.php
@@ -36,11 +36,14 @@ public function __construct(
     }
 
     /**
+     * Read handler
+     *
      * @param string $entityType
      * @param array $entityData
      * @param array $arguments
      * @return array
      * @throws \Exception
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function execute($entityType, $entityData, $arguments = [])
     {
diff --git a/app/code/Magento/SalesRule/Model/ResourceModel/SaveHandler.php b/app/code/Magento/SalesRule/Model/ResourceModel/SaveHandler.php
@@ -36,11 +36,14 @@ public function __construct(
     }
 
     /**
+     * Save handler
+     *
      * @param string $entityType
      * @param array $entityData
      * @param array $arguments
      * @return array
      * @throws \Exception
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function execute($entityType, $entityData, $arguments = [])
     {
diff --git a/app/code/Magento/SalesRule/Model/Rule/Action/Discount/CartFixed.php b/app/code/Magento/SalesRule/Model/Rule/Action/Discount/CartFixed.php
@@ -49,6 +49,8 @@ public function __construct(
     }
 
     /**
+     * Fixed discount for cart calculation
+     *
      * @param \Magento\SalesRule\Model\Rule $rule
      * @param \Magento\Quote\Model\Quote\Item\AbstractItem $item
      * @param float $qty
diff --git a/app/code/Magento/SalesRule/Model/RuleRepository.php b/app/code/Magento/SalesRule/Model/RuleRepository.php
@@ -106,7 +106,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function save(\Magento\SalesRule\Api\Data\RuleInterface $rule)
     {
@@ -118,7 +118,7 @@ public function save(\Magento\SalesRule\Api\Data\RuleInterface $rule)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getById($id)
     {
@@ -135,7 +135,7 @@ public function getById($id)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getList(SearchCriteriaInterface $searchCriteria)
     {
diff --git a/app/code/Magento/SalesRule/Setup/Patch/Data/ConvertSerializedDataToJson.php b/app/code/Magento/SalesRule/Setup/Patch/Data/ConvertSerializedDataToJson.php
@@ -11,6 +11,7 @@
 
 /**
  * Class ConvertSerializedDataToJson
+ *
  * @package Magento\SalesRule\Setup\Patch
  */
 class ConvertSerializedDataToJson implements DataPatchInterface, PatchVersionInterface
@@ -58,7 +59,7 @@ public function apply()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public static function getDependencies()
     {
@@ -68,15 +69,15 @@ public static function getDependencies()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public static function getVersion()
     {
         return '2.0.2';
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getAliases()
     {
diff --git a/app/code/Magento/SalesRule/Setup/Patch/Data/FillSalesRuleProductAttributeTable.php b/app/code/Magento/SalesRule/Setup/Patch/Data/FillSalesRuleProductAttributeTable.php
@@ -12,6 +12,7 @@
 
 /**
  * Class FillSalesRuleProductAttributeTable
+ *
  * @package Magento\SalesRule\Setup\Patch
  */
 class FillSalesRuleProductAttributeTable implements DataPatchInterface, PatchVersionInterface
@@ -64,7 +65,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function apply()
     {
@@ -101,7 +102,7 @@ public function fillSalesRuleProductAttributeTable()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public static function getDependencies()
     {
@@ -111,15 +112,15 @@ public static function getDependencies()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public static function getVersion()
     {
         return '2.0.3';
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getAliases()
     {
diff --git a/app/code/Magento/SalesRule/Setup/Patch/Data/PrepareRuleModelSerializedData.php b/app/code/Magento/SalesRule/Setup/Patch/Data/PrepareRuleModelSerializedData.php
@@ -12,6 +12,7 @@
 
 /**
  * Class PrepareRuleModelSerializedData
+ *
  * @package Magento\SalesRule\Setup\Patch
  */
 class PrepareRuleModelSerializedData implements DataPatchInterface, PatchVersionInterface
@@ -32,7 +33,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function apply()
     {
@@ -58,23 +59,23 @@ public function apply()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public static function getDependencies()
     {
         return [];
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public static function getVersion()
     {
         return '2.0.0';
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getAliases()
     {
diff --git a/app/code/Magento/Shipping/Block/Adminhtml/Order/Packaging.php b/app/code/Magento/Shipping/Block/Adminhtml/Order/Packaging.php
@@ -74,6 +74,7 @@ public function getShipment()
      * Configuration for popup window for packaging
      *
      * @return string
+     * @SuppressWarnings(PHPMD.RequestAwareBlockMethod)
      */
     public function getConfigDataJson()
     {
diff --git a/app/code/Magento/Usps/Model/Carrier.php b/app/code/Magento/Usps/Model/Carrier.php
@@ -366,6 +366,7 @@ public function getResult()
 
     /**
      * @inheritdoc
+     *
      * Starting from 23.02.2018 USPS doesn't allow to create free shipping labels via their API.
      */
     public function isShippingLabelsAvailable()
@@ -1167,6 +1168,7 @@ public function getAllowedMethods()
 
     /**
      * Return USPS county name by country ISO 3166-1-alpha-2 code
+     *
      * Return false for unknown countries
      *
      * @param string $countryId

Original file line number	Diff line number	Diff line change
`@@ -270,6 +270,8 @@ public function getIsAdvanced()`
`270`	`270`	`}`
`271`	`271`
`272`	`272`	`/**`
	`273`	`+ * Set Is Advanced`
	`274`	`+ *`
`273`	`275`	`* @param bool $isAdvanced`
`274`	`276`	`* @return $this`
`275`	`277`	`*/`
`@@ -373,6 +375,8 @@ public function getSortOrder()`
`373`	`375`	`}`
`374`	`376`
`375`	`377`	`/**`
	`378`	`+ * Set Sort Order`
	`379`	`+ *`
`376`	`380`	`* @param int $sortOrder`
`377`	`381`	`* @return $this`
`378`	`382`	`*/`
`@@ -616,7 +620,7 @@ public function setSimpleFreeShipping($simpleFreeShipping)`
`616`	`620`	`}`
`617`	`621`
`618`	`622`	`/**`
`619`		`- * {@inheritdoc}`
	`623`	`+ * @inheritdoc`
`620`	`624`	`*`
`621`	`625`	`* @return \Magento\SalesRule\Api\Data\RuleExtensionInterface\|null`
`622`	`626`	`*/`
`@@ -626,7 +630,7 @@ public function getExtensionAttributes()`
`626`	`630`	`}`
`627`	`631`
`628`	`632`	`/**`
`629`		`- * {@inheritdoc}`
	`633`	`+ * @inheritdoc`
`630`	`634`	`*`
`631`	`635`	`* @param \Magento\SalesRule\Api\Data\RuleExtensionInterface $extensionAttributes`
`632`	`636`	`* @return $this`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,9 @@`
`7`	`7`
`8`	`8`	`use Magento\SalesRule\Model\ResourceModel\Rule as RuleResource;`
`9`	`9`
	`10`	`+/**`
	`11`	`+ * Quote Config Product Attributes Class`
	`12`	`+ */`
`10`	`13`	`class QuoteConfigProductAttributes`
`11`	`14`	`{`
`12`	`15`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -36,11 +36,14 @@ public function __construct(`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`/**`
	`39`	`+ * Read handler`
	`40`	`+ *`
`39`	`41`	`* @param string $entityType`
`40`	`42`	`* @param array $entityData`
`41`	`43`	`* @param array $arguments`
`42`	`44`	`* @return array`
`43`	`45`	`* @throws \Exception`
	`46`	`+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)`
`44`	`47`	`*/`
`45`	`48`	`public function execute($entityType, $entityData, $arguments = [])`
`46`	`49`	`{`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,8 @@ public function __construct(`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`/**`
	`52`	`+ * Fixed discount for cart calculation`
	`53`	`+ *`
`52`	`54`	`* @param \Magento\SalesRule\Model\Rule $rule`
`53`	`55`	`* @param \Magento\Quote\Model\Quote\Item\AbstractItem $item`
`54`	`56`	`* @param float $qty`
Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,7 @@ public function __construct(`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`/**`
`109`		`- * {@inheritdoc}`
	`109`	`+ * @inheritdoc`
`110`	`110`	`*/`
`111`	`111`	`public function save(\Magento\SalesRule\Api\Data\RuleInterface $rule)`
`112`	`112`	`{`
`@@ -118,7 +118,7 @@ public function save(\Magento\SalesRule\Api\Data\RuleInterface $rule)`
`118`	`118`	`}`
`119`	`119`
`120`	`120`	`/**`
`121`		`- * {@inheritdoc}`
	`121`	`+ * @inheritdoc`
`122`	`122`	`*/`
`123`	`123`	`public function getById($id)`
`124`	`124`	`{`
`@@ -135,7 +135,7 @@ public function getById($id)`
`135`	`135`	`}`
`136`	`136`
`137`	`137`	`/**`
`138`		`- * {@inheritdoc}`
	`138`	`+ * @inheritdoc`
`139`	`139`	`*/`
`140`	`140`	`public function getList(SearchCriteriaInterface $searchCriteria)`
`141`	`141`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`/**`
`13`	`13`	`* Class ConvertSerializedDataToJson`
	`14`	`+ *`
`14`	`15`	`* @package Magento\SalesRule\Setup\Patch`
`15`	`16`	`*/`
`16`	`17`	`class ConvertSerializedDataToJson implements DataPatchInterface, PatchVersionInterface`
`@@ -58,7 +59,7 @@ public function apply()`
`58`	`59`	`}`
`59`	`60`
`60`	`61`	`/**`
`61`		`- * {@inheritdoc}`
	`62`	`+ * @inheritdoc`
`62`	`63`	`*/`
`63`	`64`	`public static function getDependencies()`
`64`	`65`	`{`
`@@ -68,15 +69,15 @@ public static function getDependencies()`
`68`	`69`	`}`
`69`	`70`
`70`	`71`	`/**`
`71`		`- * {@inheritdoc}`
	`72`	`+ * @inheritdoc`
`72`	`73`	`*/`
`73`	`74`	`public static function getVersion()`
`74`	`75`	`{`
`75`	`76`	`return '2.0.2';`
`76`	`77`	`}`
`77`	`78`
`78`	`79`	`/**`
`79`		`- * {@inheritdoc}`
	`80`	`+ * @inheritdoc`
`80`	`81`	`*/`
`81`	`82`	`public function getAliases()`
`82`	`83`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`
`13`	`13`	`/**`
`14`	`14`	`* Class FillSalesRuleProductAttributeTable`
	`15`	`+ *`
`15`	`16`	`* @package Magento\SalesRule\Setup\Patch`
`16`	`17`	`*/`
`17`	`18`	`class FillSalesRuleProductAttributeTable implements DataPatchInterface, PatchVersionInterface`
`@@ -64,7 +65,7 @@ public function __construct(`
`64`	`65`	`}`
`65`	`66`
`66`	`67`	`/**`
`67`		`- * {@inheritdoc}`
	`68`	`+ * @inheritdoc`
`68`	`69`	`*/`
`69`	`70`	`public function apply()`
`70`	`71`	`{`
`@@ -101,7 +102,7 @@ public function fillSalesRuleProductAttributeTable()`
`101`	`102`	`}`
`102`	`103`
`103`	`104`	`/**`
`104`		`- * {@inheritdoc}`
	`105`	`+ * @inheritdoc`
`105`	`106`	`*/`
`106`	`107`	`public static function getDependencies()`
`107`	`108`	`{`
`@@ -111,15 +112,15 @@ public static function getDependencies()`
`111`	`112`	`}`
`112`	`113`
`113`	`114`	`/**`
`114`		`- * {@inheritdoc}`
	`115`	`+ * @inheritdoc`
`115`	`116`	`*/`
`116`	`117`	`public static function getVersion()`
`117`	`118`	`{`
`118`	`119`	`return '2.0.3';`
`119`	`120`	`}`
`120`	`121`
`121`	`122`	`/**`
`122`		`- * {@inheritdoc}`
	`123`	`+ * @inheritdoc`
`123`	`124`	`*/`
`124`	`125`	`public function getAliases()`
`125`	`126`	`{`