magento-engcom/magento2ce#2299: Code style fixes

Author: Stanislav Idolov

app/code/Magento/AsynchronousOperations/Controller/Adminhtml/Bulk/Details.php

@@ -8,7 +8,7 @@
 /**
  * Class View Operation Details Controller
  */
-class Details extends \Magento\Backend\App\Action
+class Details extends \Magento\Backend\App\Action implements \Magento\Framework\App\Action\HttpGetActionInterface
 {
     /**
      * @var \Magento\Framework\View\Result\PageFactory

app/code/Magento/Backend/App/Request/BackendValidator.php

@@ -77,6 +77,8 @@ public function __construct(
     }
 
     /**
+     * Validate request
+     *
      * @param RequestInterface $request
      * @param ActionInterface $action
      *
@@ -115,6 +117,8 @@ private function validateRequest(
     }
 
     /**
+     * Create exception
+     *
      * @param RequestInterface $request
      * @param ActionInterface $action
      *

app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Theme.php

@@ -9,6 +9,9 @@
  */
 namespace Magento\Backend\Block\Widget\Grid\Column\Filter;
 
+/**
+ * Theme grid filter
+ */
 class Theme extends \Magento\Backend\Block\Widget\Grid\Column\Filter\AbstractFilter
 {
     /**
@@ -55,6 +58,7 @@ public function getHtml()
 
     /**
      * Retrieve options set in column.
+     *
      * Or load if options was not set.
      *
      * @return array

app/code/Magento/Backend/Block/Widget/Tabs.php

@@ -8,6 +8,8 @@
 use Magento\Backend\Block\Widget\Tab\TabInterface;
 
 /**
+ * Tabs widget
+ *
  * @api
  * @SuppressWarnings(PHPMD.NumberOfChildren)
  * @since 100.0.2
@@ -178,6 +180,8 @@ protected function _addTabByName($tab, $tabId)
     }
 
     /**
+     * Get active tab id
+     *
      * @return string
      */
     public function getActiveTabId()
@@ -187,6 +191,7 @@ public function getActiveTabId()
 
     /**
      * Set Active Tab
+     *
      * Tab has to be not hidden and can show
      *
      * @param string $tabId
@@ -231,7 +236,7 @@ protected function _setActiveTab($tabId)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     protected function _beforeToHtml()
     {
@@ -282,6 +287,8 @@ private function reorderTabs()
     }
 
     /**
+     * Apply tabs order
+     *
      * @param array $orderByPosition
      * @param array $orderByIdentity
      *
@@ -294,7 +301,7 @@ private function applyTabsCorrectOrder(array $orderByPosition, array $orderByIde
         /**
          * Rearrange the positions by using the after tag for each tab.
          *
-         * @var integer      $position
+         * @var int $position
          * @var TabInterface $tab
          */
         foreach ($orderByPosition as $position => $tab) {
@@ -338,6 +345,8 @@ private function finalTabsSortOrder(array $orderByPosition)
     }
 
     /**
+     * Get js object name
+     *
      * @return string
      */
     public function getJsObjectName()
@@ -346,6 +355,8 @@ public function getJsObjectName()
     }
 
     /**
+     * Get tabs ids
+     *
      * @return string[]
      */
     public function getTabsIds()
@@ -358,6 +369,8 @@ public function getTabsIds()
     }
 
     /**
+     * Get tab id
+     *
      * @param \Magento\Framework\DataObject|TabInterface $tab
      * @param bool $withPrefix
      * @return string
@@ -371,6 +384,8 @@ public function getTabId($tab, $withPrefix = true)
     }
 
     /**
+     * CVan show tab
+     *
      * @param \Magento\Framework\DataObject|TabInterface $tab
      * @return bool
      */
@@ -383,6 +398,8 @@ public function canShowTab($tab)
     }
 
     /**
+     * Get tab is hidden
+     *
      * @param \Magento\Framework\DataObject|TabInterface $tab
      * @return bool
      * @SuppressWarnings(PHPMD.BooleanGetMethodName)
@@ -396,6 +413,8 @@ public function getTabIsHidden($tab)
     }
 
     /**
+     * Get tab url
+     *
      * @param \Magento\Framework\DataObject|TabInterface $tab
      * @return string
      */
@@ -414,6 +433,8 @@ public function getTabUrl($tab)
     }
 
     /**
+     * Get tab title
+     *
      * @param \Magento\Framework\DataObject|TabInterface $tab
      * @return string
      */
@@ -426,6 +447,8 @@ public function getTabTitle($tab)
     }
 
     /**
+     * Get tab class
+     *
      * @param \Magento\Framework\DataObject|TabInterface $tab
      * @return string
      */
@@ -441,6 +464,8 @@ public function getTabClass($tab)
     }
 
     /**
+     * Get tab label
+     *
      * @param \Magento\Framework\DataObject|TabInterface $tab
      * @return string
      */
@@ -453,6 +478,8 @@ public function getTabLabel($tab)
     }
 
     /**
+     * Get tab content
+     *
      * @param \Magento\Framework\DataObject|TabInterface $tab
      * @return string
      */
@@ -469,6 +496,7 @@ public function getTabContent($tab)
 
     /**
      * Mark tabs as dependent of each other
+     *
      * Arbitrary number of tabs can be specified, but at least two
      *
      * @param string $tabOneId

app/code/Magento/Backend/Console/Command/AbstractCacheCommand.php

@@ -11,6 +11,8 @@
 use Symfony\Component\Console\Input\InputOption;
 
 /**
+ * Abstract cache command
+ *
  * @api
  * @since 100.0.2
  */
@@ -40,7 +42,7 @@ public function __construct(Manager $cacheManager)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     protected function configure()
     {

app/code/Magento/Catalog/Controller/Adminhtml/Product/Initialization/Helper.php

@@ -19,6 +19,8 @@
 use Magento\Catalog\Controller\Adminhtml\Product\Initialization\Helper\AttributeFilter;
 
 /**
+ * Product helper
+ *
  * @api
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  * @since 100.0.2
@@ -365,6 +367,8 @@ private function overwriteValue($optionId, $option, $overwriteOptions)
     }
 
     /**
+     * Get link resolver instance
+     *
      * @return LinkResolver
      * @deprecated 101.0.0
      */
@@ -377,6 +381,8 @@ private function getLinkResolver()
     }
 
     /**
+     * Get DateTimeFilter instance
+     *
      * @return \Magento\Framework\Stdlib\DateTime\Filter\DateTime
      * @deprecated 101.0.0
      */
@@ -391,6 +397,7 @@ private function getDateTimeFilter()
 
     /**
      * Remove ids of non selected websites from $websiteIds array and return filtered data
+     *
      * $websiteIds parameter expects array with website ids as keys and 1 (selected) or 0 (non selected) as values
      * Only one id (default website ID) will be set to $websiteIds array when the single store mode is turned on
      *

app/code/Magento/Catalog/Test/Unit/Controller/Adminhtml/Product/Initialization/HelperTest.php

@@ -95,6 +95,11 @@ class HelperTest extends \PHPUnit\Framework\TestCase
      */
     protected $attributeFilterMock;
 
+    /**
+     * @var \PHPUnit_Framework_MockObject_MockObject
+     */
+    private $dateTimeFilterMock;
+
     /**
      * @inheritdoc
      */
@@ -170,6 +175,11 @@ protected function setUp()
         $resolverProperty = $helperReflection->getProperty('linkResolver');
         $resolverProperty->setAccessible(true);
         $resolverProperty->setValue($this->helper, $this->linkResolverMock);
+
+        $this->dateTimeFilterMock = $this->createMock(\Magento\Framework\Stdlib\DateTime\Filter\DateTime::class);
+        $dateTimeFilterProperty = $helperReflection->getProperty('dateTimeFilter');
+        $dateTimeFilterProperty->setAccessible(true);
+        $dateTimeFilterProperty->setValue($this->helper, $this->dateTimeFilterMock);
     }
 
     /**
@@ -211,6 +221,12 @@ public function testInitialize(
         if (!empty($tierPrice)) {
             $productData = array_merge($productData, ['tier_price' => $tierPrice]);
         }
+
+        $this->dateTimeFilterMock->expects($this->once())
+            ->method('filter')
+            ->with($specialFromDate)
+            ->willReturn($specialFromDate);
+
         $attributeNonDate = $this->getMockBuilder(\Magento\Catalog\Model\ResourceModel\Eav\Attribute::class)
             ->disableOriginalConstructor()
             ->getMock();

app/code/Magento/Customer/Model/Address/AbstractAddress.php

@@ -271,7 +271,7 @@ public function setStreet($street)
      * Enforce format of the street field or other multiline custom attributes
      *
      * @param array|string $key
-     * @param null $value
+     * @param mixed $value
      * @return \Magento\Framework\DataObject
      */
     public function setData($key, $value = null)
@@ -286,6 +286,7 @@ public function setData($key, $value = null)
 
     /**
      * Check that address can have multiline attribute by this code (as street or some custom attribute)
+     *
      * @param string $code
      * @return bool
      */
@@ -403,6 +404,8 @@ public function getRegionCode()
     }
 
     /**
+     * Get region id
+     *
      * @return int
      */
     public function getRegionId()
@@ -425,6 +428,8 @@ public function getRegionId()
     }
 
     /**
+     * Get country
+     *
      * @return string
      */
     public function getCountry()
@@ -502,6 +507,8 @@ public function getConfig()
     }
 
     /**
+     * Before save handler
+     *
      * @return $this
      */
     public function beforeSave()
@@ -591,6 +598,8 @@ public function validate()
     }
 
     /**
+     * Create region instance
+     *
      * @return \Magento\Directory\Model\Region
      */
     protected function _createRegionInstance()
@@ -599,6 +608,8 @@ protected function _createRegionInstance()
     }
 
     /**
+     * Create country instance
+     *
      * @return \Magento\Directory\Model\Country
      */
     protected function _createCountryInstance()
@@ -608,6 +619,7 @@ protected function _createCountryInstance()
 
     /**
      * Unset Region from address
+     *
      * @return $this
      * @since 100.2.0
      */
@@ -617,6 +629,8 @@ public function unsRegion()
     }
 
     /**
+     * Is company required
+     *
      * @return bool
      * @since 100.2.0
      */
@@ -626,6 +640,8 @@ protected function isCompanyRequired()
     }
 
     /**
+     * Is telephone required
+     *
      * @return bool
      * @since 100.2.0
      */
@@ -635,6 +651,8 @@ protected function isTelephoneRequired()
     }
 
     /**
+     * Is fax required
+     *
      * @return bool
      * @since 100.2.0
      */

app/code/Magento/Customer/Model/Metadata/Form/Text.php

@@ -11,6 +11,9 @@
 use Magento\Customer\Api\Data\AttributeMetadataInterface;
 use Magento\Framework\Api\ArrayObjectSearch;
 
+/**
+ * Form Text metadata
+ */
 class Text extends AbstractData
 {
     /**