🔃 [EngCom] Public Pull Requests - 2.3-develop

Accepted Public Pull Requests:
 - #20425: Removed Unnecessary slash in namespace in di.xml (by @milindsingh)
 - #20247: wishlist-patch : remove the comment from wishlist product. (by @khodu)
 - #20338: Small PHPDocs fixes [Catalog module] (by @SikailoISM)
 - #20400: 'wishlist-page-edit-remove-item-misalign' :: On wish list page edit, � (by @nainesh2jcommerce)
 - #20018: remove extra dot on "How to run Magento" docs in phpserver/README.md (by @amritms)
 - #20374: Order-view-invoices :: Order view invoices template not display prope� (by @ranee2jcommerce)
 - #20336: Correct spell in JS files (by @ronak2ram)
 - #20318: Fixed a couple of spelling mistakes (by @mage2pratik)
 - #20195: Bundle-Product-add-to-cart-button-misaligned-on-tab-portrait ::Bundle� (by @ajay2jcommerce)
 - #20260: issue fixed #20259 Store switcher not sliding up and down, only dropd� (by @cedarvinda)
 - #20301: issue fixed #20299 Order item details label not aligned in mobile view (by @cedarvinda)
 - #20222: Las Palmas and Tenerife should be represented by Canary Islands in UPS (by @duckchip)
 - #19986: Issue fixed #19985 Send email confirmation popup close button area ov� (by @cedarvinda)
 - #20248: Magento widgets source models forced to use deprecated interface #20064 (by @milindsingh)
 - #20252: Fixed Issue #20121 Cancel order increases stock although "Set Items' Status to be In Stock When Order is Cancelled" is set to No (by @shikhamis11)
 - #20170: Order API resources updated. #20169 (by @milindsingh)
 - #20057: Refactor \Order\Shipment\Save Controller to use ResultInterface (by @JeroenVanLeusden)
 - #20094: [Forwardport] Fix issue 19052- Position order showing before the text box (by @davidverholen)


Fixed GitHub Issues:
 - #20245: wishlist comment not removed (reported by @khodu) has been fixed in #20247 by @khodu in 2.3-develop branch
   Related commits:
     1. db1e816

 - #20399: On wish list page edit, remove item misalign in 640 X 767 resolution (reported by @nainesh2jcommerce) has been fixed in #20400 by @nainesh2jcommerce in 2.3-develop branch
   Related commits:
     1. 12a0f05

 - #20373: Order view invoices template not display proper on ipad  (reported by @ranee2jcommerce) has been fixed in #20374 by @ranee2jcommerce in 2.3-develop branch
   Related commits:
     1. 5327400

 - #20193:  Bundle Product add to cart button misaligned on tab portrait view. (reported by @ajay2jcommerce) has been fixed in #20195 by @ajay2jcommerce in 2.3-develop branch
   Related commits:
     1. 81da50b

 - #20259: Store switcher not sliding up and down, only dropdown arrow working  (reported by @cedarvinda) has been fixed in #20260 by @cedarvinda in 2.3-develop branch
   Related commits:
     1. 8bc0309
     2. 905368c
     3. ec33182

 - #20299: Order item details label not aligned in mobile view  (reported by @swetacedcoss) has been fixed in #20301 by @cedarvinda in 2.3-develop branch
   Related commits:
     1. 0652e87
     2. b1e21db

 - #19985: Send email confirmation popup close button area overlapping to content  (reported by @cedarvinda) has been fixed in #19986 by @cedarvinda in 2.3-develop branch
   Related commits:
     1. d9620c6
     2. 8f4942a

 - #20064: Magento widgets source models forced to use deprecated interface (reported by @Floddy) has been fixed in #20248 by @milindsingh in 2.3-develop branch
   Related commits:
     1. a958f5b
     2. f7275c5

 - #20121: Cancel order increases stock although "Set Items' Status to be In Stock When Order is Cancelled" is set to No (reported by @denzyk) has been fixed in #20252 by @shikhamis11 in 2.3-develop branch
   Related commits:
     1. 473f907
     2. 8d3fc5c

 - #20169: Admin user with restricted "order create" access can "view", "cancel", etc via API (reported by @milindsingh) has been fixed in #20170 by @milindsingh in 2.3-develop branch
   Related commits:
     1. 4b0eeb6

 - #19052: Position order showing before the text box (reported by @Dharmeshvaja91) has been fixed in #20094 by @davidverholen in 2.3-develop branch
   Related commits:
     1. 53943f8

Author: magento-engcom-team

app/code/Magento/Catalog/Api/CategoryLinkRepositoryInterface.php

@@ -39,7 +39,7 @@ public function delete(\Magento\Catalog\Api\Data\CategoryProductLinkInterface $p
     /**
      * Remove the product assignment from the category by category id and sku
      *
-     * @param string $categoryId
+     * @param int $categoryId
      * @param string $sku
      * @return bool will returned True if products successfully deleted
      *

app/code/Magento/Catalog/Api/Data/ProductRender/PriceInfoInterface.php

@@ -8,6 +8,7 @@
 
 /**
  * Price interface.
+ *
  * @api
  * @since 101.1.0
  */
@@ -23,6 +24,7 @@ public function getFinalPrice();
 
     /**
      * Set the final price: usually it calculated as minimal price of the product
+     *
      * Can be different depends on type of product
      *
      * @param float $finalPrice
@@ -33,6 +35,7 @@ public function setFinalPrice($finalPrice);
 
     /**
      * Retrieve max price of a product
+     *
      * E.g. for product with custom options is price with the most expensive custom option
      *
      * @return float
@@ -51,6 +54,7 @@ public function setMaxPrice($maxPrice);
 
     /**
      * Set max regular price
+     *
      * Max regular price is the same, as maximum price, except of excluding calculating special price and catalog rules
      * in it
      *
@@ -105,6 +109,8 @@ public function setSpecialPrice($specialPrice);
     public function getSpecialPrice();
 
     /**
+     * Retrieve minimal price
+     *
      * @return float
      * @since 101.1.0
      */
@@ -129,6 +135,7 @@ public function getRegularPrice();
 
     /**
      * Regular price - is price of product without discounts and special price with taxes and fixed product tax
+     *
      * Usually this price is corresponding to price in admin panel of product
      *
      * @param float $regularPrice
@@ -148,7 +155,7 @@ public function getFormattedPrices();
     /**
      * Set dto with formatted prices
      *
-     * @param string[] $formattedPriceInfo
+     * @param FormattedPriceInfoInterface $formattedPriceInfo
      * @return void
      * @since 101.1.0
      */

app/code/Magento/Catalog/Api/Data/ProductRenderInterface.php

@@ -30,7 +30,7 @@ public function getAddToCartButton();
     /**
      * Set information needed for render "Add To Cart" button on front
      *
-     * @param \Magento\Catalog\Api\Data\ProductRender\ButtonInterface $addToCartData
+     * @param ButtonInterface $cartAddToCartButton
      * @return void
      * @since 101.1.0
      */
@@ -47,14 +47,15 @@ public function getAddToCompareButton();
     /**
      * Set information needed for render "Add To Compare" button on front
      *
-     * @param ButtonInterface $compareUrlData
+     * @param ButtonInterface $compareButton
      * @return string
      * @since 101.1.0
      */
     public function setAddToCompareButton(ButtonInterface $compareButton);
 
     /**
      * Provide information needed for render prices and adjustments for different product types on front
+     *
      * Prices are represented in raw format and in current currency
      *
      * @return \Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface
@@ -73,6 +74,7 @@ public function setPriceInfo(PriceInfoInterface $priceInfo);
 
     /**
      * Provide enough information, that needed to render image on front
+     *
      * Images can be separated by image codes
      *
      * @return \Magento\Catalog\Api\Data\ProductRender\ImageInterface[]
@@ -167,6 +169,7 @@ public function getIsSalable();
 
     /**
      * Set information about product saleability (Stock, other conditions)
+     *
      * Is used to provide information to frontend JS renders
      * You can add plugin, in order to hide product on product page or product list on front
      *
@@ -178,6 +181,7 @@ public function setIsSalable($isSalable);
 
     /**
      * Provide information about current store id or requested store id
+     *
      * Product should be assigned to provided store id
      * This setting affect store scope attributes
      *
@@ -197,6 +201,7 @@ public function setStoreId($storeId);
 
     /**
      * Provide current or desired currency code to product
+     *
      * This setting affect formatted prices*
      *
      * @return string

app/code/Magento/Catalog/Block/Adminhtml/Product/Frontend/Product/Watermark.php

@@ -4,15 +4,15 @@
  * See COPYING.txt for license details.
  */
 
+namespace Magento\Catalog\Block\Adminhtml\Product\Frontend\Product;
+
+use Magento\Framework\Data\Form\Element\AbstractElement;
+
 /**
  * Fieldset config form element renderer
  *
  * @author      Magento Core Team <core@magentocommerce.com>
  */
-namespace Magento\Catalog\Block\Adminhtml\Product\Frontend\Product;
-
-use Magento\Framework\Data\Form\Element\AbstractElement;
-
 class Watermark extends \Magento\Backend\Block\AbstractBlock implements
     \Magento\Framework\Data\Form\Element\Renderer\RendererInterface
 {
@@ -60,6 +60,8 @@ public function __construct(
     }
 
     /**
+     * Render form element as HTML
+     *
      * @param AbstractElement $element
      * @return string
      */
@@ -124,13 +126,14 @@ public function render(AbstractElement $element)
     }
 
     /**
+     * Get header html for render
+     *
      * @param AbstractElement $element
      * @return string
      * @SuppressWarnings(PHPMD.UnusedLocalVariable)
      */
     protected function _getHeaderHtml($element)
     {
-        $id = $element->getHtmlId();
         $default = !$this->getRequest()->getParam('website') && !$this->getRequest()->getParam('store');
 
         $html = '<h4 class="icon-head head-edit-form">' . $element->getLegend() . '</h4>';
@@ -148,6 +151,8 @@ protected function _getHeaderHtml($element)
     }
 
     /**
+     * Get footer html for render
+     *
      * @param AbstractElement $element
      * @return string
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)

app/code/Magento/Catalog/Controller/Adminhtml/Category/Move.php

@@ -8,6 +8,9 @@
 
 use Magento\Framework\App\Action\HttpPostActionInterface as HttpPostActionInterface;
 
+/**
+ * Move category admin controller
+ */
 class Move extends \Magento\Catalog\Controller\Adminhtml\Category implements HttpPostActionInterface
 {
     /**
@@ -46,7 +49,7 @@ public function __construct(
     /**
      * Move category action
      *
-     * @return \Magento\Framework\Controller\Result\Raw
+     * @return \Magento\Framework\Controller\Result\Json
      */
     public function execute()
     {

app/code/Magento/Catalog/Controller/Index/Index.php

@@ -5,12 +5,17 @@
  */
 namespace Magento\Catalog\Controller\Index;
 
-class Index extends \Magento\Framework\App\Action\Action
+use Magento\Framework\App\Action\HttpGetActionInterface;
+
+/**
+ * Catalog index page controller.
+ */
+class Index extends \Magento\Framework\App\Action\Action implements HttpGetActionInterface
 {
     /**
      * Index action
      *
-     * @return $this
+     * @return \Magento\Framework\Controller\Result\Redirect
      */
     public function execute()
     {

app/code/Magento/Catalog/Helper/Product/Configuration.php

@@ -55,6 +55,7 @@ class Configuration extends AbstractHelper implements ConfigurationInterface
      * @param \Magento\Framework\Filter\FilterManager $filter
      * @param \Magento\Framework\Stdlib\StringUtils $string
      * @param Json $serializer
+     * @param Escaper $escaper
      */
     public function __construct(
         \Magento\Framework\App\Helper\Context $context,

app/code/Magento/Catalog/Helper/Product/ProductList.php

@@ -42,6 +42,7 @@ class ProductList
 
     /**
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
+     * @param \Magento\Framework\Registry $coreRegistry
      */
     public function __construct(
         \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,

app/code/Magento/Catalog/Helper/Product/View.php

@@ -10,7 +10,9 @@
 
 /**
  * Catalog category helper
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  */
 class View extends \Magento\Framework\App\Helper\AbstractHelper
 {
@@ -105,7 +107,7 @@ public function __construct(
      *
      * @param \Magento\Framework\View\Result\Page $resultPage
      * @param \Magento\Catalog\Model\Product $product
-     * @return \Magento\Framework\View\Result\Page
+     * @return $this
      */
     private function preparePageMetadata(ResultPage $resultPage, $product)
     {

app/code/Magento/Catalog/Model/Indexer/Product/Category/Action/Rows.php

@@ -17,6 +17,8 @@
 use Magento\Store\Model\StoreManagerInterface;
 
 /**
+ * Category rows indexer.
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Rows extends \Magento\Catalog\Model\Indexer\Category\Product\AbstractAction
@@ -213,6 +215,7 @@ protected function isRangingNeeded()
     /**
      * Returns a list of category ids which are assigned to product ids in the index
      *
+     * @param array $productIds
      * @return \Magento\Framework\Indexer\CacheContext
      */
     private function getCategoryIdsFromIndex(array $productIds)