Class Mage_Catalog_Model_Product_Type_Abstract

Abstract model for product type implementation

Direct known subclasses

Mage_Bundle_Model_Product_Type, Mage_Catalog_Model_Product_Type_Configurable, Mage_Catalog_Model_Product_Type_Grouped, Mage_Catalog_Model_Product_Type_Simple, Mage_Catalog_Model_Product_Type_Virtual

Indirect known subclasses

Mage_Downloadable_Model_Product_Type

Abstract
Package: Mage\Catalog
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/Catalog/Model/Product/Type/Abstract.php

Methods summary
`public Mage_Catalog_Model_Product_Type_Abstract`	# `setProduct( Mage_Catalog_Model_Product $product )` Specify type instance product Specify type instance product Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `Mage_Catalog_Model_Product_Type_Abstract`
`public Mage_Catalog_Model_Product_Type_Abstract`	# `setTypeId( string $typeId )` Specify type identifier Specify type identifier Parameters `$typeId` `string` $typeId Returns `Mage_Catalog_Model_Product_Type_Abstract`
`public Mage_Catalog_Model_Product`	# `getProduct( Mage_Catalog_Model_Product $product = null )` Retrieve catalog product object Retrieve catalog product object Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `Mage_Catalog_Model_Product`
`public Varien_Object`	# `getRelationInfo( )` Return relation info about used products for specific type instance Return relation info about used products for specific type instance Returns `Varien_Object` Object with information data
`public array`	# `getChildrenIds( integer $parentId, boolean $required = true )` Retrieve Required children ids Return grouped array, ex array( group => array(ids) ) Retrieve Required children ids Return grouped array, ex array( group => array(ids) ) Parameters `$parentId` `integer` $parentId `$required` `boolean` $required Returns `array`
`public array`	# `getParentIdsByChild( integer\|array $childId )` Retrieve parent ids array by requered child Retrieve parent ids array by requered child Parameters `$childId` `integer\|array` $childId Returns `array`
`public array`	# `getSetAttributes( Mage_Catalog_Model_Product $product = null )` Get array of product set attributes Get array of product set attributes Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `array`
`public integer`	# `attributesCompare( Mage_Catalog_Model_Entity_Attribute $attribute1, Mage_Catalog_Model_Entity_Attribute $attribute2 )` Compare attribues sorting Compare attribues sorting Parameters `$attribute1` `Mage_Catalog_Model_Entity_Attribute` $attribute1 `$attribute2` `Mage_Catalog_Model_Entity_Attribute` $attribute2 Returns `integer`
`public array`	# `getEditableAttributes( Mage_Catalog_Model_Product $product = null )` Retrieve product type attributes Retrieve product type attributes Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `array`
`public Mage_Eav_Model_Entity_Attribute_Abstract`	# `getAttributeById( integer $attributeId, mixed $product = null )` Retrieve product attribute by identifier Retrieve product attribute by identifier Parameters `$attributeId` `integer` $attributeId `$product` Returns `Mage_Eav_Model_Entity_Attribute_Abstract`
`public boolean`	# `isVirtual( Mage_Catalog_Model_Product $product = null )` Check is virtual product Check is virtual product Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `boolean`
`public boolean`	# `isSalable( Mage_Catalog_Model_Product $product = null )` Check is product available for sale Check is product available for sale Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `boolean`
`protected array\|string`	# `_prepareProduct( Varien_Object $buyRequest, Mage_Catalog_Model_Product $product, string $processMode )` Prepare product and its configuration to be added to some products list. Perform standard preparation process and then prepare options belonging to specific product type. Prepare product and its configuration to be added to some products list. Perform standard preparation process and then prepare options belonging to specific product type. Parameters `$buyRequest` `Varien_Object` $buyRequest `$product` `Mage_Catalog_Model_Product` $product `$processMode` `string` $processMode Returns `array\|string`
`public array\|string`	# `processConfiguration( Varien_Object $buyRequest, Mage_Catalog_Model_Product $product = null, string $processMode = Mage_Catalog_Model_Product_Type_Abstract::PROCESS_MODE_LITE )` Process product configuaration Process product configuaration Parameters `$buyRequest` `Varien_Object` $buyRequest `$product` `Mage_Catalog_Model_Product` $product `$processMode` `string` $processMode Returns `array\|string`
`public array\|string`	# `prepareForCartAdvanced( Varien_Object $buyRequest, Mage_Catalog_Model_Product $product = null, null\|string $processMode = null )` Initialize product(s) for add to cart process. Advanced version of func to prepare product for cart - processMode can be specified there. Initialize product(s) for add to cart process. Advanced version of func to prepare product for cart - processMode can be specified there. Parameters `$buyRequest` `Varien_Object` $buyRequest `$product` `Mage_Catalog_Model_Product` $product `$processMode` `null\|string` $processMode Returns `array\|string`
`public array\|string`	# `prepareForCart( Varien_Object $buyRequest, Mage_Catalog_Model_Product $product = null )` Initialize product(s) for add to cart process Initialize product(s) for add to cart process Parameters `$buyRequest` `Varien_Object` $buyRequest `$product` `Mage_Catalog_Model_Product` $product Returns `array\|string`
`public Mage_Catalog_Model_Product_Type_Abstract`	# `processFileQueue( )` Process File Queue Process File Queue Returns `Mage_Catalog_Model_Product_Type_Abstract`
`public`	# `addFileQueue( array $queueOptions )` Add file to File Queue Add file to File Queue Parameters `$queueOptions` `array` $queueOptions Array of File Queue (eg. ['operation'=>'move', 'src_name'=>'filename', 'dst_name'=>'filename2'])
`protected boolean`	# `_isStrictProcessMode( string $processMode )` Check if current process mode is strict Check if current process mode is strict Parameters `$processMode` `string` $processMode Returns `boolean`
`public string`	# `getSpecifyOptionMessage( )` Retrieve message for specify option(s) Retrieve message for specify option(s) Returns `string`
`protected array`	# `_prepareOptions( Varien_Object $buyRequest, Mage_Catalog_Model_Product $product, string $processMode )` Process custom defined options for product Process custom defined options for product Parameters `$buyRequest` `Varien_Object` $buyRequest `$product` `Mage_Catalog_Model_Product` $product `$processMode` `string` $processMode Returns `array`
`public Mage_Catalog_Model_Product_Type_Abstract`	# `checkProductBuyState( Mage_Catalog_Model_Product $product = null )` Check if product can be bought Check if product can be bought Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `Mage_Catalog_Model_Product_Type_Abstract` Throws `Mage_Core_Exception`
`public array`	# `getOrderOptions( Mage_Catalog_Model_Product $product = null )` Prepare additional options/information for order item which will be created from this product Prepare additional options/information for order item which will be created from this product Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `array`
`public Mage_Catalog_Model_Product_Type_Abstract`	# `save( Mage_Catalog_Model_Product $product = null )` Save type related data Save type related data Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `Mage_Catalog_Model_Product_Type_Abstract`
`protected`	# `_removeNotApplicableAttributes( Mage_Catalog_Model_Product $product = null )` Remove don't applicable attributes data Remove don't applicable attributes data Parameters `$product` `Mage_Catalog_Model_Product` $product
`public Mage_Catalog_Model_Product_Type_Abstract`	# `beforeSave( Mage_Catalog_Model_Product $product = null )` Before save type related data Before save type related data Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `Mage_Catalog_Model_Product_Type_Abstract`
`public boolean`	# `isComposite( Mage_Catalog_Model_Product $product = null )` Check if product is composite (grouped, configurable, etc) Check if product is composite (grouped, configurable, etc) Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `boolean`
`public boolean`	# `canConfigure( Mage_Catalog_Model_Product $product = null )` Check if product is configurable Check if product is configurable Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `boolean`
`public boolean`	# `canUseQtyDecimals( )` Check if product qty is fractional number Check if product qty is fractional number Returns `boolean`
`public string`	# `getSku( Mage_Catalog_Model_Product $product = null )` Default action to get sku of product Default action to get sku of product Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `string`
`public string`	# `getOptionSku( Mage_Catalog_Model_Product $product = null, string $sku = '' )` Default action to get sku of product with option Default action to get sku of product with option Parameters `$product` `Mage_Catalog_Model_Product` $product Product with Custom Options `$sku` `string` $sku Product SKU without option Returns `string`
`public decimal`	# `getWeight( Mage_Catalog_Model_Product $product = null )` Default action to get weight of product Default action to get weight of product Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `decimal`
`public boolean`	# `hasOptions( Mage_Catalog_Model_Product $product = null )` Return true if product has options Return true if product has options Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `boolean`
`public object`	# `updateQtyOption( array $options, Varien_Object $option, mixed $value, mixed $product = null )` Method is needed for specific actions to change given configuration options values according current product type logic Example: the cataloginventory validation of decimal qty can change qty to int, so need to change configuration item qty option value too. Method is needed for specific actions to change given configuration options values according current product type logic Example: the cataloginventory validation of decimal qty can change qty to int, so need to change configuration item qty option value too. Parameters `$options` `array` $options `$option` `Varien_Object` $option `$value` `mixed` $value `$product` Returns `object` Mage_Catalog_Model_Product_Type_Abstract
`public boolean`	# `hasRequiredOptions( Mage_Catalog_Model_Product $product = null )` Check if product has required options Check if product has required options Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `boolean`
`public integer\|Mage_Core_Model_Store`	# `getStoreFilter( mixed $product = null )` Retrive store filter for associated products Retrive store filter for associated products Returns `integer\|Mage_Core_Model_Store`
`public Mage_Catalog_Model_Product_Type_Configurable`	# `setStoreFilter( mixed $store = null, mixed $product = null )` Set store filter for associated products Set store filter for associated products Parameters `$store` `mixed` $store int\|Mage_Core_Model_Store `$product` Returns `Mage_Catalog_Model_Product_Type_Configurable`
`public boolean`	# `getForceChildItemQtyChanges( mixed $product = null )` Allow for updates of chidren qty's (applicable for complicated product types. As default returns false) Allow for updates of chidren qty's (applicable for complicated product types. As default returns false) Returns `boolean` false
`public float`	# `prepareQuoteItemQty( mixed $qty, mixed $product = null )` Prepare Quote Item Quantity Prepare Quote Item Quantity Parameters `$qty` `mixed` $qty `$product` Returns `float`
`public Mage_Catalog_Model_Product_Type_Abstract`	# `assignProductToOption( Mage_Catalog_Model_Product $optionProduct, Mage_Sales_Model_Quote_Item_Option $option, Mage_Catalog_Model_Product $product = null )` Implementation of product specify logic of which product needs to be assigned to option. For example if product which was added to option already removed from catalog. Implementation of product specify logic of which product needs to be assigned to option. For example if product which was added to option already removed from catalog. Parameters `$optionProduct` `Mage_Catalog_Model_Product` $optionProduct `$option` `Mage_Sales_Model_Quote_Item_Option` $option `$product` `Mage_Catalog_Model_Product` $product Returns `Mage_Catalog_Model_Product_Type_Abstract`
`public Mage_Catalog_Model_Product_Type_Abstract`	# `setConfig( array $config )` Setting specified product type variables Setting specified product type variables Parameters `$config` `array` $config Returns `Mage_Catalog_Model_Product_Type_Abstract`
`public array`	# `getSearchableData( Mage_Catalog_Model_Product $product = null )` Retrieve additional searchable data from type instance Using based on product id and store_id data Retrieve additional searchable data from type instance Using based on product id and store_id data Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `array`
`public array`	# `getProductsToPurchaseByReqGroups( Mage_Catalog_Model_Product $product = null )` Retrieve products divided into groups required to purchase At least one product in each group has to be purchased Retrieve products divided into groups required to purchase At least one product in each group has to be purchased Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `array`
`public array`	# `processBuyRequest( Mage_Catalog_Model_Product $product, Varien_Object $buyRequest )` Prepare selected options for product Prepare selected options for product Parameters `$product` `Mage_Catalog_Model_Product` $product `$buyRequest` `Varien_Object` $buyRequest Returns `array`
`public array`	# `checkProductConfiguration( Mage_Catalog_Model_Product $product, Varien_Object $buyRequest )` Check product's options configuration Check product's options configuration Parameters `$product` `Mage_Catalog_Model_Product` $product `$buyRequest` `Varien_Object` $buyRequest Returns `array`
`public boolean`	# `isMapEnabledInOptions( Mage_Catalog_Model_Product $product, integer $visibility = null )` Check if Minimum advertise price is enabled at least in one option Check if Minimum advertise price is enabled at least in one option Parameters `$product` `Mage_Catalog_Model_Product` $product `$visibility` `integer` $visibility Returns `boolean`

Constants summary
`integer`	`CALCULATE_CHILD`	`0`	#
`integer`	`CALCULATE_PARENT`	`1`	#
`integer`	`SHIPMENT_SEPARATELY`	`1`	# values for shipment type (invoice etc) values for shipment type (invoice etc)
`integer`	`SHIPMENT_TOGETHER`	`0`	#
`string`	`PROCESS_MODE_FULL`	`'full'`	# Process modes Process modes Full validation - all required options must be set, whole configuration must be valid
`string`	`PROCESS_MODE_LITE`	`'lite'`	# Process modes Process modes Lite validation - only received options are validated
`string`	`OPTION_PREFIX`	`'option_'`	# Item options prefix Item options prefix

Properties summary
`protected string`	`$_typeId`		# Product type instance id Product type instance id
`protected boolean`	`$_isComposite`	`false`	# Is a composite product type Is a composite product type
`protected boolean`	`$_canConfigure`	`false`	# Is a configurable product type Is a configurable product type
`protected boolean`	`$_canUseQtyDecimals`	`true`	# Whether product quantity is fractional number or not Whether product quantity is fractional number or not
`protected array`	`$_fileQueue`	`array()`	# File queue array File queue array

Packages

Classes

Interfaces

Class Mage_Catalog_Model_Product_Type_Abstract

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters