Class Mage_ImportExport_Model_Import_Entity_Abstract

Import entity abstract model

Direct known subclasses

Mage_ImportExport_Model_Import_Entity_Customer, Mage_ImportExport_Model_Import_Entity_Customer_Address, Mage_ImportExport_Model_Import_Entity_Product

Abstract
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/Abstract.php

Methods summary
`public`	# `__construct( )` Constructor. Constructor.
`protected Mage_ImportExport_Model_Import_Adapter_Abstract`	# `_getSource( )` Inner source object getter. Inner source object getter. Returns `Mage_ImportExport_Model_Import_Adapter_Abstract`
`abstract protected boolean`	# `_importData( )` Import data rows. Import data rows. Returns `boolean`
`protected boolean`	# `_isRowScopeDefault( array $rowData )` Returns boolean TRUE if row scope is default (fundamental) scope. Returns boolean TRUE if row scope is default (fundamental) scope. Parameters `$rowData` `array` $rowData Returns `boolean`
`protected array`	# `_prepareRowForDb( array $rowData )` Change row data before saving in DB table. Change row data before saving in DB table. Parameters `$rowData` `array` $rowData Returns `array`
`protected Mage_ImportExport_Model_Import_Entity_Abstract`	# `_saveValidatedBunches( )` Validate data rows and save bunches to DB. Validate data rows and save bunches to DB. Returns `Mage_ImportExport_Model_Import_Entity_Abstract`
`public Mage_ImportExport_Model_Import_Adapter_Abstract`	# `addRowError( string $errorCode, integer $errorRowNum, string $colName = null )` Add error with corresponding current data source row number. Add error with corresponding current data source row number. Parameters `$errorCode` `string` $errorCode Error code or simply column name `$errorRowNum` `integer` $errorRowNum Row number. `$colName` `string` $colName OPTIONAL Column name. Returns `Mage_ImportExport_Model_Import_Adapter_Abstract`
`public Mage_ImportExport_Model_Import_Entity_Abstract`	# `addMessageTemplate( string $errorCode, string $message )` Add message template for specific error code from outside. Add message template for specific error code from outside. Parameters `$errorCode` `string` $errorCode Error code `$message` `string` $message Message template Returns `Mage_ImportExport_Model_Import_Entity_Abstract`
`public array`	# `getAttributeOptions( Mage_Eav_Model_Entity_Attribute_Abstract $attribute, array $indexValAttrs = array() )` Returns attributes all values in label-value or value-value pairs form. Labels are lower-cased. Returns attributes all values in label-value or value-value pairs form. Labels are lower-cased. Parameters `$attribute` `Mage_Eav_Model_Entity_Attribute_Abstract` $attribute `$indexValAttrs` `array` $indexValAttrs OPTIONAL Additional attributes' codes with index values. Returns `array`
`public string`	# `getBehavior( )` Import behavior getter. Import behavior getter. Returns `string`
`abstract public string`	# `getEntityTypeCode( )` EAV entity type code getter. EAV entity type code getter. Returns `string`
`public integer`	# `getEntityTypeId( )` Entity type ID getter. Entity type ID getter. Returns `integer`
`public array`	# `getErrorMessages( )` Returns error information grouped by error types and translated (if possible). Returns error information grouped by error types and translated (if possible). Returns `array`
`public integer`	# `getErrorsCount( )` Returns error counter value. Returns error counter value. Returns `integer`
`public integer`	# `getErrorsLimit( )` Returns error limit value. Returns error limit value. Returns `integer`
`public integer`	# `getInvalidRowsCount( )` Returns invalid rows count. Returns invalid rows count. Returns `integer`
`public array`	# `getNotices( )` Returns model notices. Returns model notices. Returns `array`
`public integer`	# `getProcessedEntitiesCount( )` Returns number of checked entities. Returns number of checked entities. Returns `integer`
`public integer`	# `getProcessedRowsCount( )` Returns number of checked rows. Returns number of checked rows. Returns `integer`
`public Mage_ImportExport_Model_Import_Adapter_Abstract`	# `getSource( )` Source object getter. Source object getter. Returns `Mage_ImportExport_Model_Import_Adapter_Abstract` Throws `Exception`
`public boolean`	# `importData( )` Import process start. Import process start. Returns `boolean` Result of operation.
`public boolean`	# `isAttributeParticular( string $attrCode )` Is attribute contains particular data (not plain entity attribute). Is attribute contains particular data (not plain entity attribute). Parameters `$attrCode` `string` $attrCode Returns `boolean`
`public boolean`	# `isAttributeValid( string $attrCode, array $attrParams, array $rowData, integer $rowNum )` Check one attribute. Can be overridden in child. Check one attribute. Can be overridden in child. Parameters `$attrCode` `string` $attrCode Attribute code `$attrParams` `array` $attrParams Attribute params `$rowData` `array` $rowData Row data `$rowNum` `integer` $rowNum Returns `boolean`
`public boolean`	# `isDataValid( )` Is all of data valid? Is all of data valid? Returns `boolean`
`public boolean`	# `isImportAllowed( )` Import possibility getter. Import possibility getter. Returns `boolean`
`public boolean`	# `isRowAllowedToImport( array $rowData, integer $rowNum )` Returns TRUE if row is valid and not in skipped rows array. Returns TRUE if row is valid and not in skipped rows array. Parameters `$rowData` `array` $rowData `$rowNum` `integer` $rowNum Returns `boolean`
`abstract public boolean`	# `validateRow( array $rowData, integer $rowNum )` Validate data row. Validate data row. Parameters `$rowData` `array` $rowData `$rowNum` `integer` $rowNum Returns `boolean`
`public Mage_ImportExport_Model_Import_Entity_Abstract`	# `setParameters( array $params )` Set data from outside to change behavior. I.e. for setting some default parameters etc. Set data from outside to change behavior. I.e. for setting some default parameters etc. Parameters `$params` `array` $params Returns `Mage_ImportExport_Model_Import_Entity_Abstract`
`public Mage_ImportExport_Model_Import_Entity_Abstract`	# `setSource( Mage_ImportExport_Model_Import_Adapter_Abstract $source )` Source model setter. Source model setter. Parameters `$source` `Mage_ImportExport_Model_Import_Adapter_Abstract` $source Returns `Mage_ImportExport_Model_Import_Entity_Abstract`
`public Mage_ImportExport_Model_Import_Entity_Abstract`	# `validateData( )` Validate data. Validate data. Returns `Mage_ImportExport_Model_Import_Entity_Abstract` Throws `Exception`

Constants summary
`integer`	`DB_MAX_PACKET_COEFFICIENT`	`900000`	# Database constants Database constants
`integer`	`DB_MAX_PACKET_DATA`	`1048576`	#
`integer`	`DB_MAX_VARCHAR_LENGTH`	`256`	#
`integer`	`DB_MAX_TEXT_LENGTH`	`65536`	#

Properties summary
`protected Varien_Adapter_Interface`	`$_connection`		# DB connection. DB connection.
`protected boolean`	`$_dataValidated`	`false`	# Has data process validation done? Has data process validation done?
`protected Mage_ImportExport_Model_Mysql4_Import_Data`	`$_dataSourceModel`		# DB data source model. DB data source model.
`protected integer`	`$_entityTypeId`		# Entity type id. Entity type id.
`protected array`	`$_errors`	`array()`	# Error codes with arrays of corresponding row numbers. Error codes with arrays of corresponding row numbers.
`protected integer`	`$_errorsCount`	`0`	# Error counter. Error counter.
`protected integer`	`$_errorsLimit`	`100`	# Limit of errors after which pre-processing will exit. Limit of errors after which pre-processing will exit.
`protected boolean`	`$_importAllowed`	`true`	# Flag to disable import. Flag to disable import.
`protected array`	`$_indexValueAttributes`	`array()`	# Attributes with index (not label) value. Attributes with index (not label) value.
`protected array`	`$_invalidRows`	`array()`	# Array of invalid rows numbers. Array of invalid rows numbers.
`protected array`	`$_messageTemplates`	`array()`	# Validation failure message template definitions. Validation failure message template definitions.
`protected array`	`$_notices`	`array()`	# Notice messages. Notice messages.
`protected array`	`$_parameters`	`array()`	# Entity model parameters. Entity model parameters.
`protected array`	`$_particularAttributes`	`array()`	# Column names that holds values with particular meaning. Column names that holds values with particular meaning.
`protected array`	`$_permanentAttributes`	`array()`	# Permanent entity columns. Permanent entity columns.
`protected integer`	`$_processedEntitiesCount`	`0`	# Number of entities processed by validation. Number of entities processed by validation.
`protected integer`	`$_processedRowsCount`	`0`	# Number of rows processed by validation. Number of rows processed by validation.
`protected array`	`$_rowsToSkip`	`array()`	# Rows to skip. Valid rows but we have some reasons to skip them. Rows to skip. Valid rows but we have some reasons to skip them. [Row number 1] => true, ... [Row number N] => true
`protected array`	`$_validatedRows`	`array()`	# Array of numbers of validated rows as keys and boolean TRUE as values. Array of numbers of validated rows as keys and boolean TRUE as values.
`protected Mage_ImportExport_Model_Import_Adapter_Abstract`	`$_source`		# Source model. Source model.
`protected array`	`$_uniqueAttributes`	`array()`	# Array of unique attributes Array of unique attributes

Packages

Classes

Class Mage_ImportExport_Model_Import_Entity_Abstract

Direct known subclasses

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Throws

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Throws