mattwire
Advanced Import

Repository

civix generate:module myextension
/**
 * Implements hook_civicrm_advimport_helpers()
 */
function myextension_civicrm_advimport_helpers(&$helpers) {
  $helpers[] = [
    'class' => 'CRM_Myextension_Advimport_Example',
    'label' => E::ts('Example data'),
    'type' => '[see below]',
  ];
}
<?php

use CRM_Myextension_ExtensionUtil as E;

class CRM_Myextension_Advimport_Example extends CRM_Advimport_Helper_PHPExcel {

  /**
   * Returns a human-readable name for this helper.
   */
  function getHelperLabel() {
    return E::ts("MyExtension - Example import");
  }

  /**
   * By default, a field mapping will be shown, but unless you have defined
   * one in getMapping() - example later below - you may want to skip it.
   * Displaying it is useful for debugging at first.
   */
  function mapfieldMethod() {
    return 'skip';
  }

  /**
   * Import an item gotten from the queue.
   *
   * This is where, in custom PHP import scripts, you would program all
   * the logic on how to handle imports the old fashioned way.
   */
  function processItem($params) {
    // At some point, we will have automatic validation on 'mandatory'
    // and validation rule (positive, string, etc).
    if (empty($params['custom_11'])) {
      throw new Exception("Favourite Colour is a mandatory field.");
    }

    if ($params['custom_11'] == 'Rainbow') {
      // Logs a warning, to flag entries for review
      // (you could also manually add a group/tag or create an activity, depending on your workflow,
      // but very often, admins just want a quick way to glance over some types of changes)
      CRM_Advimport_Utils::logImportWarning($params, "Verify that the contact has a Unicorn Certification 2.0");
    }

    // This example import expects the contact to exist already,
    // so if it's not the case, we need to flag it as an error.
    // Exceptions are caught by advimport, and admins can later review.
    $contact = civicrm_api3('Contact', 'getsingle', [
      'external_identifier' => $params['external_identifier'],
      'return.id' => 1,
      'return.custom_11' => 1,
    ]);

    if ($contact['custom_11'] != $params['custom_11']) {
      civicrm_api3('Contact', 'create', [
        'id' => $contact['id'],
        'custom_11' => $params['custom_11'],
      ]);

      // As a design choice for this example importer, we are adding contacts
      // to a group/tag (depending on the admin's choice when they started the
      // import) only if they had data that has changed.
      CRM_Advimport_Utils::addContactToGroupOrTag($contact['id'], $params);
    }

    // This associates the imported row with the contact that we matched on.
    // If we had created a contact, we would have used the `$result['id']` from
    // the Contact.create above.
    // This is optional and only to help with debugging. It helps to know which
    // contact was matched, so that we can quickly manually double-check the changes.
    CRM_Advimport_Utils::setEntityTableAndId($params, 'civicrm_contact', $contact['id']);
  }

}
  /**
   * Available fields.
   */
  function getMapping(&$form) {
    $map = [
      'external_identifier' => [
        'label' => 'External ID',
        'field' => 'external_identifier',
      ],
      'custom_11' => [
        'label' => 'Favourite Colour',
        'field' => 'custom_11',
      ],
      'date' => [
        'label' => 'Start Date',
        'field' => 'date',
        'aliases' => ['Date'],
        'description' => 'The start date in format d/m/Y',
        // If true, it allows the user to bulk update this field from the 'review data' interface
        'bulk_update' => true,
      ],
    ];

    return $map;
  }
[
   <key> => [
     'label' => <label>,
     'field' => <field>,
     'aliases' => [<alias>, ...]
   ]
]
[
  'first_name' => [ 'label' => 'First Name', 'field' => 'first_name', 'aliases' => ['Given Name'] ],
]
  /**
   * Available fields.
   */
  function getMapping(&$form) {
    $map = parent::getMapping($form);

    $map['external_identifier']['label'] = 'External ID';
    $map['external_identifier']['aliases'] = ['DonorID'];

    unset($map['not_relevant_field']);

    return $map;
  }
  /**
   * Post-import
   *
   * As the name implies, this is called after the import has
   * finished running. It is added as an item on the queue.
   * A use-case for this, could be to cleaup/tag leftover data after
   * an import (assuming the import linked the entity_ids with
   * each row, then you could check which entities were not updated).
   *
   * The params include the advimport_id, so you can lookup any
   * necessary data (such as the table_name) in there.
   */
  function postImport($params) {

  }
class CRM_Myextension_Advimport_MembershipRenewal extends CRM_Advimport_Helper_SearchBatchUpdate {

  public function getDataFromQuery($contact_ids = []) {
    $values = [];

    // Fetch the data from a Custom Search (which defines our columns)
    $search = new CRM_Myextension_Search_Form_Member($values);
    $sql = $search->all(0);
    $sql .= ' AND contact_a.id IN (' . implode($contact_ids, ',') . ')';

    $dao = CRM_Core_DAO::executeQuery($sql);

    $data = $dao->fetchAll();
    $headers = array_keys($data[0]);

    // Still not sure if this should be done systematically or leave it to the implementation
    foreach ($data as &$row) {
      $search->alterRow($row);
    }

    return [$headers, $data];
  }

  public function processItem($params) {
    // import implementation
  }

}