Mage_Wishlist - DOC block update (#742)

- doc blocks added/fixed - PSR2 fixes (whitespaces, linebreaks, ...) Co-authored-by: Tymoteusz Motylewski <t.motylewski@gmail.com>
OpenMage · Jun 27, 2020 · 4352930 · 4352930
1 parent 19648fd
commit 4352930
Show file tree

Hide file tree

Showing 36 changed files with 247 additions and 170 deletions.
diff --git a/app/code/core/Mage/Wishlist/Block/Abstract.php b/app/code/core/Mage/Wishlist/Block/Abstract.php
@@ -106,7 +106,7 @@ protected function _getWishlist()
      * Prepare additional conditions to collection
      *
      * @param Mage_Wishlist_Model_Resource_Item_Collection $collection
-     * @return Mage_Wishlist_Block_Customer_Wishlist
+     * @return $this
      */
     protected function _prepareCollection($collection)
     {
@@ -151,8 +151,8 @@ public function getWishlistInstance()
     /**
      * Back compatibility retrieve wishlist product items
      *
+     * @return Mage_Wishlist_Model_Resource_Item_Collection
      * @deprecated after 1.4.2.0
-     * @return Mage_Wishlist_Model_Mysql4_Item_Collection
      */
     public function getWishlist()
     {

diff --git a/app/code/core/Mage/Wishlist/Block/Customer/Sharing.php b/app/code/core/Mage/Wishlist/Block/Customer/Sharing.php
@@ -37,14 +37,14 @@ class Mage_Wishlist_Block_Customer_Sharing extends Mage_Core_Block_Template
     /**
      * Entered Data cache
      *
-     * @param array
+     * @var array
      */
-    protected  $_enteredData = null;
+    protected $_enteredData = null;
 
     /**
      * Prepare Global Layout
      *
-     * @return $this
+     * @return void
      */
     protected function _prepareLayout()
     {
@@ -79,8 +79,7 @@ public function getEnteredData($key)
 
         if (!$this->_enteredData || !isset($this->_enteredData[$key])) {
             return null;
-        }
-        else {
+        } else {
             return $this->escapeHtml($this->_enteredData[$key]);
         }
     }

diff --git a/app/code/core/Mage/Wishlist/Block/Customer/Sidebar.php b/app/code/core/Mage/Wishlist/Block/Customer/Sidebar.php
@@ -47,8 +47,8 @@ public function getTitle()
     /**
      * Add sidebar conditions to collection
      *
-     * @param  Mage_Wishlist_Model_Resource_Item_Collection $collection
-     * @return Mage_Wishlist_Block_Customer_Wishlist
+     * @param Mage_Wishlist_Model_Resource_Item_Collection $collection
+     * @return $this
      */
     protected function _prepareCollection($collection)
     {
@@ -157,6 +157,4 @@ public function getCacheTags()
         }
         return parent::getCacheTags();
     }
-
-
 }
diff --git a/app/code/core/Mage/Wishlist/Block/Customer/Wishlist.php b/app/code/core/Mage/Wishlist/Block/Customer/Wishlist.php
@@ -54,7 +54,7 @@ protected function _prepareCollection($collection)
     /**
      * Preparing global layout
      *
-     * @return $this
+     * @return void
      */
     protected function _prepareLayout()
     {
@@ -99,7 +99,7 @@ public function getOptionsRenderCfgs()
         return $this->_optionsCfg;
     }
 
-    /*
+    /**
      * Adds config for rendering product type options
      *
      * @deprecated after 1.6.2.0

diff --git a/app/code/core/Mage/Wishlist/Block/Customer/Wishlist/Item/Column/Comment.php b/app/code/core/Mage/Wishlist/Block/Customer/Wishlist/Item/Column/Comment.php
@@ -31,8 +31,7 @@
  * @package     Mage_Wishlist
  * @author      Magento Core Team <core@magentocommerce.com>
  */
-class Mage_Wishlist_Block_Customer_Wishlist_Item_Column_Comment
-    extends Mage_Wishlist_Block_Customer_Wishlist_Item_Column
+class Mage_Wishlist_Block_Customer_Wishlist_Item_Column_Comment extends Mage_Wishlist_Block_Customer_Wishlist_Item_Column
 {
     /**
      * Retrieve column javascript code

diff --git a/app/code/core/Mage/Wishlist/Block/Customer/Wishlist/Item/Options.php b/app/code/core/Mage/Wishlist/Block/Customer/Wishlist/Item/Options.php
@@ -30,6 +30,9 @@
  * @category   Mage
  * @package    Mage_Wishlist
  * @author     Magento Core Team <core@magentocommerce.com>
+ *
+ * @method Mage_Wishlist_Model_Item getItem()
+ * @method $this setOptionList(array $value)
  */
 class Mage_Wishlist_Block_Customer_Wishlist_Item_Options extends Mage_Wishlist_Block_Abstract
 {
@@ -52,7 +55,7 @@ public function __construct()
         Mage::dispatchEvent('product_option_renderer_init', array('block' => $this));
     }
 
-    /*
+    /**
      * Adds config for rendering product type options
      *
      * @param string $productType

diff --git a/app/code/core/Mage/Wishlist/Block/Customer/Wishlist/Items.php b/app/code/core/Mage/Wishlist/Block/Customer/Wishlist/Items.php
@@ -43,7 +43,7 @@ public function getColumns()
         $columns = array();
         foreach ($this->getSortedChildren() as $code) {
             $child = $this->getChild($code);
-            if ($child->isEnabled()){
+            if ($child->isEnabled()) {
                 $columns[] = $child;
             }
         }

diff --git a/app/code/core/Mage/Wishlist/Block/Item/Configure.php b/app/code/core/Mage/Wishlist/Block/Item/Configure.php
@@ -57,7 +57,7 @@ protected function getWishlistItem()
     /**
      * Configure product view blocks
      *
-     * @return $this
+     * @inheritDoc
      */
     protected function _prepareLayout()
     {

diff --git a/app/code/core/Mage/Wishlist/Block/Links.php b/app/code/core/Mage/Wishlist/Block/Links.php
@@ -88,18 +88,18 @@ protected function _createLabel($count)
     {
         if ($count > 1) {
             return $this->__('My Wishlist (%d items)', $count);
-        } else if ($count == 1) {
+        } elseif ($count == 1) {
             return $this->__('My Wishlist (%d item)', $count);
         } else {
             return $this->__('My Wishlist');
         }
     }
 
     /**
-     * @deprecated after 1.4.2.0
+     * @return Mage_Wishlist_Block_Links
      * @see Mage_Wishlist_Block_Links::__construct
      *
-     * @return array
+     * @deprecated after 1.4.2.0
      */
     public function addWishlistLink()
     {
@@ -113,7 +113,7 @@ public function addWishlistLink()
      */
     public function getCacheTags()
     {
-        /** @var $wishlist Mage_Wishlist_Model_Wishlist */
+        /** @var Mage_Wishlist_Model_Wishlist $wishlist */
         $wishlist = $this->helper('wishlist')->getWishlist();
         $this->addModelTags($wishlist);
         foreach ($wishlist->getItemCollection() as $item) {

diff --git a/app/code/core/Mage/Wishlist/Block/Render/Item/Price.php b/app/code/core/Mage/Wishlist/Block/Render/Item/Price.php
@@ -30,6 +30,10 @@
  * @category   Mage
  * @package    Mage_Wishlist
  * @author     Magento Core Team <core@magentocommerce.com>
+ *
+ * @method Mage_Catalog_Model_Product getProduct()
+ * @method string getDisplayMinimalPrice()
+ * @method string getIdSuffix()
  */
 class Mage_Wishlist_Block_Render_Item_Price extends Mage_Core_Block_Template
 {

diff --git a/app/code/core/Mage/Wishlist/Block/Share/Email/Rss.php b/app/code/core/Mage/Wishlist/Block/Share/Email/Rss.php
@@ -24,13 +24,14 @@
  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
-
 /**
  * Wishlist RSS URL to Email Block
  *
  * @category   Mage
  * @package    Mage_Wishlist
  * @author     Magento Core Team <core@magentocommerce.com>
+ *
+ * @method $this setWishlistId(int $value)
  */
 class Mage_Wishlist_Block_Share_Email_Rss extends Mage_Core_Block_Template
 {

diff --git a/app/code/core/Mage/Wishlist/Controller/Abstract.php b/app/code/core/Mage/Wishlist/Controller/Abstract.php
@@ -105,8 +105,8 @@ public function allcartAction()
             $qtys = array_filter(json_decode($qtysString), 'strlen');
         }
 
+        /** @var Mage_Wishlist_Model_Item $item */
         foreach ($collection as $item) {
-            /** @var Mage_Wishlist_Model_Item */
             try {
                 $disableAddToCart = $item->getProduct()->getDisableAddToCart();
                 $item->unsProduct();
@@ -123,11 +123,10 @@ public function allcartAction()
                 if ($item->addToCart($cart, $isOwner)) {
                     $addedItems[] = $item->getProduct();
                 }
-
             } catch (Mage_Core_Exception $e) {
                 if ($e->getCode() == Mage_Wishlist_Model_Item::EXCEPTION_CODE_NOT_SALABLE) {
                     $notSalable[] = $item;
-                } else if ($e->getCode() == Mage_Wishlist_Model_Item::EXCEPTION_CODE_HAS_REQUIRED_OPTIONS) {
+                } elseif ($e->getCode() == Mage_Wishlist_Model_Item::EXCEPTION_CODE_HAS_REQUIRED_OPTIONS) {
                     $hasOptions[] = $item;
                 } else {
                     $messages[] = $this->__('%s for "%s".', trim($e->getMessage(), '.'), $item->getProduct()->getName());
@@ -150,7 +149,7 @@ public function allcartAction()
         }
         if (Mage::helper('checkout/cart')->getShouldRedirectToCart()) {
             $redirectUrl = Mage::helper('checkout/cart')->getCartUrl();
-        } else if ($this->_getRefererUrl()) {
+        } elseif ($this->_getRefererUrl()) {
             $redirectUrl = $this->_getRefererUrl();
         } else {
             $redirectUrl = $indexUrl;
@@ -193,8 +192,7 @@ public function allcartAction()
             // save wishlist model for setting date of last update
             try {
                 $wishlist->save();
-            }
-            catch (Exception $e) {
+            } catch (Exception $e) {
                 Mage::getSingleton('wishlist/session')->addError($this->__('Cannot update wishlist'));
                 $redirectUrl = $indexUrl;
             }

diff --git a/app/code/core/Mage/Wishlist/Helper/Data.php b/app/code/core/Mage/Wishlist/Helper/Data.php
@@ -258,7 +258,7 @@ protected function _getUrlStore($item)
         if ($product) {
             if ($product->isVisibleInSiteVisibility()) {
                 $storeId = $product->getStoreId();
-            } else if ($product->hasUrlDataObject()) {
+            } elseif ($product->hasUrlDataObject()) {
                 $storeId = $product->getUrlDataObject()->getStoreId();
             }
         }

diff --git a/app/code/core/Mage/Wishlist/Model/Config/Source/Summary.php b/app/code/core/Mage/Wishlist/Model/Config/Source/Summary.php
@@ -25,6 +25,9 @@
  */
 class Mage_Wishlist_Model_Config_Source_Summary
 {
+    /**
+     * @return array
+     */
     public function toOptionArray()
     {
         return array(