Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage_ImportExport_Adminhtml_ExportController
  • Mage_ImportExport_Adminhtml_ImportController
  • Mage_ImportExport_Block_Adminhtml_Export_Edit
  • Mage_ImportExport_Block_Adminhtml_Export_Edit_Form
  • Mage_ImportExport_Block_Adminhtml_Export_Filter
  • Mage_ImportExport_Block_Adminhtml_Import_Edit
  • Mage_ImportExport_Block_Adminhtml_Import_Edit_Form
  • Mage_ImportExport_Block_Adminhtml_Import_Frame_Result
  • Mage_ImportExport_Helper_Data
  • Mage_ImportExport_Model_Abstract
  • Mage_ImportExport_Model_Config
  • Mage_ImportExport_Model_Export
  • Mage_ImportExport_Model_Export_Adapter_Abstract
  • Mage_ImportExport_Model_Export_Adapter_Csv
  • Mage_ImportExport_Model_Export_Entity_Abstract
  • Mage_ImportExport_Model_Export_Entity_Customer
  • Mage_ImportExport_Model_Export_Entity_Product
  • Mage_ImportExport_Model_Export_Entity_Product_Type_Abstract
  • Mage_ImportExport_Model_Export_Entity_Product_Type_Configurable
  • Mage_ImportExport_Model_Export_Entity_Product_Type_Grouped
  • Mage_ImportExport_Model_Export_Entity_Product_Type_Simple
  • Mage_ImportExport_Model_Import
  • Mage_ImportExport_Model_Import_Adapter
  • Mage_ImportExport_Model_Import_Adapter_Abstract
  • Mage_ImportExport_Model_Import_Adapter_Csv
  • Mage_ImportExport_Model_Import_Entity_Abstract
  • Mage_ImportExport_Model_Import_Entity_Customer
  • Mage_ImportExport_Model_Import_Entity_Customer_Address
  • Mage_ImportExport_Model_Import_Entity_Product
  • Mage_ImportExport_Model_Import_Entity_Product_Type_Abstract
  • Mage_ImportExport_Model_Import_Entity_Product_Type_Configurable
  • Mage_ImportExport_Model_Import_Entity_Product_Type_Grouped
  • Mage_ImportExport_Model_Import_Entity_Product_Type_Simple
  • Mage_ImportExport_Model_Import_Proxy_Product
  • Mage_ImportExport_Model_Import_Proxy_Product_Resource
  • Mage_ImportExport_Model_Import_Uploader
  • Mage_ImportExport_Model_Mysql4_Import_Data
  • Mage_ImportExport_Model_Mysql4_Setup
  • Mage_ImportExport_Model_Resource_Import_Data
  • Mage_ImportExport_Model_Resource_Setup
  • Mage_ImportExport_Model_Source_Export_Entity
  • Mage_ImportExport_Model_Source_Export_Format
  • Mage_ImportExport_Model_Source_Import_Behavior
  • Mage_ImportExport_Model_Source_Import_Entity
  • Overview
  • Package
  • Class
  • Tree

Class Mage_ImportExport_Model_Import_Entity_Product

Import entity product model

Mage_ImportExport_Model_Import_Entity_Abstract
Extended by Mage_ImportExport_Model_Import_Entity_Product
Package: Mage\ImportExport
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/ImportExport/Model/Import/Entity/Product.php
Methods summary
public
# __construct( )

Constructor.

Constructor.

Overrides

Mage_ImportExport_Model_Import_Entity_Abstract::__construct()
protected Mage_ImportExport_Model_Import_Entity_Product
# _deleteProducts( )

Delete products.

Delete products.

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected boolean
# _importData( )

Create Product entity from raw data.

Create Product entity from raw data.

Returns

boolean
Result of operation.

Throws

Exception
protected Mage_ImportExport_Model_Import_Entity_Product
# _initAttributeSets( )

Initialize attribute sets code-to-id pairs.

Initialize attribute sets code-to-id pairs.

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected Mage_ImportExport_Model_Import_Entity_Product
# _initCategories( )

Initialize categories text-path to ID hash.

Initialize categories text-path to ID hash.

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected Mage_ImportExport_Model_Import_Entity_Product
# _initCustomerGroups( )

Initialize customer groups.

Initialize customer groups.

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected Mage_ImportExport_Model_Import_Entity_Product
# _initSkus( )

Initialize existent product SKUs.

Initialize existent product SKUs.

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected Mage_ImportExport_Model_Import_Entity_Product
# _initStores( )

Initialize stores hash.

Initialize stores hash.

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected Mage_ImportExport_Model_Import_Entity_Product
# _initTypeModels( )

Initialize product type models.

Initialize product type models.

Returns

Mage_ImportExport_Model_Import_Entity_Product

Throws

Exception
protected Mage_ImportExport_Model_Import_Entity_Product
# _initWebsites( )

Initialize website values.

Initialize website values.

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected boolean
# _isProductCategoryValid( array $rowData, integer $rowNum )

Check product category validity.

Check product category validity.

Parameters

$rowData
array
$rowData
$rowNum
integer
$rowNum

Returns

boolean
protected boolean
# _isProductWebsiteValid( array $rowData, integer $rowNum )

Check product website belonging.

Check product website belonging.

Parameters

$rowData
array
$rowData
$rowNum
integer
$rowNum

Returns

boolean
protected array
# _prepareRowForDb( array $rowData )

Set valid attribute set and product type to rows with all scopes to ensure that existing products doesn't changed.

Set valid attribute set and product type to rows with all scopes to ensure that existing products doesn't changed.

Parameters

$rowData
array
$rowData

Returns

array

Overrides

Mage_ImportExport_Model_Import_Entity_Abstract::_prepareRowForDb()
protected boolean
# _isTierPriceValid( array $rowData, integer $rowNum )

Check tier price data validity.

Check tier price data validity.

Parameters

$rowData
array
$rowData
$rowNum
integer
$rowNum

Returns

boolean
protected boolean
# _isGroupPriceValid( array $rowData, integer $rowNum )

Check group price data validity.

Check group price data validity.

Parameters

$rowData
array
$rowData
$rowNum
integer
$rowNum

Returns

boolean
protected boolean
# _isSuperProductsSkuValid( array $rowData, integer $rowNum )

Check super products SKU

Check super products SKU

Parameters

$rowData
array
$rowData
$rowNum
integer
$rowNum

Returns

boolean
protected Mage_ImportExport_Model_Import_Entity_Product
# _saveCustomOptions( )

Custom options save.

Custom options save.

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected Mage_ImportExport_Model_Import_Entity_Product
# _saveLinks( )

Gather and save information about product links. Must be called after ALL products saving done.

Gather and save information about product links. Must be called after ALL products saving done.

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected Mage_ImportExport_Model_Import_Entity_Product
# _saveProductAttributes( array $attributesData )

Save product attributes.

Save product attributes.

Parameters

$attributesData
array
$attributesData

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected Mage_ImportExport_Model_Import_Entity_Product
# _saveProductCategories( array $categoriesData )

Save product categories.

Save product categories.

Parameters

$categoriesData
array
$categoriesData

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected Mage_ImportExport_Model_Import_Entity_Product
# _saveProductEntity( array $entityRowsIn, array $entityRowsUp )

Update and insert data in entity table.

Update and insert data in entity table.

Parameters

$entityRowsIn
array
$entityRowsIn Row for insert
$entityRowsUp
array
$entityRowsUp Row for update

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected Mage_ImportExport_Model_Import_Entity_Product
# _saveProducts( )

Gather and save information about product entities.

Gather and save information about product entities.

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected Mage_ImportExport_Model_Import_Entity_Product
# _saveProductTierPrices( array $tierPriceData )

Save product tier prices.

Save product tier prices.

Parameters

$tierPriceData
array
$tierPriceData

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected Mage_ImportExport_Model_Import_Entity_Product
# _saveProductGroupPrices( array $groupPriceData )

Save product group prices.

Save product group prices.

Parameters

$groupPriceData
array
$groupPriceData

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected
# _getUploader( )

Returns an object for upload a media files

Returns an object for upload a media files

protected string
# _uploadMediaFiles( string $fileName )

Uploading files into the "catalog/product" media folder. Return a new file name if the same file is already exists.

Uploading files into the "catalog/product" media folder. Return a new file name if the same file is already exists.

Parameters

$fileName
string
$fileName

Returns

string
protected Mage_ImportExport_Model_Import_Entity_Product
# _saveMediaGallery( array $mediaGalleryData )

Save product media gallery.

Save product media gallery.

Parameters

$mediaGalleryData
array
$mediaGalleryData

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected Mage_ImportExport_Model_Import_Entity_Product
# _saveProductWebsites( array $websiteData )

Save product websites.

Save product websites.

Parameters

$websiteData
array
$websiteData

Returns

Mage_ImportExport_Model_Import_Entity_Product
protected Mage_ImportExport_Model_Import_Entity_Product
# _saveStockItem( )

Stock item saving.

Stock item saving.

Returns

Mage_ImportExport_Model_Import_Entity_Product
public array
# getAttrSetIdToName( )

Atttribute set ID-to-name pairs getter.

Atttribute set ID-to-name pairs getter.

Returns

array
public Varien_Db_Adapter_Pdo_Mysql
# getConnection( )

DB connection getter.

DB connection getter.

Returns

Varien_Db_Adapter_Pdo_Mysql
public string
# getEntityTypeCode( )

EAV entity type code getter.

EAV entity type code getter.

Returns

string
public array
# getNewSku( )

New products SKU data.

New products SKU data.

Returns

array
public array|null
# getNextBunch( )

Get next bunch of validatetd rows.

Get next bunch of validatetd rows.

Returns

array|null
public array
# getOldSku( )

Existing products SKU getter.

Existing products SKU getter.

Returns

array
public integer
# getRowScope( array $rowData )

Obtain scope of the row from row data.

Obtain scope of the row from row data.

Parameters

$rowData
array
$rowData

Returns

integer
public array
# getWebsiteCodes( )

All website codes to ID getter.

All website codes to ID getter.

Returns

array
public boolean
# validateRow( array $rowData, integer $rowNum )

Validate data row.

Validate data row.

Parameters

$rowData
array
$rowData
$rowNum
integer
$rowNum

Returns

boolean
public array
# getAffectedEntityIds( )

Get array of affected products

Get array of affected products

Returns

array
Methods inherited from Mage_ImportExport_Model_Import_Entity_Abstract
_getSource(), _isRowScopeDefault(), _saveValidatedBunches(), addMessageTemplate(), addRowError(), getAttributeOptions(), getBehavior(), getEntityTypeId(), getErrorMessages(), getErrorsCount(), getErrorsLimit(), getInvalidRowsCount(), getNotices(), getProcessedEntitiesCount(), getProcessedRowsCount(), getSource(), importData(), isAttributeParticular(), isAttributeValid(), isDataValid(), isImportAllowed(), isRowAllowedToImport(), setParameters(), setSource(), validateData()
Constants summary
string CONFIG_KEY_PRODUCT_TYPES 'global/importexport/import_product_types'
#
integer BUNCH_SIZE 20
#

Size of bunch - part of products to save in one step.

Size of bunch - part of products to save in one step.

string VALUE_ALL 'all'
#

Value that means all entities (e.g. websites, groups etc.)

Value that means all entities (e.g. websites, groups etc.)

integer SCOPE_DEFAULT 1
#

Data row scopes.

Data row scopes.

integer SCOPE_WEBSITE 2
#
integer SCOPE_STORE 0
#
integer SCOPE_NULL -1
#
string COL_STORE '_store'
#

Permanent column names.

Permanent column names.

Names that begins with underscore is not an attribute. This name convention is for to avoid interference with same attribute name.

string COL_ATTR_SET '_attribute_set'
#
string COL_TYPE '_type'
#
string COL_CATEGORY '_category'
#
string COL_ROOT_CATEGORY '_root_category'
#
string COL_SKU 'sku'
#
string ERROR_INVALID_SCOPE 'invalidScope'
#

Error codes.

Error codes.

string ERROR_INVALID_WEBSITE 'invalidWebsite'
#
string ERROR_INVALID_STORE 'invalidStore'
#
string ERROR_INVALID_ATTR_SET 'invalidAttrSet'
#
string ERROR_INVALID_TYPE 'invalidType'
#
string ERROR_INVALID_CATEGORY 'invalidCategory'
#
string ERROR_VALUE_IS_REQUIRED 'isRequired'
#
string ERROR_TYPE_CHANGED 'typeChanged'
#
string ERROR_SKU_IS_EMPTY 'skuEmpty'
#
string ERROR_NO_DEFAULT_ROW 'noDefaultRow'
#
string ERROR_CHANGE_TYPE 'changeProductType'
#
string ERROR_DUPLICATE_SCOPE 'duplicateScope'
#
string ERROR_DUPLICATE_SKU 'duplicateSKU'
#
string ERROR_CHANGE_ATTR_SET 'changeAttrSet'
#
string ERROR_TYPE_UNSUPPORTED 'productTypeUnsupported'
#
string ERROR_ROW_IS_ORPHAN 'rowIsOrphan'
#
string ERROR_INVALID_TIER_PRICE_QTY 'invalidTierPriceOrQty'
#
string ERROR_INVALID_TIER_PRICE_SITE 'tierPriceWebsiteInvalid'
#
string ERROR_INVALID_TIER_PRICE_GROUP 'tierPriceGroupInvalid'
#
string ERROR_TIER_DATA_INCOMPLETE 'tierPriceDataIsIncomplete'
#
string ERROR_INVALID_GROUP_PRICE_SITE 'groupPriceWebsiteInvalid'
#
string ERROR_INVALID_GROUP_PRICE_GROUP 'groupPriceGroupInvalid'
#
string ERROR_GROUP_PRICE_DATA_INCOMPLETE 'groupPriceDataIsIncomplete'
#
string ERROR_SKU_NOT_FOUND_FOR_DELETE 'skuNotFoundToDelete'
#
string ERROR_SUPER_PRODUCTS_SKU_NOT_FOUND 'superProductsSkuNotFound'
#
Constants inherited from Mage_ImportExport_Model_Import_Entity_Abstract
DB_MAX_PACKET_COEFFICIENT, DB_MAX_PACKET_DATA, DB_MAX_TEXT_LENGTH, DB_MAX_VARCHAR_LENGTH
Properties summary
protected array $_attrSetIdToName array()
#

Pairs of attribute set ID-to-name.

Pairs of attribute set ID-to-name.

protected array $_attrSetNameToId array()
#

Pairs of attribute set name-to-ID.

Pairs of attribute set name-to-ID.

protected array $_categories array()
#

Categories text-path to ID hash.

Categories text-path to ID hash.

protected array $_categoriesWithRoots array()
#

Categories text-path to ID hash with roots checking.

Categories text-path to ID hash with roots checking.

protected array $_customerGroups array()
#

Customer groups ID-to-name.

Customer groups ID-to-name.

protected array $_indexValueAttributes array( 'status', 'tax_class_id', 'visibility', 'enable_googlecheckout', 'gift_message_available', 'custom_design' )
#

Attributes with index (not label) value.

Attributes with index (not label) value.

protected array $_linkNameToId array( '_links_related_' => Mage_Catalog_Model_Product_Link::LINK_TYPE_RELATED, '_links_crosssell_' => Mage_Catalog_Model_Product_Link::LINK_TYPE_CROSSSELL, '_links_upsell_' => Mage_Catalog_Model_Product_Link::LINK_TYPE_UPSELL )
#

Links attribute name-to-link type ID.

Links attribute name-to-link type ID.

protected array $_messageTemplates array( self::ERROR_INVALID_SCOPE => 'Invalid value in Scope column', self::ERROR_INVALID_WEBSITE => 'Invalid value in Website column (website does not exists?)', self::ERROR_INVALID_STORE => 'Invalid value in Store column (store does not exists?)', self::ERROR_INVALID_ATTR_SET => 'Invalid value for Attribute Set column (set does not exists?)', self::ERROR_INVALID_TYPE => 'Product Type is invalid or not supported', self::ERROR_INVALID_CATEGORY => 'Category does not exists', self::ERROR_VALUE_IS_REQUIRED => "Required attribute '%s' has an empty value", self::ERROR_TYPE_CHANGED => 'Trying to change type of existing products', self::ERROR_SKU_IS_EMPTY => 'SKU is empty', self::ERROR_NO_DEFAULT_ROW => 'Default values row does not exists', self::ERROR_CHANGE_TYPE => 'Product type change is not allowed', self::ERROR_DUPLICATE_SCOPE => 'Duplicate scope', self::ERROR_DUPLICATE_SKU => 'Duplicate SKU', self::ERROR_CHANGE_ATTR_SET => 'Product attribute set change is not allowed', self::ERROR_TYPE_UNSUPPORTED => 'Product type is not supported', self::ERROR_ROW_IS_ORPHAN => 'Orphan rows that will be skipped due default row errors', self::ERROR_INVALID_TIER_PRICE_QTY => 'Tier Price data price or quantity value is invalid', self::ERROR_INVALID_TIER_PRICE_SITE => 'Tier Price data website is invalid', self::ERROR_INVALID_TIER_PRICE_GROUP => 'Tier Price customer group ID is invalid', self::ERROR_TIER_DATA_INCOMPLETE => 'Tier Price data is incomplete', self::ERROR_SKU_NOT_FOUND_FOR_DELETE => 'Product with specified SKU not found', self::ERROR_SUPER_PRODUCTS_SKU_NOT_FOUND => 'Product with specified super products SKU not found' )
#

Validation failure message template definitions

Validation failure message template definitions

protected array $_newSku array()
#

Dry-runned products information from import file.

Dry-runned products information from import file.

[SKU] => array( 'type_id' => (string) product type 'attr_set_id' => (int) product attribute set ID 'entity_id' => (int) product ID (value for new products will be set after entity save) 'attr_set_code' => (string) attribute set code )

protected array $_oldSku array()
#

Existing products SKU-related information in form of array:

Existing products SKU-related information in form of array:

[SKU] => array( 'type_id' => (string) product type 'attr_set_id' => (int) product attribute set ID 'entity_id' => (int) product ID 'supported_type' => (boolean) is product type supported by current version of import module )

protected array $_particularAttributes array( '_store', '_attribute_set', '_type', self::COL_CATEGORY, self::COL_ROOT_CATEGORY, '_product_websites', '_tier_price_website', '_tier_price_customer_group', '_tier_price_qty', '_tier_price_price', '_links_related_sku', '_group_price_website', '_group_price_customer_group', '_group_price_price', '_links_related_position', '_links_crosssell_sku', '_links_crosssell_position', '_links_upsell_sku', '_links_upsell_position', '_custom_option_store', '_custom_option_type', '_custom_option_title', '_custom_option_is_required', '_custom_option_price', '_custom_option_sku', '_custom_option_max_characters', '_custom_option_sort_order', '_custom_option_file_extension', '_custom_option_image_size_x', '_custom_option_image_size_y', '_custom_option_row_title', '_custom_option_row_price', '_custom_option_row_sku', '_custom_option_row_sort', '_media_attribute_id', '_media_image', '_media_lable', '_media_position', '_media_is_disabled' )
#

Column names that holds values with particular meaning.

Column names that holds values with particular meaning.

protected array $_imagesArrayKeys array( '_media_image', 'image', 'small_image', 'thumbnail' )
#

Column names that holds images files names

Column names that holds images files names

protected array $_permanentAttributes array(self::COL_SKU)
#

Permanent entity columns.

Permanent entity columns.

protected array $_productTypeModels array()
#

Array of supported product types as keys with appropriate model object as value.

Array of supported product types as keys with appropriate model object as value.

protected array $_storeCodeToId array()
#

All stores code-ID pairs.

All stores code-ID pairs.

protected array $_storeIdToWebsiteStoreIds array()
#

Store ID to its website stores IDs.

Store ID to its website stores IDs.

protected array $_websiteCodeToId array()
#

Website code-to-ID

Website code-to-ID

protected array $_websiteCodeToStoreIds array()
#

Website code to store code-to-ID pairs which it consists.

Website code to store code-to-ID pairs which it consists.

protected Mage_ImportExport_Model_Import_Uploader $_fileUploader
#

Media files uploader

Media files uploader

Properties inherited from Mage_ImportExport_Model_Import_Entity_Abstract
$_connection, $_dataSourceModel, $_dataValidated, $_entityTypeId, $_errors, $_errorsCount, $_errorsLimit, $_importAllowed, $_invalidRows, $_notices, $_parameters, $_processedEntitiesCount, $_processedRowsCount, $_rowsToSkip, $_source, $_uniqueAttributes, $_validatedRows
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0