ENGCOM-2071: Fix missing PHPDocs hinting for AdvancedPricingImportExport module #15872

Author: Stanislav Idolov

app/code/Magento/AdvancedPricingImportExport/Model/Export/AdvancedPricing.php

@@ -103,7 +103,6 @@ class AdvancedPricing extends \Magento\CatalogImportExport\Model\Export\Product
      * @param \Magento\CatalogImportExport\Model\Export\RowCustomizerInterface $rowCustomizer
      * @param ImportProduct\StoreResolver $storeResolver
      * @param \Magento\Customer\Api\GroupRepositoryInterface $groupRepository
-     * @throws \Magento\Framework\Exception\LocalizedException
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -192,6 +191,7 @@ protected function initTypeModels()
      * Export process
      *
      * @return string
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function export()
     {
@@ -461,6 +461,7 @@ protected function getTierPrices(array $productLinksIds, $table)
      *
      * @param int $websiteId
      * @return string
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
     protected function _getWebsiteCode(int $websiteId): string
     {
@@ -491,6 +492,8 @@ protected function _getWebsiteCode(int $websiteId): string
      * @param int $customerGroupId
      * @param int $allGroups
      * @return string
+     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
      */
     protected function _getCustomerGroupById(
         int $customerGroupId,

app/code/Magento/AdvancedPricingImportExport/Model/Import/AdvancedPricing.php

@@ -8,7 +8,6 @@
 use Magento\CatalogImportExport\Model\Import\Product as ImportProduct;
 use Magento\CatalogImportExport\Model\Import\Product\RowValidatorInterface as ValidatorInterface;
 use Magento\ImportExport\Model\Import\ErrorProcessing\ProcessingErrorAggregatorInterface;
-use Magento\Framework\App\ResourceConnection;
 
 /**
  * Class AdvancedPricing
@@ -619,6 +618,7 @@ protected function processCountNewPrices(array $tierPrices)
      * Get product entity link field
      *
      * @return string
+     * @throws \Exception
      */
     private function getProductEntityLinkField()
     {

app/code/Magento/AdvancedPricingImportExport/Model/Import/AdvancedPricing/Validator.php

@@ -28,6 +28,7 @@ public function __construct($validators = [])
      *
      * @param array $value
      * @return bool
+     * @throws \Zend_Validate_Exception
      */
     public function isValid($value)
     {

app/code/Magento/AdvancedPricingImportExport/Test/Unit/Model/Export/AdvancedPricingTest.php

@@ -347,6 +347,7 @@ protected function tearDown()
      * @param $object
      * @param $property
      * @return mixed
+     * @throws \ReflectionException
      */
     protected function getPropertyValue($object, $property)
     {
@@ -362,6 +363,8 @@ protected function getPropertyValue($object, $property)
      * @param $object
      * @param $property
      * @param $value
+     * @return mixed
+     * @throws \ReflectionException
      */
     protected function setPropertyValue(&$object, $property, $value)
     {

app/code/Magento/AdvancedPricingImportExport/Test/Unit/Model/Import/AdvancedPricing/Validator/TierPriceTest.php

@@ -346,6 +346,7 @@ public function isValidAddMessagesCallDataProvider()
      * @param object $object
      * @param string $property
      * @return mixed
+     * @throws \ReflectionException
      */
     protected function getPropertyValue($object, $property)
     {
@@ -363,6 +364,7 @@ protected function getPropertyValue($object, $property)
      * @param string $property
      * @param mixed $value
      * @return object
+     * @throws \ReflectionException
      */
     protected function setPropertyValue(&$object, $property, $value)
     {

app/code/Magento/AdvancedPricingImportExport/Test/Unit/Model/Import/AdvancedPricingTest.php

@@ -209,6 +209,10 @@ public function testGetEntityTypeCode()
      * Test method validateRow against its result.
      *
      * @dataProvider validateRowResultDataProvider
+     * @param array $rowData
+     * @param string|null $behavior
+     * @param bool $expectedResult
+     * @throws \ReflectionException
      */
     public function testValidateRowResult($rowData, $behavior, $expectedResult)
     {
@@ -234,6 +238,10 @@ public function testValidateRowResult($rowData, $behavior, $expectedResult)
      * Test method validateRow whether AddRowError is called.
      *
      * @dataProvider validateRowAddRowErrorCallDataProvider
+     * @param array $rowData
+     * @param string|null $behavior
+     * @param string $error
+     * @throws \ReflectionException
      */
     public function testValidateRowAddRowErrorCall($rowData, $behavior, $error)
     {
@@ -324,6 +332,13 @@ public function testSaveAdvancedPricing()
      * Take into consideration different data and check relative internal calls.
      *
      * @dataProvider saveAndReplaceAdvancedPricesAppendBehaviourDataProvider
+     * @param array $data
+     * @param string $tierCustomerGroupId
+     * @param string $groupCustomerGroupId
+     * @param string $tierWebsiteId
+     * @param string $groupWebsiteId
+     * @param array $expectedTierPrices
+     * @throws \ReflectionException
      */
     public function testSaveAndReplaceAdvancedPricesAppendBehaviourDataAndCalls(
         $data,
@@ -956,6 +971,7 @@ public function processCountExistingPricesDataProvider()
      * @param $object
      * @param $property
      * @return mixed
+     * @throws \ReflectionException
      */
     protected function getPropertyValue($object, $property)
     {
@@ -972,6 +988,8 @@ protected function getPropertyValue($object, $property)
      * @param $object
      * @param $property
      * @param $value
+     * @return mixed
+     * @throws \ReflectionException
      */
     protected function setPropertyValue(&$object, $property, $value)
     {
@@ -990,7 +1008,8 @@ protected function setPropertyValue(&$object, $property, $value)
      * @param string $method
      * @param array $args
      *
-     * @return mixed the method result.
+     * @return mixed
+     * @throws \ReflectionException
      */
     private function invokeMethod($object, $method, $args = [])
     {
@@ -1007,6 +1026,7 @@ private function invokeMethod($object, $method, $args = [])
      * @param array $methods
      *
      * @return \PHPUnit_Framework_MockObject_MockObject
+     * @throws \ReflectionException
      */
     private function getAdvancedPricingMock($methods = [])
     {