3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2017
33 class CRM_Core_BAO_Mapping
extends CRM_Core_DAO_Mapping
{
38 public function __construct() {
39 parent
::__construct();
43 * Fetch object based on array of properties.
45 * @param array $params
46 * (reference ) an assoc array of name/value pairs.
47 * @param array $defaults
48 * (reference ) an assoc array to hold the flattened values.
51 * CRM_Core_DAO_Mapping object on success, otherwise NULL
53 public static function retrieve(&$params, &$defaults) {
54 $mapping = new CRM_Core_DAO_Mapping();
55 $mapping->copyValues($params);
56 if ($mapping->find(TRUE)) {
57 CRM_Core_DAO
::storeValues($mapping, $defaults);
71 public static function del($id) {
72 // delete from mapping_field table
73 $mappingField = new CRM_Core_DAO_MappingField();
74 $mappingField->mapping_id
= $id;
75 $mappingField->delete();
77 // delete from mapping table
78 $mapping = new CRM_Core_DAO_Mapping();
80 if ($mapping->find(TRUE)) {
81 $result = $mapping->delete();
88 * Takes an associative array and creates a contact object.
90 * The function extract all the params it needs to initialize the create a
91 * contact object. the params array could contain additional unused name/value
94 * @param array $params
95 * An array of name/value pairs.
98 * CRM_Core_DAO_Mapper object on success, otherwise NULL
100 public static function add($params) {
101 $mapping = new CRM_Core_DAO_Mapping();
102 $mapping->copyValues($params);
109 * Get the list of mappings.
111 * @param string $mappingType
115 * Array of mapping names, keyed by id.
117 public static function getMappings($mappingType) {
118 $result = civicrm_api3('Mapping', 'get', array(
119 'mapping_type_id' => $mappingType,
127 foreach ($result['values'] as $key => $value) {
128 $mapping[$key] = $value['name'];
134 * Get the mappings array, creating if it does not exist.
136 * @param string $mappingType
140 * Array of mapping names, keyed by id.
142 * @throws \CiviCRM_API3_Exception
144 public static function getCreateMappingValues($mappingType) {
146 return CRM_Core_BAO_Mapping
::getMappings($mappingType);
148 catch (CiviCRM_API3_Exception
$e) {
149 // Having a valid mapping_type_id is now enforced. However, rather than error let's
150 // add it. This is required for Multi value which could be done by upgrade script, but
151 // it feels like there could be other instances so this is safer.
152 $errorParams = $e->getExtraParams();
153 if ($errorParams['error_field'] === 'mapping_type_id') {
154 $mappingValues = civicrm_api3('Mapping', 'getoptions', array('field' => 'mapping_type_id'));
155 civicrm_api3('OptionValue', 'create', array(
156 'option_group_id' => 'mapping_type',
157 'label' => $mappingType,
158 'value' => max(array_keys($mappingValues['values'])) +
1,
161 return CRM_Core_BAO_Mapping
::getMappings($mappingType);
168 * Get the mapping fields.
170 * @param int $mappingId
173 * @param bool $addPrimary
174 * Add the key 'Primary' when the field is a location field AND there is
175 * no location type (meaning Primary)?
178 * array of mapping fields
180 public static function getMappingFields($mappingId, $addPrimary = FALSE) {
181 //mapping is to be loaded from database
182 $mapping = new CRM_Core_DAO_MappingField();
183 $mapping->mapping_id
= $mappingId;
184 $mapping->orderBy('column_number');
187 $mappingName = $mappingLocation = $mappingContactType = $mappingPhoneType = array();
188 $mappingImProvider = $mappingRelation = $mappingOperator = $mappingValue = $mappingWebsiteType = array();
189 while ($mapping->fetch()) {
190 $mappingName[$mapping->grouping
][$mapping->column_number
] = $mapping->name
;
191 $mappingContactType[$mapping->grouping
][$mapping->column_number
] = $mapping->contact_type
;
193 if (!empty($mapping->location_type_id
)) {
194 $mappingLocation[$mapping->grouping
][$mapping->column_number
] = $mapping->location_type_id
;
196 elseif ($addPrimary) {
197 if (CRM_Contact_BAO_Contact
::isFieldHasLocationType($mapping->name
)) {
198 $mappingLocation[$mapping->grouping
][$mapping->column_number
] = ts('Primary');
201 $mappingLocation[$mapping->grouping
][$mapping->column_number
] = NULL;
205 if (!empty($mapping->phone_type_id
)) {
206 $mappingPhoneType[$mapping->grouping
][$mapping->column_number
] = $mapping->phone_type_id
;
209 // get IM service provider type id from mapping fields
210 if (!empty($mapping->im_provider_id
)) {
211 $mappingImProvider[$mapping->grouping
][$mapping->column_number
] = $mapping->im_provider_id
;
214 if (!empty($mapping->website_type_id
)) {
215 $mappingWebsiteType[$mapping->grouping
][$mapping->column_number
] = $mapping->website_type_id
;
218 if (!empty($mapping->relationship_type_id
)) {
219 $mappingRelation[$mapping->grouping
][$mapping->column_number
] = "{$mapping->relationship_type_id}_{$mapping->relationship_direction}";
222 if (!empty($mapping->operator
)) {
223 $mappingOperator[$mapping->grouping
][$mapping->column_number
] = $mapping->operator
;
226 if (!empty($mapping->value
)) {
227 $mappingValue[$mapping->grouping
][$mapping->column_number
] = $mapping->value
;
245 * Check Duplicate Mapping Name.
247 * @param string $nameField
249 * @param string $mapTypeId
254 public static function checkMapping($nameField, $mapTypeId) {
255 $mapping = new CRM_Core_DAO_Mapping();
256 $mapping->name
= $nameField;
257 $mapping->mapping_type_id
= $mapTypeId;
258 return (bool) $mapping->find(TRUE);
262 * Function returns associated array of elements, that will be passed for search.
264 * @param int $smartGroupId
268 * associated array of elements
270 public static function getFormattedFields($smartGroupId) {
271 $returnFields = array();
273 //get the fields from mapping table
274 $dao = new CRM_Core_DAO_MappingField();
275 $dao->mapping_id
= $smartGroupId;
277 while ($dao->fetch()) {
278 $fldName = $dao->name
;
279 if ($dao->location_type_id
) {
280 $fldName .= "-{$dao->location_type_id}";
282 if ($dao->phone_type
) {
283 $fldName .= "-{$dao->phone_type}";
285 $returnFields[$fldName]['value'] = $dao->value
;
286 $returnFields[$fldName]['op'] = $dao->operator
;
287 $returnFields[$fldName]['grouping'] = $dao->grouping
;
289 return $returnFields;
293 * Build the mapping form.
295 * @param CRM_Core_Form $form
296 * @param string $mappingType
297 * (Export/Search Builder). (Import apparently used to use this but does no longer).
298 * @param int $mappingId
299 * @param int $columnNo
300 * @param int $blockCount
301 * (no of blocks shown).
302 * @param NULL $exportMode
304 public static function buildMappingForm(&$form, $mappingType, $mappingId, $columnNo, $blockCount, $exportMode = NULL) {
306 $hasLocationTypes = array();
307 $hasRelationTypes = array();
310 //get the saved mapping details
312 if ($mappingType == 'Export') {
313 $columnCount = array('1' => $columnNo);
314 $form->applyFilter('saveMappingName', 'trim');
316 //to save the current mappings
317 if (!isset($mappingId)) {
318 $saveDetailsName = ts('Save this field mapping');
319 $form->add('text', 'saveMappingName', ts('Name'));
320 $form->add('text', 'saveMappingDesc', ts('Description'));
323 $form->assign('loadedMapping', $mappingId);
325 $params = array('id' => $mappingId);
327 $mappingDetails = CRM_Core_BAO_Mapping
::retrieve($params, $temp);
329 $form->assign('savedName', $mappingDetails->name
);
331 $form->add('hidden', 'mappingId', $mappingId);
333 $form->addElement('checkbox', 'updateMapping', ts('Update this field mapping'), NULL);
334 $saveDetailsName = ts('Save as a new field mapping');
335 $form->add('text', 'saveMappingName', ts('Name'));
336 $form->add('text', 'saveMappingDesc', ts('Description'));
339 $form->addElement('checkbox', 'saveMapping', $saveDetailsName, NULL, array('onclick' => "showSaveDetails(this)"));
340 $form->addFormRule(array('CRM_Export_Form_Map', 'formRule'), $form->get('mappingTypeId'));
342 elseif ($mappingType == 'Search Builder') {
343 $columnCount = $columnNo;
344 $form->addElement('submit', 'addBlock', ts('Also include contacts where'),
345 array('class' => 'submit-link')
349 $contactType = array('Individual', 'Household', 'Organization');
350 foreach ($contactType as $value) {
351 if ($mappingType == 'Search Builder') {
352 // get multiple custom group fields in this context
353 $contactFields = CRM_Contact_BAO_Contact
::exportableFields($value, FALSE, FALSE, FALSE, TRUE);
356 $contactFields = CRM_Contact_BAO_Contact
::exportableFields($value, FALSE, TRUE);
358 $contactFields = array_merge($contactFields, CRM_Contact_BAO_Query_Hook
::singleton()->getFields());
360 // exclude the address options disabled in the Address Settings
361 $fields[$value] = CRM_Core_BAO_Address
::validateAddressOptions($contactFields);
362 ksort($fields[$value]);
363 if ($mappingType == 'Export') {
364 $relationships = array();
365 $relationshipTypes = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, NULL, NULL, $value, TRUE);
366 asort($relationshipTypes);
368 foreach ($relationshipTypes as $key => $var) {
369 list($type) = explode('_', $key);
371 $relationships[$key]['title'] = $var;
372 $relationships[$key]['headerPattern'] = '/' . preg_quote($var, '/') . '/';
373 $relationships[$key]['export'] = TRUE;
374 $relationships[$key]['relationship_type_id'] = $type;
375 $relationships[$key]['related'] = TRUE;
376 $relationships[$key]['hasRelationType'] = 1;
379 if (!empty($relationships)) {
380 $fields[$value] = array_merge($fields[$value],
381 array('related' => array('title' => ts('- related contact info -'))),
388 //get the current employer for mapping.
389 if ($mappingType == 'Export') {
390 $fields['Individual']['current_employer_id']['title'] = ts('Current Employer ID');
393 // add component fields
394 $compArray = array();
396 //we need to unset groups, tags, notes for component export
397 if ($exportMode != CRM_Export_Form_Select
::CONTACT_EXPORT
) {
403 unset($fields['Individual'][$value]);
404 unset($fields['Household'][$value]);
405 unset($fields['Organization'][$value]);
409 if ($mappingType == 'Search Builder') {
410 //build the common contact fields array.
411 $fields['Contact'] = array();
412 foreach ($fields['Individual'] as $key => $value) {
413 if (!empty($fields['Household'][$key]) && !empty($fields['Organization'][$key])) {
414 $fields['Contact'][$key] = $value;
415 unset($fields['Organization'][$key],
416 $fields['Household'][$key],
417 $fields['Individual'][$key]);
420 if (array_key_exists('note', $fields['Contact'])) {
421 $noteTitle = $fields['Contact']['note']['title'];
422 $fields['Contact']['note']['title'] = $noteTitle . ': ' . ts('Body and Subject');
423 $fields['Contact']['note_body'] = array('title' => $noteTitle . ': ' . ts('Body Only'), 'name' => 'note_body');
424 $fields['Contact']['note_subject'] = array(
425 'title' => $noteTitle . ': ' . ts('Subject Only'),
426 'name' => 'note_subject',
431 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
)) {
432 if (CRM_Core_Permission
::access('CiviContribute')) {
433 $fields['Contribution'] = CRM_Contribute_BAO_Contribution
::getExportableFieldsWithPseudoConstants();
434 unset($fields['Contribution']['contribution_contact_id']);
435 $compArray['Contribution'] = ts('Contribution');
439 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
)) {
440 if (CRM_Core_Permission
::access('CiviEvent')) {
441 $fields['Participant'] = CRM_Event_BAO_Participant
::exportableFields();
442 //get the component payment fields
443 if ($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
) {
444 $componentPaymentFields = array();
445 foreach (CRM_Export_BAO_Export
::componentPaymentFields() as $payField => $payTitle) {
446 $componentPaymentFields[$payField] = array('title' => $payTitle);
448 $fields['Participant'] = array_merge($fields['Participant'], $componentPaymentFields);
451 $compArray['Participant'] = ts('Participant');
455 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::MEMBER_EXPORT
)) {
456 if (CRM_Core_Permission
::access('CiviMember')) {
457 $fields['Membership'] = CRM_Member_BAO_Membership
::getMembershipFields($exportMode);
458 unset($fields['Membership']['membership_contact_id']);
459 $compArray['Membership'] = ts('Membership');
463 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::PLEDGE_EXPORT
)) {
464 if (CRM_Core_Permission
::access('CiviPledge')) {
465 $fields['Pledge'] = CRM_Pledge_BAO_Pledge
::exportableFields();
466 unset($fields['Pledge']['pledge_contact_id']);
467 $compArray['Pledge'] = ts('Pledge');
471 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::CASE_EXPORT
)) {
472 if (CRM_Core_Permission
::access('CiviCase')) {
473 $fields['Case'] = CRM_Case_BAO_Case
::exportableFields();
474 $compArray['Case'] = ts('Case');
476 $fields['Activity'] = CRM_Activity_BAO_Activity
::exportableFields('Case');
477 $compArray['Activity'] = ts('Case Activity');
479 unset($fields['Case']['case_contact_id']);
482 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::GRANT_EXPORT
)) {
483 if (CRM_Core_Permission
::access('CiviGrant')) {
484 $fields['Grant'] = CRM_Grant_BAO_Grant
::exportableFields();
485 unset($fields['Grant']['grant_contact_id']);
486 if ($mappingType == 'Search Builder') {
487 unset($fields['Grant']['grant_type_id']);
489 $compArray['Grant'] = ts('Grant');
493 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::ACTIVITY_EXPORT
)) {
494 $fields['Activity'] = CRM_Activity_BAO_Activity
::exportableFields('Activity');
495 $compArray['Activity'] = ts('Activity');
498 //Contact Sub Type For export
499 $contactSubTypes = array();
500 $subTypes = CRM_Contact_BAO_ContactType
::subTypeInfo();
502 foreach ($subTypes as $subType => $val) {
503 //adding subtype specific relationships CRM-5256
504 $csRelationships = array();
506 if ($mappingType == 'Export') {
507 $subTypeRelationshipTypes
508 = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, NULL, NULL, $val['parent'],
509 FALSE, 'label', TRUE, $subType);
511 foreach ($subTypeRelationshipTypes as $key => $var) {
512 if (!array_key_exists($key, $fields[$val['parent']])) {
513 list($type) = explode('_', $key);
515 $csRelationships[$key]['title'] = $var;
516 $csRelationships[$key]['headerPattern'] = '/' . preg_quote($var, '/') . '/';
517 $csRelationships[$key]['export'] = TRUE;
518 $csRelationships[$key]['relationship_type_id'] = $type;
519 $csRelationships[$key]['related'] = TRUE;
520 $csRelationships[$key]['hasRelationType'] = 1;
525 $fields[$subType] = $fields[$val['parent']] +
$csRelationships;
527 //custom fields for sub type
528 $subTypeFields = CRM_Core_BAO_CustomField
::getFieldsForImport($subType);
529 $fields[$subType] +
= $subTypeFields;
531 if (!empty($subTypeFields) ||
!empty($csRelationships)) {
532 $contactSubTypes[$subType] = $val['label'];
536 foreach ($fields as $key => $value) {
538 foreach ($value as $key1 => $value1) {
539 //CRM-2676, replacing the conflict for same custom field name from different custom group.
540 $customGroupName = self
::getCustomGroupName($key1);
542 if ($customGroupName) {
543 $relatedMapperFields[$key][$key1] = $mapperFields[$key][$key1] = $customGroupName . ': ' . $value1['title'];
546 $relatedMapperFields[$key][$key1] = $mapperFields[$key][$key1] = $value1['title'];
548 if (isset($value1['hasLocationType'])) {
549 $hasLocationTypes[$key][$key1] = $value1['hasLocationType'];
552 if (isset($value1['hasRelationType'])) {
553 $hasRelationTypes[$key][$key1] = $value1['hasRelationType'];
554 unset($relatedMapperFields[$key][$key1]);
558 if (array_key_exists('related', $relatedMapperFields[$key])) {
559 unset($relatedMapperFields[$key]['related']);
563 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
565 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
567 // FIXME: dirty hack to make the default option show up first. This
568 // avoids a mozilla browser bug with defaults on dynamically constructed
570 if ($defaultLocationType) {
571 $defaultLocation = $locationTypes[$defaultLocationType->id
];
572 unset($locationTypes[$defaultLocationType->id
]);
573 $locationTypes = array($defaultLocationType->id
=> $defaultLocation) +
$locationTypes;
576 $locationTypes = array(' ' => ts('Primary')) +
$locationTypes;
578 // since we need a hierarchical list to display contact types & subtypes,
579 // this is what we going to display in first selector
580 $contactTypes = CRM_Contact_BAO_ContactType
::getSelectElements(FALSE, FALSE);
581 if ($mappingType == 'Search Builder') {
582 $contactTypes = array('Contact' => ts('Contacts')) +
$contactTypes;
585 $sel1 = array('' => ts('- select record type -')) +
$contactTypes +
$compArray;
587 foreach ($sel1 as $key => $sel) {
589 // sort everything BUT the contactType which is sorted separately by
590 // an initial commit of CRM-13278 (check ksort above)
591 if (!in_array($key, $contactType)) {
592 asort($mapperFields[$key]);
594 $sel2[$key] = array('' => ts('- select field -')) +
$mapperFields[$key];
600 $phoneTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id');
601 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
604 foreach ($sel1 as $k => $sel) {
606 foreach ($locationTypes as $key => $value) {
607 if (trim($key) != '') {
608 $sel4[$k]['phone'][$key] = &$phoneTypes;
609 $sel4[$k]['im'][$key] = &$imProviders;
615 foreach ($sel1 as $k => $sel) {
617 foreach ($mapperFields[$k] as $key => $value) {
618 if (isset($hasLocationTypes[$k][$key])) {
619 $sel3[$k][$key] = $locationTypes;
628 // Array for core fields and relationship custom data
629 $relationshipTypes = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE);
631 if ($mappingType == 'Export') {
632 foreach ($sel1 as $k => $sel) {
634 foreach ($mapperFields[$k] as $field => $dontCare) {
635 if (isset($hasRelationTypes[$k][$field])) {
636 list($id, $first, $second) = explode('_', $field);
637 // FIX ME: For now let's not expose custom data related to relationship
638 $relationshipCustomFields = array();
639 //$relationshipCustomFields = self::getRelationTypeCustomGroupData( $id );
640 //asort($relationshipCustomFields);
642 $relatedFields = array();
643 $relationshipType = new CRM_Contact_BAO_RelationshipType();
644 $relationshipType->id
= $id;
645 if ($relationshipType->find(TRUE)) {
646 $direction = "contact_sub_type_$second";
647 $target_type = 'contact_type_' . $second;
648 if (isset($relationshipType->$direction)) {
649 $relatedFields = array_merge((array) $relatedMapperFields[$relationshipType->$direction], (array) $relationshipCustomFields);
651 elseif (isset($relationshipType->$target_type)) {
652 $relatedFields = array_merge((array) $relatedMapperFields[$relationshipType->$target_type], (array) $relationshipCustomFields);
654 //CRM-20672 If contact target type not set e.g. "All Contacts" relationship - present user with all field options and let them determine what they expect to work
656 $types = CRM_Contact_BAO_ContactType
::basicTypes(FALSE);
657 foreach ($types as $contactType => $label) {
658 $relatedFields = array_merge($relatedFields, (array) $relatedMapperFields[$label]);
660 $relatedFields = array_merge($relatedFields, (array) $relationshipCustomFields);
663 $relationshipType->free();
664 asort($relatedFields);
665 $sel5[$k][$field] = $relatedFields;
671 //Location Type for relationship fields
672 foreach ($sel5 as $k => $v) {
674 foreach ($v as $rel => $fields) {
675 foreach ($fields as $field => $fieldLabel) {
676 if (isset($hasLocationTypes[$k][$field])) {
677 $sel6[$k][$rel][$field] = $locationTypes;
684 //PhoneTypes for relationship fields
686 foreach ($sel6 as $k => $rel) {
688 foreach ($rel as $phonekey => $phonevalue) {
689 foreach ($locationTypes as $locType => $loc) {
690 if (trim($locType) != '') {
691 $sel7[$k][$phonekey]['phone'][$locType] = &$phoneTypes;
692 $sel7[$k][$phonekey]['im'][$locType] = &$imProviders;
700 //special fields that have location, hack for primary location
701 $specialFields = array(
703 'supplemental_address_1',
704 'supplemental_address_2',
705 'supplemental_address_3',
708 'postal_code_suffix',
718 if (isset($mappingId)) {
719 list($mappingName, $mappingContactType, $mappingLocation, $mappingPhoneType, $mappingImProvider,
720 $mappingRelation, $mappingOperator, $mappingValue
721 ) = CRM_Core_BAO_Mapping
::getMappingFields($mappingId);
723 $blkCnt = count($mappingName);
724 if ($blkCnt >= $blockCount) {
725 $blockCount = $blkCnt +
1;
727 for ($x = 1; $x < $blockCount; $x++
) {
728 if (isset($mappingName[$x])) {
729 $colCnt = count($mappingName[$x]);
730 if ($colCnt >= $columnCount[$x]) {
731 $columnCount[$x] = $colCnt;
737 $form->_blockCount
= $blockCount;
738 $form->_columnCount
= $columnCount;
740 $form->set('blockCount', $form->_blockCount
);
741 $form->set('columnCount', $form->_columnCount
);
743 $defaults = $noneArray = $nullArray = array();
745 for ($x = 1; $x < $blockCount; $x++
) {
747 for ($i = 0; $i < $columnCount[$x]; $i++
) {
749 $sel = &$form->addElement('hierselect', "mapper[$x][$i]", ts('Mapper for Field %1', array(1 => $i)), NULL);
752 if (isset($mappingId)) {
753 $locationId = isset($mappingLocation[$x][$i]) ?
$mappingLocation[$x][$i] : 0;
754 if (isset($mappingName[$x][$i])) {
755 if (is_array($mapperFields[$mappingContactType[$x][$i]])) {
757 if (isset($mappingRelation[$x][$i])) {
758 $relLocationId = isset($mappingLocation[$x][$i]) ?
$mappingLocation[$x][$i] : 0;
759 if (!$relLocationId && in_array($mappingName[$x][$i], $specialFields)) {
760 $relLocationId = " ";
763 $relPhoneType = isset($mappingPhoneType[$x][$i]) ?
$mappingPhoneType[$x][$i] : NULL;
765 $defaults["mapper[$x][$i]"] = array(
766 $mappingContactType[$x][$i],
767 $mappingRelation[$x][$i],
770 $mappingName[$x][$i],
776 $noneArray[] = array($x, $i, 2);
778 if (!$phoneType && !$imProvider) {
779 $noneArray[] = array($x, $i, 3);
781 if (!$mappingName[$x][$i]) {
782 $noneArray[] = array($x, $i, 4);
784 if (!$relLocationId) {
785 $noneArray[] = array($x, $i, 5);
787 if (!$relPhoneType) {
788 $noneArray[] = array($x, $i, 6);
790 $noneArray[] = array($x, $i, 2);
793 $phoneType = isset($mappingPhoneType[$x][$i]) ?
$mappingPhoneType[$x][$i] : NULL;
794 $imProvider = isset($mappingImProvider[$x][$i]) ?
$mappingImProvider[$x][$i] : NULL;
795 if (!$locationId && in_array($mappingName[$x][$i], $specialFields)) {
799 $defaults["mapper[$x][$i]"] = array(
800 $mappingContactType[$x][$i],
801 $mappingName[$x][$i],
805 if (!$mappingName[$x][$i]) {
806 $noneArray[] = array($x, $i, 1);
809 $noneArray[] = array($x, $i, 2);
811 if (!$phoneType && !$imProvider) {
812 $noneArray[] = array($x, $i, 3);
815 $noneArray[] = array($x, $i, 4);
816 $noneArray[] = array($x, $i, 5);
817 $noneArray[] = array($x, $i, 6);
822 if (CRM_Utils_Array
::value($i, CRM_Utils_Array
::value($x, $mappingOperator))) {
823 $defaults["operator[$x][$i]"] = CRM_Utils_Array
::value($i, $mappingOperator[$x]);
826 if (CRM_Utils_Array
::value($i, CRM_Utils_Array
::value($x, $mappingValue))) {
827 $defaults["value[$x][$i]"] = CRM_Utils_Array
::value($i, $mappingValue[$x]);
832 //Fix for Search Builder
833 if ($mappingType == 'Export') {
840 $formValues = $form->exportValues();
842 if (empty($formValues)) {
843 // Incremented length for third select box(relationship type)
844 for ($k = 1; $k < $j; $k++
) {
845 $noneArray[] = array($x, $i, $k);
849 if (!empty($formValues['mapper'][$x])) {
850 foreach ($formValues['mapper'][$x] as $value) {
851 for ($k = 1; $k < $j; $k++
) {
852 if (!isset($formValues['mapper'][$x][$i][$k]) ||
853 (!$formValues['mapper'][$x][$i][$k])
855 $noneArray[] = array($x, $i, $k);
858 $nullArray[] = array($x, $i, $k);
864 for ($k = 1; $k < $j; $k++
) {
865 $noneArray[] = array($x, $i, $k);
870 //Fix for Search Builder
871 if ($mappingType == 'Export') {
872 if (!isset($mappingId) ||
$i >= count(reset($mappingName))) {
873 if (isset($formValues['mapper']) &&
874 isset($formValues['mapper'][$x][$i][1]) &&
875 array_key_exists($formValues['mapper'][$x][$i][1], $relationshipTypes)
877 $sel->setOptions(array($sel1, $sel2, $sel5, $sel6, $sel7, $sel3, $sel4));
880 $sel->setOptions(array($sel1, $sel2, $sel3, $sel4, $sel5, $sel6, $sel7));
884 $sel->setOptions(array($sel1, $sel2, $sel3, $sel4, $sel5, $sel6, $sel7));
888 $sel->setOptions(array($sel1, $sel2, $sel3, $sel4));
891 if ($mappingType == 'Search Builder') {
892 //CRM -2292, restricted array set
893 $operatorArray = array('' => ts('-operator-')) + CRM_Core_SelectValues
::getSearchBuilderOperators();
895 $form->add('select', "operator[$x][$i]", '', $operatorArray);
896 $form->add('text', "value[$x][$i]", '');
899 //end of columnCnt for
900 if ($mappingType == 'Search Builder') {
901 $title = ts('Another search field');
904 $title = ts('Select more fields');
907 $form->addElement('submit', "addMore[$x]", $title, array('class' => 'submit-link'));
911 $js = "<script type='text/javascript'>\n";
912 $formName = "document." . (($mappingType == 'Export') ?
'Map' : 'Builder');
913 if (!empty($nullArray)) {
914 $js .= "var nullArray = [";
917 foreach ($nullArray as $element) {
918 $key = "{$element[0]}, {$element[1]}, {$element[2]}";
919 if (!isset($seen[$key])) {
920 $elements[] = "[$key]";
924 $js .= implode(', ', $elements);
927 for (var i=0;i<nullArray.length;i++) {
928 if ( {$formName}['mapper['+nullArray[i][0]+']['+nullArray[i][1]+']['+nullArray[i][2]+']'] ) {
929 {$formName}['mapper['+nullArray[i][0]+']['+nullArray[i][1]+']['+nullArray[i][2]+']'].style.display = '';
934 if (!empty($noneArray)) {
935 $js .= "var noneArray = [";
938 foreach ($noneArray as $element) {
939 $key = "{$element[0]}, {$element[1]}, {$element[2]}";
940 if (!isset($seen[$key])) {
941 $elements[] = "[$key]";
945 $js .= implode(', ', $elements);
948 for (var i=0;i<noneArray.length;i++) {
949 if ( {$formName}['mapper['+noneArray[i][0]+']['+noneArray[i][1]+']['+noneArray[i][2]+']'] ) {
950 {$formName}['mapper['+noneArray[i][0]+']['+noneArray[i][1]+']['+noneArray[i][2]+']'].style.display = 'none';
955 $js .= "</script>\n";
957 $form->assign('initHideBoxes', $js);
958 $form->assign('columnCount', $columnCount);
959 $form->assign('blockCount', $blockCount);
960 $form->setDefaults($defaults);
962 $form->setDefaultAction('refresh');
966 * Function returns all custom fields with group title and
969 * @param int $relationshipTypeId
970 * Related relationship type id.
973 * all custom field titles
975 public function getRelationTypeCustomGroupData($relationshipTypeId) {
977 $customFields = CRM_Core_BAO_CustomField
::getFields('Relationship', NULL, NULL, $relationshipTypeId, NULL, NULL);
978 $groupTitle = array();
979 foreach ($customFields as $krelation => $vrelation) {
980 $groupTitle[$vrelation['label']] = $vrelation['groupTitle'] . '...' . $vrelation['label'];
987 * Function returns all Custom group Names.
989 * @param int $customfieldId
992 * @return null|string
993 * $customGroupName all custom group names
995 public static function getCustomGroupName($customfieldId) {
996 if ($customFieldId = CRM_Core_BAO_CustomField
::getKeyID($customfieldId)) {
997 $customGroupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', $customFieldId, 'custom_group_id');
998 $customGroupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $customGroupId, 'title');
1000 if (strlen($customGroupName) > 13) {
1001 $customGroupName = substr($customGroupName, 0, 10) . '...';
1004 return $customGroupName;
1009 * Function returns associated array of elements, that will be passed for search
1011 * @param array $params
1012 * Associated array of submitted values.
1014 * Row no of the fields.
1018 * formatted associated array of elements
1020 public static function formattedFields(&$params, $row = FALSE) {
1023 if (empty($params) ||
!isset($params['mapper'])) {
1027 $types = array('Individual', 'Organization', 'Household');
1028 foreach ($params['mapper'] as $key => $value) {
1029 $contactType = NULL;
1030 foreach ($value as $k => $v) {
1031 if (in_array($v[0], $types)) {
1032 if ($contactType && $contactType != $v[0]) {
1033 CRM_Core_Error
::fatal(ts("Cannot have two clauses with different types: %1, %2",
1034 array(1 => $contactType, 2 => $v[0])
1037 $contactType = $v[0];
1039 if (!empty($v['1'])) {
1041 $v2 = CRM_Utils_Array
::value('2', $v);
1042 if ($v2 && trim($v2)) {
1043 $fldName .= "-{$v[2]}";
1046 $v3 = CRM_Utils_Array
::value('3', $v);
1047 if ($v3 && trim($v3)) {
1048 $fldName .= "-{$v[3]}";
1051 $value = $params['value'][$key][$k];
1053 if ($v[0] == 'Contribution' && substr($fldName, 0, 7) != 'custom_'
1054 && substr($fldName, 0, 10) != 'financial_'
1055 && substr($fldName, 0, 8) != 'payment_') {
1056 if (substr($fldName, 0, 13) != 'contribution_') {
1057 $fldName = 'contribution_' . $fldName;
1061 // CRM-14983: verify if values are comma separated convert to array
1062 if (!is_array($value) && strstr($params['operator'][$key][$k], 'IN')) {
1063 $value = explode(',', $value);
1064 $value = array($params['operator'][$key][$k] => $value);
1066 // CRM-19081 Fix legacy StateProvince Field Values.
1067 // These derive from smart groups created using search builder under older
1068 // CiviCRM versions.
1069 if (!is_numeric($value) && $fldName == 'state_province') {
1070 $value = CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Address', 'state_province_id', $value);
1076 $params['operator'][$key][$k],
1085 $params['operator'][$key][$k],
1104 //add sortByCharacter values
1105 if (isset($params['sortByCharacter'])) {
1109 $params['sortByCharacter'],
1118 * @param array $params
1122 public static function &returnProperties(&$params) {
1124 'contact_type' => 1,
1125 'contact_sub_type' => 1,
1129 if (empty($params) ||
empty($params['mapper'])) {
1133 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
1134 foreach ($params['mapper'] as $key => $value) {
1135 foreach ($value as $k => $v) {
1137 if ($v[1] == 'groups' ||
$v[1] == 'tags') {
1141 if (isset($v[2]) && is_numeric($v[2])) {
1142 if (!array_key_exists('location', $fields)) {
1143 $fields['location'] = array();
1146 // make sure that we have a location fields and a location type for this
1147 $locationName = $locationTypes[$v[2]];
1148 if (!array_key_exists($locationName, $fields['location'])) {
1149 $fields['location'][$locationName] = array();
1150 $fields['location'][$locationName]['location_type'] = $v[2];
1153 if ($v[1] == 'phone' ||
$v[1] == 'email' ||
$v[1] == 'im') {
1154 // phone type handling
1156 $fields['location'][$locationName][$v[1] . "-" . $v[3]] = 1;
1159 $fields['location'][$locationName][$v[1]] = 1;
1163 $fields['location'][$locationName][$v[1]] = 1;
1177 * Save the mapping field info for search builder / export given the formvalues
1179 * @param array $params
1180 * Asscociated array of formvalues.
1181 * @param int $mappingId
1186 public static function saveMappingFields(&$params, $mappingId) {
1187 //delete mapping fields records for existing mapping
1188 $mappingFields = new CRM_Core_DAO_MappingField();
1189 $mappingFields->mapping_id
= $mappingId;
1190 $mappingFields->delete();
1192 if (empty($params['mapper'])) {
1196 //save record in mapping field table
1197 foreach ($params['mapper'] as $key => $value) {
1199 foreach ($value as $k => $v) {
1201 if (!empty($v['1'])) {
1202 $saveMappingFields = new CRM_Core_DAO_MappingField();
1204 $saveMappingFields->mapping_id
= $mappingId;
1205 $saveMappingFields->name
= CRM_Utils_Array
::value('1', $v);
1206 $saveMappingFields->contact_type
= CRM_Utils_Array
::value('0', $v);
1207 $locationId = CRM_Utils_Array
::value('2', $v);
1208 $saveMappingFields->location_type_id
= is_numeric($locationId) ?
$locationId : NULL;
1210 if ($v[1] == 'phone') {
1211 $saveMappingFields->phone_type_id
= CRM_Utils_Array
::value('3', $v);
1213 elseif ($v[1] == 'im') {
1214 $saveMappingFields->im_provider_id
= CRM_Utils_Array
::value('3', $v);
1217 if (!empty($params['operator'])) {
1218 $saveMappingFields->operator
= CRM_Utils_Array
::value($k, $params['operator'][$key]);
1220 if (!empty($params['value'])) {
1221 $saveMappingFields->value
= CRM_Utils_Array
::value($k, $params['value'][$key]);
1223 // Handle mapping for 'related contact' fields
1224 if (count(explode('_', CRM_Utils_Array
::value('1', $v))) > 2) {
1225 list($id, $first, $second) = explode('_', CRM_Utils_Array
::value('1', $v));
1226 if (($first == 'a' && $second == 'b') ||
($first == 'b' && $second == 'a')) {
1228 if (!empty($v['2'])) {
1229 $saveMappingFields->name
= CRM_Utils_Array
::value('2', $v);
1231 elseif (!empty($v['4'])) {
1232 $saveMappingFields->name
= CRM_Utils_Array
::value('4', $v);
1235 if (is_numeric(CRM_Utils_Array
::value('3', $v))) {
1236 $locationTypeid = CRM_Utils_Array
::value('3', $v);
1238 elseif (is_numeric(CRM_Utils_Array
::value('5', $v))) {
1239 $locationTypeid = CRM_Utils_Array
::value('5', $v);
1242 if (is_numeric(CRM_Utils_Array
::value('4', $v))) {
1243 $phoneTypeid = CRM_Utils_Array
::value('4', $v);
1245 elseif (is_numeric(CRM_Utils_Array
::value('6', $v))) {
1246 $phoneTypeid = CRM_Utils_Array
::value('6', $v);
1249 $saveMappingFields->location_type_id
= is_numeric($locationTypeid) ?
$locationTypeid : NULL;
1250 $saveMappingFields->phone_type_id
= is_numeric($phoneTypeid) ?
$phoneTypeid : NULL;
1251 $saveMappingFields->relationship_type_id
= $id;
1252 $saveMappingFields->relationship_direction
= "{$first}_{$second}";
1256 $saveMappingFields->grouping
= $key;
1257 $saveMappingFields->column_number
= $colCnt;
1258 $saveMappingFields->save();
1260 $locationTypeid = $phoneTypeid = NULL;