class RelationsImportSettings in CRM Core 7

Hierarchy

• class \CRMCoreDataImportSettings
  • class \RelationsImportSettingsBase
    • class \RelationsImportSettings

1 string reference to 'RelationsImportSettings'

RelationsImportSettings.inc in modules/crm_core_data_import/plugins/settings/RelationsImportSettings.inc

File

modules/crm_core_data_import/plugins/settings/RelationsImportSettings.inc, line 14

class RelationsImportSettings extends RelationsImportSettingsBase {

  /**
   * Returns TRUE if conditions match for settings.
   */
  public function displayConditions($importer) {
    $active = FALSE;
    $settings = $importer
      ->getSettings();

    // If enabled crm_core_relationship module and source plugin not CivicrmDataSourceHandler.
    if (module_exists('crm_core_relationship') && !is_a($importer->source_plugin, 'CivicrmDataSourceHandler')) {
      $entities = $this
        ->entityList($settings);
      foreach ($entities as $entity_info) {
        if ($entity_info['entity_type'] == 'crm_core_contact') {
          $active = TRUE;
        }
      }
    }
    return $active;
  }

  /**
   * Performs when import was successful.
   */
  public function postImport($importer, $item) {
    $settings = $importer
      ->getSettings();
    if (!empty($settings['relations']['enable']) && !empty($settings['relations']['fields']) && !is_a($importer->source_plugin, 'CivicrmDataSourceHandler')) {
      $list = $importer->source_plugin
        ->getEntitiesForRelationships($settings['relations'], $item, $importer);

      // Process list of the related entities.
      foreach ($list as $item2) {
        if (empty($item2['source_entity']->id) || empty($item2['destination_entity']->id)) {

          // throw an error if one or more of the entities are missing
          $message = 'Error importing relationships: The entity ID for the source or destination cannot be found.<br>';
          $message .= 'Process Name: "@title"<br>Relationship Importer: "@importer"<br>Source ID: "@source"<br>Destination ID: "@destination"';
          watchdog(t('CRM Core Data Import'), t($message), $variables = array(
            '@title' => $importer->title,
            '@importer' => $importer->source,
            '@source' => $item2['source_entity']->id,
            '@destination' => $item2['destination_entity']->id,
          ), $severity = WATCHDOG_ERROR);
        }
        else {
          $this
            ->createRelation($item2['source_entity'], $item2['destination_entity'], $item2['plugin_data']['relation_type']);
        }
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CRMCoreDataImportSettings::cleanFormValues	public	function	Clear form values.
CRMCoreDataImportSettings::entityList	public	function	List of entities.
CRMCoreDataImportSettings::getMatchMappingEntity	public	function	Returns entity from mapping which match to entity type and bundle.
CRMCoreDataImportSettings::preImport	public	function	Pre import handler.	1
RelationsImportSettings::displayConditions	public	function	Returns TRUE if conditions match for settings. Overrides CRMCoreDataImportSettings::displayConditions
RelationsImportSettings::postImport	public	function	Performs when import was successful. Overrides CRMCoreDataImportSettings::postImport
RelationsImportSettingsBase::configForm	public	function	Configuration form for settings plugin. Overrides CRMCoreDataImportSettings::configForm	1
RelationsImportSettingsBase::configFormSubmit	public	function	Submission handler for configForm(). Overrides CRMCoreDataImportSettings::configFormSubmit	1
RelationsImportSettingsBase::configFormValidate	public	function	Validation handler for configForm(). Overrides CRMCoreDataImportSettings::configFormValidate	1
RelationsImportSettingsBase::createRelation	public	function	Create relation between contacts.
RelationsImportSettingsBase::formAttachFieldRelation	public	function	Attach one relation field to form.
RelationsImportSettingsBase::formAttachRelations	public	function	Attach relation fields to form.
RelationsImportSettingsBase::getAvailableRelations	public	function	Build a list of available relations relevant to current settings.
RelationsImportSettingsBase::relationExists	public	function	Check if a relation exists between two contacts.