Class Mage_Wishlist_Model_Item

Wishlist item model

Varien_Object

Mage_Wishlist_Model_Item implements Mage_Catalog_Model_Product_Configuration_Item_Interface

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/Model/Item.php

Methods summary
`protected`	# `_construct( )` Initialize resource model Initialize resource model
`public Mage_Wishlist_Model_Item`	# `setQty( integer $qty )` Set quantity. If quantity is less than 0 - set it to 1 Set quantity. If quantity is less than 0 - set it to 1 Parameters `$qty` `integer` $qty Returns `Mage_Wishlist_Model_Item`
`protected Mage_Wishlist_Model_Mysql4_Item`	# `_getResource( )` Retrieve resource instance wrapper Retrieve resource instance wrapper Returns `Mage_Wishlist_Model_Mysql4_Item` Overrides `Mage_Core_Model_Abstract::_getResource()`
`protected boolean`	# `_compareOptions( array $options1, array $options2 )` Check if two options array are identical Check if two options array are identical Parameters `$options1` `array` $options1 `$options2` `array` $options2 Returns `boolean`
`protected Mage_Wishlist_Model_Item`	# `_addOptionCode( Mage_Wishlist_Model_Item_Option $option )` Register option code Register option code Parameters `$option` `Mage_Wishlist_Model_Item_Option` $option Returns `Mage_Wishlist_Model_Item`
`protected boolean`	# `_hasModelChanged( )` Checks that item model has data changes. Call save item options if model isn't need to save in DB Checks that item model has data changes. Call save item options if model isn't need to save in DB Returns `boolean` Overrides `Mage_Core_Model_Abstract::_hasModelChanged()`
`protected Mage_Wishlist_Model_Item`	# `_saveItemOptions( )` Save item options Save item options Returns `Mage_Wishlist_Model_Item`
`public Mage_Core_Model_Abstract`	# `save( )` Save model plus its options Ensures saving options in case when resource model was not changed Save model plus its options Ensures saving options in case when resource model was not changed Returns `Mage_Core_Model_Abstract` Overrides `Mage_Core_Model_Abstract::save()`
`protected Mage_Wishlist_Model_Item`	# `_afterSave( )` Save item options after item saved Save item options after item saved Returns `Mage_Wishlist_Model_Item` Overrides `Mage_Core_Model_Abstract::_afterSave()`
`public boolean`	# `validate( )` Validate wish list item data Validate wish list item data Returns `boolean` Throws `Mage_Core_Exception`
`protected Mage_Wishlist_Model_Item`	# `_beforeSave( )` Check required data Check required data Returns `Mage_Wishlist_Model_Item` Overrides `Mage_Core_Model_Abstract::_beforeSave()`
`public Mage_Wishlist_Model_Item`	# `loadByProductWishlist( integer $wishlistId, integer $productId, array $sharedStores )` Load item by product, wishlist and shared stores Load item by product, wishlist and shared stores Parameters `$wishlistId` `integer` $wishlistId `$productId` `integer` $productId `$sharedStores` `array` $sharedStores Returns `Mage_Wishlist_Model_Item`
`public Mage_Catalog_Model_Product`	# `getProduct( )` Retrieve item product instance Retrieve item product instance Returns `Mage_Catalog_Model_Product` Throws `Mage_Core_Exception` Implementation of `Mage_Catalog_Model_Product_Configuration_Item_Interface::getProduct()`
`public boolean`	# `addToCart( Mage_Checkout_Model_Cart $cart, boolean $delete = false )` Add or Move item product to shopping cart Add or Move item product to shopping cart Return true if product was successful added or exception with code Return false for disabled or unvisible products Parameters `$cart` `Mage_Checkout_Model_Cart` $cart `$delete` `boolean` $delete delete the item after successful add to cart Returns `boolean` Throws `Mage_Core_Exception`
`public string`	# `getProductUrl( )` Retrieve Product View Page URL Retrieve Product View Page URL If product has required options add special key to URL Returns `string`
`public Varien_Object`	# `getBuyRequest( )` Returns formatted buy request - object, holding request received from product view page with keys and options for configured product Returns formatted buy request - object, holding request received from product view page with keys and options for configured product Returns `Varien_Object`
`public Mage_Wishlist_Model_Item`	# `mergeBuyRequest( array\|Varien_Object $buyRequest )` Merge data to item info_buyRequest option Merge data to item info_buyRequest option Parameters `$buyRequest` `array\|Varien_Object` $buyRequest Returns `Mage_Wishlist_Model_Item`
`public Mage_Wishlist_Model_Item`	# `setBuyRequest( Varien_Object $buyRequest )` Set buy request - object, holding request received from product view page with keys and options for configured product Set buy request - object, holding request received from product view page with keys and options for configured product Parameters `$buyRequest` `Varien_Object` $buyRequest Returns `Mage_Wishlist_Model_Item`
`public boolean`	# `isRepresent( Mage_Catalog_Model_Product $product, Varien_Object $buyRequest )` Check product representation in item Check product representation in item Parameters `$product` `Mage_Catalog_Model_Product` $product `$buyRequest` `Varien_Object` $buyRequest Returns `boolean`
`public boolean`	# `representProduct( Mage_Catalog_Model_Product $product )` Check product representation in item Check product representation in item Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `boolean`
`public boolean`	# `compareOptions( array $options1, array $options2 )` Check if two options array are identical First options array is prerogative Second options array checked against first one Check if two options array are identical First options array is prerogative Second options array checked against first one Parameters `$options1` `array` $options1 `$options2` `array` $options2 Returns `boolean`
`public Mage_Wishlist_Model_Item`	# `setOptions( array $options )` Initialize item options Initialize item options Parameters `$options` `array` $options Returns `Mage_Wishlist_Model_Item`
`public array`	# `getOptions( )` Get all item options Get all item options Returns `array`
`public array`	# `getOptionsByCode( )` Get all item options as array with codes in array key Get all item options as array with codes in array key Returns `array`
`public Mage_Wishlist_Model_Item`	# `addOption( Mage_Wishlist_Model_Item_Option $option )` Add option to item Add option to item Parameters `$option` `Mage_Wishlist_Model_Item_Option` $option Returns `Mage_Wishlist_Model_Item`
`public Mage_Wishlist_Model_Item`	# `removeOption( string $code )` Remove option from item options Remove option from item options Parameters `$code` `string` $code Returns `Mage_Wishlist_Model_Item`
`public Mage_Wishlist_Model_Item_Option`	# `getOptionByCode( string $code )` Get item option by code Get item option by code Parameters `$code` `string` $code Returns `Mage_Wishlist_Model_Item_Option` \|\| null Implementation of `Mage_Catalog_Model_Product_Configuration_Item_Interface::getOptionByCode()`
`public boolean`	# `canHaveQty( )` Returns whether Qty field is valid for this item Returns whether Qty field is valid for this item Returns `boolean`
`public`	# `getCustomDownloadUrl( )` Get current custom option download url Get current custom option download url
`public`	# `setCustomDownloadUrl( mixed $url )` Sets custom option download url Sets custom option download url
`public null\|Varien_Object`	# `getFileDownloadParams( )` Returns special download params (if needed) for custom option with type = 'file'. Needed to implement Mage_Catalog_Model_Product_Configuration_Item_Interface. Returns special download params (if needed) for custom option with type = 'file'. Needed to implement Mage_Catalog_Model_Product_Configuration_Item_Interface. We have to customize only controller url, so return it. Returns `null\|Varien_Object` Implementation of `Mage_Catalog_Model_Product_Configuration_Item_Interface::getFileDownloadParams()`
`public Mage_Wishlist_Model_Item`	# `loadWithOptions( integer $id, null\|string\|array $optionsFilter = null )` Loads item together with its options (default load() method doesn't load options). If we need to load only some of options, then option code or array of option codes can be provided in $optionsFilter. Loads item together with its options (default load() method doesn't load options). If we need to load only some of options, then option code or array of option codes can be provided in $optionsFilter. Parameters `$id` `integer` $id `$optionsFilter` `null\|string\|array` $optionsFilter Returns `Mage_Wishlist_Model_Item`

Methods inherited from Mage_Core_Model_Abstract
`_afterDelete(), _afterDeleteCommit(), _afterLoad(), _beforeDelete(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), setId()`

Constants summary
`integer`	`EXCEPTION_CODE_NOT_SALABLE`	`901`	#
`integer`	`EXCEPTION_CODE_HAS_REQUIRED_OPTIONS`	`902`	#

Properties summary
`protected string`	`$_customOptionDownloadUrl`	`'wishlist/index/downloadCustomOption'`	# Custom path to download attached file Custom path to download attached file
`protected string`	`$_eventPrefix`	`'wishlist_item'`	# Prefix of model events names Prefix of model events names
`protected string`	`$_eventObject`	`'item'`	# Parameter name in event Parameter name in event In observe method you can use $observer->getEvent()->getItem() in this case
`protected array`	`$_options`	`array()`	# Item options array Item options array
`protected array`	`$_optionsByCode`	`array()`	# Item options by code cache Item options by code cache
`protected array`	`$_notRepresentOptions`	`array('info_buyRequest')`	# Not Represent options Not Represent options
`protected mixed`	`$_flagOptionsSaved`	`null`	# Flag stating that options were successfully saved Flag stating that options were successfully saved

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Class Mage_Wishlist_Model_Item

Parameters

Returns

Returns

Overrides

Parameters

Returns

Parameters

Returns

Returns

Overrides

Returns

Returns

Overrides

Returns

Overrides

Returns

Throws

Returns

Overrides

Parameters

Returns

Returns

Throws

Implementation of

Parameters

Returns

Throws

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Implementation of

Returns

Returns

Implementation of

Parameters

Returns