PHPDoc and type hints

Marcel Hauri · chirag-wagento · commit 0a0d7813d082 · 2018-06-07T04:37:14.000Z
diff --git a/app/code/Magento/Catalog/Block/Adminhtml/Category/Tree.php b/app/code/Magento/Catalog/Block/Adminhtml/Category/Tree.php
@@ -325,7 +325,7 @@ public function getBreadcrumbsJavascript($path, $javascriptVarName)
      *
      * @param Node|array $node
      * @param int $level
-     * @return string
+     * @return array
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      * @SuppressWarnings(PHPMD.NPathComplexity)
      */
diff --git a/app/code/Magento/Catalog/Block/Adminhtml/Category/Widget/Chooser.php b/app/code/Magento/Catalog/Block/Adminhtml/Category/Widget/Chooser.php
@@ -144,7 +144,7 @@ function (node, e) {
      *
      * @param \Magento\Framework\Data\Tree\Node|array $node
      * @param int $level
-     * @return string
+     * @return array
      */
     protected function _getNodeJson($node, $level = 0)
     {
diff --git a/app/code/Magento/Catalog/Block/Adminhtml/Form/Renderer/Fieldset/Element.php b/app/code/Magento/Catalog/Block/Adminhtml/Form/Renderer/Fieldset/Element.php
@@ -21,7 +21,7 @@ class Element extends \Magento\Backend\Block\Widget\Form\Renderer\Fieldset\Eleme
     /**
      * Retrieve data object related with form
      *
-     * @return \Magento\Catalog\Model\Product || \Magento\Catalog\Model\Category
+     * @return \Magento\Catalog\Model\Product|\Magento\Catalog\Model\Category
      */
     public function getDataObject()
     {
diff --git a/app/code/Magento/Catalog/Block/Adminhtml/Product/Attribute/Grid.php b/app/code/Magento/Catalog/Block/Adminhtml/Product/Attribute/Grid.php
@@ -101,8 +101,7 @@ protected function _prepareColumns()
                 'type' => 'options',
                 'options' => ['1' => __('Yes'), '0' => __('No')],
                 'align' => 'center'
-            ],
-            'is_user_defined'
+            ]
         );
 
         $this->_eventManager->dispatch('product_attribute_grid_build', ['grid' => $this]);
diff --git a/app/code/Magento/Catalog/Block/Adminhtml/Product/Edit/Tab/Attributes/Search.php b/app/code/Magento/Catalog/Block/Adminhtml/Product/Edit/Tab/Attributes/Search.php
@@ -81,7 +81,7 @@ public function getSelectorOptions()
      *
      * @param string $labelPart
      * @param int $templateId
-     * @return \Magento\Catalog\Model\ResourceModel\Product\Attribute\Collection
+     * @return array
      */
     public function getSuggestedAttributes($labelPart, $templateId = null)
     {
diff --git a/app/code/Magento/Catalog/Block/Adminhtml/Rss/Grid/Link.php b/app/code/Magento/Catalog/Block/Adminhtml/Rss/Grid/Link.php
@@ -69,7 +69,7 @@ public function isRssAllowed()
     }
 
     /**
-     * @return string
+     * @return array
      */
     protected function getLinkParams()
     {
diff --git a/app/code/Magento/Catalog/Block/Category/Rss/Link.php b/app/code/Magento/Catalog/Block/Category/Rss/Link.php
@@ -62,7 +62,7 @@ public function getLabel()
     }
 
     /**
-     * @return string
+     * @return array
      */
     protected function getLinkParams()
     {
diff --git a/app/code/Magento/Catalog/Block/Product/AbstractProduct.php b/app/code/Magento/Catalog/Block/Product/AbstractProduct.php
@@ -195,7 +195,7 @@ public function getAddToCompareUrl()
      * Gets minimal sales quantity
      *
      * @param \Magento\Catalog\Model\Product $product
-     * @return int|null
+     * @return float|null
      */
     public function getMinimalQty($product)
     {
diff --git a/app/code/Magento/Catalog/Block/Product/View/Options/AbstractOptions.php b/app/code/Magento/Catalog/Block/Product/View/Options/AbstractOptions.php
@@ -178,7 +178,7 @@ public function getPrice($price, $includingTax = null)
      * Returns price converted to current currency rate
      *
      * @param float $price
-     * @return float
+     * @return float|string
      */
     public function getCurrencyPrice($price)
     {
diff --git a/app/code/Magento/Catalog/Block/Rss/Product/Special.php b/app/code/Magento/Catalog/Block/Rss/Product/Special.php
@@ -107,7 +107,7 @@ protected function _construct()
     }
 
     /**
-     * @return string
+     * @return array
      */
     public function getRssData()
     {

Original file line number	Diff line number	Diff line change
`@@ -325,7 +325,7 @@ public function getBreadcrumbsJavascript($path, $javascriptVarName)`
`325`	`325`	`*`
`326`	`326`	`* @param Node\|array $node`
`327`	`327`	`* @param int $level`
`328`		`- * @return string`
	`328`	`+ * @return array`
`329`	`329`	`* @SuppressWarnings(PHPMD.CyclomaticComplexity)`
`330`	`330`	`* @SuppressWarnings(PHPMD.NPathComplexity)`
`331`	`331`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,7 @@ function (node, e) {`
`144`	`144`	`*`
`145`	`145`	`* @param \Magento\Framework\Data\Tree\Node\|array $node`
`146`	`146`	`* @param int $level`
`147`		`- * @return string`
	`147`	`+ * @return array`
`148`	`148`	`*/`
`149`	`149`	`protected function _getNodeJson($node, $level = 0)`
`150`	`150`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ class Element extends \Magento\Backend\Block\Widget\Form\Renderer\Fieldset\Eleme`
`21`	`21`	`/**`
`22`	`22`	`* Retrieve data object related with form`
`23`	`23`	`*`
`24`		`- * @return \Magento\Catalog\Model\Product \|\| \Magento\Catalog\Model\Category`
	`24`	`+ * @return \Magento\Catalog\Model\Product\|\Magento\Catalog\Model\Category`
`25`	`25`	`*/`
`26`	`26`	`public function getDataObject()`
`27`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ public function getSelectorOptions()`
`81`	`81`	`*`
`82`	`82`	`* @param string $labelPart`
`83`	`83`	`* @param int $templateId`
`84`		`- * @return \Magento\Catalog\Model\ResourceModel\Product\Attribute\Collection`
	`84`	`+ * @return array`
`85`	`85`	`*/`
`86`	`86`	`public function getSuggestedAttributes($labelPart, $templateId = null)`
`87`	`87`	`{`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ public function isRssAllowed()`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`/**`
`72`		`- * @return string`
	`72`	`+ * @return array`
`73`	`73`	`*/`
`74`	`74`	`protected function getLinkParams()`
`75`	`75`	`{`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public function getLabel()`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`/**`
`65`		`- * @return string`
	`65`	`+ * @return array`
`66`	`66`	`*/`
`67`	`67`	`protected function getLinkParams()`
`68`	`68`	`{`
Original file line number	Diff line number	Diff line change
`@@ -195,7 +195,7 @@ public function getAddToCompareUrl()`
`195`	`195`	`* Gets minimal sales quantity`
`196`	`196`	`*`
`197`	`197`	`* @param \Magento\Catalog\Model\Product $product`
`198`		`- * @return int\|null`
	`198`	`+ * @return float\|null`
`199`	`199`	`*/`
`200`	`200`	`public function getMinimalQty($product)`
`201`	`201`	`{`
Original file line number	Diff line number	Diff line change
`@@ -178,7 +178,7 @@ public function getPrice($price, $includingTax = null)`
`178`	`178`	`* Returns price converted to current currency rate`
`179`	`179`	`*`
`180`	`180`	`* @param float $price`
`181`		`- * @return float`
	`181`	`+ * @return float\|string`
`182`	`182`	`*/`
`183`	`183`	`public function getCurrencyPrice($price)`
`184`	`184`	`{`
Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ protected function _construct()`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`/**`
`110`		`- * @return string`
	`110`	`+ * @return array`
`111`	`111`	`*/`
`112`	`112`	`public function getRssData()`
`113`	`113`	`{`