Class Mage_Wishlist_Model_Wishlist

Description
Description | Vars (details) | Methods (details)

Wishlist model

Located in /Wishlist/Model/Wishlist.php (line 35) 

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Wishlist_Model_Wishlist
Variable Summary
Description | Vars (details) | Methods (details)
Mage_Wishlist_Model_Mysql4_Item_Collection $_itemCollection
Mage_Core_Model_Store $_store
array $_storeIds
Method Summary
Description | Vars (details) | Methods (details)
Mage_Wishlist_Model_Wishlist addItem (Mage_Wishlist_Model_Item $item)
Mage_Wishlist_Model_Item|string addNewItem (int|Mage_Catalog_Model_Product $product, [mixed $buyRequest = null], [bool $forciblySetQty = false])
Mage_Wishlist_Model_Wishlist getCustomerId ()
array getDataForSave ()
Mage_Wishlist_Model_Item getItem (int $itemId)
Mage_Wishlist_Model_Mysql4_Item_Collection getItemCollection ()
int getItemsCount ()
Mage_Wishlist_Model_Mysql4_Product_Collection getProductCollection ()
array getSharedStoreIds ([bool $current = true])
Mage_Core_Model_Store getStore ()
bool isOwner (int $customerId)
bool isSalable ()
Mage_Wishlist_Model_Wishlist loadByCode (string $code)
Mage_Wishlist_Model_Wishlist loadByCustomer (mixed $customer, [bool $create = false])
Mage_Wishlist_Model_Wishlist setCustomerId (int $customerId)
Mage_Wishlist_Model_Wishlist setSharedStoreIds (array $storeIds)
Mage_Wishlist_Model_Wishlist setStore (Mage_Core_Model_Store $store)
Mage_Wishlist_Model_Wishlist updateItem (int $itemId, Varien_Object $buyRequest, [null|array|Varien_Object $params = null])
Mage_Wishlist_Model_Item _addCatalogProduct ( $product, [int $qty = 1], [bool $forciblySetQty = false])
Mage_Sales_Model_Quote _afterSave ()
Mage_Wishlist_Model_Wishlist _beforeSave ()
void _construct ()
string _getSharingRandomCode ()
Variables
Description | Vars (details) | Methods (details)
Mage_Wishlist_Model_Mysql4_Item_Collection $_itemCollection = null (line 42)

Wishlist item collection

  • access: protected
Mage_Core_Model_Store $_store = null (line 49)

Store filter for wishlist

  • access: protected
array $_storeIds = null (line 56)

Shared store ids (website stores)

  • access: protected

Inherited Variables

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
 Mage_Core_Model_Abstract::$_dataSaveAllowed
 Mage_Core_Model_Abstract::$_eventObject
 Mage_Core_Model_Abstract::$_eventPrefix
 Mage_Core_Model_Abstract::$_isObjectNew
 Mage_Core_Model_Abstract::$_resource
 Mage_Core_Model_Abstract::$_resourceCollectionName
 Mage_Core_Model_Abstract::$_resourceName
Methods
Description | Vars (details) Methods (details)
addItem (line 237)

Adding item to wishlist

  • access: public
Mage_Wishlist_Model_Wishlist addItem (Mage_Wishlist_Model_Item $item)
addNewItem (line 256)

Adds new product to wishlist.

Returns new item or string on error.

  • access: public
Mage_Wishlist_Model_Item|string addNewItem (int|Mage_Catalog_Model_Product $product, [mixed $buyRequest = null], [bool $forciblySetQty = false])
getCustomerId (line 346)

Retrieve customer id

  • access: public
Mage_Wishlist_Model_Wishlist getCustomerId ()
getDataForSave (line 356)

Retrieve data for save

  • access: public
array getDataForSave ()
getItem (line 205)

Retrieve wishlist item collection

  • access: public
Mage_Wishlist_Model_Item getItem (int $itemId)
  • int $itemId
getItemCollection (line 189)

Retrieve wishlist item collection

  • access: public
Mage_Wishlist_Model_Mysql4_Item_Collection getItemCollection ()
getItemsCount (line 429)

Retrieve wishlist items count

  • access: public
int getItemsCount ()
getProductCollection (line 221)

Retrieve Product collection

Mage_Wishlist_Model_Mysql4_Product_Collection getProductCollection ()
getSharedStoreIds (line 371)

Retrieve shared store ids for current website or all stores if $current is false

  • access: public
array getSharedStoreIds ([bool $current = true])
  • bool $current: Use current website or not
getStore (line 404)

Retrieve wishlist store object

  • access: public
Mage_Core_Model_Store getStore ()
isOwner (line 455)

Check customer is owner this wishlist

  • access: public
bool isOwner (int $customerId)
  • int $customerId
isSalable (line 439)

Retrieve wishlist has salable item(s)

  • access: public
bool isSalable ()
loadByCode (line 97)

Load by sharing code

  • access: public
Mage_Wishlist_Model_Wishlist loadByCode (string $code)
  • string $code
loadByCustomer (line 74)

Load wishlist by customer

  • access: public
Mage_Wishlist_Model_Wishlist loadByCustomer (mixed $customer, [bool $create = false])
  • mixed $customer
  • bool $create: Create wishlist if don't exists
setCustomerId (line 336)

Set customer id

  • access: public
Mage_Wishlist_Model_Wishlist setCustomerId (int $customerId)
  • int $customerId
setSharedStoreIds (line 393)

Set shared store ids

  • access: public
Mage_Wishlist_Model_Wishlist setSharedStoreIds (array $storeIds)
  • array $storeIds
setStore (line 418)

Set wishlist store

  • access: public
Mage_Wishlist_Model_Wishlist setStore (Mage_Core_Model_Store $store)
updateItem (line 482)

Update wishlist Item and set data from request

$params sets how current item configuration must be taken into account and additional options. It's passed to Mage_Catalog_Helper_Product->addParamsToBuyRequest() to compose resulting buyRequest.

Basically it can hold

  • 'current_config', Varien_Object or array - current buyRequest that configures product in this item, used to restore currently attached files
  • 'files_prefix': string[a-z0-9_] - prefix that was added at frontend to names of file options (file inputs), so they won't intersect with other submitted options
For more options see Mage_Catalog_Helper_Product->addParamsToBuyRequest()

Mage_Wishlist_Model_Wishlist updateItem (int $itemId, Varien_Object $buyRequest, [null|array|Varien_Object $params = null])
  • int $itemId
  • Varien_Object $buyRequest
  • null|array|Varien_Object $params
_addCatalogProduct (line 152)

Adding catalog product object data to wishlist

  • access: protected
Mage_Wishlist_Model_Item _addCatalogProduct ( $product, [int $qty = 1], [bool $forciblySetQty = false])
_afterSave (line 134)

Save related items

  • access: protected
Mage_Sales_Model_Quote _afterSave ()
Redefinition of:
Mage_Core_Model_Abstract::_afterSave()
Processing object after save data
_beforeSave (line 122)

Set date of last update for wishlist

  • access: protected
Mage_Wishlist_Model_Wishlist _beforeSave ()
Redefinition of:
Mage_Core_Model_Abstract::_beforeSave()
Processing object before save data
_construct (line 62)

Initialize resource model

  • access: protected
void _construct ()
_getSharingRandomCode (line 112)

Retrieve sharing code (random string)

  • access: protected
string _getSharingRandomCode ()

Inherited Methods

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()

Documentation generated on Fri, 11 Feb 2011 17:16:28 +0200 by phpDocumentor 1.4.3