modules/Import/Importer.php
Classes
\Importer
Package:
Properties
\$bean
$bean= ''
Details
- Type
- \$bean
\ImportFieldSanitizer
$ifs= ''
Details
- Type
- \ImportFieldSanitizer
\importColumns
$importColumns= ''
Details
- Type
- \importColumns
\importSource
$importSource= ''
Details
- Type
- \importSource
\$isUpdateOnly
$isUpdateOnly= ''
Details
- Type
- \$isUpdateOnly
\sugarToExternalSourceFieldMap
$sugarToExternalSourceFieldMap= 'array()'
Default value
array()Details- Type
- \sugarToExternalSourceFieldMap
Methods
__construct(
$importSource, $bean
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $importSource | ||
| $bean |
_convertId(
string $string
)
:
stringclean id's when being imported
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $string | string |
| Type | Description |
|---|---|
| string |
_undoCreatedBeans(
array $ids
)
:
voidIf a bean save is not done for some reason, this method will undo any of the beans that were created
Parameters
| Name | Type | Description |
|---|---|---|
| $ids | array | ids of user_last_import records created |
checkRelatedIDsAfterSave(
$focus
)
:
voidupon bean save, the relationships are saved by SugarBean->save_relationship_changes() method, but those values depend on the request object and is not reliable during import. This function makes sure any defined related or parent id's are processed and their relationship saved.
Parameters
| Name | Type | Description |
|---|---|---|
| $focus |
cloneExistingBean(
$focus
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $focus |
getFieldSanitizer(
)
:
voidgetImportColumns(
)
:
voidgetImportableModules(
)
:
void
static
handleImportErrors(
int $errno, string $errstr, string $errfile, string $errline
)
:
void
static
Replaces PHP error handler in Step4
Parameters
| Name | Type | Description |
|---|---|---|
| $errno | int | |
| $errstr | string | |
| $errfile | string | |
| $errline | string |
import(
)
:
voidimportRow(
$row
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $row |
populateDefaultMapValue(
$field, $fieldValue, $fieldDef
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $field | ||
| $fieldValue | ||
| $fieldDef |
removeDeletedBean(
$focus
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $focus |
retrieveAdvancedMapping(
)
:
voidsanitizeFieldValueByType(
$rowValue, $fieldDef, $defaultRowValue, $focus, $fieldTranslated
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $rowValue | ||
| $fieldDef | ||
| $defaultRowValue | ||
| $focus | ||
| $fieldTranslated |
saveImportBean(
$focus, $newRecord
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $focus | ||
| $newRecord |
saveMappingFile(
)
:
voidsetFieldKeyTranslator(
$translator
)
:
voidSets a translation map from sugar field key to external source key used while importing a row. This allows external sources to return a data set that is an associative array rather than numerically indexed.
Parameters
| Name | Type | Description |
|---|---|---|
| $translator |