Docs For Class Mage_Wishlist_Model_Mysql4_Item

Description

Wishlist item collection

author: Magento Core Team <[email protected]>
copyright: Copyright (c) 2010 Magento Inc. (http://www.magentocommerce.com)

Located in /Wishlist/Model/Mysql4/Item/Collection.php (line 35)

Varien_Data_Collection_Db
   |
   --Mage_Core_Model_Mysql4_Collection_Abstract
      |
      --Mage_Wishlist_Model_Mysql4_Item_Collection

Variable Summary

boolean $_addDaysInWishlist

boolean $_isProductNameJoined

int $_itemsQty

array $_productIds

bool $_productInStock

bool $_productSalable

bool $_productVisible

array $_storeIds

Method Summary

Mage_Wishlist_Model_Mysql4_Item_Collection addDaysFilter (array $constraints)

Mage_Wishlist_Model_Mysql4_Item_Collection addDaysInWishlist ()

Mage_Wishlist_Model_Mysql4_Item_Collection addProductNameFilter (string $productName)

Mage_Wishlist_Model_Mysql4_Item_Collection addStoreData ()

Mage_Wishlist_Model_Mysql4_Item_Collection addStoreFilter ([int|array $store = null])

Mage_Wishlist_Model_Mysql4_Item_Collection addWishlistFilter (Mage_Wishlist_Model_Wishlist $wishlist)

Mage_Wishlist_Model_Mysql4_Item_Collection addWishListSortOrder ([string $attribute = 'added_at'], [string $dir = 'desc'])

int getItemsQty ()

Mage_Wishlist_Model_Mysql4_Item_Collection resetSortOrder ()

Mage_Wishlist_Model_Mysql4_Item_Collection setInStockFilter ([bool $flag = true])

Mage_Wishlist_Model_Mysql4_Item_Collection setOrderByProductName (string $dir)

Mage_Wishlist_Model_Mysql4_Item_Collection setSalableFilter ([bool $flag = true])

Mage_Wishlist_Model_Mysql4_Item_Collection setVisibilityFilter ([bool $flag = true])

Mage_Wishlist_Model_Mysql4_Item_Collection _afterLoad ()

Mage_Wishlist_Model_Mysql4_Item_Collection _assignOptions ()

Mage_Wishlist_Model_Mysql4_Item_Collection _assignProducts ()

void _construct ()

Mage_Wishlist_Model_Mysql4_Item_Collection _joinProductNameTable ()

Variables

boolean $_addDaysInWishlist = false (line 77)

Add days in whishlist filter of product collection

access: protected

boolean $_isProductNameJoined = false (line 91)

Whether product name attribute value table is joined in select

access: protected

int $_itemsQty (line 84)

Sum of items collection qty

access: protected

array $_productIds = array() (line 63)

Product Ids array

access: protected

bool $_productInStock = false (line 56)

If product out of stock, its item will be removed after load

access: protected

bool $_productSalable = false (line 49)

Product Salable Filter to product collection flag

access: protected

bool $_productVisible = false (line 42)

Product Visibility Filter to product collection flag

access: protected

array $_storeIds = array() (line 70)

Store Ids array

access: protected

Inherited Variables

Inherited from Mage_Core_Model_Mysql4_Collection_Abstract

Mage_Core_Model_Mysql4_Collection_Abstract::$_eventObject
Mage_Core_Model_Mysql4_Collection_Abstract::$_eventPrefix
Mage_Core_Model_Mysql4_Collection_Abstract::$_fieldsToSelect
Mage_Core_Model_Mysql4_Collection_Abstract::$_fieldsToSelectChanged
Mage_Core_Model_Mysql4_Collection_Abstract::$_initialFieldsToSelect
Mage_Core_Model_Mysql4_Collection_Abstract::$_joinedTables
Mage_Core_Model_Mysql4_Collection_Abstract::$_mainTable
Mage_Core_Model_Mysql4_Collection_Abstract::$_model
Mage_Core_Model_Mysql4_Collection_Abstract::$_resetItemsDataChanged
Mage_Core_Model_Mysql4_Collection_Abstract::$_resource
Mage_Core_Model_Mysql4_Collection_Abstract::$_resourceModel

Methods

addDaysFilter (line 342)

Adds filter on days in wishlist

$constraints may contain 'from' and 'to' indexes with number of days to look for items

access: public

Mage_Wishlist_Model_Mysql4_Item_Collection addDaysFilter (array $constraints)

array $constraints

addDaysInWishlist (line 325)

Set add days in whishlist

This method appears in 1.5.0.0 in deprecated state, because:

we need it to make wishlist item collection interface as much as possible compatible with old wishlist product collection
this method is useless because we can calculate days in php, and don't use MySQL for it

deprecated: after 1.4.2.0
access: public

Mage_Wishlist_Model_Mysql4_Item_Collection addDaysInWishlist ()

addProductNameFilter (line 410)

Adds filter on product name

access: public

Mage_Wishlist_Model_Mysql4_Item_Collection addProductNameFilter (string $productName)

string $productName

addStoreData (line 242)

Add items store data to collection

access: public

Mage_Wishlist_Model_Mysql4_Item_Collection addStoreData ()

addStoreFilter (line 222)

Add filter by shared stores

access: public

Mage_Wishlist_Model_Mysql4_Item_Collection addStoreFilter ([int|array $store = null])

int|array $store

addWishlistFilter (line 210)

Add filter by wishlist object

access: public

Mage_Wishlist_Model_Mysql4_Item_Collection addWishlistFilter (Mage_Wishlist_Model_Wishlist $wishlist)

Mage_Wishlist_Model_Wishlist $wishlist

addWishListSortOrder (line 259)

Add wishlist sort order

access: public

Mage_Wishlist_Model_Mysql4_Item_Collection addWishListSortOrder ([string $attribute = 'added_at'], [string $dir = 'desc'])

string $attribute
string $dir

getItemsQty (line 437)

Get sum of items collection qty

access: public

int getItemsQty ()

resetSortOrder (line 270)

Reset sort order

access: public

Mage_Wishlist_Model_Mysql4_Item_Collection resetSortOrder ()

setInStockFilter (line 308)

Set In Stock Filter.

This filter remove items with no salable product.

access: public

Mage_Wishlist_Model_Mysql4_Item_Collection setInStockFilter ([bool $flag = true])

bool $flag

setOrderByProductName (line 425)

Sets ordering by product name

access: public

Mage_Wishlist_Model_Mysql4_Item_Collection setOrderByProductName (string $dir)

string $dir

setSalableFilter (line 295)

Set Salable Filter.

This filter apply Salable Product Types Filter to product collection.

access: public

Mage_Wishlist_Model_Mysql4_Item_Collection setSalableFilter ([bool $flag = true])

bool $flag

setVisibilityFilter (line 282)

Set product Visibility Filter to product collection flag

access: public

Mage_Wishlist_Model_Mysql4_Item_Collection setVisibilityFilter ([bool $flag = true])

bool $flag

_afterLoad (line 109)

After load processing

access: protected

Mage_Wishlist_Model_Mysql4_Item_Collection _afterLoad ()

Redefinition of:

Mage_Core_Model_Mysql4_Collection_Abstract::_afterLoad(): Redeclare after load method for specifying collection items original data

_assignOptions (line 130)

Add options to items

access: protected

Mage_Wishlist_Model_Mysql4_Item_Collection _assignOptions ()

_assignProducts (line 149)

Add products to items and item options

access: protected

Mage_Wishlist_Model_Mysql4_Item_Collection _assignProducts ()

_construct (line 98)

Initialize resource model for collection

access: public

void _construct ()

Redefinition of:

Mage_Core_Model_Mysql4_Collection_Abstract::_construct(): Initialization here

_joinProductNameTable (line 379)

Joins product name attribute value to use it in WHERE and ORDER clauses

access: protected

Mage_Wishlist_Model_Mysql4_Item_Collection _joinProductNameTable ()

Inherited Methods

Inherited From Mage_Core_Model_Mysql4_Collection_Abstract

Mage_Core_Model_Mysql4_Collection_Abstract::__construct()
Mage_Core_Model_Mysql4_Collection_Abstract::addExpressionFieldToSelect()
Mage_Core_Model_Mysql4_Collection_Abstract::addFieldToSelect()
Mage_Core_Model_Mysql4_Collection_Abstract::getAllIds()
Mage_Core_Model_Mysql4_Collection_Abstract::getMainTable()
Mage_Core_Model_Mysql4_Collection_Abstract::getModelName()
Mage_Core_Model_Mysql4_Collection_Abstract::getResource()
Mage_Core_Model_Mysql4_Collection_Abstract::getResourceModelName()
Mage_Core_Model_Mysql4_Collection_Abstract::getSelect()
Mage_Core_Model_Mysql4_Collection_Abstract::getTable()
Mage_Core_Model_Mysql4_Collection_Abstract::join()
Mage_Core_Model_Mysql4_Collection_Abstract::removeAllFieldsFromSelect()
Mage_Core_Model_Mysql4_Collection_Abstract::removeFieldFromSelect()
Mage_Core_Model_Mysql4_Collection_Abstract::resetItemsDataChanged()
Mage_Core_Model_Mysql4_Collection_Abstract::save()
Mage_Core_Model_Mysql4_Collection_Abstract::setMainTable()
Mage_Core_Model_Mysql4_Collection_Abstract::setModel()
Mage_Core_Model_Mysql4_Collection_Abstract::setResetItemsDataChanged()
Mage_Core_Model_Mysql4_Collection_Abstract::setResourceModel()
Mage_Core_Model_Mysql4_Collection_Abstract::_afterLoad()
Mage_Core_Model_Mysql4_Collection_Abstract::_beforeLoad()
Mage_Core_Model_Mysql4_Collection_Abstract::_canUseCache()
Mage_Core_Model_Mysql4_Collection_Abstract::_construct()
Mage_Core_Model_Mysql4_Collection_Abstract::_getCacheTags()
Mage_Core_Model_Mysql4_Collection_Abstract::_getInitialFieldsToSelect()
Mage_Core_Model_Mysql4_Collection_Abstract::_init()
Mage_Core_Model_Mysql4_Collection_Abstract::_initInitialFieldsToSelect()
Mage_Core_Model_Mysql4_Collection_Abstract::_initSelect()
Mage_Core_Model_Mysql4_Collection_Abstract::_initSelectFields()
Mage_Core_Model_Mysql4_Collection_Abstract::_loadCache()
Mage_Core_Model_Mysql4_Collection_Abstract::_saveCache()

Class Constants

Inherited Constants

Inherited from Mage_Core_Model_Mysql4_Collection_Abstract

Mage_Core_Model_Mysql4_Collection_Abstract::CACHE_TAG

Class Mage_Wishlist_Model_Mysql4_Item_Collection

Inherited Variables

Inherited Methods

Inherited Constants