Class Mage_Wishlist_Helper_Data

Wishlist Data Helper

Mage_Wishlist_Helper_Data

Package: Mage\Wishlist
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Wishlist/Helper/Data.php

Methods summary
`protected Mage_Customer_Model_Session`	# `_getCustomerSession( )` Retreive customer session Retreive customer session Returns `Mage_Customer_Model_Session`
`protected boolean`	# `_isCustomerLogIn( )` Retrieve customer login status Retrieve customer login status Returns `boolean`
`protected Mage_Customer_Model_Customer`	# `_getCurrentCustomer( )` Retrieve logged in customer Retrieve logged in customer Returns `Mage_Customer_Model_Customer`
`public`	# `setCustomer( Mage_Customer_Model_Customer $customer )` Set current customer Set current customer Parameters `$customer` `Mage_Customer_Model_Customer` $customer
`public Mage_Customer_Model_Customer\|null`	# `getCustomer( )` Retrieve current customer Retrieve current customer Returns `Mage_Customer_Model_Customer\|null`
`public Mage_Wishlist_Model_Wishlist`	# `getWishlist( )` Retrieve wishlist by logged in customer Retrieve wishlist by logged in customer Returns `Mage_Wishlist_Model_Wishlist`
`public integer`	# `getItemCount( )` Retrieve wishlist item count (include config settings) Used in top link menu only Retrieve wishlist item count (include config settings) Used in top link menu only Returns `integer`
`protected Mage_Wishlist_Model_Resource_Item_Collection`	# `_createWishlistItemCollection( )` Create wishlist item collection Create wishlist item collection Returns `Mage_Wishlist_Model_Resource_Item_Collection`
`public Mage_Wishlist_Model_Resource_Item_Collection`	# `getWishlistItemCollection( )` Retrieve wishlist items collection Retrieve wishlist items collection Returns `Mage_Wishlist_Model_Resource_Item_Collection`
`protected Mage_Core_Model_Store`	# `_getUrlStore( Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item $item )` Retrieve Item Store for URL Retrieve Item Store for URL Parameters `$item` `Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item` $item Returns `Mage_Core_Model_Store`
`public string`	# `getRemoveUrl( Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item $item )` Retrieve URL for removing item from wishlist Retrieve URL for removing item from wishlist Parameters `$item` `Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item` $item Returns `string`
`public string`	# `getConfigureUrl( Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item $item )` Retrieve URL for removing item from wishlist Retrieve URL for removing item from wishlist Parameters `$item` `Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item` $item Returns `string`
`public string\|boolean`	# `getAddUrl( Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item $item )` Retrieve url for adding product to wishlist Retrieve url for adding product to wishlist Parameters `$item` `Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item` $item Returns `string\|boolean`
`public string`	# `getMoveFromCartUrl( integer $itemId )` Retrieve url for adding product to wishlist Retrieve url for adding product to wishlist Parameters `$itemId` `integer` $itemId Returns `string`
`public string\|boolean`	# `getUpdateUrl( Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item $item )` Retrieve url for updating product in wishlist Retrieve url for updating product in wishlist Parameters `$item` `Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item` $item Returns `string\|boolean`
`public string\|boolean`	# `getAddUrlWithParams( Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item $item, array $params = array() )` Retrieve url for adding product to wishlist with params Retrieve url for adding product to wishlist with params Parameters `$item` `Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item` $item `$params` `array` $params Returns `string\|boolean`
`public string`	# `getAddToCartUrl( string\|Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item $item )` Retrieve URL for adding item to shoping cart Retrieve URL for adding item to shoping cart Parameters `$item` `string\|Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item` $item Returns `string`
`public string`	# `getSharedAddToCartUrl( string\|Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item $item )` Retrieve URL for adding item to shoping cart from shared wishlist Retrieve URL for adding item to shoping cart from shared wishlist Parameters `$item` `string\|Mage_Catalog_Model_Product\|Mage_Wishlist_Model_Item` $item Returns `string`
`public string`	# `getListUrl( integer $wishlistId = null )` Retrieve customer wishlist url Retrieve customer wishlist url Parameters `$wishlistId` `integer` $wishlistId Returns `string`
`public boolean`	# `isAllow( )` Check is allow wishlist module Check is allow wishlist module Returns `boolean`
`public boolean`	# `isAllowInCart( )` Check is allow wishlist action in shopping cart Check is allow wishlist action in shopping cart Returns `boolean`
`public string\|null`	# `getCustomerName( )` Retrieve customer name Retrieve customer name Returns `string\|null`
`public string`	# `getRssUrl( mixed $wishlistId = null )` Retrieve RSS URL Retrieve RSS URL Parameters `$wishlistId` `mixed` $wishlistId Returns `string`
`public boolean`	# `isRssAllow( )` Is allow RSS Is allow RSS Returns `boolean`
`public string`	# `defaultCommentString( )` Retrieve default empty comment message Retrieve default empty comment message Returns `string`
`public string`	# `getDefaultWishlistName( )` Retrieve default empty comment message Retrieve default empty comment message Returns `string`
`public Mage_Wishlist_Helper_Data`	# `calculate( )` Calculate count of wishlist items and put value to customer session. Method called after wishlist modifications and trigger 'wishlist_items_renewed' event. Depends from configuration. Calculate count of wishlist items and put value to customer session. Method called after wishlist modifications and trigger 'wishlist_items_renewed' event. Depends from configuration. Returns `Mage_Wishlist_Helper_Data`
`public boolean`	# `isDisplayQty( )` Should display item quantities in my wishlist link Should display item quantities in my wishlist link Returns `boolean`

Methods inherited from Mage_Core_Helper_Abstract
`__(), _cleanCache(), _getModuleName(), _getRequest(), _getUrl(), _loadCache(), _removeCache(), _saveCache(), escapeHtml(), escapeUrl(), getLayout(), isModuleEnabled(), isModuleOutputEnabled(), jsQuoteEscape(), quoteEscape(), removeTags(), setLayout(), stripTags(), translateArray(), urlDecode(), urlEncode()`

Constants summary
`string`	`XML_PATH_WISHLIST_LINK_USE_QTY`	`'wishlist/wishlist_link/use_qty'`	# Config key 'Display Wishlist Summary' Config key 'Display Wishlist Summary'
`string`	`XML_PATH_CATALOGINVENTORY_SHOW_OUT_OF_STOCK`	`'cataloginventory/options/show_out_of_stock'`	# Config key 'Display Out of Stock Products' Config key 'Display Out of Stock Products'

Properties summary
`protected Mage_Customer_Model_Customer`	`$_currentCustomer`	`null`	# Currently logged in customer Currently logged in customer
`protected Mage_Wishlist_Model_Wishlist`	`$_wishlist`	`null`	# Customer Wishlist instance Customer Wishlist instance
`protected Mage_Wishlist_Model_Mysql4_Product_Collection`	`$_productCollection`	`null`	# Wishlist Product Items Collection Wishlist Product Items Collection
`protected Mage_Wishlist_Model_Resource_Item_Collection`	`$_wishlistItemCollection`	`null`	# Wishlist Items Collection Wishlist Items Collection

Properties inherited from Mage_Core_Helper_Abstract
`$_layout, $_moduleName, $_request`

Packages

Classes

Class Mage_Wishlist_Helper_Data

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns