3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Core_BAO_Mapping
extends CRM_Core_DAO_Mapping
{
40 public function __construct() {
41 parent
::__construct();
45 * Fetch object based on array of properties
47 * @param array $params
48 * (reference ) an assoc array of name/value pairs.
49 * @param array $defaults
50 * (reference ) an assoc array to hold the flattened values.
53 * CRM_Core_DAO_Mapping object on success, otherwise NULL
56 public static function retrieve(&$params, &$defaults) {
57 $mapping = new CRM_Core_DAO_Mapping();
58 $mapping->copyValues($params);
59 if ($mapping->find(TRUE)) {
60 CRM_Core_DAO
::storeValues($mapping, $defaults);
75 public static function del($id) {
76 // delete from mapping_field table
77 $mappingField = new CRM_Core_DAO_MappingField();
78 $mappingField->mapping_id
= $id;
79 $mappingField->find();
80 while ($mappingField->fetch()) {
81 $mappingField->delete();
84 // delete from mapping table
85 $mapping = new CRM_Core_DAO_Mapping();
88 CRM_Core_Session
::setStatus(ts('Selected mapping has been deleted successfully.'), ts('Deleted'), 'success');
94 * Takes an associative array and creates a contact object
96 * The function extract all the params it needs to initialize the create a
97 * contact object. the params array could contain additional unused name/value
100 * @param array $params
101 * An array of name/value pairs.
104 * CRM_Core_DAO_Mapper object on success, otherwise NULL
107 public static function add($params) {
108 $mapping = new CRM_Core_DAO_Mapping();
109 $mapping->copyValues($params);
116 * Get the list of mappings
118 * @param string $mappingTypeId
122 * array of mapping name
125 public static function getMappings($mappingTypeId) {
127 $mappingDAO = new CRM_Core_DAO_Mapping();
128 $mappingDAO->mapping_type_id
= $mappingTypeId;
131 while ($mappingDAO->fetch()) {
132 $mapping[$mappingDAO->id
] = $mappingDAO->name
;
139 * Get the mapping fields
141 * @param int $mappingId
145 * array of mapping fields
148 public static function getMappingFields($mappingId) {
149 //mapping is to be loaded from database
150 $mapping = new CRM_Core_DAO_MappingField();
151 $mapping->mapping_id
= $mappingId;
152 $mapping->orderBy('column_number');
155 $mappingName = $mappingLocation = $mappingContactType = $mappingPhoneType = array();
156 $mappingImProvider = $mappingRelation = $mappingOperator = $mappingValue = $mappingWebsiteType = array();
157 while ($mapping->fetch()) {
158 $mappingName[$mapping->grouping
][$mapping->column_number
] = $mapping->name
;
159 $mappingContactType[$mapping->grouping
][$mapping->column_number
] = $mapping->contact_type
;
161 if (!empty($mapping->location_type_id
)) {
162 $mappingLocation[$mapping->grouping
][$mapping->column_number
] = $mapping->location_type_id
;
165 if (!empty($mapping->phone_type_id
)) {
166 $mappingPhoneType[$mapping->grouping
][$mapping->column_number
] = $mapping->phone_type_id
;
169 // get IM service provider type id from mapping fields
170 if (!empty($mapping->im_provider_id
)) {
171 $mappingImProvider[$mapping->grouping
][$mapping->column_number
] = $mapping->im_provider_id
;
174 if (!empty($mapping->website_type_id
)) {
175 $mappingWebsiteType[$mapping->grouping
][$mapping->column_number
] = $mapping->website_type_id
;
178 if (!empty($mapping->relationship_type_id
)) {
179 $mappingRelation[$mapping->grouping
][$mapping->column_number
] = "{$mapping->relationship_type_id}_{$mapping->relationship_direction}";
182 if (!empty($mapping->operator
)) {
183 $mappingOperator[$mapping->grouping
][$mapping->column_number
] = $mapping->operator
;
186 if (!empty($mapping->value
)) {
187 $mappingValue[$mapping->grouping
][$mapping->column_number
] = $mapping->value
;
205 * Check Duplicate Mapping Name
207 * @param string $nameField
209 * @param string $mapTypeId
214 public static function checkMapping($nameField, $mapTypeId) {
215 $mapping = new CRM_Core_DAO_Mapping();
216 $mapping->name
= $nameField;
217 $mapping->mapping_type_id
= $mapTypeId;
218 return (bool) $mapping->find(TRUE);
222 * Function returns associated array of elements, that will be passed for search
224 * @param int $smartGroupId
228 * associated array of elements
231 public static function getFormattedFields($smartGroupId) {
232 $returnFields = array();
234 //get the fields from mapping table
235 $dao = new CRM_Core_DAO_MappingField();
236 $dao->mapping_id
= $smartGroupId;
238 while ($dao->fetch()) {
239 $fldName = $dao->name
;
240 if ($dao->location_type_id
) {
241 $fldName .= "-{$dao->location_type_id}";
243 if ($dao->phone_type
) {
244 $fldName .= "-{$dao->phone_type}";
246 $returnFields[$fldName]['value'] = $dao->value
;
247 $returnFields[$fldName]['op'] = $dao->operator
;
248 $returnFields[$fldName]['grouping'] = $dao->grouping
;
250 return $returnFields;
254 * Build the mapping form
256 * @param CRM_Core_Form $form
257 * @param string $mappingType
258 * (Export/Import/Search Builder).
259 * @param int $mappingId
260 * @param int $columnNo
261 * @param int $blockCount
262 * (no of blocks shown).
263 * @param NULL $exportMode
268 public static function buildMappingForm(&$form, $mappingType = 'Export', $mappingId = NULL, $columnNo, $blockCount = 3, $exportMode = NULL) {
269 if ($mappingType == 'Export') {
271 $columnCount = array('1' => $columnNo);
273 elseif ($mappingType == 'Search Builder') {
275 $columnCount = $columnNo;
278 //get the saved mapping details
280 if ($mappingType == 'Export') {
281 $form->applyFilter('saveMappingName', 'trim');
283 //to save the current mappings
284 if (!isset($mappingId)) {
285 $saveDetailsName = ts('Save this field mapping');
286 $form->add('text', 'saveMappingName', ts('Name'));
287 $form->add('text', 'saveMappingDesc', ts('Description'));
290 $form->assign('loadedMapping', $mappingId);
292 $params = array('id' => $mappingId);
294 $mappingDetails = CRM_Core_BAO_Mapping
::retrieve($params, $temp);
296 $form->assign('savedName', $mappingDetails->name
);
298 $form->add('hidden', 'mappingId', $mappingId);
300 $form->addElement('checkbox', 'updateMapping', ts('Update this field mapping'), NULL);
301 $saveDetailsName = ts('Save as a new field mapping');
302 $form->add('text', 'saveMappingName', ts('Name'));
303 $form->add('text', 'saveMappingDesc', ts('Description'));
306 $form->addElement('checkbox', 'saveMapping', $saveDetailsName, NULL, array('onclick' => "showSaveDetails(this)"));
307 $form->addFormRule(array('CRM_Export_Form_Map', 'formRule'), $form->get('mappingTypeId'));
309 elseif ($mappingType == 'Search Builder') {
310 $form->addElement('submit', 'addBlock', ts('Also include contacts where'),
311 array('class' => 'submit-link')
316 $hasLocationTypes = array();
317 $hasRelationTypes = array();
320 if ($mappingType == 'Export') {
323 elseif ($mappingType == 'Search Builder') {
327 $contactType = array('Individual', 'Household', 'Organization');
328 foreach ($contactType as $value) {
329 $contactFields = CRM_Contact_BAO_Contact
::exportableFields($value, FALSE, $required);
330 $contactFields = array_merge($contactFields, CRM_Contact_BAO_Query_Hook
::singleton()->getFields());
332 // exclude the address options disabled in the Address Settings
333 $fields[$value] = CRM_Core_BAO_Address
::validateAddressOptions($contactFields);
334 ksort($fields[$value]);
335 if ($mappingType == 'Export') {
336 $relationships = array();
337 $relationshipTypes = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, NULL, NULL, $value);
338 asort($relationshipTypes);
340 foreach ($relationshipTypes as $key => $var) {
341 list($type) = explode('_', $key);
343 $relationships[$key]['title'] = $var;
344 $relationships[$key]['headerPattern'] = '/' . preg_quote($var, '/') . '/';
345 $relationships[$key]['export'] = TRUE;
346 $relationships[$key]['relationship_type_id'] = $type;
347 $relationships[$key]['related'] = TRUE;
348 $relationships[$key]['hasRelationType'] = 1;
351 if (!empty($relationships)) {
352 $fields[$value] = array_merge($fields[$value],
353 array('related' => array('title' => ts('- related contact info -'))),
360 //get the current employer for mapping.
362 $fields['Individual']['current_employer']['title'] = ts('Current Employer');
365 // add component fields
366 $compArray = array();
368 //we need to unset groups, tags, notes for component export
369 if ($exportMode != CRM_Export_Form_Select
::CONTACT_EXPORT
) {
375 unset($fields['Individual'][$value]);
376 unset($fields['Household'][$value]);
377 unset($fields['Organization'][$value]);
381 if ($mappingType == 'Search Builder') {
382 //build the common contact fields array.
383 $fields['Contact'] = array();
384 foreach ($fields['Individual'] as $key => $value) {
385 if (!empty($fields['Household'][$key]) && !empty($fields['Organization'][$key])) {
386 $fields['Contact'][$key] = $value;
387 unset($fields['Organization'][$key],
388 $fields['Household'][$key],
389 $fields['Individual'][$key]);
392 if (array_key_exists('note', $fields['Contact'])) {
393 $noteTitle = $fields['Contact']['note']['title'];
394 $fields['Contact']['note']['title'] = $noteTitle . ': ' . ts('Body and Subject');
395 $fields['Contact']['note_body'] = array('title' => $noteTitle . ': ' . ts('Body Only'), 'name' => 'note_body');
396 $fields['Contact']['note_subject'] = array(
397 'title' => $noteTitle . ': ' . ts('Subject Only'),
398 'name' => 'note_subject'
403 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
)) {
404 if (CRM_Core_Permission
::access('CiviContribute')) {
405 $fields['Contribution'] = CRM_Contribute_BAO_Contribution
::exportableFields();
406 foreach (array('contribution_contact_id', 'contribution_soft_credit_name', 'contribution_soft_credit_amount', 'contribution_soft_credit_type', 'contribution_soft_credit_contribution_id') as $element) {
407 unset($fields['Contribution'][$element]);
409 $compArray['Contribution'] = ts('Contribution');
413 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
)) {
414 if (CRM_Core_Permission
::access('CiviEvent')) {
415 $fields['Participant'] = CRM_Event_BAO_Participant
::exportableFields();
416 //get the component payment fields
417 if ($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
) {
418 require_once 'CRM/Export/BAO/Export.php';
419 $componentPaymentFields = array();
420 foreach (CRM_Export_BAO_Export
::componentPaymentFields() as $payField => $payTitle) {
421 $componentPaymentFields[$payField] = array('title' => $payTitle);
423 $fields['Participant'] = array_merge($fields['Participant'], $componentPaymentFields);
426 $compArray['Participant'] = ts('Participant');
430 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::MEMBER_EXPORT
)) {
431 if (CRM_Core_Permission
::access('CiviMember')) {
432 $fields['Membership'] = CRM_Member_BAO_Membership
::getMembershipFields($exportMode);
433 unset($fields['Membership']['membership_contact_id']);
434 $compArray['Membership'] = ts('Membership');
438 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::PLEDGE_EXPORT
)) {
439 if (CRM_Core_Permission
::access('CiviPledge')) {
440 $fields['Pledge'] = CRM_Pledge_BAO_Pledge
::exportableFields();
441 unset($fields['Pledge']['pledge_contact_id']);
442 $compArray['Pledge'] = ts('Pledge');
446 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::CASE_EXPORT
)) {
447 if (CRM_Core_Permission
::access('CiviCase')) {
448 $fields['Case'] = CRM_Case_BAO_Case
::exportableFields();
449 $compArray['Case'] = ts('Case');
451 $fields['Activity'] = CRM_Activity_BAO_Activity
::exportableFields('Case');
452 $compArray['Activity'] = ts('Case Activity');
454 unset($fields['Case']['case_contact_id']);
457 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::GRANT_EXPORT
)) {
458 if (CRM_Core_Permission
::access('CiviGrant')) {
459 $fields['Grant'] = CRM_Grant_BAO_Grant
::exportableFields();
460 unset($fields['Grant']['grant_contact_id']);
461 if ($mappingType == 'Search Builder') {
462 unset($fields['Grant']['grant_type_id']);
464 $compArray['Grant'] = ts('Grant');
468 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::ACTIVITY_EXPORT
)) {
469 $fields['Activity'] = CRM_Activity_BAO_Activity
::exportableFields('Activity');
470 $compArray['Activity'] = ts('Activity');
473 //Contact Sub Type For export
474 $contactSubTypes = array();
475 $subTypes = CRM_Contact_BAO_ContactType
::subTypeInfo();
477 foreach ($subTypes as $subType => $val) {
478 //adding subtype specific relationships CRM-5256
479 $csRelationships = array();
481 if ($mappingType == 'Export') {
482 $subTypeRelationshipTypes =
483 CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, NULL, NULL, $val['parent'],
484 FALSE, 'label', TRUE, $subType);
486 foreach ($subTypeRelationshipTypes as $key => $var) {
487 if (!array_key_exists($key, $fields[$val['parent']])) {
488 list($type) = explode('_', $key);
490 $csRelationships[$key]['title'] = $var;
491 $csRelationships[$key]['headerPattern'] = '/' . preg_quote($var, '/') . '/';
492 $csRelationships[$key]['export'] = TRUE;
493 $csRelationships[$key]['relationship_type_id'] = $type;
494 $csRelationships[$key]['related'] = TRUE;
495 $csRelationships[$key]['hasRelationType'] = 1;
500 $fields[$subType] = $fields[$val['parent']] +
$csRelationships;
502 //custom fields for sub type
503 $subTypeFields = CRM_Core_BAO_CustomField
::getFieldsForImport($subType);
504 $fields[$subType] +
= $subTypeFields;
506 if (!empty($subTypeFields) ||
!empty($csRelationships)) {
507 $contactSubTypes[$subType] = $val['label'];
513 foreach ($fields as $key => $value) {
515 foreach ($value as $key1 => $value1) {
516 //CRM-2676, replacing the conflict for same custom field name from different custom group.
517 $customGroupName = self
::getCustomGroupName($key1);
519 if ($customGroupName) {
520 $relatedMapperFields[$key][$key1] = $mapperFields[$key][$key1] = $customGroupName . ': ' . $value1['title'];
523 $relatedMapperFields[$key][$key1] = $mapperFields[$key][$key1] = $value1['title'];
525 if (isset($value1['hasLocationType'])) {
526 $hasLocationTypes[$key][$key1] = $value1['hasLocationType'];
529 if (isset($value1['hasRelationType'])) {
530 $hasRelationTypes[$key][$key1] = $value1['hasRelationType'];
531 unset($relatedMapperFields[$key][$key1]);
535 if (array_key_exists('related', $relatedMapperFields[$key])) {
536 unset($relatedMapperFields[$key]['related']);
540 $mapperKeys = array_keys($mapperFields);
542 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
544 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
546 // FIXME: dirty hack to make the default option show up first. This
547 // avoids a mozilla browser bug with defaults on dynamically constructed
549 if ($defaultLocationType) {
550 $defaultLocation = $locationTypes[$defaultLocationType->id
];
551 unset($locationTypes[$defaultLocationType->id
]);
552 $locationTypes = array($defaultLocationType->id
=> $defaultLocation) +
$locationTypes;
555 $locationTypes = array(' ' => ts('Primary')) +
$locationTypes;
557 // since we need a hierarchical list to display contact types & subtypes,
558 // this is what we going to display in first selector
559 $contactTypes = CRM_Contact_BAO_ContactType
::getSelectElements(FALSE, FALSE);
560 if ($mappingType == 'Search Builder') {
561 $contactTypes = array('Contact' => ts('Contacts')) +
$contactTypes;
564 $sel1 = array('' => ts('- select record type -')) +
$contactTypes +
$compArray;
566 foreach ($sel1 as $key => $sel) {
568 // sort everything BUT the contactType which is sorted seperately by
569 // an initial commit of CRM-13278 (check ksort above)
570 if (!in_array($key, $contactType)) {
571 asort($mapperFields[$key]);
573 $sel2[$key] = array('' => ts('- select field -')) +
$mapperFields[$key];
579 $phoneTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id');
580 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
583 foreach ($sel1 as $k => $sel) {
585 foreach ($locationTypes as $key => $value) {
586 if (trim($key) != '') {
587 $sel4[$k]['phone'][$key] = &$phoneTypes;
588 $sel4[$k]['im'][$key] = &$imProviders;
594 foreach ($sel1 as $k => $sel) {
596 foreach ($mapperFields[$k] as $key => $value) {
597 if (isset($hasLocationTypes[$k][$key])) {
598 $sel3[$k][$key] = $locationTypes;
607 // Array for core fields and relationship custom data
608 $relationshipTypes = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE);
610 if ($mappingType == 'Export') {
611 foreach ($sel1 as $k => $sel) {
613 foreach ($mapperFields[$k] as $field => $dontCare) {
614 if (isset($hasRelationTypes[$k][$field])) {
615 list($id, $first, $second) = explode('_', $field);
616 // FIX ME: For now let's not expose custom data related to relationship
617 $relationshipCustomFields = array();
618 //$relationshipCustomFields = self::getRelationTypeCustomGroupData( $id );
619 //asort($relationshipCustomFields);
621 $relationshipType = new CRM_Contact_BAO_RelationshipType();
622 $relationshipType->id
= $id;
623 if ($relationshipType->find(TRUE)) {
624 $direction = "contact_sub_type_$second";
625 if (isset($relationshipType->$direction)) {
626 $relatedFields = array_merge((array) $relatedMapperFields[$relationshipType->$direction], (array) $relationshipCustomFields);
629 $target_type = 'contact_type_' . $second;
630 $relatedFields = array_merge((array) $relatedMapperFields[$relationshipType->$target_type], (array) $relationshipCustomFields);
633 $relationshipType->free();
634 asort($relatedFields);
635 $sel5[$k][$field] = $relatedFields;
641 //Location Type for relationship fields
642 foreach ($sel5 as $k => $v) {
644 foreach ($v as $rel => $fields) {
645 foreach ($fields as $field => $fieldLabel) {
646 if (isset($hasLocationTypes[$k][$field])) {
647 $sel6[$k][$rel][$field] = $locationTypes;
654 //PhoneTypes for relationship fields
656 foreach ($sel6 as $k => $rel) {
658 foreach ($rel as $phonekey => $phonevalue) {
659 foreach ($locationTypes as $locType => $loc) {
660 if (trim($locType) != '') {
661 $sel7[$k][$phonekey]['phone'][$locType] = &$phoneTypes;
662 $sel7[$k][$phonekey]['im'][$locType] = &$imProviders;
670 //special fields that have location, hack for primary location
671 $specialFields = array(
673 'supplemental_address_1',
674 'supplemental_address_2',
677 'postal_code_suffix',
687 if (isset($mappingId)) {
690 list($mappingName, $mappingContactType, $mappingLocation, $mappingPhoneType, $mappingImProvider,
691 $mappingRelation, $mappingOperator, $mappingValue
692 ) = CRM_Core_BAO_Mapping
::getMappingFields($mappingId);
694 $blkCnt = count($mappingName);
695 if ($blkCnt >= $blockCount) {
696 $blockCount = $blkCnt +
1;
698 for ($x = 1; $x < $blockCount; $x++
) {
699 if (isset($mappingName[$x])) {
700 $colCnt = count($mappingName[$x]);
701 if ($colCnt >= $columnCount[$x]) {
702 $columnCount[$x] = $colCnt;
708 $form->_blockCount
= $blockCount;
709 $form->_columnCount
= $columnCount;
711 $form->set('blockCount', $form->_blockCount
);
712 $form->set('columnCount', $form->_columnCount
);
714 $defaults = $noneArray = $nullArray = array();
716 //used to warn for mismatch column count or mismatch mapping
718 for ($x = 1; $x < $blockCount; $x++
) {
720 for ($i = 0; $i < $columnCount[$x]; $i++
) {
722 $sel = &$form->addElement('hierselect', "mapper[$x][$i]", ts('Mapper for Field %1', array(1 => $i)), NULL);
725 if (isset($mappingId)) {
726 $locationId = isset($mappingLocation[$x][$i]) ?
$mappingLocation[$x][$i] : 0;
727 if (isset($mappingName[$x][$i])) {
728 if (is_array($mapperFields[$mappingContactType[$x][$i]])) {
730 if (isset($mappingRelation[$x][$i])) {
732 $contactDetails = strtolower(str_replace(" ", "_", $mappingName[$x][$i]));
733 $relLocationId = isset($mappingLocation[$x][$i]) ?
$mappingLocation[$x][$i] : 0;
734 if (!$relLocationId && in_array($mappingName[$x][$i], $specialFields)) {
735 $relLocationId = " ";
738 $relPhoneType = isset($mappingPhoneType[$x][$i]) ?
$mappingPhoneType[$x][$i] : NULL;
740 $defaults["mapper[$x][$i]"] = array(
741 $mappingContactType[$x][$i],
742 $mappingRelation[$x][$i],
745 $mappingName[$x][$i],
751 $noneArray[] = array($x, $i, 2);
753 if (!$phoneType && !$imProvider) {
754 $noneArray[] = array($x, $i, 3);
756 if (!$mappingName[$x][$i]) {
757 $noneArray[] = array($x, $i, 4);
759 if (!$relLocationId) {
760 $noneArray[] = array($x, $i, 5);
762 if (!$relPhoneType) {
763 $noneArray[] = array($x, $i, 6);
765 $noneArray[] = array($x, $i, 2);
768 $phoneType = isset($mappingPhoneType[$x][$i]) ?
$mappingPhoneType[$x][$i] : NULL;
769 $imProvider = isset($mappingImProvider[$x][$i]) ?
$mappingImProvider[$x][$i] : NULL;
770 if (!$locationId && in_array($mappingName[$x][$i], $specialFields)) {
774 $defaults["mapper[$x][$i]"] = array(
775 $mappingContactType[$x][$i],
776 $mappingName[$x][$i],
780 if (!$mappingName[$x][$i]) {
781 $noneArray[] = array($x, $i, 1);
784 $noneArray[] = array($x, $i, 2);
786 if (!$phoneType && !$imProvider) {
787 $noneArray[] = array($x, $i, 3);
790 $noneArray[] = array($x, $i, 4);
791 $noneArray[] = array($x, $i, 5);
792 $noneArray[] = array($x, $i, 6);
797 if (CRM_Utils_Array
::value($i, CRM_Utils_Array
::value($x, $mappingOperator))) {
798 $defaults["operator[$x][$i]"] = CRM_Utils_Array
::value($i, $mappingOperator[$x]);
801 if (CRM_Utils_Array
::value($i, CRM_Utils_Array
::value($x, $mappingValue))) {
802 $defaults["value[$x][$i]"] = CRM_Utils_Array
::value($i, $mappingValue[$x]);
807 //Fix for Search Builder
808 if ($mappingType == 'Export') {
815 $formValues = $form->exportValues();
817 if (empty($formValues)) {
818 // Incremented length for third select box(relationship type)
819 for ($k = 1; $k < $j; $k++
) {
820 $noneArray[] = array($x, $i, $k);
824 if (!empty($formValues['mapper'][$x])) {
825 foreach ($formValues['mapper'][$x] as $value) {
826 for ($k = 1; $k < $j; $k++
) {
827 if (!isset($formValues['mapper'][$x][$i][$k]) ||
828 (!$formValues['mapper'][$x][$i][$k])
830 $noneArray[] = array($x, $i, $k);
833 $nullArray[] = array($x, $i, $k);
839 for ($k = 1; $k < $j; $k++
) {
840 $noneArray[] = array($x, $i, $k);
845 //Fix for Search Builder
846 if ($mappingType == 'Export') {
847 if (!isset($mappingId) ||
$i >= count(reset($mappingName))) {
848 if (isset($formValues['mapper']) &&
849 isset($formValues['mapper'][$x][$i][1]) &&
850 array_key_exists($formValues['mapper'][$x][$i][1], $relationshipTypes)
852 $sel->setOptions(array($sel1, $sel2, $sel5, $sel6, $sel7, $sel3, $sel4));
855 $sel->setOptions(array($sel1, $sel2, $sel3, $sel4, $sel5, $sel6, $sel7));
859 $sel->setOptions(array($sel1, $sel2, $sel3, $sel4, $sel5, $sel6, $sel7));
863 $sel->setOptions(array($sel1, $sel2, $sel3, $sel4));
866 if ($mappingType == 'Search Builder') {
867 //CRM -2292, restricted array set
868 $operatorArray = array('' => ts('-operator-')) + CRM_Core_SelectValues
::getSearchBuilderOperators();
870 $form->add('select', "operator[$x][$i]", '', $operatorArray);
871 $form->add('text', "value[$x][$i]", '');
874 //end of columnCnt for
875 if ($mappingType == 'Search Builder') {
876 $title = ts('Another search field');
879 $title = ts('Select more fields');
882 $form->addElement('submit', "addMore[$x]", $title, array('class' => 'submit-link'));
886 $js = "<script type='text/javascript'>\n";
887 $formName = "document.{$name}";
888 if (!empty($nullArray)) {
889 $js .= "var nullArray = [";
892 foreach ($nullArray as $element) {
893 $key = "{$element[0]}, {$element[1]}, {$element[2]}";
894 if (!isset($seen[$key])) {
895 $elements[] = "[$key]";
899 $js .= implode(', ', $elements);
902 for (var i=0;i<nullArray.length;i++) {
903 if ( {$formName}['mapper['+nullArray[i][0]+']['+nullArray[i][1]+']['+nullArray[i][2]+']'] ) {
904 {$formName}['mapper['+nullArray[i][0]+']['+nullArray[i][1]+']['+nullArray[i][2]+']'].style.display = '';
909 if (!empty($noneArray)) {
910 $js .= "var noneArray = [";
913 foreach ($noneArray as $element) {
914 $key = "{$element[0]}, {$element[1]}, {$element[2]}";
915 if (!isset($seen[$key])) {
916 $elements[] = "[$key]";
920 $js .= implode(', ', $elements);
923 for (var i=0;i<noneArray.length;i++) {
924 if ( {$formName}['mapper['+noneArray[i][0]+']['+noneArray[i][1]+']['+noneArray[i][2]+']'] ) {
925 {$formName}['mapper['+noneArray[i][0]+']['+noneArray[i][1]+']['+noneArray[i][2]+']'].style.display = 'none';
930 $js .= "</script>\n";
932 $form->assign('initHideBoxes', $js);
933 $form->assign('columnCount', $columnCount);
934 $form->assign('blockCount', $blockCount);
935 $form->setDefaults($defaults);
937 $form->setDefaultAction('refresh');
941 * Function returns all custom fields with group title and
944 * @param int $relationshipTypeId
945 * Related relationship type id.
948 * all custom field titles
950 public function getRelationTypeCustomGroupData($relationshipTypeId) {
952 $customFields = CRM_Core_BAO_CustomField
::getFields('Relationship', NULL, NULL, $relationshipTypeId, NULL, NULL);
953 $groupTitle = array();
954 foreach ($customFields as $krelation => $vrelation) {
955 $groupTitle[$vrelation['label']] = $vrelation['groupTitle'] . '...' . $vrelation['label'];
962 * Function returns all Custom group Names
964 * @param int $customfieldId
967 * @return null|string
968 * $customGroupName all custom group names
971 public static function getCustomGroupName($customfieldId) {
972 if ($customFieldId = CRM_Core_BAO_CustomField
::getKeyID($customfieldId)) {
973 $customGroupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', $customFieldId, 'custom_group_id');
974 $customGroupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $customGroupId, 'title');
976 if (strlen($customGroupName) > 13) {
977 $customGroupName = substr($customGroupName, 0, 10) . '...';
980 return $customGroupName;
985 * Function returns associated array of elements, that will be passed for search
987 * @param array $params
988 * Associated array of submitted values.
990 * Row no of the fields.
994 * formatted associated array of elements
997 public static function formattedFields(&$params, $row = FALSE) {
1000 if (empty($params) ||
!isset($params['mapper'])) {
1004 $types = array('Individual', 'Organization', 'Household');
1005 foreach ($params['mapper'] as $key => $value) {
1006 $contactType = NULL;
1007 foreach ($value as $k => $v) {
1008 if (in_array($v[0], $types)) {
1009 if ($contactType && $contactType != $v[0]) {
1010 CRM_Core_Error
::fatal(ts("Cannot have two clauses with different types: %1, %2",
1011 array(1 => $contactType, 2 => $v[0])
1014 $contactType = $v[0];
1016 if (!empty($v['1'])) {
1018 $v2 = CRM_Utils_Array
::value('2', $v);
1019 if ($v2 && trim($v2)) {
1020 $fldName .= "-{$v[2]}";
1023 $v3 = CRM_Utils_Array
::value('3', $v);
1024 if ($v3 && trim($v3)) {
1025 $fldName .= "-{$v[3]}";
1028 $value = $params['value'][$key][$k];
1029 if ($fldName == 'group' ||
$fldName == 'tag') {
1030 $value = trim($value);
1031 $value = str_replace('(', '', $value);
1032 $value = str_replace(')', '', $value);
1034 $v = explode(',', $value);
1036 foreach ($v as $i) {
1041 if ($v[0] == 'Contribution' && substr($fldName, 0, 7) != 'custom_'
1042 && substr($fldName, 0, 10) != 'financial_'
1043 && substr($fldName, 0, 8) != 'payment_') {
1044 if (substr($fldName, 0, 13) != 'contribution_') {
1045 $fldName = 'contribution_' . $fldName;
1049 // CRM-14563: we store checkbox, multi-select and adv-multi select custom field using separator, hence it
1050 // needs special handling.
1051 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($v[1])) {
1052 $isCustomField = TRUE;
1053 $customFieldType = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', $cfID, 'html_type');
1054 $specialHTMLType = array(
1058 'Multi-Select State/Province',
1059 'Multi-Select Country',
1062 // override the operator to handle separator ( note: this might have some performance issues )
1063 if (in_array($customFieldType, $specialHTMLType)) {
1064 // FIX ME: != and few other operators are not handled
1065 $specialOperators = array('=', 'IN', 'LIKE');
1067 if (in_array($params['operator'][$key][$k], $specialOperators)) {
1068 $params['operator'][$key][$k] = 'RLIKE';
1073 // CRM-14983: verify if values are comma separated convert to array
1074 if (!is_array($value) && (strpos($value, ',') !== FALSE ||
strstr($value, '(')) && empty($isCustomField) && $params['operator'][$key][$k] == 'IN') {
1075 preg_match('#\((.*?)\)#', $value, $match);
1076 $tmpArray = explode(',', $match[1]);
1077 $value = array_combine(array_values($tmpArray), array_values($tmpArray));
1083 $params['operator'][$key][$k],
1092 $params['operator'][$key][$k],
1111 //add sortByCharacter values
1112 if (isset($params['sortByCharacter'])) {
1116 $params['sortByCharacter'],
1127 * @param array $params
1131 public static function &returnProperties(&$params) {
1133 'contact_type' => 1,
1134 'contact_sub_type' => 1,
1138 if (empty($params) ||
empty($params['mapper'])) {
1142 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
1143 foreach ($params['mapper'] as $key => $value) {
1144 foreach ($value as $k => $v) {
1146 if ($v[1] == 'groups' ||
$v[1] == 'tags') {
1150 if (isset($v[2]) && is_numeric($v[2])) {
1151 if (!array_key_exists('location', $fields)) {
1152 $fields['location'] = array();
1155 // make sure that we have a location fields and a location type for this
1156 $locationName = $locationTypes[$v[2]];
1157 if (!array_key_exists($locationName, $fields['location'])) {
1158 $fields['location'][$locationName] = array();
1159 $fields['location'][$locationName]['location_type'] = $v[2];
1162 if ($v[1] == 'phone' ||
$v[1] == 'email' ||
$v[1] == 'im') {
1163 // phone type handling
1165 $fields['location'][$locationName][$v[1] . "-" . $v[3]] = 1;
1168 $fields['location'][$locationName][$v[1]] = 1;
1172 $fields['location'][$locationName][$v[1]] = 1;
1186 * Save the mapping field info for search builder / export given the formvalues
1188 * @param array $params
1189 * Asscociated array of formvalues.
1190 * @param int $mappingId
1196 public static function saveMappingFields(&$params, $mappingId) {
1197 //delete mapping fields records for exixting mapping
1198 $mappingFields = new CRM_Core_DAO_MappingField();
1199 $mappingFields->mapping_id
= $mappingId;
1200 $mappingFields->delete();
1202 if (empty($params['mapper'])) {
1206 //save record in mapping field table
1207 foreach ($params['mapper'] as $key => $value) {
1209 foreach ($value as $k => $v) {
1211 if (!empty($v['1'])) {
1212 $saveMappingFields = new CRM_Core_DAO_MappingField();
1214 $saveMappingFields->mapping_id
= $mappingId;
1215 $saveMappingFields->name
= CRM_Utils_Array
::value('1', $v);
1216 $saveMappingFields->contact_type
= CRM_Utils_Array
::value('0', $v);
1217 $locationId = CRM_Utils_Array
::value('2', $v);
1218 $saveMappingFields->location_type_id
= is_numeric($locationId) ?
$locationId : NULL;
1220 if ($v[1] == 'phone') {
1221 $saveMappingFields->phone_type_id
= CRM_Utils_Array
::value('3', $v);
1223 elseif ($v[1] == 'im') {
1224 $saveMappingFields->im_provider_id
= CRM_Utils_Array
::value('3', $v);
1227 if (!empty($params['operator'])) {
1228 $saveMappingFields->operator
= CRM_Utils_Array
::value($k, $params['operator'][$key]);
1230 if (!empty($params['value'])) {
1231 $saveMappingFields->value
= CRM_Utils_Array
::value($k, $params['value'][$key]);
1233 // Handle mapping for 'related contact' fields
1234 if (count(explode('_', CRM_Utils_Array
::value('1', $v))) > 2) {
1235 list($id, $first, $second) = explode('_', CRM_Utils_Array
::value('1', $v));
1236 if (($first == 'a' && $second == 'b') ||
($first == 'b' && $second == 'a')) {
1238 if (!empty($v['2'])) {
1239 $saveMappingFields->name
= CRM_Utils_Array
::value('2', $v);
1241 elseif (!empty($v['4'])) {
1242 $saveMappingFields->name
= CRM_Utils_Array
::value('4', $v);
1245 if (is_numeric(CRM_Utils_Array
::value('3', $v))) {
1246 $locationTypeid = CRM_Utils_Array
::value('3', $v);
1248 elseif (is_numeric(CRM_Utils_Array
::value('5', $v))) {
1249 $locationTypeid = CRM_Utils_Array
::value('5', $v);
1252 if (is_numeric(CRM_Utils_Array
::value('4', $v))) {
1253 $phoneTypeid = CRM_Utils_Array
::value('4', $v);
1255 elseif (is_numeric(CRM_Utils_Array
::value('6', $v))) {
1256 $phoneTypeid = CRM_Utils_Array
::value('6', $v);
1259 $saveMappingFields->location_type_id
= is_numeric($locationTypeid) ?
$locationTypeid : NULL;
1260 $saveMappingFields->phone_type_id
= is_numeric($phoneTypeid) ?
$phoneTypeid : NULL;
1261 $saveMappingFields->relationship_type_id
= $id;
1262 $saveMappingFields->relationship_direction
= "{$first}_{$second}";
1266 $saveMappingFields->grouping
= $key;
1267 $saveMappingFields->column_number
= $colCnt;
1268 $saveMappingFields->save();
1270 $locationTypeid = $phoneTypeid = NULL;