node = $node;
$this->settings = $node->webform_civicrm;
$this->data = $this->settings['data'];
$this->enabled = wf_crm_enabled_fields($node);
$this->all_fields = wf_crm_get_fields();
$this->all_sets = wf_crm_get_fields('sets');
}
/**
* This is first called during form validation. We create an instance of this object and stash it in a static variable.
* It is destroyed and rebuilt between each page submission, but after (successful) validation of the final page,
* this cache allows the object instance to persist throughout (final) validate, preSave and postSave operations.
* @param stdClass $node
* @return wf_crm_webform_postprocess
*/
static function singleton($node) {
if (!self::$singleton) {
self::$singleton = new wf_crm_webform_postprocess($node);
}
return self::$singleton;
}
/**
* Called after a webform is submitted
* Or, for a multipage form, called after each page
* @param array $form
* @param array $form_state (reference)
*/
public function validate($form, &$form_state) {
$this->form = $form;
$this->form_state = &$form_state;
$this->rawValues = _webform_client_form_submit_flatten($this->node, wf_crm_aval($this->form_state, 'values:submitted'));
$this->crmValues = wf_crm_enabled_fields($this->node, $this->rawValues);
// Even though this object is destroyed between page submissions, this trick allows us to persist some data - see below
$this->ent = wf_crm_aval($form_state, 'civicrm:ent', array());
$this->hiddenFieldValidation();
$this->validateThisPage($this->form['submitted']);
if (!empty($this->data['participant']) && !empty($this->data['participant_reg_type'])) {
$this->loadMultiPageData();
$this->validateParticipants();
}
// Process live contribution. If the transaction is unsuccessful it will trigger a form validation error.
if ($this->contribution_page) {
// Ensure contribution js is still loaded if the form has to refresh
$this->addPaymentJs();
$this->loadMultiPageData();
if ($this->tallyLineItems()) {
if ($this->isLivePaymentProcessor() && $this->isPaymentPage() && !form_get_errors()) {
if ($this->validateBillingFields()) {
if ($this->createBillingContact()) {
$this->submitLivePayment();
}
}
}
}
}
// Even though this object is destroyed between page submissions, this trick allows us to persist some data - see above
$form_state['civicrm']['ent'] = $this->ent;
$form_state['civicrm']['line_items'] = $this->line_items;
}
/**
* Process webform submission when it is about to be saved. Called by the following hook:
* @see webform_civicrm_webform_submission_presave
* @param stdClass $submission
*/
public function preSave(&$submission) {
$this->submission = &$submission;
$this->data = $this->settings['data'];
// Check for existing submission
$this->setUpdateParam();
// Fill $this->id from existing contacts
$this->getExistingContactIds();
// While saving a draft, just skip to postSave and write the record
if (!empty($this->submission->is_draft)) {
return;
}
$this->fillDataFromSubmission();
// Create/update contacts
foreach ($this->data['contact'] as $c => $contact) {
if (empty($this->ent['contact'][$c]['id'])) {
// Don't create contact if we don't have a name or email
if ($this->isContactEmpty($contact)) {
$this->ent['contact'][$c]['id'] = 0;
continue;
}
$this->ent['contact'][$c]['id'] = $this->findDuplicateContact($contact);
}
// Current employer must wait for ContactRef ids to be filled
unset($contact['contact'][1]['employer_id']);
$newContact = empty($this->ent['contact'][$c]['id']);
// Create new contact
if ($newContact) {
$this->ent['contact'][$c]['id'] = $this->createContact($contact);
}
if ($c == 1) {
$this->setLoggingContact();
}
// Update existing contact
if (!$newContact) {
$this->updateContact($contact, $c);
}
}
// $this->ent['contact'] will now contain all contacts in order, with 0 as a placeholder id for any contact not saved
ksort($this->ent['contact']);
// Once all contacts are saved we can fill contact ref fields
$this->fillContactRefs();
// Save a non-live transaction
if (empty($this->ent['contribution'][1]['id']) && $this->totalContribution) {
$this->createDeferredPayment();
}
// Create/update other data associated with contacts
foreach ($this->data['contact'] as $c => $contact) {
$cid = $this->ent['contact'][$c]['id'];
if (!$cid) {
continue;
}
$this->saveCurrentEmployer($contact, $cid);
$this->saveCustomData($contact, $cid, 'Contact', !empty($this->existing_contacts[$c]));
$this->fillHiddenContactFields($cid, $c);
$this->saveContactLocation($contact, $cid, $c);
$this->saveGroupsAndTags($contact, $cid, $c);
// Process relationships
foreach (wf_crm_aval($contact, 'relationship', array()) as $n => $params) {
$relationship_type_id = wf_crm_aval($params, 'relationship_type_id');
if ($relationship_type_id) {
foreach ((array) $relationship_type_id as $params['relationship_type_id']) {
$this->processRelationship($params, $cid, $this->ent['contact'][$n]['id']);
}
}
}
// Process event participation
if (isset($this->all_sets['participant']) && !empty($this->data['participant_reg_type'])) {
$this->processParticipants($c, $cid);
}
}
// We do this after all contacts and addresses exist
$this->processSharedAddresses();
// Process memberships after relationships have been created
foreach ($this->ent['contact'] as $c => $contact) {
if ($contact['id'] && isset($this->all_sets['membership']) && !empty($this->data['membership'][$c]['number_of_membership'])) {
$this->processMemberships($c, $contact['id']);
}
}
}
/**
* Process webform submission after it is has been saved. Called by the following hooks:
* @see webform_civicrm_webform_submission_insert
* @see webform_civicrm_webform_submission_update
* @param stdClass $submission
*/
public function postSave($submission) {
$this->submission = $submission;
if (empty($this->submission->is_draft)) {
// Save cases
if (!empty($this->data['case']['number_of_case'])) {
$this->processCases();
}
// Save activities
if (!empty($this->data['activity']['number_of_activity'])) {
$this->processActivities();
}
// Save grants
if (isset($this->data['grant']['number_of_grant'])) {
$this->processGrants();
}
// Save contribution custom data & line-items
if (!empty($this->ent['contribution'][1]['id'])) {
$this->processContribution();
}
}
// Write record; we do this when creating, updating, or saving a draft of a webform submission.
$record = $this->formatSubmission();
drupal_write_record('webform_civicrm_submissions', $record, $this->update);
// Calling an IPN payment processor will result in a redirect so this happens after everything else
if (empty($this->submission->is_draft) && !empty($this->ent['contribution'][1]['id']) && $this->contributionIsIncomplete && !$this->contributionIsPayLater) {
$this->submitIPNPayment();
}
// Send receipt
if (empty($this->submission->is_draft)
&& !empty($this->ent['contribution'][1]['id'])
&& !empty($this->contribution_page['is_email_receipt'])
&& (!$this->contributionIsIncomplete || $this->contributionIsPayLater) ) {
$this->sendReceipt();
}
}
/**
* Send receipt
*/
private function sendReceipt(){
// tax integration
if (!is_null($this->tax_rate)) {
$template = CRM_Core_Smarty::singleton();
$template->assign('dataArray', array( "{$this->tax_rate}" => $this->tax_rate/100 ));
}
if ($this->contributionIsIncomplete) {
$template = CRM_Core_Smarty::singleton();
$template->assign('is_pay_later', 1);
}
$contribute_id = $this->ent['contribution'][1]['id'];
wf_civicrm_api('contribution', 'sendconfirmation', array('id' => $contribute_id) + $this->contribution_page);
}
/**
* Formats submission data as expected by the schema
*/
private function formatSubmission() {
$data = $this->ent;
unset($data['contact']);
$record = array(
'sid' => $this->submission->sid,
'contact_id' => '-',
'civicrm_data' => $data,
);
foreach ($this->ent['contact'] as $contact) {
$record['contact_id'] .= $contact['id'] . '-';
}
return $record;
}
/**
* Force Drupal to ignore errors for fields hidden by this module
*/
private function hiddenFieldValidation() {
$errors = form_get_errors();
foreach ((array) $errors as $key => $error) {
$pieces = wf_crm_explode_key(substr($key, strrpos($key, '][') + 2));
if ($pieces) {
list( , $c, $ent, $n, $table, $name) = $pieces;
if ($this->isFieldHiddenByExistingContactSettings($ent, $c, $table, $n, $name)) {
$this->unsetError($key);
}
elseif ($table == 'address' && !empty($this->crmValues["civicrm_{$c}_contact_{$n}_address_master_id"])) {
$master_id = $this->crmValues["civicrm_{$c}_contact_{$n}_address_master_id"];
// If widget is checkboxes, need to filter the array
if (!is_array($master_id) || array_filter($master_id)) {
$this->unsetError($key);
}
}
}
}
}
/**
* Recursive validation callback for webform page submission
*
* @param array $elements
* FAPI form array
*/
private function validateThisPage($elements) {
// Recurse through form elements.
foreach (element_children($elements) as $key) {
if (is_array($elements[$key]) && ($element = $elements[$key])) {
$this->validateThisPage($elements[$key]);
if (!empty($element['#civicrm_data_type'])
&& substr(wf_crm_aval($element, '#type', ''), 0, 4) === 'text'
&& isset($element['#value'])
&& $element['#value'] !== '') {
$dt = $element['#civicrm_data_type'];
// Validate state/prov abbreviation
if ($dt == 'state_province_abbr') {
$ckey = str_replace('state_province', 'country', $key);
if (!empty($this->crmValues[$ckey]) && is_numeric($this->crmValues[$ckey])) {
$country_id = $this->crmValues[$ckey];
}
else {
$config = CRM_Core_Config::singleton();
$country_id = $config->defaultContactCountry;
}
$states = wf_crm_get_states($country_id);
if ($states && !array_key_exists(strtoupper($element['#value']), $states)) {
$countries = wf_crm_apivalues('address', 'getoptions', array('field' => 'country_id'));
form_error($element, t('Mismatch: "@state" is not a state/province of %country. Please enter a valid state/province abbreviation for %field.', array('@state' => $element['#value'], '%country' => $countries[$country_id], '%field' => $element['#title'])));
}
}
// Strings and files don't need any validation
elseif ($dt !== 'String' && $dt !== 'Memo' && $dt !== 'File'
&& CRM_Utils_Type::escape($element['#value'], $dt, FALSE) === NULL) {
// Allow data type names to be translated
switch ($dt) {
case 'Int':
$dt = t('an integer');
break;
case 'Float':
$dt = t('a number');
break;
case 'Link':
$dt = t('a web address starting with http://');
break;
case 'Money':
$dt = t('a currency value');
break;
}
form_error($element, t('Please enter @type for %field.', array('@type' => $dt, '%field' => $element['#title'])));
}
}
}
}
}
/**
* Validate event participants and add line items
*/
private function validateParticipants() {
// If we have no valid contacts on the form, don't bother continuing
if (!$this->existing_contacts) {
return;
}
$count = $this->data['participant_reg_type'] == 'all' ? count($this->existing_contacts) : 1;
// Collect selected events
foreach ($this->data['participant'] as $c => $par) {
if ($this->data['participant_reg_type'] == 'all') {
$contacts = $this->existing_contacts;
}
elseif (isset($this->existing_contacts[$c])) {
$contacts = array($this->existing_contacts[$c]);
}
else {
continue;
}
foreach (wf_crm_aval($par, 'participant', array()) as $n => $p) {
foreach (array_filter(wf_crm_aval($p, 'event_id', array())) as $id_and_type) {
list($eid) = explode('-', $id_and_type);
if (is_numeric($eid)) {
$this->events[$eid]['ended'] = TRUE;
$this->events[$eid]['title'] = t('this event');
$this->events[$eid]['count'] = wf_crm_aval($this->events, "$eid:count", 0) + $count;
if (!empty($p['fee_amount'])) {
$this->line_items[] = array(
'qty' => $count,
'entity_table' => 'civicrm_participant',
'event_id' => $eid,
'contact_ids' => $contacts,
'unit_price' => $p['fee_amount'],
'element' => "civicrm_{$c}_participant_{$n}_participant_{$id_and_type}",
);
}
}
}
}
}
// Subtract events already registered for - this only works with known contacts
$cids = array_filter($this->existing_contacts);
if ($this->events && $cids) {
$dao = CRM_Core_DAO::executeQuery("SELECT event_id, contact_id
FROM civicrm_participant p, civicrm_participant_status_type s
WHERE s.id = p.status_id AND s.is_counted = 1
AND event_id IN (" . implode(',', array_keys($this->events)) . ")
AND contact_id IN (" . implode(',', $cids) . ")
AND is_test = 0");
while ($dao->fetch()) {
if (isset($this->events[$dao->event_id])) {
if (!(--$this->events[$dao->event_id]['count'])) {
unset($this->events[$dao->event_id]);
}
}
foreach ($this->line_items as $k => &$item) {
if ($dao->event_id == $item['event_id'] && in_array($dao->contact_id, $item['contact_ids'])) {
unset($this->line_items[$k]['contact_ids'][array_search($dao->contact_id, $item['contact_ids'])]);
if (!(--$item['qty'])) {
unset($this->line_items[$k]);
}
}
}
}
$dao->free();
}
$this->loadEvents();
// Add event info to line items
$format = wf_crm_aval($this->data['reg_options'], 'title_display', 'title');
foreach ($this->line_items as &$item) {
$item['label'] = wf_crm_format_event($this->events[$item['event_id']], $format);
$item['financial_type_id'] = wf_crm_aval($this->events[$item['event_id']], 'financial_type_id', 'Event Fee');
}
// Form Validation
if (!empty($this->data['reg_options']['validate'])) {
foreach ($this->events as $eid => $event) {
if ($event['ended']) {
form_set_error($eid, t('Sorry, you can no longer register for %event.', array('%event' => $event['title'])));
}
elseif ($event['max_participants'] && $event['count'] > $event['remaining']) {
if (!empty($event['full'])) {
form_set_error($eid, '' . $event['title'] . ': ' . $event['full_message']);
}
else {
form_set_error($eid, format_plural($event['remaining'],
'Sorry, you tried to register !count people for %event but there is only 1 space remaining.',
'Sorry, you tried to register !count people for %event but there are only @count spaces remaining.',
array('%event' => $event['title'], '!count' => $event['count'])));
}
}
}
}
}
/**
* Load entire webform submission during validation, including contact ids and $this->data
* Used when validation for one page needs access to submitted values from other pages
*/
private function loadMultiPageData() {
if (!$this->multiPageDataLoaded) {
$this->multiPageDataLoaded = TRUE;
if (!empty($this->form_state['storage']['submitted'])
&& wf_crm_aval($this->form_state, 'storage:page_num', 1) > 1)
{
$this->rawValues += $this->form_state['storage']['submitted'];
$this->crmValues = wf_crm_enabled_fields($this->node, $this->rawValues);
}
// Check how many valid contacts we have
foreach ($this->data['contact'] as $c => $contact) {
// Check if we have a contact_id
$fid = "civicrm_{$c}_contact_1_contact_existing";
if ($this->verifyExistingContact(wf_crm_aval($this->crmValues, $fid), $fid)) {
$this->existing_contacts[$c] = $this->crmValues[$fid];
}
// Or else see if enough info was entered to create a contact - use 0 as a placeholder for unknown cid
elseif (wf_crm_name_field_exists($this->crmValues, $c, $contact['contact'][1]['contact_type'])) {
$this->existing_contacts[$c] = 0;
}
}
// Fill data array with submitted form values
$this->fillDataFromSubmission();
}
}
/**
* If this is an update op, set param for drupal_write_record()
*/
private function setUpdateParam() {
if (!empty($this->submission->sid)) {
$submitted = array($this->submission->sid => new stdClass());
webform_civicrm_webform_submission_load($submitted);
if (isset($submitted[$this->submission->sid]->civicrm)) {
$this->update = 'sid';
}
}
}
/**
* Fetch contact ids from "existing contact" fields
*/
private function getExistingContactIds() {
foreach ($this->enabled as $field_key => $fid) {
if (substr($field_key, -8) == 'existing') {
list(, $c, ) = explode('_', $field_key, 3);
$cid = wf_crm_aval($this->submissionValue($fid), 0);
$this->ent['contact'][$c]['id'] = $this->verifyExistingContact($cid, $field_key);
if ($this->ent['contact'][$c]['id']) {
$this->existing_contacts[$c] = $cid;
}
}
}
}
/**
* Ensure we have a valid contact id in a contact ref field
* @param $cid
* @param $fid
* @return int
*/
private function verifyExistingContact($cid, $fid) {
if (wf_crm_is_positive($cid) && !empty($this->enabled[$fid])) {
module_load_include('inc', 'webform_civicrm', 'includes/contact_component');
$component = $this->getComponent($fid);
$filters = wf_crm_search_filters($this->node, $component);
// Verify access to this contact
if (wf_crm_contact_access($component, $filters, $cid) !== FALSE) {
return $cid;
}
}
return 0;
}
/**
* Check if at least one required field was filled for a contact
* @param array $contact
* @return bool
*/
private function isContactEmpty($contact) {
$contact_type = $contact['contact'][1]['contact_type'];
foreach (wf_crm_required_contact_fields($contact_type) as $f) {
if (!empty($contact[$f['table']][1][$f['name']])) {
return FALSE;
}
}
return TRUE;
}
/**
* Search for an existing contact using default strict rule
* @param array $contact
* @return int
*/
private function findDuplicateContact($contact) {
$dupes = $rule_type = $rule_id = NULL;
$rule = wf_crm_aval($contact, 'matching_rule', 'Unsupervised', TRUE);
if ($rule) {
$params = array('check_permission' => FALSE);
foreach ($contact as $table => $field) {
if (is_array($field) && !empty($field[1])) {
if (substr($table, 0, 2) == 'cg') {
//TODO pass custom data to deduper
}
// If sharing an address, use the master
elseif ($table == 'address' && !empty($field[1]['master_id'])) {
$m = $field[1]['master_id'];
// If master address is exposed to the form, use it
if (!empty($contact[$m]['address'][1])) {
$params['civicrm_address'] = $contact[$m]['address'][1];
}
// Else look up the master contact's address
elseif (!empty($this->existing_contacts[$m])) {
$masters = wf_civicrm_api('address', 'get',
array(
'contact_id' => $this->ent['contact'][$m]['id'],
'sort' => 'is_primary DESC'
));
if (!empty($masters['values'])) {
$params['civicrm_address'] = array_shift($masters['values']);
}
}
}
elseif (in_array($table, array(
'contact',
'address',
'email',
'phone',
'website'
))) {
$params['civicrm_' . $table] = $field[1];
}
}
}
// This is either a default type (Unsupervised or Supervised) or the id of a specific rule
if (is_numeric($rule)) {
$rule_id = $rule;
}
else {
$rule_type = $rule;
}
$dupes = CRM_Dedupe_Finder::dupesByParams($params, ucfirst($contact['contact'][1]['contact_type']), $rule_type, array(), $rule_id);
}
if ($dupes) {
return $dupes[0];
}
return 0;
}
/**
* Create a new contact
* @param array $contact
* @return int
*/
private function createContact($contact) {
$params = $contact['contact'][1];
// CiviCRM API is too picky about this, imho
$params['contact_type'] = ucfirst($params['contact_type']);
unset($params['contact_id'], $params['id']);
if (!isset($params['source'])) {
$params['source'] = $this->settings['new_contact_source'];
}
// If creating individual with no first/last name,
// set display name and sort_name
if ($params['contact_type'] == 'Individual' && empty($params['first_name']) && empty($params['last_name'])) {
$params['display_name'] = $params['sort_name'] = empty($params['nick_name']) ? $contact['email'][1]['email'] : $params['nick_name'];
}
$result = wf_civicrm_api('contact', 'create', $params);
return wf_crm_aval($result, 'id', 0);
}
/**
* Update a contact
* @param array $contact
* @param int $c
*/
private function updateContact($contact, $c) {
$params = $contact['contact'][1];
unset($params['contact_type'], $params['contact_id']);
// Fetch data from existing multivalued fields
$fetch = $multi = array();
foreach ($this->all_fields as $fid => $field) {
if (!empty($field['extra']['multiple']) && substr($fid, 0, 7) == 'contact') {
list(, $name) = explode('_', $fid, 2);
if ($name != 'privacy' && isset($params[$name])) {
$fetch["return.$name"] = 1;
$multi[] = $name;
}
}
}
// Merge data from existing multivalued fields
if ($multi) {
$existing = wf_civicrm_api('contact', 'get', array('id' => $this->ent['contact'][$c]['id']) + $fetch);
$existing = wf_crm_aval($existing, 'values:' . $this->ent['contact'][$c]['id'], array());
foreach ($multi as $name) {
$exist = array_filter(drupal_map_assoc((array) wf_crm_aval($existing, $name, array())));
// Only known contacts are allowed to empty a field
if (!empty($this->existing_contacts[$c])) {
foreach ($this->getExposedOptions("civicrm_{$c}_contact_1_contact_$name") as $k => $v) {
unset($exist[$k]);
}
}
$params[$name] = array_unique(array_merge($params[$name], $exist));
}
}
$params['id'] = $this->ent['contact'][$c]['id'];
wf_civicrm_api('contact', 'create', $params);
}
/**
* Save current employer for a contact
* @param array $contact
* @param int $cid
*/
function saveCurrentEmployer($contact, $cid) {
if ($contact['contact'][1]['contact_type'] == 'individual' && !empty($contact['contact'][1]['employer_id'])) {
wf_civicrm_api('contact', 'create', array(
'id' => $cid,
'employer_id' => $contact['contact'][1]['employer_id'],
));
}
}
/**
* Fill values for hidden ID & CS fields
* @param int $c
* @param int $cid
*/
private function fillHiddenContactFields($cid, $c) {
$fid = 'civicrm_' . $c . '_contact_1_contact_';
if (!empty($this->enabled[$fid . 'contact_id'])) {
$this->submissionValue($this->enabled[$fid . 'contact_id'], $cid);
}
if (!empty($this->enabled[$fid . 'existing'])) {
$this->submissionValue($this->enabled[$fid . 'existing'], $cid);
}
if (!empty($this->enabled[$fid . 'external_identifier']) && !empty($this->existing_contacts[$c])) {
$exid = wf_civicrm_api('contact', 'get', array('contact_id' => $cid, 'return.external_identifier' => 1));
$this->submissionValue($this->enabled[$fid . 'external_identifier'], wf_crm_aval($exid, "values:$cid:external_identifier"));
}
if (!empty($this->enabled[$fid . 'cs'])) {
$cs = $this->submissionValue($this->enabled[$fid . 'cs']);
$life = !empty($cs[0]) ? intval(24 * $cs[0]) : 'inf';
$cs = CRM_Contact_BAO_Contact_Utils::generateChecksum($cid, NULL, $life);
$this->submissionValue($this->enabled[$fid . 'cs'], $cs);
}
}
/**
* Save location data for a contact
* @param array $contact
* @param int $cid
* @param int $c
*/
private function saveContactLocation($contact, $cid, $c) {
foreach (wf_crm_location_fields() as $location) {
if (!empty($contact[$location])) {
$existing = array();
$params = array('contact_id' => $cid);
if ($location != 'website') {
$params['options'] = array('sort' => 'is_primary DESC');
}
$result = wf_civicrm_api($location, 'get', $params);
if (!empty($result['values'])) {
$contact[$location] = self::reorderLocationValues($contact[$location], $result['values'], $location);
// start array index at 1
$existing = array_merge(array(array()), $result['values']);
}
foreach ($contact[$location] as $i => $params) {
// Translate state/prov abbr to id
if (!empty($params['state_province_id'])) {
$config = CRM_Core_Config::singleton();
if (!($params['state_province_id'] = wf_crm_state_abbr($params['state_province_id'], 'id', wf_crm_aval($params, 'country_id', $config->defaultContactCountry)))) {
$params['state_province_id'] = '';
}
}
// Substitute county stub ('-' is a hack to get around required field when there are no available counties)
if (isset($params['county_id']) && $params['county_id'] === '-') {
$params['county_id'] = '';
}
// Update drupal email address
if ($location == 'email' && !empty($params['email']) && $i == 1) {
$uid = wf_crm_user_cid($cid, 'contact');
if ($uid) {
$user = user_load($uid);
if ($params['email'] != $user->mail) {
// Verify this email is unique before saving it to user
$args = array(':mail' => $params['email']);
if (!(db_query("SELECT count(uid) FROM {users} WHERE mail = :mail", $args)->fetchField())) {
user_save($user, array('mail' => $params['email']));
}
}
}
}
// Check if anything was changed, else skip the update
if (!empty($existing[$i])) {
$same = TRUE;
foreach ($params as $param => $val) {
if ($val != (string) wf_crm_aval($existing[$i], $param, '')) {
$same = FALSE;
}
}
if ($same) {
continue;
}
}
if ($location == 'address') {
// Store shared addresses for later since we haven't necessarily processed
// the contact this address is shared with yet.
if (!empty($params['master_id'])) {
$this->shared_address[$cid][$i] = array(
'id' => wf_crm_aval($existing, "$i:id"),
'mc' => $params['master_id'],
'loc' => $params['location_type_id'],
);
continue;
}
// Reset calculated values when updating an address
$params['master_id'] = $params['geo_code_1'] = $params['geo_code_2'] = 'null';
}
$params['contact_id'] = $cid;
if (!empty($existing[$i])) {
$params['id'] = $existing[$i]['id'];
}
if ($this->locationIsEmpty($location, $params)) {
// Delete this location if nothing was entered and this is a known contact
if (!empty($this->existing_contacts[$c]) && !empty($params['id'])) {
wf_civicrm_api($location, 'delete', $params);
}
continue;
}
if ($location != 'website') {
if (empty($params['location_type_id'])) {
$params['location_type_id'] = wf_crm_aval($existing, "$i:location_type_id", 1);
}
$params['is_primary'] = $i == 1 ? 1 : 0;
}
wf_civicrm_api($location, 'create', $params);
}
}
}
}
/**
* Save groups and tags for a contact
* @param array $contact
* @param int $cid
* @param int $c
*/
private function saveGroupsAndTags($contact, $cid, $c) {
// Process groups & tags
foreach ($this->all_fields as $fid => $field) {
list($set, $type) = explode('_', $fid, 2);
if ($set == 'other') {
$field_name = 'civicrm_' . $c . '_contact_1_' . $fid;
if (!empty($contact['other'][1][$type]) || isset($this->enabled[$field_name])) {
$add = wf_crm_aval($contact, "other:1:$type", array());
$remove = empty($this->existing_contacts[$c]) ? array() : $this->getExposedOptions($field_name, $add);
$this->addOrRemoveMultivaluedData($field['table'], 'contact', $cid, $add, $remove);
}
}
}
}
/**
* Handle adding/removing multivalued data for a contact/activity/etc.
* Currently used only for groups and tags, but written with expansion in mind.
*
* @param $data_type
* 'group' or 'tag'
* @param $entity_type
* Parent entity: 'contact' etc.
* @param $id
* Entity id
* @param $add
* Groups/tags to add
* @param array $remove
* Groups/tags to remove
*/
private function addOrRemoveMultivaluedData($data_type, $entity_type, $id, $add, $remove = array()) {
$confirmations_sent = $existing = $params = array();
$add = drupal_map_assoc($add);
static $mailing_lists = array();
switch ($data_type) {
case 'group':
$api = 'group_contact';
break;
case 'tag':
$api = 'entity_tag';
break;
default:
$api = $data_type;
}
if (!empty($add) || !empty($remove)) {
// Retrieve current records for this entity
if ($entity_type == 'contact') {
$params['contact_id'] = $id;
}
else {
$params['entity_id'] = $id;
$params['entity_type'] = 'civicrm_' . $entity_type;
}
$fetch = wf_civicrm_api($api, 'get', $params);
foreach (wf_crm_aval($fetch, 'values', array()) as $i) {
$existing[] = $i[$data_type . '_id'];
unset($add[$i[$data_type . '_id']]);
}
foreach ($remove as $i => $name) {
if (!in_array($i, $existing)) {
unset($remove[$i]);
}
}
}
if (!empty($add)) {
// Prepare for sending subscription confirmations
if ($data_type == 'group' && !empty($this->settings['confirm_subscription'])) {
// Retrieve this contact's primary email address and perform error-checking
$result = wf_civicrm_api('email', 'get', array('contact_id' => $id, 'options' => array('sort' => 'is_primary DESC')));
if (!empty($result['values'])) {
foreach ($result['values'] as $value) {
if (($value['is_primary'] || empty($email)) && strpos($value['email'], '@')) {
$email = $value['email'];
}
}
$mailer_params = array(
'contact_id' => $id,
'email' => $email,
);
if (empty($mailing_lists)) {
$mailing_lists = wf_crm_apivalues('group', 'get', array('visibility' => 'Public Pages', 'group_type' => 2), 'title');
}
}
}
foreach ($add as $a) {
$params[$data_type . '_id'] = $mailer_params['group_id'] = $a;
if ($data_type == 'group' && isset($mailing_lists[$a]) && !empty($email)) {
$result = wf_civicrm_api('mailing_event_subscribe', 'create', $mailer_params);
if (empty($result['is_error'])) {
$confirmations_sent[] = check_plain($mailing_lists[$a]);
}
else {
wf_civicrm_api($api, 'create', $params);
}
}
else {
wf_civicrm_api($api, 'create', $params);
}
}
if ($confirmations_sent) {
drupal_set_message(t('A message has been sent to %email to confirm subscription to !group.', array('%email' => $email, '!group' => '' . implode(' ' . t('and') . ' ', $confirmations_sent) . '')));
}
}
// Remove data from entity
foreach ($remove as $a => $name) {
$params[$data_type . '_id'] = $a;
wf_civicrm_api($api, 'delete', $params);
}
if (!empty($remove) && $data_type == 'group') {
$display_name = wf_civicrm_api('contact', 'get', array('contact_id' => $id, 'return.display_name' => 1));
$display_name = wf_crm_aval($display_name, "values:$id:display_name", t('Contact'));
drupal_set_message(t('%contact has been removed from !group.', array('%contact' => $display_name, '!group' => '' . implode(' ' . t('and') . ' ', $remove) . '')));
}
}
/**
* Add/update relationship for a pair of contacts
*
* @param $params
* Params array for relationship api
* @param $cid1
* Contact id
* @param $cid2
* Contact id
*/
private function processRelationship($params, $cid1, $cid2) {
if (!empty($params['relationship_type_id']) && $cid2 && $cid1 != $cid2) {
list($type, $side) = explode('_', $params['relationship_type_id']);
$existing = $this->getRelationship(array($params['relationship_type_id']), $cid1, $cid2);
$perm = wf_crm_aval($params, 'relationship_permission');
// Swap contacts if this is an inverse relationship
if ($side == 'b' || ($existing && $existing['contact_id_a'] != $cid1)) {
list($cid1, $cid2) = array($cid2, $cid1);
if ($perm == 1 || $perm == 2) {
$perm = $perm == 1 ? 2 : 1;
}
}
$params += $existing;
$params['contact_id_a'] = $cid1;
$params['contact_id_b'] = $cid2;
$params['relationship_type_id'] = $type;
if ($perm) {
$params['is_permission_a_b'] = $params['is_permission_b_a'] = $perm == 3 ? 1 : 0;
if ($perm == 1 || $perm == 2) {
$params['is_permission_' . ($perm == 1 ? 'a_b' : 'b_a')] = 1;
}
}
unset($params['relationship_permission']);
wf_civicrm_api('relationship', 'create', $params);
}
}
/**
* Process event participation for a contact
* @param int $c
* @param int $cid
*/
private function processParticipants($c, $cid) {
static $registered_by_id = array();
$n = $this->data['participant_reg_type'] == 'separate' ? $c : 1;
if ($p = wf_crm_aval($this->data, "participant:$n:participant")) {
// Fetch existing participant records
$existing = array();
$dao = CRM_Core_DAO::executeQuery("SELECT id, event_id FROM civicrm_participant WHERE contact_id = $cid AND is_test = 0");
while ($dao->fetch()) {
$existing[$dao->event_id] = $dao->id;
}
foreach ($p as $e => $params) {
$remove = array();
$fid = "civicrm_{$c}_participant_{$e}_participant_event_id";
// Automatic status - de-selected events will be cancelled if 'disable_unregister' is not selected
if (empty($this->data['reg_options']['disable_unregister'])) {
if (empty($params['status_id'])) {
foreach ($this->getExposedOptions($fid) as $eid => $title) {
list($eid) = explode('-', $eid);
if (isset($existing[$eid])) {
$remove[$eid] = $title;
}
}
}
}
if (!empty($params['event_id'])) {
$params['contact_id'] = $cid;
if (empty($params['campaign_id']) || empty($this->all_fields['participant_campaign_id'])) {
unset($params['campaign_id']);
}
// Reformat custom data from nested arrays
$custom = array();
foreach ($this->data['participant'][$n] as $key => $vals) {
if (substr($key, 0, 2) == 'cg' && isset($vals[$e])) {
$custom[$key][1] = $vals[$e];
}
}
// Loop through event ids to support multi-valued form elements
$this->events = (array) $params['event_id'];
foreach ($this->events as $i => $id_and_type) {
if (!empty($id_and_type)) {
list($eid) = explode('-', $id_and_type);
$params['event_id'] = $eid;
unset($remove[$eid], $params['registered_by_id'], $params['id'], $params['source']);
// Is existing participant?
if (!empty($existing[$eid])) {
$params['id'] = $existing[$params['event_id']];
}
else {
if (isset($this->data['contact'][$c]['contact'][1]['source'])) {
$params['source'] = $this->data['contact'][$c]['contact'][1]['source'];
}
else {
$params['source'] = $this->settings['new_contact_source'];
}
if ($c > 1 && !empty($registered_by_id[$e][$i])) {
$params['registered_by_id'] = $registered_by_id[$e][$i];
}
}
// Automatic status
if (empty($params['status_id']) && empty($params['id'])) {
$params['status_id'] = 'Registered';
// Pending payment status
if ($this->contributionIsIncomplete && !empty($params['fee_amount'])) {
$params['status_id'] = $this->contributionIsPayLater ? 'Pending from pay later' : 'Pending from incomplete transaction';
}
}
// Do not update status of existing participant in "Automatic" mode
if (empty($params['status_id'])) {
unset($params['status_id']);
}
$result = wf_civicrm_api('participant', 'create', $params);
// Update line-item
foreach ($this->line_items as &$item) {
if ($item['element'] == "civicrm_{$n}_participant_{$e}_participant_{$id_and_type}") {
if (empty($item['participant_id'])) {
$item['participant_id'] = $item['entity_id'] = $result['id'];
}
$item['participant_count'] = wf_crm_aval($item, 'participant_count', 0) + 1;
break;
}
}
// When registering contact 1, store id to apply to other contacts
if ($c == 1) {
$registered_by_id[$e][$i] = $result['id'];
}
if ($custom) {
$this->saveCustomData($custom, $result['id'], 'Participant');
}
}
}
}
foreach ($remove as $eid => $title) {
wf_civicrm_api('participant', 'create', array('status_id' => "Cancelled", 'id' => $existing[$eid]));
drupal_set_message(t('Registration cancelled for !event', array('!event' => $title)));
}
}
}
}
/**
* Process memberships for a contact
* Called during webform submission
* @param int $c
* @param int $cid
*/
private function processMemberships($c, $cid) {
static $types;
if (!isset($types)) {
$types = wf_crm_apivalues('membership_type', 'get');
}
$existing = $this->findMemberships($cid);
foreach (wf_crm_aval($this->data, "membership:$c:membership", array()) as $n => $params) {
$membershipStatus = "";
$membershipEndDate = "";
$is_active = FALSE;
if (empty($params['membership_type_id'])) {
continue;
}
// Search for existing membership to renew - must belong to same domain and organization
// But not necessarily the same membership type to allow for upsell
if (!empty($params['num_terms'])) {
$type = $types[$params['membership_type_id']];
foreach ($existing as $mem) {
$existing_type = $types[$mem['membership_type_id']];
if ($type['domain_id'] == $existing_type['domain_id'] && $type['member_of_contact_id'] == $existing_type['member_of_contact_id']) {
$params['id'] = $mem['id'];
// If we have an exact match, look no further
if ($mem['membership_type_id'] == $params['membership_type_id']) {
$is_active = $mem['is_active'];
$membershipStatus = $mem['status'];
$membershipEndDate = $mem['end_date'];
break;
}
}
}
}
if (empty($params['id'])) {
if (isset($this->data['contact'][$c]['contact'][1]['source'])) {
$params['source'] = $this->data['contact'][$c]['contact'][1]['source'];
}
else {
$params['source'] = $this->settings['new_contact_source'];
}
}
// Automatic status
if (empty($params['status_id'])) {
unset($params['status_id']);
// Pending payment status
if ($this->contributionIsIncomplete && $this->getMembershipTypeField($params['membership_type_id'], 'minimum_fee')) {
if ($is_active == FALSE) {
$params['status_id'] = 'Pending';
} else {
$params['status_id'] = $membershipStatus;
$params['end_date'] = $membershipEndDate;
}
}
}
// Override status
else {
$params['is_override'] = 1;
}
$params['contact_id'] = $cid;
// The api won't let us manually set status without this weird param
$params['skipStatusCal'] = !empty($params['status_id']);
$result = wf_civicrm_api('membership', 'create', $params);
if (!empty($result['id'])) {
// Issue #2516924 If existing membership create renewal activity
if (!empty($params['id'])) {
$membership = $result['values'][$result['id']];
$actParams = array(
'source_record_id' => $result['id'],
'activity_type_id' => 'Membership Renewal',
'target_id' => $cid,
);
$memType = wf_civicrm_api('MembershipType', 'getsingle', array('id' => $membership['membership_type_id']));
$memStatus = wf_civicrm_api('MembershipStatus', 'getsingle', array('id' => $membership['status_id']));
$actParams['subject'] = ts("%1 - Status: %2", array(1 => $memType['name'], 2 => $memStatus['label']));
wf_civicrm_api('Activity', 'create', $actParams);
}
foreach ($this->line_items as &$item) {
if ($item['element'] == "civicrm_{$c}_membership_{$n}") {
$item['membership_id'] = $result['id'];
break;
}
}
}
}
}
/**
* Process shared addresses
*/
private function processSharedAddresses() {
foreach ($this->shared_address as $cid => $shared) {
foreach ($shared as $i => $addr) {
if (!empty($this->ent['contact'][$addr['mc']]['id'])) {
$masters = wf_civicrm_api('address', 'get', array('contact_id' => $this->ent['contact'][$addr['mc']]['id'], 'options' => array('sort' => 'is_primary DESC')));
if (!empty($masters['values'])) {
$masters = array_values($masters['values']);
// Pick the address with the same location type; default to primary.
$params = $masters[0];
foreach ($masters as $m) {
if ($m['location_type_id'] == $addr['loc']) {
$params = $m;
break;
}
}
$params['master_id'] = $params['id'];
$params['id'] = $addr['id'];
$params['contact_id'] = $cid;
$params['is_primary'] = $i == 1;
wf_civicrm_api('address', 'create', $params);
}
}
}
}
}
/**
* Save case data
*/
private function processCases() {
foreach (wf_crm_aval($this->data, 'case', array()) as $n => $data) {
if (is_array($data) && !empty($data['case'][1]['client_id'])) {
$params = $data['case'][1];
// Set some defaults in create mode
if (empty($this->ent['case'][$n]['id'])) {
if (empty($params['case_type_id'])) {
// Abort if no case type.
continue;
}
// Automatic status... for lack of anything fancier just pick the first option ("Ongoing" on a standard install)
if (empty($params['status_id'])) {
$options = wf_crm_apivalues('case', 'getoptions', array('field' => 'status_id'));
$params['status_id'] = current(array_keys($options));
}
if (empty($params['subject'])) {
$params['subject'] = check_plain($this->node->title);
}
// Automatic creator_id - default to current user or contact 1
if (empty($data['case'][1]['creator_id'])) {
if (user_is_logged_in()) {
$params['creator_id'] = wf_crm_user_cid();
}
elseif (!empty($this->ent['contact'][1]['id'])) {
$params['creator_id'] = $this->ent['contact'][1]['id'];
}
else {
// Abort if no creator available
continue;
}
}
}
// Update mode
else {
$params['id'] = $this->ent['case'][$n]['id'];
// These params aren't allowed in update mode
unset($params['creator_id'], $params['case_type_id']);
}
// Allow "automatic" status to pass-thru
if (empty($params['status_id'])) {
unset($params['status_id']);
}
$result = wf_civicrm_api('case', 'create', $params);
// Final processing if save was successful
if (!empty($result['id'])) {
// Store id
$this->ent['case'][$n]['id'] = $result['id'];
// Save custom field data
$this->saveCustomData($data, $result['id'], 'Case', FALSE);
// Save case roles
foreach ($params as $param => $val) {
if ($val && strpos($param, 'role_') === 0) {
foreach ((array) $params['client_id'] as $client) {
wf_civicrm_api('relationship', 'create', array(
'relationship_type_id' => substr($param, 5),
'contact_id_a' => $client,
'contact_id_b' => $val,
'case_id' => $result['id'],
));
}
}
}
}
}
}
}
/**
* Save activity data
*/
private function processActivities() {
foreach (wf_crm_aval($this->data, 'activity', array()) as $n => $data) {
if (is_array($data)) {
$params = $data['activity'][1];
// Create mode
if (empty($this->ent['activity'][$n]['id'])) {
// Automatic status based on whether activity_date_time is in the future
if (empty($params['status_id'])) {
$params['status_id'] = strtotime(wf_crm_aval($params, 'activity_date_time', 'now')) > time() ? 'Scheduled' : 'Completed';
}
// Automatic source_contact_id - default to current user or contact 1
if (empty($data['activity'][1]['source_contact_id'])) {
if (user_is_logged_in()) {
$params['source_contact_id'] = wf_crm_user_cid();
}
elseif (!empty($this->ent['contact'][1]['id'])) {
$params['source_contact_id'] = $this->ent['contact'][1]['id'];
}
}
// Format details as html
$params['details'] = nl2br(wf_crm_aval($params, 'details', ''));
// Add webform results to details
if (!empty($this->data['activity'][$n]['details']['entire_result'])) {
module_load_include('inc', 'webform', 'includes/webform.submissions');
$submission = webform_submission_render($this->node, $this->submission, NULL, 'html');
$params['details'] .= drupal_render($submission);
}
if (!empty($this->data['activity'][$n]['details']['view_link'])) {
$params['details'] .= '' . l(t('View Webform Submission'), "node/{$this->node->nid}/submission/{$this->submission->sid}", array('absolute' => TRUE, 'alias' => TRUE)) . '
';
}
if (!empty($this->data['activity'][$n]['details']['edit_link'])) {
$params['details'] .= '' . l(t('Edit Submission'), "node/{$this->node->nid}/submission/{$this->submission->sid}/edit", array('absolute' => TRUE, 'alias' => TRUE)) . '
';
}
}
// Update mode
else {
$params['id'] = $this->ent['activity'][$n]['id'];
}
// Allow "automatic" values to pass-thru if empty
foreach ($params as $field => $value) {
if ((isset($this->all_fields["activity_$field"]['empty_option']) || isset($this->all_fields["activity_$field"]['exposed_empty_option'])) && !$value) {
unset($params[$field]);
}
}
// Handle survey data
if (!empty($this->data['activity'][$n]['activity'][1]['survey_id'])) {
$params['source_record_id'] = $this->data['activity'][$n]['activity'][1]['survey_id'];
// Set default subject
if (empty($params['id']) && empty($params['subject'])) {
$survey = wf_civicrm_api('survey', 'getsingle', array('id' => $this->data['activity'][$n]['activity'][1]['survey_id'], 'return' => 'title'));
$params['subject'] = wf_crm_aval($survey, 'title', '');
}
}
// File on case
if (!empty($this->data['activity'][$n]['case_type_id'])) {
// Webform case
if ($this->data['activity'][$n]['case_type_id'][0] === '#') {
$case_num = substr($this->data['activity'][$n]['case_type_id'], 1);
if (!empty($this->ent['case'][$case_num]['id'])) {
$params['case_id'] = $this->ent['case'][$case_num]['id'];
}
}
// Search for case by criteria
else {
$case_contact = $this->ent['contact'][$this->data['activity'][$n]['case_contact_id']]['id'];
if ($case_contact) {
// Proceed only if this activity is not already filed on a case
if (empty($params['id']) || !wf_crm_apivalues('case', 'get', array('activity_id' => $params['id']))) {
$case = $this->findCaseForContact($case_contact, array(
'status_id' => $this->data['activity'][$n]['case_status_id'],
'case_type_id' => $this->data['activity'][$n]['case_type_id'],
));
if ($case) {
$params['case_id'] = $case['id'];
}
}
}
}
}
$result = wf_civicrm_api('activity', 'create', $params);
// Final processing if save was successful
if (!empty($result['id'])) {
// Store id
$this->ent['activity'][$n]['id'] = $result['id'];
// Save custom data & attachments
$this->saveCustomData($data, $result['id'], 'Activity', FALSE);
if (isset($data['activityupload'])) {
$this->processAttachments('activity', $n, $result['id'], empty($params['id']));
}
if (!empty($params['assignee_contact_id'])) {
if (CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'activity_assignee_notification')) {
// Send email to assignees. TODO: Move to CiviCRM API?
$assignee = wf_civicrm_api('contact', 'getsingle', array('id' => $params['assignee_contact_id']));
if (!empty($assignee['email'])) {
$mail = array($assignee['email'] => $assignee);
// Include attachments while sending a copy of activity.
$attachments = CRM_Core_BAO_File::getEntityFile('civicrm_activity', $this->ent['act'][1]);
CRM_Case_BAO_Case::sendActivityCopy(NULL, $result['id'], $mail, $attachments, NULL);
}
}
}
}
}
}
}
/**
* Save grants
*/
private function processGrants() {
foreach (wf_crm_aval($this->data, 'grant', array()) as $n => $data) {
if (is_array($data) && !empty($data['grant'][1]['contact_id'])) {
$params = $data['grant'][1];
// Set some defaults in create mode
if (empty($this->ent['grant'][$n]['id'])) {
// Automatic status... for lack of anything fancier just pick the first option ("Submitted" on a standard install)
if (empty($params['status_id'])) {
$options = wf_crm_apivalues('grant', 'getoptions', array('field' => 'status_id'));
$params['status_id'] = current(array_keys($options));
}
if (empty($params['application_received_date'])) {
$params['application_received_date'] = 'now';
}
if (empty($params['grant_report_received'])) {
$params['grant_report_received'] = '0';
}
}
// Update mode
else {
$params['id'] = $this->ent['grant'][$n]['id'];
}
// Allow "automatic" status to pass-thru
if (empty($params['status_id'])) {
unset($params['status_id']);
}
$result = wf_civicrm_api('grant', 'create', $params);
// Final processing if save was successful
if (!empty($result['id'])) {
// Store id
$this->ent['grant'][$n]['id'] = $result['id'];
// Save custom data & attachments
$this->saveCustomData($data, $result['id'], 'Grant', FALSE);
if (isset($data['grantupload'])) {
$this->processAttachments('grant', $n, $result['id'], empty($params['id']));
}
}
}
}
}
/**
* Calculate line-items for this webform submission
*/
private function tallyLineItems() {
// Contribution
$fid = 'civicrm_1_contribution_1_contribution_total_amount';
if (isset($this->enabled[$fid]) || $this->getData($fid) > 0) {
$this->line_items[] = array(
'qty' => 1,
'unit_price' => $this->getData($fid),
'financial_type_id' => $this->contribution_page['financial_type_id'],
'label' => wf_crm_aval($this->node->webform['components'], $this->enabled[$fid] . ':name', t('Contribution')),
'element' => 'civicrm_1_contribution_1',
'entity_table' => 'civicrm_contribution',
);
}
// Membership
foreach (wf_crm_aval($this->data, 'membership', array()) as $c => $memberships) {
if (isset($this->existing_contacts[$c]) && !empty($memberships['number_of_membership'])) {
foreach ($memberships['membership'] as $n => $item) {
if (!empty($item['membership_type_id'])) {
$type = $item['membership_type_id'];
$price = $this->getMembershipTypeField($type, 'minimum_fee');
//if number of terms is set, regard membership fee field as price per term
//if you choose to set dates manually while membership fee field is enabled, take the membership fee as total cost of this membership
if (isset($item['fee_amount'])) {
$price = $item['fee_amount'];
if (empty($item['num_terms'])) {
$item['num_terms'] = 1;
}
}
if ($price) {
$this->line_items[] = array(
'qty' => $item['num_terms'],
'unit_price' => $price,
'financial_type_id' => $this->getMembershipTypeField($type, 'financial_type_id'),
'label' => $this->getMembershipTypeField($type, 'name'),
'element' => "civicrm_{$c}_membership_{$n}",
'entity_table' => 'civicrm_membership',
);
}
}
}
}
}
// Calculate totals
$this->totalContribution = 0;
foreach ($this->line_items as &$item) {
// tax integration
if (!is_null($this->tax_rate)) {
$item['line_total'] = $item['unit_price'] * (int) $item['qty'];
$item['tax_amount'] = ($this->tax_rate / 100) * $item['line_total'];
$this->totalContribution += (1 + $this->tax_rate / 100) * $item['unit_price'] * (int) $item['qty'];
}
else {
$this->totalContribution += $item['line_total'] = $item['unit_price'] * (int) $item['qty'];
}
}
return $this->totalContribution;
}
/**
* Are billing fields exposed to this webform page?
* @return bool
*/
private function isPaymentPage() {
$page = wf_crm_aval($this->form_state, 'storage:page_num', 1);
$field = $this->getComponent('civicrm_1_contribution_1_contribution_contribution_page_id');
return $page == $field['page_num'];
}
/**
* @return bool
*/
private function isLivePaymentProcessor() {
if ($this->payment_processor) {
if ($this->payment_processor['billing_mode'] == self::BILLING_MODE_LIVE) {
return TRUE;
}
// In mixed mode (where there is e.g. a PayPal button + credit card fields) the cc field will contain a placeholder if the button was clicked
if ($this->payment_processor['billing_mode'] == self::BILLING_MODE_MIXED && wf_crm_aval($_POST, 'credit_card_number') != 'express') {
return TRUE;
}
}
return FALSE;
}
/**
* Normalize and validate billing input
* @return bool
*/
private function validateBillingFields() {
$valid = TRUE;
$params = $card_errors = array();
// These are hard-coded in CiviCRM so we may as well hard-code them here
// Value = translated label to be shown during validation or FALSE if not required
$billing_fields = array(
'credit_card_number' => ts('Card Number'),
'cvv2' => ts('Security Code'),
'credit_card_type' => ts('Card Type'),
'billing_first_name' => ts('Billing First Name'),
'billing_middle_name' => FALSE,
'billing_last_name' => ts('Billing Last Name'),
'billing_street_address-5' => ts('Street Address'),
'billing_city-5' => ts('City'),
'billing_country_id-5' => ts('Country'),
'billing_state_province_id-5' => FALSE,
'billing_postal_code-5' => ts('Postal Code'),
);
if (!empty($_POST['stripe_token'])) {
// Using Stripe payment processor - cc fields not posted
$billing_fields['credit_card_number'] = FALSE;
$billing_fields['cvv2'] = FALSE;
}
if (!empty($_POST['bank_account_type'])) {
// unset/bypass the CC validation if we're doing Direct Debit (ACHEFT) - in that case we have a Bank Account Type
$billing_fields['credit_card_number'] = FALSE;
$billing_fields['cvv2'] = FALSE;
$billing_fields['credit_card_type'] = FALSE;
$_POST['credit_card_exp_date']['M'] = '12';
$_POST['credit_card_exp_date']['Y'] = '2099';
}
foreach ($billing_fields as $field => $label) {
if (empty($_POST[$field]) && $label !== FALSE) {
form_set_error($field, t('!name field is required.', array('!name' => check_plain($label))));
$valid = FALSE;
}
if (!empty($_POST[$field])) {
$name = str_replace('billing_', '', str_replace('-5', '', $field));
$submitted[$name] = $params[$name] = $params[$field] = $_POST[$field];
}
}
// Validate country
if (!empty($params['country_id'])) {
if (!array_key_exists($params['country_id'], wf_crm_apivalues('address', 'getoptions', array('field' => 'country_id')))) {
form_set_error('billing_country_id-5', t('Illegal value entered for Country'));
$valid = $params['country_id'] = FALSE;
}
}
// Validate state/province
if (!empty($params['country_id'])) {
$states = wf_crm_apivalues('address', 'getoptions', array('field' => 'state_province_id', 'country_id' => $params['country_id']));
if ($states && (empty($params['state_province_id']) || !isset($states[$params['state_province_id']]))) {
form_set_error('billing_state_province_id-5', t('!name field is required.', array('!name' => check_plain(ts('State/Province')))));
$valid = FALSE;
}
}
// Validate credit card number & cvv2
CRM_Core_Payment_Form::validateCreditCard($params, $card_errors);
foreach ($card_errors as $field => $msg) {
form_set_error($field, $msg);
$valid = FALSE;
}
// Check expiration date
$submitted['credit_card_exp_date[Y]'] = $params['year'] = wf_crm_aval($_POST, 'credit_card_exp_date:Y', 0);
// There seems to be some inconsistency with capitalization here
$params['month'] = (int) wf_crm_aval($_POST, 'credit_card_exp_date:M', wf_crm_aval($_POST, 'credit_card_exp_date:m', 0));
$submitted['credit_card_exp_date[M]'] = $submitted['credit_card_exp_date[m]'] = $params['month'];
if ($params['year'] < date('Y') || ($params['year'] == date('Y') && $params['month'] < date('n'))) {
form_set_error('billing', ts('Credit card expiration date cannot be a past date.'));
$valid = FALSE;
}
// Email
for ($i = 1; $i <= $this->data['contact'][1]['number_of_email']; ++$i) {
if (!empty($this->crmValues["civicrm_1_contact_{$i}_email_email"])) {
$params['email'] = $this->crmValues["civicrm_1_contact_{$i}_email_email"];
break;
}
}
if (empty($params['email'])) {
form_set_error('billing_email', ts('An email address is required to complete this transaction.'));
$valid = FALSE;
}
if ($valid) {
$this->billing_params = $params;
}
// Since billing fields are not "real" form fields they get cleared if the page reloads.
// We add a bit of js to fix this annoyance.
drupal_add_js(array('webform_civicrm' => array('billingSubmission' => $submitted)), 'setting');
return $valid;
}
/**
* Create contact 1 if not already existing (required by contribution.transact)
* @return int
*/
private function createBillingContact() {
$cid = wf_crm_aval($this->existing_contacts, 1);
if (!$cid) {
$contact = $this->data['contact'][1];
// Only use middle name from billing if we are using the rest of the billing name as well
if (empty($contact['contact'][1]['first_name']) && !empty($this->billing_params['middle_name'])) {
$contact['contact'][1]['middle_name'] = $this->billing_params['middle_name'];
}
$contact['contact'][1] += array(
'first_name' => $this->billing_params['first_name'],
'last_name' => $this->billing_params['last_name'],
);
$cid = $this->findDuplicateContact($contact);
}
$address = array(
'street_address' => $this->billing_params['street_address'],
'city' => $this->billing_params['city'],
'country_id' => $this->billing_params['country_id'],
'state_province_id' => wf_crm_aval($this->billing_params, 'state_province_id'),
'postal_code' => $this->billing_params['postal_code'],
'location_type_id' => 'Billing',
);
$email = array(
'email' => $this->billing_params['email'],
'location_type_id' => 'Billing',
);
if (!$cid) {
$cid = $this->createContact($contact);
}
else {
foreach (array('address', 'email') as $loc) {
$result = wf_civicrm_api($loc, 'get', array(
'contact_id' => $cid,
'location_type_id' => 'Billing',
));
// Use first id if we have any results
if (!empty($result['values'])) {
$ids = array_keys($result['values']);
${$loc}['id'] = $ids[0];
}
}
}
if ($cid) {
$address['contact_id'] = $email['contact_id'] = $this->ent['contact'][1]['id'] = $cid;
wf_civicrm_api('address', 'create', $address);
wf_civicrm_api('email', 'create', $email);
}
return $cid;
}
/**
* Execute payment processor transaction
* This happens during form validation and sets a form error if unsuccessful
*/
private function submitLivePayment() {
$result = wf_civicrm_api('contribution', 'transact', $this->contributionParams());
if (empty($result['id'])) {
if (!empty($result['error_message'])) {
form_set_error('contribution', $result['error_message']);
}
else {
form_set_error('contribution', t('Transaction failed. Please verify all billing fields are correct.'));
}
return;
}
$this->ent['contribution'][1]['id'] = $result['id'];
}
/**
* Create Incomplete (Pay-Later or IPN) Contribution
*/
private function createDeferredPayment() {
$this->contributionIsIncomplete = TRUE;
$this->contributionIsPayLater = empty($this->data['contribution'][1]['contribution'][1]['payment_processor_id']);
$params = $this->contributionParams();
$params['contribution_status_id'] = 'Pending';
$params['is_pay_later'] = $this->contributionIsPayLater;
//Fix IPN payments marked as paid by cheque
if (empty($params['payment_instrument_id'])) {
if ($params['payment_processor_id'] && $this->contribution_page['is_monetary']) {
$defaultPaymentInstrument = CRM_Core_OptionGroup::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1');
$params['payment_instrument_id'] = key($defaultPaymentInstrument);
}
}
$result = wf_civicrm_api('contribution', 'create', $params);
$this->ent['contribution'][1]['id'] = $result['id'];
}
/**
* Call IPN payment processor to redirect to payment site
*/
private function submitIPNPayment() {
$config = CRM_Core_Config::singleton();
$params = $this->data['contribution'][1]['contribution'][1];
$processor_type = wf_civicrm_api('payment_processor', 'getsingle', array('id' => $params['payment_processor_id']));
if (version_compare($this->civicrm_version, 4.7, '<')) {
$mode = empty($params['is_test']) ? 'live' : 'test';
$paymentProcessor = CRM_Core_Payment::singleton($mode, $processor_type);
}
else {
$paymentProcessor = \Civi\Payment\System::singleton()->getByName($processor_type, $params['is_test']);
}
// Add contact details to params (most processors want a first_name and last_name)
$contact = wf_civicrm_api('contact', 'getsingle', array('id' => $this->ent['contact'][1]['id']));
$params += $contact;
$params['contributionID'] = $params['id'] = $this->ent['contribution'][1]['id'];
// Generate a fake qfKey in case payment processor redirects to contribution thank-you page
$params['qfKey'] = $this->getQfKey();
$params['contactID'] = $params['contact_id'];
$params['currency'] = $params['currencyID'] = $this->contribution_page['currency'];
$params['total_amount'] = $this->totalContribution;
// Some processors want this one way, some want it the other
$params['amount'] = $params['total_amount'];
$params['financial_type_id'] = $this->contribution_page['financial_type_id'];
$params['source'] = $this->settings['new_contact_source'];
$params['item_name'] = t('Webform Payment: @title', array('@title' => $this->node->title));
if (method_exists($paymentProcessor, 'setSuccessUrl')) {
$paymentProcessor->setSuccessUrl($this->getIpnRedirectUrl('success'));
$paymentProcessor->setCancelUrl($this->getIpnRedirectUrl('cancel'));
}
// Legacy paypal settings. Remove when dropping support for CiviCRM 4.6 and below.
// @see webform_civicrm_civicrm_alterPaymentProcessorParams
$params['webform_redirect_cancel'] = $this->getIpnRedirectUrl('cancel');
$params['webform_redirect_success'] = $this->getIpnRedirectUrl('success');
$paymentProcessor->doTransferCheckout($params, 'contribute');
}
/**
* @param $type
* @return string
*/
public function getIpnRedirectUrl($type) {
$url = trim($this->node->webform['redirect_url']);
if ($url == '' || $type == 'cancel') {
$url = url('node/' . $this->node->nid, array('absolute' => TRUE));
}
elseif ($url == '') {
$query = array('sid' => $this->submission->sid);
// Add token if user is not authenticated, inline with 'webform_client_form_submit()'
if (user_is_anonymous()) {
$query['token'] = webform_get_submission_access_token($this->submission);
}
$url = url("node/{$this->node->nid}/done", array('query' => $query, 'absolute' => TRUE));
}
else {
$parsed = webform_replace_url_tokens($url, $this->node, $this->submission);
$parsed[1]['absolute'] = TRUE;
$url = url($parsed[0], $parsed[1]);
}
return $url;
}
/**
* Format contribution params for transact/pay-later
* @return array
*/
private function contributionParams() {
$params = $this->billing_params + $this->data['contribution'][1]['contribution'][1];
$params['financial_type_id'] = $this->contribution_page['financial_type_id'];
$params['currency'] = $params['currencyID'] = $this->contribution_page['currency'];
$params['skipRecentView'] = $params['skipLineItem'] = 1;
$params['contact_id'] = $this->ent['contact'][1]['id'];
$params['total_amount'] = $this->totalContribution;
// Some processors use this for matching and updating the contribution status
if (!$this->contributionIsPayLater) {
$params['invoice_id'] = $this->data['contribution'][1]['contribution'][1]['invoiceID'] = md5(uniqid(rand(), TRUE));
}
// tax integration
// TODO: needs review if this is changed in 4.6
if (!is_null($this->tax_rate)) {
$params['non_deductible_amount'] = $this->totalContribution;
$params['tax_amount'] = ($params['total_amount'] / ($this->tax_rate + 100)) * $this->tax_rate;
}
$params['description'] = t('Webform Payment: @title', array('@title' => $this->node->title));
if (!isset($params['source'])) {
$params['source'] = $this->settings['new_contact_source'];
}
// pass all submitted values to payment processor
foreach ($_POST as $key => $value) {
if (empty($params[$key])) {
$params[$key] = $value;
}
}
// Fix bug for testing.
if ($params['is_test'] == 1) {
$liveProcessorName = wf_civicrm_api('payment_processor', 'getvalue', array(
'id' => $params['payment_processor_id'],
'return' => 'name',
));
// Lookup current domain for multisite support
static $domain = 0;
if (!$domain) {
$domain = wf_civicrm_api('domain', 'get', array('current_domain' => 1, 'return' => 'id'));
$domain = wf_crm_aval($domain, 'id', 1);
}
$params['payment_processor_id'] = wf_civicrm_api('payment_processor', 'getvalue', array(
'return' => 'id',
'name' => $liveProcessorName,
'is_test' => 1,
'domain_id' => $domain,
));
}
// doPayment requries payment_processor and payment_processor_mode fields.
if (version_compare($this->civicrm_version, '4.7', '>=')) {
$params['payment_processor'] = $params['payment_processor_id'];
}
// Save this stuff for later
unset($params['soft'], $params['honor_contact_id'], $params['honor_type_id']);
return $params;
}
/**
* Post-processing of contribution
* This happens during form post-processing
*/
private function processContribution() {
$contribution = $this->data['contribution'][1]['contribution'][1];
$id = $this->ent['contribution'][1]['id'];
// Save custom data
$this->saveCustomData($this->data['contribution'][1], $id, 'Contribution', FALSE);
// Save soft credits
if (!empty($contribution['soft'])) {
foreach (array_filter($contribution['soft']) as $cid) {
wf_civicrm_api('contribution_soft', 'create', array(
'contact_id' => $cid,
'contribution_id' => $id,
'amount' => $contribution['total_amount'],
'currency' => $this->contribution_page['currency'],
));
}
}
// Save honoree
// FIXME: these api params were deprecated in 4.5, should be switched to use soft-credits when we drop support for 4.4
if (!empty($contribution['honor_contact_id']) && !empty($contribution['honor_type_id'])) {
wf_civicrm_api('contribution', 'create', array(
'id' => $id,
'total_amount' => $contribution['total_amount'],
'honor_contact_id' => $contribution['honor_contact_id'],
'honor_type_id' => $contribution['honor_type_id'],
));
}
$contributionResult = CRM_Contribute_BAO_Contribution::getValues(array('id' => $id), CRM_Core_DAO::$_nullArray, CRM_Core_DAO::$_nullArray);
// Save line-items
foreach ($this->line_items as &$item) {
if (empty($item['line_total'])) {
continue;
}
if (empty($item['entity_id'])) {
$item['entity_id'] = $id;
}
// tax integration
if (empty($item['contribution_id'])) {
$item['contribution_id'] = $id;
}
// Membership
if (!empty($item['membership_id'])) {
$item['entity_id'] = $item['membership_id'];
$lineItemArray = wf_civicrm_api('LineItem', 'get', array(
'entity_table' => "civicrm_membership",
'entity_id' => $item['entity_id'],
));
if ($lineItemArray['count'] != 0) {
// We only require first membership (signup) entry to make this work.
$firstLineItem = array_shift($lineItemArray['values']);
// Membership signup line item entry.
// Line Item record is already present for membership by this stage.
// Just need to upgrade contribution_id column in the record.
if (!isset($firstLineItem['contribution_id'])) {
$item['id'] = $firstLineItem['id'];
}
}
}
$line_result = wf_civicrm_api('line_item', 'create', $item);
$item['id'] = $line_result['id'];
$lineItemRecord = json_decode(json_encode($item), FALSE);
// Add financial_item and entity_financial_trxn
$result = CRM_Financial_BAO_FinancialItem::add($lineItemRecord, $contributionResult);
if (!is_null($this->tax_rate)) {
$result = CRM_Financial_BAO_FinancialItem::add($lineItemRecord, $contributionResult, TRUE);
}
// Create participant/membership payment records
if (isset($item['membership_id']) || isset($item['participant_id'])) {
$type = isset($item['participant_id']) ? 'participant' : 'membership';
wf_civicrm_api("{$type}_payment", 'create', array(
"{$type}_id" => $item["{$type}_id"],
'contribution_id' => $id,
));
}
}
}
/**
* @param string $ent - entity type
* @param int $n - entity number
* @param int $id - entity id
* @param bool $new - is this a new object? (should we bother checking for existing data)
*/
private function processAttachments($ent, $n, $id, $new = FALSE) {
$attachments = $new ? array() : $this->getAttachments($ent, $id);
foreach ((array) wf_crm_aval($this->data[$ent], "$n:{$ent}upload:1") as $num => $file_id) {
if ($file_id) {
list(, $i) = explode('_', $num);
$dao = new CRM_Core_DAO_EntityFile();
if (!empty($attachments[$i])) {
$dao->id = $attachments[$i]['id'];
}
$dao->file_id = $file_id;
$dao->entity_id = $id;
$dao->entity_table = "civicrm_$ent";
$dao->save();
}
}
}
/**
* Recursive function to fill ContactRef fields with contact IDs
*
* @internal param $values null|array
* Leave blank - used internally to recurse through data
* @internal param $depth int
* Leave blank - used internally to track recursion level
*/
private function fillContactRefs($values = NULL, $depth = 0) {
$order = array('ent', 'c', 'table', 'n', 'name');
static $ent = '';
static $c = '';
static $table = '';
static $n = '';
if ($values === NULL) {
$values = $this->data;
}
foreach ($values as $key => $val) {
${$order[$depth]} = $key;
if ($depth < 4 && is_array($val)) {
$this->fillContactRefs($val, $depth + 1);
}
elseif ($depth == 4 && $val && wf_crm_aval($this->all_fields, "{$table}_$name:data_type") == 'ContactReference') {
if (is_array($val)) {
$this->data[$ent][$c][$table][$n][$name] = array();
foreach ($val as $v) {
if (is_numeric($v) && !empty($this->ent['contact'][$v]['id'])) {
$this->data[$ent][$c][$table][$n][$name][] = $this->ent['contact'][$v]['id'];
}
}
}
else {
unset($this->data[$ent][$c][$table][$n][$name]);
if (!empty($this->ent['contact'][$val]['id'])) {
$this->data[$ent][$c][$table][$n][$name] = $this->ent['contact'][$val]['id'];
}
}
}
}
}
/**
* Fill data array with submitted form values
*/
private function fillDataFromSubmission() {
foreach ($this->enabled as $field_key => $fid) {
$val = $this->submissionValue($fid);
// If value is null then it was hidden by a webform conditional rule - skip it
if ($val !== NULL && $val !== array(NULL)) {
list( , $c, $ent, $n, $table, $name) = explode('_', $field_key, 6);
// Fieldsets and existing contact fields are not strictly CiviCRM fields, so ignore
if ($name === 'existing' || $name === 'fieldset') {
continue;
}
// Ignore values from fields hidden by existing contact component
if ($this->isFieldHiddenByExistingContactSettings($ent, $c, $table, $n, $name)) {
// Also remove the value from the webform submission
$this->submissionValue($fid, array(NULL));
continue;
}
$field = $this->all_fields[$table . '_' . $name];
$component = $this->node->webform['components'][$this->enabled[$field_key]];
// Ignore values from hidden fields
if ($field['type'] == 'hidden') {
continue;
}
// Translate privacy options into separate values
if ($name === 'privacy') {
foreach (array_keys($this->getExposedOptions($field_key)) as $key) {
$this->data[$ent][$c][$table][$n][$key] = in_array($key, $val);
}
continue;
}
$dataType = wf_crm_aval($field, 'data_type');
if (!empty($field['extra']['multiple'])) {
if ($val === array('')) {
$val = array();
}
// Merge with existing data
if (!empty($this->data[$ent][$c][$table][$n][$name]) && is_array($this->data[$ent][$c][$table][$n][$name])) {
$val = array_unique(array_merge($val, $this->data[$ent][$c][$table][$n][$name]));
}
// Implode data that will be stored as a string
if ($table !== 'other' && $name !== 'event_id' && $name !== 'relationship_type_id' && $table !== 'contact' && $dataType != 'ContactReference') {
$val = CRM_Utils_Array::implodePadded($val);
}
}
elseif ($name === 'image_URL') {
if (empty($val[0]) || !($val = $this->getDrupalFileUrl($val[0]))) {
// This field can't be emptied due to the nature of file uploads
continue;
}
}
elseif ($dataType == 'File') {
if (empty($val[0]) || !($val = $this->saveDrupalFileToCivi($val[0]))) {
// This field can't be emptied due to the nature of file uploads
continue;
}
}
elseif ($field['type'] === 'date') {
$val = empty($val[0]) ? '' : str_replace('-', '', $val[0]);
// Add time field value
$time = wf_crm_aval($this->data, "$ent:$c:$table:$n:$name", '');
// Remove default date if it has been added
if (strlen($time) == 14) {
$time = substr($time, -6);
}
$val .= $time;
}
// The admin can change a number field to use checkbox/radio/select/grid widget and we'll sum the result
elseif ($field['type'] === 'number') {
$sum = 0;
foreach ((array) $val as $k => $v) {
// Perform multiplication across grid elements
if ($component['type'] == 'grid' && is_numeric($k)) {
$v = $v * $k;
}
if (is_numeric($v)) {
$sum += $v;
}
}
// We don't allow negative payments
$val = $sum < 0 ? 0 : $sum;
}
else {
$val = isset($val[0]) ? $val[0] : '';
}
// Fudge together date and time fields
if ($field['type'] === 'time' && substr($name, -8) === 'timepart') {
$name = str_replace('_timepart', '', $name);
// Add date (default to today)
$date = wf_crm_aval($this->data, "$ent:$c:$table:$n:$name", date('Ymd'));
$val = $date . str_replace(':', '', $val);
}
// Only known contacts are allowed to empty a field
if (($val !== '' && $val !== NULL && $val !== array()) || !empty($this->existing_contacts[$c])) {
$this->data[$ent][$c][$table][$n][$name] = $val;
}
}
}
}
/**
* Test whether a field has been hidden due to existing contact settings
* @param $ent
* @param $c
* @param $table
* @param $n
* @param $name
* @return bool
*/
private function isFieldHiddenByExistingContactSettings($ent, $c, $table, $n, $name) {
if ($ent == 'contact' && isset($this->enabled["civicrm_{$c}_contact_1_contact_existing"])) {
$component = $this->getComponent("civicrm_{$c}_contact_1_contact_existing");
$existing_contact_val = $this->submissionValue($component['cid']);
// Fields are hidden if value is empty (no selection) or a numeric contact id
if (!$existing_contact_val[0] || is_numeric($existing_contact_val[0])) {
$type = ($table == 'contact' && strpos($name, 'name')) ? 'name' : $table;
if (in_array($type, $component['extra']['hide_fields'])) {
// With the no_hide_blank setting we must load the contact to determine if the field was hidden
if (wf_crm_aval($component['extra'], 'no_hide_blank')) {
$value = wf_crm_aval($this->loadContact($c), "$table:$n:$name");
return !(!$value && !is_numeric($value));
}
else {
return TRUE;
}
}
}
}
return FALSE;
}
/**
* Test if any relevant data has been entered for a location
* @param string $location
* @param array $params
* @return bool
*/
private function locationIsEmpty($location, $params) {
switch ($location) {
case 'address':
return empty($params['street_address'])
&& empty($params['city'])
&& empty($params['state_province_id'])
&& empty($params['country_id'])
&& empty($params['postal_code'])
&& (empty($params['master_id']) || $params['master_id'] == 'null');
case 'website':
return empty($params['url']);
case 'im':
return empty($params['name']);
default:
return empty($params[$location]);
}
}
/**
* Clears an error against a form element.
* Used to disable validation when this module hides a field
* @see https://api.drupal.org/comment/49163#comment-49163
*
* @param $name string
*/
private function unsetError($name) {
$errors = &drupal_static('form_set_error', array());
$removed_messages = array();
if (isset($errors[$name])) {
$removed_messages[] = $errors[$name];
unset($errors[$name]);
}
$_SESSION['messages']['error'] = array_diff($_SESSION['messages']['error'], $removed_messages);
if (empty($_SESSION['messages']['error'])) {
unset($_SESSION['messages']['error']);
}
}
/**
* Get or set a value from a webform submission
* During validation phase we use $this->crmValues
* During submission processing we use $this->submission
*
* @param $fid
* Numeric webform component id
* @param $value
* Value to set - leave empty to get a value rather than setting it
*
* @return array|null field value if found
*/
protected function submissionValue($fid, $value = NULL) {
// In submission processing context
if ($this->submission) {
if (!isset($this->submission->data[$fid])) {
return NULL;
}
$field =& $this->submission->data[$fid];
// During submission preprocessing this is used to alter the submission
if ($value !== NULL) {
$field = (array) $value;
}
return $field;
}
// In validation context - no need to ever change the value so just return it
else {
if (!isset($this->rawValues[$fid])) {
return NULL;
}
// rawValues is slightly different from submission->data in that empty values are present in arrays
if (is_array($this->rawValues[$fid])) {
$val = array_filter($this->rawValues[$fid]);
return $val;
}
else {
return (array) $this->rawValues[$fid];
}
}
}
/**
* Identifies contact 1 as acting user for CiviCRM's advanced logging
*/
public function setLoggingContact() {
if (!empty($this->ent['contact'][1]['id']) && user_is_anonymous()) {
CRM_Core_DAO::executeQuery('SET @civicrm_user_id = %1', array(1 => array($this->ent['contact'][1]['id'], 'Integer')));
}
}
/**
* reorder submitted location values according to existing location values
*
* @param array $submittedLocationValues
* @param array $existingLocationValues
* @param string $entity
* @return array
*/
protected function reorderLocationValues($submittedLocationValues, $existingLocationValues, $entity) {
$reorderedArray = array();
$index = 1;
$entityTypeIdIndex = $entity.'_type_id';
$entity = $entity == 'website' ? 'url' : $entity; // for website only
foreach ($existingLocationValues as $eValue) {
$existingLocationTypeId = $entity != 'url' ? $eValue['location_type_id'] : NULL;
$existingEntityTypeId = isset($eValue[$entityTypeIdIndex]) ? $eValue[$entityTypeIdIndex] : NULL;
if (!empty($existingEntityTypeId)) {
$reorderedArray[$index][$entityTypeIdIndex] = $existingEntityTypeId;
}
elseif (!empty($existingLocationTypeId)) {
$reorderedArray[$index]['location_type_id'] = $existingLocationTypeId;
}
$reorderedArray[$index][$entity] = $eValue[$entity];
// address field contain many sub fields and should be handled differently
if ($entity != 'address') {
$submittedLocationValues = self::unsetEmptyValueIndexes($submittedLocationValues, $entity);
$reorderedArray[$index][$entity] = $eValue[$entity];
}
else {
foreach (wf_crm_address_fields() as $field) {
$reorderedArray[$index][$field] = isset($eValue[$field]) ? $eValue[$field] : '';
}
// handle supplemental addresses
$subAddressIndex = 1;
$subAddField = 'supplemental_address_' . $subAddressIndex;
while(isset($eValue[$subAddField])) {
$reorderedArray[$index][$subAddField] = $eValue[$subAddField];
$subAddField = 'supplemental_address_' . ++$subAddressIndex;
}
}
foreach ($submittedLocationValues as $key => $sValue) {
$sLocationTypeId = isset($sValue['location_type_id']) ? $sValue['location_type_id'] : NULL;
$sEntityTypeId = isset($sValue[$entityTypeIdIndex]) ? $sValue[$entityTypeIdIndex] : NULL;
if (($existingLocationTypeId == $sLocationTypeId && empty($sEntityTypeId))
||
($existingEntityTypeId == $sEntityTypeId && empty($sLocationTypeId))
||
($existingLocationTypeId == $sLocationTypeId && $existingEntityTypeId == $sEntityTypeId)) {
// address field contain many sub fields and should be handled differently
if ($entity != 'address') {
$reorderedArray[$index][$entity] = $sValue[$entity];
}
else {
foreach (wf_crm_address_fields() as $field) {
if (isset($sValue[$field])) {
$reorderedArray[$index][$field] = $sValue[$field];
}
}
// handle supplemental addresses
$subAddressIndex = 1;
$subAddField = 'supplemental_address_' . $subAddressIndex;
while(isset($sValue[$subAddField])) {
$reorderedArray[$index][$subAddField] = $sValue[$subAddField];
$subAddField = 'supplemental_address_' . ++$subAddressIndex;
}
}
unset($submittedLocationValues[$key]);
}
}
$index++;
}
// handle remaining values
if (!empty($submittedLocationValues)) {
// cannot use array_push, array_merge because preserving array keys is important
foreach ($submittedLocationValues as $sValue) {
$reorderedArray[] = $sValue;
}
}
return $reorderedArray;
}
private function unsetEmptyValueIndexes($values, $entity) {
foreach ($values as $k => $v) {
if (!isset($v[$entity])) {
unset($values[$k]);
}
}
return $values;
}
}