Class Shop_Item_Import_Csv_Controller

Import Csv Controller

Доступные методы:

encoding('UTF-8') кодировка импорта
file('my.csv') имя импортируемого CSV-файла, который ранее был загружен во временную директорию
seek($int) позиция в файле импорта
time(20) ограничение времени импорта за шаг, из конфигурационного файла, по умолчанию 20
step(100) ограничение количества импортируемых за шаг, из конфигурационного файла, по умолчанию 100
entriesLimit(500) ограничение количества проводок в документе, из конфигурационного файла, по умолчанию 5000
separator($str) разделитель столбцов в CSV-файле, по умолчанию ';'
limiter() ограничитель строки в CSV-файле, по умолчанию '"'
firstlineheader(TRUE|FALSE) первая строка - название полей
csv_fields(array) массив соответствий полей CSV сущностям системы HostCMS
imagesPath($str) путь к импортируемым картинкам, конкатенируется с переденными в файле
importAction($int) действие с существующими товарами: 1 - обновить существующие товары, 2 - не обновлять существующие товары, 3 - удалить содержимое магазина до импорта. По умолчанию 1
searchIndexation(TRUE|FALSE) индексировать импортируемые данные, по умолчанию FALSE
deletePropertyValues(TRUE|FALSE|array()) удалять существующие значения дополнительных свойств перед импортом новых, по умолчанию TRUE
deleteUnsentModificationsByProperties(TRUE|FALSE) удалять непереданные модификации, созданные по дополнительным свойствам, по умолчанию FALSE
deleteImage(TRUE|FALSE) удалять основные изображения

Shop_Item_Import_Csv_Controller

Package: HostCMS\Shop
Copyright: © 2005-2021 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru
Author: Hostmake LLC
Version: 6.x
Located at shop/item/import/csv/controller.php

Methods summary

`public integer`	# `getInsertedItemsCount( )` Get inserted items count Get inserted items count Returns integer
`public integer`	# `getInsertedGroupsCount( )` Get inserted groups count Get inserted groups count Returns integer
`public integer`	# `getUpdatedItemsCount( )` Get updated items count Get updated items count Returns integer
`public integer`	# `getUpdatedGroupsCount( )` Get updated groups count Get updated groups count Returns integer
`protected Shop_Item_Import_Csv_Controller`	# `_incInsertedGroups( integer $iGroupId )` Increment inserted groups Increment inserted groups Parameters `$iGroupId` group ID Returns `Shop_Item_Import_Csv_Controller`
`protected Shop_Item_Import_Csv_Controller`	# `_incUpdatedGroups( integer $iGroupId )` Increment updated groups Increment updated groups Parameters `$iGroupId` group ID Returns `Shop_Item_Import_Csv_Controller`
`protected Shop_Item_Import_Csv_Controller`	# `_incInsertedItems( integer $iItemId )` Increment inserted items Increment inserted items Parameters `$iItemId` item ID Returns `Shop_Item_Import_Csv_Controller`
`protected Shop_Item_Import_Csv_Controller`	# `_incUpdatedItems( integer $iItemId )` Increment updated items Increment updated items Parameters `$iItemId` item ID Returns `Shop_Item_Import_Csv_Controller`
`protected Shop_Item_Import_Csv_Controller`	# `init( )` Initialization Initialization Returns `Shop_Item_Import_Csv_Controller`
`public Shop_Model`	# `getCurrentShop( )` Get $this->_oCurrentShop Get $this->_oCurrentShop Returns `Shop_Model` $oCurrentShop
`public Shop_Item_Import_Csv_Controller`	# `setCurrentItem( Shop_Item_Model $oCurrentItem )` Set $this->_oCurrentItem Set $this->_oCurrentItem Parameters `$oCurrentItem` Returns `Shop_Item_Import_Csv_Controller`
`public Shop_Item_Model`	# `getCurrentItem( )` Get $this->_oCurrentItem Get $this->_oCurrentItem Returns `Shop_Item_Model`
`public Shop_Item_Import_Csv_Controller`	# `setCurrentOrder( Shop_Order_Model $oCurrentOrder )` Set $this->_oCurrentOrder Set $this->_oCurrentOrder Parameters `$oCurrentOrder` Returns `Shop_Item_Import_Csv_Controller`
`public Shop_Order_Model`	# `getCurrentOrder( )` Get $this->_oCurrentOrder Get $this->_oCurrentOrder Returns `Shop_Order_Model`
`public`	# `__construct( integer $iCurrentShopId, integer $iCurrentGroupId = 0 )` Constructor. Constructor. Parameters `$iCurrentShopId` shop ID `$iCurrentGroupId` current group ID Hostcms-event Shop_Item_Import_Csv_Controller.onAfterConstruct Overrides `Core_Servant_Properties::__construct`
`protected`	# `_addEntitiesOfProperties( $prefix, $color, $parent_id = 0, $level = 0 )`
`public`	# `addField( string $caption, string $color, string $entityName )` Add Field Add Field Parameters `$caption` `$color` color, e.g. #AAA `$entityName` entity name, e.g. seller_name
`public`	# `addFieldAsArray( string $entityName, array $aField )` Add Field Add Field Parameters `$entityName` entity name, e.g. seller_name `$aField` entity option, e.g. array('caption' => 'Seller Name', 'attr' => array('style' => 'background-color: #AAA'))
`protected Shop_Group`	# `_doSaveGroup( Shop_Group_Model $oShop_Group )` Save group Save group Parameters `$oShop_Group` group Returns Shop_Group
`protected`	# `_uploadHttpFile( $sSourceFile )`
`public string`	# `getFilePath( )` Get the full path of the CSV file Get the full path of the CSV file Returns string
`public boolean`	# `deleteUploadedFile( )` Delete uploaded CSV file Delete uploaded CSV file Returns boolean
`public`	# `import( )` Импорт CSV Импорт CSV Hostcms-event Shop_Item_Import_Csv_Controller.onBeforeImport Shop_Item_Import_Csv_Controller.onAfterImport Shop_Item_Import_Csv_Controller.onBeforeSwitch Shop_Item_Import_Csv_Controller.onBeforeFindByMarking Shop_Item_Import_Csv_Controller.onAfterFindByMarking Shop_Item_Import_Csv_Controller.onBeforeAdminUpload Shop_Item_Import_Csv_Controller.onBeforeImportItemProperty Shop_Item_Import_Csv_Controller.onBeforeCaseDefault Shop_Item_Import_Csv_Controller.onBeforeAssociated Shop_Item_Import_Csv_Controller.onAfterImportItem
`protected Shop_Item_Import_Csv_Controller`	# `_allowPropertyForGroup( Property_Model $oProperty, integer $shop_group_id )` Allow Property For Group Allow Property For Group Parameters `$oProperty` `$shop_group_id` Returns `Shop_Item_Import_Csv_Controller`
`protected Shop_Item_Import_Csv_Controller`	# `_setPrices( Shop_Item_Model $oShop_Item )` Set Prices by $this->_aExternalPrices Set Prices by $this->_aExternalPrices Parameters `$oShop_Item` Returns `Shop_Item_Import_Csv_Controller`
`protected`	# `_clearWhileLoop( )`
`protected`	# `_addItemPropertyValue( Shop_Item_Model $oShopItem, Property_Model $oProperty, string $sPropertyValue, $position = 0 )` Add property to item Add property to item Parameters `$oShopItem` item `$oProperty` `$sPropertyValue` property value `$position` Hostcms-event Shop_Item_Import_Csv_Controller.onAddItemPropertyValueDefault
`protected`	# `_addGroupPropertyValue( Shop_Group_Model $oShop_Group, Property_Model $oProperty, string $sPropertyValue, $position = 0 )` Add property to group Add property to group Parameters `$oShop_Group` `$oProperty` `$sPropertyValue` property value `$position` Hostcms-event Shop_Item_Import_Csv_Controller.onBeforeImportGroupProperty Shop_Item_Import_Csv_Controller.onAddGroupPropertyValueDefault
`protected array`	# `_getTags( )` Get cached tags of array Get cached tags of array Returns array
`public string`	# `__toString( )` Convert object to string Convert object to string Returns string Overrides `Core_Servant_Properties::__toString`
`public array`	# `getCSVLine( handler $fileDescriptor )` Get CSV line from file Get CSV line from file Parameters `$fileDescriptor` descriptor Returns array
`public Shop_Item_Import_Csv_Controller`	# `clear( )` Clear object Clear object Returns `Shop_Item_Import_Csv_Controller`
`public array`	# `__sleep( )` Execute some routine before serialization Execute some routine before serialization Returns array
`public Shop_Item_Import_Csv_Controller`	# `__wakeup( )` Reestablish any database connections that may have been lost during serialization and perform other reinitialization tasks Reestablish any database connections that may have been lost during serialization and perform other reinitialization tasks Returns `Shop_Item_Import_Csv_Controller`
`public`	# `getPosted( )`
`protected`	# `_getInventory( $shop_warehouse_id )`
`protected`	# `_getPriceSetting( )`
`public`	# `postAll( )`
`public`	# `postNext( )`
`public static array`	# `CorrectToEncoding( array $sLine, string $encodeTo, string $encodeFrom = 'UTF-8' )` Correct CSV-line encoding Correct CSV-line encoding Deprecated 6.9.7 Parameters `$sLine` current CSV-file line `$encodeTo` detination encoding `$encodeFrom` source encoding Returns array

Methods inherited from Core_Servant_Properties

__call(), __get(), __isset(), __set(), addAllowedProperties(), addAllowedProperty(), set(), setUnlimitedProperties()

Properties summary

`protected array`	`$_aInsertedGroupIDs` Array of inserted groups Array of inserted groups	# `array()`
`protected array`	`$_aClearedItemsPropertyValues` Array of ID's and GUIDs of cleared item's properties Array of ID's and GUIDs of cleared item's properties	# `array()`
`protected array`	`$_aClearedGroupsPropertyValues` Array of ID's and GUIDs of cleared groups's properties Array of ID's and GUIDs of cleared groups's properties	# `array()`
`protected array`	`$_aUpdatedGroupIDs` Array of updated groups Array of updated groups	# `array()`
`protected array`	`$_aInsertedItemIDs` Array of inserted items Array of inserted items	# `array()`
`protected array`	`$_aUpdatedItemIDs` Array of updated items Array of updated items	# `array()`
`protected integer`	`$_iCurrentShopId` ID of current shop ID of current shop	# `0`
`protected integer`	`$_iCurrentGroupId` ID of current group ID of current group	# `0`
`protected Shop_Model`	`$_oCurrentShop` Current shop Current shop	#
`protected Shop_Group_Model`	`$_oCurrentGroup` Current group Current group	#
`protected Shop_Item_Model`	`$_oCurrentItem` Current item Current item	#
`protected Shop_Item_Model`	`$_oCurrentOrder` Current order Current order	#
`protected Shop_Order_Item_Model`	`$_oCurrentOrderItem` Current order item Current order item	#
`protected string`	`$_sCurrentTags` Current tags Current tags	#
`protected string`	`$_sAssociatedItemMark` Mark of associated item Артикул родительского товара - признак того, что данный товар сопутствует товару с данным артикулом Mark of associated item Артикул родительского товара - признак того, что данный товар сопутствует товару с данным артикулом	#
`protected Shop_Item_Digital_Model`	`$_oCurrentShopEItem` Current digital item Текущий электронный товар Current digital item Текущий электронный товар	#
`protected Shop_Specialprice_Model`	`$_oCurrentShopSpecialPrice` Current special price Текущая специальная цена для товара Current special price Текущая специальная цена для товара	#
`protected array`	`$_aExternalPrices` List of external prices Вспомогательные массивы данных List of external prices Вспомогательные массивы данных	# `array()`
`protected array`	`$_aWarehouses` List of warehouses List of warehouses	# `array()`
`protected array`	`$_aExternalProperties` List of goods' external properties List of goods' external properties	# `array()`
`protected array`	`$_aExternalPropertiesSmall` List of small parts of external properties List of small parts of external properties	# `array()`
`protected array`	`$_aExternalPropertiesDesc` List of descriptions of external properties List of descriptions of external properties	# `array()`
`protected array`	`$_aGroupExternalProperties` List of group's external properties List of group's external properties	# `array()`
`protected array`	`$_aModificationsByProperties` List of modification by properties List of modification by properties	# `array()`
`protected array`	`$_aAdditionalGroups` List of additional group List of additional group	# `array()`
`protected array`	`$_aBarcodes` List of barcodes List of barcodes	# `array()`
`protected array`	`$_aSets` List of items GUID in the set List of items GUID in the set	# `array()`
`protected array`	`$_aItemTabs` List of item's tabs List of item's tabs	# `array()`
`protected null\|string`	`$_jsonPath` Path to the temprorary json file Path to the temprorary json file	# `NULL`
`protected array`	`$_aPropertiesTree`	# `array()`
`protected array`	`$_aPropertyDirsTree`	# `array()`
`protected array`	`$_allowedProperties` Allowed object properties Allowed object properties	# `array( 'encoding', 'file', 'seek', 'time', 'step', 'entriesLimit', 'separator', 'limiter', 'firstlineheader', 'csv_fields', 'imagesPath', 'importAction', 'searchIndexation', 'deletePropertyValues', 'deleteUnsentModificationsByProperties', 'deleteImage' )`
`protected integer`	`$_InsertedItemsCount` Count of inserted items Count of inserted items	#
`protected integer`	`$_UpdatedItemsCount` Count of updated items Count of updated items	#
`protected integer`	`$_InsertedGroupsCount` Count of inserted groups Count of inserted groups	#
`protected integer`	`$_UpdatedGroupsCount` Count of updated groups Count of updated groups	#
`protected string`	`$_sBigImageFile` Path of the big image Path of the big image	# `''`
`protected string`	`$_sSmallImageFile` Path of the small image Path of the small image	# `''`
`protected array`	`$_aCreatedItemIDs` IDs of created shop_items IDs of created shop_items	# `array()`
`protected array`	`$_aConfig` CSV config CSV config	# `NULL`
`protected`	`$_aTags` Array of cached tags Array of cached tags	# `NULL`
`public array`	`$aEntities`	# `array()`
`protected integer`	`$_posted`	# `0`
`protected array`	`$_aShop_Warehouse_Inventory_Ids`	# `array()`
`protected array`	`$_aShop_Warehouse_Inventory_Counts`	# `array()`
`protected array`	`$_aShop_Warehouse_Inventory_Previous_Ids`	# `array()`
`protected`	`$_oShop_Price_Setting_Id`	# `NULL`
`protected`	`$_oShop_Price_Setting_Count`	# `NULL`
`protected array`	`$_oShop_Price_Setting_Previous_Ids`	# `array()`

Properties inherited from Core_Servant_Properties

$_propertiesValues, $_unlimitedProperties

Classes

Exceptions

Functions

Class Shop_Item_Import_Csv_Controller

Methods summary

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Hostcms-event

Overrides

Parameters

Parameters

Parameters

Returns

Returns

Returns

Hostcms-event

Parameters

Returns

Parameters

Returns

Parameters

Hostcms-event

Parameters

Hostcms-event

Returns

Returns

Overrides

Parameters

Returns

Returns

Returns

Returns

Deprecated

Parameters

Returns

Methods inherited from Core_Servant_Properties

Properties summary

Properties inherited from Core_Servant_Properties