abstract class CRMCoreDataSourceHandler in CRM Core 7
@file Default source handler for CRM Core Data Import
Hierarchy
- class \CRMCoreDataSourceHandler
Expanded class hierarchy of CRMCoreDataSourceHandler
File
- modules/
crm_core_data_import/ plugins/ source/ CRMCoreDataSourceHandler.inc, line 7 - Default source handler for CRM Core Data Import
View source
abstract class CRMCoreDataSourceHandler {
public $sourceMapping = FALSE;
public $settings;
/**
* Configuration form for source plugin.
*
* @param array $form
* Form elements.
*
* @param array $form_state
* Form state.
*
* @param array $settings
* Source plugin settings.
*/
public abstract function configForm(&$form, &$form_state, $settings);
/**
* Validation handler for configForm().
*/
public abstract function configFormValidate(&$form, &$form_state, $settings);
/**
* Submission handler for configForm().
*/
public abstract function configFormSubmit(&$form, &$form_state, $settings);
/**
* Configuration form for source mapping.
*/
public function sourceMappingForm(&$form, &$form_state, $settings) {
}
/**
* Validation handler for sourceMappingForm().
*/
public function sourceMappingFormValidate(&$form, &$form_state, $settings) {
}
/**
* Submission handler for sourceMappingForm().
*/
public function sourceMappingFormSubmit(&$form, &$form_state, $settings) {
}
/**
* Returns available fields for mapping.
*/
public abstract function getFields($settings);
/**
* Returns MigrationSource instance.
*/
public abstract function migrateSource($settings, $entity_type, $entity_bundle, $mapping);
/**
* Returns related list entities from migration results for relationships.
*/
public abstract function getEntitiesForRelationships($settings, $item, $importer);
/**
* Returns related list entities from migration results for references.
*/
public abstract function getEntitiesForReferences($settings, $item, $importer);
/**
* Returns related list entities from migration results for users.
*/
public abstract function getEntitiesForUsers($settings, $item, $importer);
/**
* Alter for field mapping form.
*/
public function fieldMappingFormAlter(&$form, &$form_state) {
}
/**
* Alter for source fields on the mapping form.
*/
public function mappingSourceFieldsAlter(&$fields, $entity_type, $entity_bundle, $importer) {
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CRMCoreDataSourceHandler:: |
public | property | ||
CRMCoreDataSourceHandler:: |
public | property | 1 | |
CRMCoreDataSourceHandler:: |
abstract public | function | Configuration form for source plugin. | 2 |
CRMCoreDataSourceHandler:: |
abstract public | function | Submission handler for configForm(). | 2 |
CRMCoreDataSourceHandler:: |
abstract public | function | Validation handler for configForm(). | 2 |
CRMCoreDataSourceHandler:: |
public | function | Alter for field mapping form. | |
CRMCoreDataSourceHandler:: |
abstract public | function | Returns related list entities from migration results for references. | 2 |
CRMCoreDataSourceHandler:: |
abstract public | function | Returns related list entities from migration results for relationships. | 2 |
CRMCoreDataSourceHandler:: |
abstract public | function | Returns related list entities from migration results for users. | 2 |
CRMCoreDataSourceHandler:: |
abstract public | function | Returns available fields for mapping. | 2 |
CRMCoreDataSourceHandler:: |
public | function | Alter for source fields on the mapping form. | 1 |
CRMCoreDataSourceHandler:: |
abstract public | function | Returns MigrationSource instance. | 2 |
CRMCoreDataSourceHandler:: |
public | function | Configuration form for source mapping. | 1 |
CRMCoreDataSourceHandler:: |
public | function | Submission handler for sourceMappingForm(). | 1 |
CRMCoreDataSourceHandler:: |
public | function | Validation handler for sourceMappingForm(). | 1 |