3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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 function __construct() {
41 parent
::__construct();
45 * Takes a bunch of params that are needed to match certain criteria and
46 * retrieves the relevant objects. Typically the valid params are only
47 * contact_id. We'll tweak this function to be more full featured over a period
48 * of time. This is the inverse function of create. It also stores all the retrieved
49 * values in the default array
51 * @param array $params (reference ) an assoc array of name/value pairs
52 * @param array $defaults (reference ) an assoc array to hold the flattened values
54 * @return object CRM_Core_DAO_Mapping object on success, otherwise null
58 static function retrieve(&$params, &$defaults) {
59 $mapping = new CRM_Core_DAO_Mapping();
60 $mapping->copyValues($params);
61 if ($mapping->find(TRUE)) {
62 CRM_Core_DAO
::storeValues($mapping, $defaults);
69 * Function to delete the mapping
71 * @param int $id mapping id
78 static function del($id) {
79 // delete from mapping_field table
80 $mappingField = new CRM_Core_DAO_MappingField();
81 $mappingField->mapping_id
= $id;
82 $mappingField->find();
83 while ($mappingField->fetch()) {
84 $mappingField->delete();
87 // delete from mapping table
88 $mapping = new CRM_Core_DAO_Mapping();
91 CRM_Core_Session
::setStatus(ts('Selected mapping has been deleted successfully.'), ts('Deleted'), 'success');
97 * takes an associative array and creates a contact object
99 * The function extract all the params it needs to initialize the create a
100 * contact object. the params array could contain additional unused name/value
103 * @param array $params an array of name/value pairs
105 * @return object CRM_Core_DAO_Mapper object on success, otherwise null
109 static function add($params) {
110 $mapping = new CRM_Core_DAO_Mapping();
111 $mapping->copyValues($params);
118 * function to get the list of mappings
120 * @params string $mappingTypeId mapping type id
122 * @param $mappingTypeId
124 * @return array $mapping array of mapping name
128 static function getMappings($mappingTypeId) {
130 $mappingDAO = new CRM_Core_DAO_Mapping();
131 $mappingDAO->mapping_type_id
= $mappingTypeId;
134 while ($mappingDAO->fetch()) {
135 $mapping[$mappingDAO->id
] = $mappingDAO->name
;
142 * function to get the mapping fields
144 * @params int $mappingId mapping id
148 * @return array $mappingFields array of mapping fields
152 static function getMappingFields($mappingId) {
153 //mapping is to be loaded from database
154 $mapping = new CRM_Core_DAO_MappingField();
155 $mapping->mapping_id
= $mappingId;
156 $mapping->orderBy('column_number');
159 $mappingName = $mappingLocation = $mappingContactType = $mappingPhoneType = array();
160 $mappingImProvider = $mappingRelation = $mappingOperator = $mappingValue = $mappingWebsiteType = array();
161 while ($mapping->fetch()) {
162 $mappingName[$mapping->grouping
][$mapping->column_number
] = $mapping->name
;
163 $mappingContactType[$mapping->grouping
][$mapping->column_number
] = $mapping->contact_type
;
165 if (!empty($mapping->location_type_id
)) {
166 $mappingLocation[$mapping->grouping
][$mapping->column_number
] = $mapping->location_type_id
;
169 if (!empty($mapping->phone_type_id
)) {
170 $mappingPhoneType[$mapping->grouping
][$mapping->column_number
] = $mapping->phone_type_id
;
173 // get IM service provider type id from mapping fields
174 if (!empty($mapping->im_provider_id
)) {
175 $mappingImProvider[$mapping->grouping
][$mapping->column_number
] = $mapping->im_provider_id
;
178 if (!empty($mapping->website_type_id
)) {
179 $mappingWebsiteType[$mapping->grouping
][$mapping->column_number
] = $mapping->website_type_id
;
182 if (!empty($mapping->relationship_type_id
)) {
183 $mappingRelation[$mapping->grouping
][$mapping->column_number
] = "{$mapping->relationship_type_id}_{$mapping->relationship_direction}";
186 if (!empty($mapping->operator
)) {
187 $mappingOperator[$mapping->grouping
][$mapping->column_number
] = $mapping->operator
;
190 if (!empty($mapping->value
)) {
191 $mappingValue[$mapping->grouping
][$mapping->column_number
] = $mapping->value
;
196 $mappingName, $mappingContactType, $mappingLocation, $mappingPhoneType,
197 $mappingImProvider, $mappingRelation, $mappingOperator, $mappingValue, $mappingWebsiteType,
202 *function to check Duplicate Mapping Name
204 * @params $nameField string mapping Name
206 * @params $mapTypeId string mapping Type
213 static function checkMapping($nameField, $mapTypeId) {
214 $mapping = new CRM_Core_DAO_Mapping();
215 $mapping->name
= $nameField;
216 $mapping->mapping_type_id
= $mapTypeId;
217 if ($mapping->find(TRUE)) {
226 * Function returns associated array of elements, that will be passed for search
228 * @params int $smartGroupId smart group id
230 * @param $smartGroupId
232 * @return array $returnFields associated array of elements@static
235 static function getFormattedFields($smartGroupId) {
236 $returnFields = array();
238 //get the fields from mapping table
239 $dao = new CRM_Core_DAO_MappingField();
240 $dao->mapping_id
= $smartGroupId;
242 while ($dao->fetch()) {
243 $fldName = $dao->name
;
244 if ($dao->location_type_id
) {
245 $fldName .= "-{$dao->location_type_id}";
247 if ($dao->phone_type
) {
248 $fldName .= "-{$dao->phone_type}";
250 $returnFields[$fldName]['value'] = $dao->value
;
251 $returnFields[$fldName]['op'] = $dao->operator
;
252 $returnFields[$fldName]['grouping'] = $dao->grouping
;
254 return $returnFields;
258 * Function to build the mapping form
260 * @params object $form form object
261 * @params string $mappingType mapping type (Export/Import/Search Builder)
262 * @params int $mappingId mapping id
263 * @params mixed $columnCount column count is int for and array for search builder
264 * @params int $blockCount block count (no of blocks shown)
267 * @param string $mappingType
268 * @param null $mappingId
270 * @param int $blockCount
271 * @param null $exportMode
277 static function buildMappingForm(&$form, $mappingType = 'Export', $mappingId = NULL, $columnNo, $blockCount = 3, $exportMode = NULL) {
278 if ($mappingType == 'Export') {
280 $columnCount = array('1' => $columnNo);
282 elseif ($mappingType == 'Search Builder') {
284 $columnCount = $columnNo;
287 //get the saved mapping details
289 if ($mappingType == 'Export') {
290 $form->applyFilter('saveMappingName', 'trim');
292 //to save the current mappings
293 if (!isset($mappingId)) {
294 $saveDetailsName = ts('Save this field mapping');
295 $form->add('text', 'saveMappingName', ts('Name'));
296 $form->add('text', 'saveMappingDesc', ts('Description'));
299 $form->assign('loadedMapping', $mappingId);
301 $params = array('id' => $mappingId);
303 $mappingDetails = CRM_Core_BAO_Mapping
::retrieve($params, $temp);
305 $form->assign('savedName', $mappingDetails->name
);
307 $form->add('hidden', 'mappingId', $mappingId);
309 $form->addElement('checkbox', 'updateMapping', ts('Update this field mapping'), NULL);
310 $saveDetailsName = ts('Save as a new field mapping');
311 $form->add('text', 'saveMappingName', ts('Name'));
312 $form->add('text', 'saveMappingDesc', ts('Description'));
315 $form->addElement('checkbox', 'saveMapping', $saveDetailsName, NULL, array('onclick' => "showSaveDetails(this)"));
316 $form->addFormRule(array('CRM_Export_Form_Map', 'formRule'), $form->get('mappingTypeId'));
318 elseif ($mappingType == 'Search Builder') {
319 $form->addElement('submit', 'addBlock', ts('Also include contacts where'),
320 array('class' => 'submit-link')
325 $hasLocationTypes = array();
326 $hasRelationTypes = array();
329 if ($mappingType == 'Export') {
332 elseif ($mappingType == 'Search Builder') {
336 $contactType = array('Individual', 'Household', 'Organization');
337 foreach ($contactType as $value) {
338 $contactFields = CRM_Contact_BAO_Contact
::exportableFields($value, FALSE, $required);
339 $contactFields = array_merge($contactFields, CRM_Contact_BAO_Query_Hook
::singleton()->getFields());
341 // exclude the address options disabled in the Address Settings
342 $fields[$value] = CRM_Core_BAO_Address
::validateAddressOptions($contactFields);
343 ksort($fields[$value]);
344 if ($mappingType == 'Export') {
345 $relationships = array();
346 $relationshipTypes = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, NULL, NULL, $value);
347 asort($relationshipTypes);
349 foreach ($relationshipTypes as $key => $var) {
350 list($type) = explode('_', $key);
352 $relationships[$key]['title'] = $var;
353 $relationships[$key]['headerPattern'] = '/' . preg_quote($var, '/') . '/';
354 $relationships[$key]['export'] = TRUE;
355 $relationships[$key]['relationship_type_id'] = $type;
356 $relationships[$key]['related'] = TRUE;
357 $relationships[$key]['hasRelationType'] = 1;
360 if (!empty($relationships)) {
361 $fields[$value] = array_merge($fields[$value],
362 array('related' => array('title' => ts('- related contact info -'))),
369 //get the current employer for mapping.
371 $fields['Individual']['current_employer']['title'] = ts('Current Employer');
374 // add component fields
375 $compArray = array();
377 //we need to unset groups, tags, notes for component export
378 if ($exportMode != CRM_Export_Form_Select
::CONTACT_EXPORT
) {
380 'groups', 'tags', 'notes') as $value) {
381 unset($fields['Individual'][$value]);
382 unset($fields['Household'][$value]);
383 unset($fields['Organization'][$value]);
387 if ($mappingType == 'Search Builder') {
388 //build the common contact fields array.
389 $fields['Contact'] = array();
390 foreach ($fields['Individual'] as $key => $value) {
391 if (!empty($fields['Household'][$key]) && !empty($fields['Organization'][$key])) {
392 $fields['Contact'][$key] = $value;
393 unset($fields['Organization'][$key],
394 $fields['Household'][$key],
395 $fields['Individual'][$key]);
398 if (array_key_exists('note', $fields['Contact'])) {
399 $noteTitle = $fields['Contact']['note']['title'];
400 $fields['Contact']['note']['title'] = $noteTitle . ': ' . ts('Body and Subject');
401 $fields['Contact']['note_body'] = array( 'title' => $noteTitle . ': ' . ts('Body only'), 'name' => 'note_body' );
402 $fields['Contact']['note_subject'] = array( 'title' => $noteTitle . ': ' . ts('Subject only'), 'name' => 'note_subject' );
406 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
)) {
407 if (CRM_Core_Permission
::access('CiviContribute')) {
408 $fields['Contribution'] = CRM_Contribute_BAO_Contribution
::exportableFields();
409 unset($fields['Contribution']['contribution_contact_id']);
410 unset($fields['Contribution']['contribution_status_id']);
411 $compArray['Contribution'] = ts('Contribution');
415 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
)) {
416 if (CRM_Core_Permission
::access('CiviEvent')) {
417 $fields['Participant'] = CRM_Event_BAO_Participant
::exportableFields();
418 //get the component payment fields
419 if ($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
) {
420 require_once 'CRM/Export/BAO/Export.php';
421 $componentPaymentFields = array();
422 foreach (CRM_Export_BAO_Export
::componentPaymentFields() as $payField => $payTitle) {
423 $componentPaymentFields[$payField] = array('title' => $payTitle);
425 $fields['Participant'] = array_merge($fields['Participant'], $componentPaymentFields);
428 unset($fields['Participant']['participant_contact_id']);
429 $compArray['Participant'] = ts('Participant');
433 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::MEMBER_EXPORT
)) {
434 if (CRM_Core_Permission
::access('CiviMember')) {
435 $fields['Membership'] = CRM_Member_BAO_Membership
::getMembershipFields($exportMode);
436 unset($fields['Membership']['membership_contact_id']);
437 $compArray['Membership'] = ts('Membership');
441 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::PLEDGE_EXPORT
)) {
442 if (CRM_Core_Permission
::access('CiviPledge')) {
443 $fields['Pledge'] = CRM_Pledge_BAO_Pledge
::exportableFields();
444 unset($fields['Pledge']['pledge_contact_id']);
445 $compArray['Pledge'] = ts('Pledge');
449 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::CASE_EXPORT
)) {
450 if (CRM_Core_Permission
::access('CiviCase')) {
451 $fields['Case'] = CRM_Case_BAO_Case
::exportableFields();
452 $compArray['Case'] = ts('Case');
454 $fields['Activity'] = CRM_Activity_BAO_Activity
::exportableFields('Case');
455 $compArray['Activity'] = ts('Case Activity');
457 unset($fields['Case']['case_contact_id']);
460 if (($mappingType == 'Search Builder') ||
($exportMode == CRM_Export_Form_Select
::GRANT_EXPORT
)) {
461 if (CRM_Core_Permission
::access('CiviGrant')) {
462 $fields['Grant'] = CRM_Grant_BAO_Grant
::exportableFields();
463 unset($fields['Grant']['grant_contact_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
548 * selector widgets. */
551 if ($defaultLocationType) {
552 $defaultLocation = $locationTypes[$defaultLocationType->id
];
553 unset($locationTypes[$defaultLocationType->id
]);
554 $locationTypes = array(
555 $defaultLocationType->id
=> $defaultLocation) +
$locationTypes;
558 $locationTypes = array(
559 ' ' => ts('Primary')) +
$locationTypes;
561 // since we need a hierarchical list to display contact types & subtypes,
562 // this is what we going to display in first selector
563 $contactTypes = CRM_Contact_BAO_ContactType
::getSelectElements(FALSE, FALSE);
564 if ($mappingType == 'Search Builder') {
565 $contactTypes = array('Contact' => ts('Contacts')) +
$contactTypes;
569 array('' => ts('- select record type -')) +
$contactTypes +
$compArray;
571 foreach ($sel1 as $key => $sel) {
573 // sort everything BUT the contactType which is sorted seperately by
574 // an initial commit of CRM-13278 (check ksort above)
575 if (!in_array($key, $contactType)) {
576 asort($mapperFields[$key]);
578 $sel2[$key] = array('' => ts('- select field -')) +
$mapperFields[$key];
584 $phoneTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id');
585 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
588 foreach ($sel1 as $k => $sel) {
590 foreach ($locationTypes as $key => $value) {
591 if (trim($key) != '') {
592 $sel4[$k]['phone'][$key] = &$phoneTypes;
593 $sel4[$k]['im'][$key] = &$imProviders;
599 foreach ($sel1 as $k => $sel) {
601 foreach ($mapperFields[$k] as $key => $value) {
602 if (isset($hasLocationTypes[$k][$key])) {
603 $sel3[$k][$key] = $locationTypes;
612 //Array for core fields and relationship custom data
614 $relationshipTypes = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE);
616 if ($mappingType == 'Export') {
617 foreach ($sel1 as $k => $sel) {
619 foreach ($mapperFields[$k] as $field => $dontCare) {
620 if (isset($hasRelationTypes[$k][$field])) {
621 list($id, $first, $second) = explode('_', $field);
622 // FIX ME: For now let's not expose custom data related to relationship
623 $relationshipCustomFields = array();
624 //$relationshipCustomFields = self::getRelationTypeCustomGroupData( $id );
625 //asort( $relationshipCustomFields ) ;
627 $relationshipType = new CRM_Contact_BAO_RelationshipType();
628 $relationshipType->id
= $id;
629 if ($relationshipType->find(TRUE)) {
630 $direction = "contact_sub_type_$second";
631 if (isset($relationshipType->$direction)) {
632 $relatedFields = array_merge((array)$relatedMapperFields[$relationshipType->$direction], (array)$relationshipCustomFields);
635 $target_type = 'contact_type_' . $second;
636 $relatedFields = array_merge((array)$relatedMapperFields[$relationshipType->$target_type], (array)$relationshipCustomFields);
639 $relationshipType->free();
640 asort($relatedFields);
641 $sel5[$k][$field] = $relatedFields;
647 //Location Type for relationship fields
649 foreach ($sel5 as $k => $v) {
651 foreach ($v as $rel => $fields) {
652 foreach ($fields as $field => $fieldLabel) {
653 if (isset($hasLocationTypes[$k][$field])) {
654 $sel6[$k][$rel][$field] = $locationTypes;
661 //PhoneTypes for relationship fields
663 foreach ($sel6 as $k => $rel) {
665 foreach ($rel as $phonekey => $phonevalue) {
666 foreach ($locationTypes as $locType => $loc) {
667 if (trim($locType) != '') {
668 $sel7[$k][$phonekey]['phone'][$locType] = &$phoneTypes;
669 $sel7[$k][$phonekey]['im'][$locType] = &$imProviders;
677 //special fields that have location, hack for primary location
678 $specialFields = array(
679 'street_address', 'supplemental_address_1', 'supplemental_address_2',
680 'city', 'postal_code', 'postal_code_suffix', 'geo_code_1', 'geo_code_2',
681 'state_province', 'country', 'phone', 'email', 'im',
684 if (isset($mappingId)) {
687 list($mappingName, $mappingContactType, $mappingLocation, $mappingPhoneType, $mappingImProvider,
688 $mappingRelation, $mappingOperator, $mappingValue
689 ) = CRM_Core_BAO_Mapping
::getMappingFields($mappingId);
691 $blkCnt = count($mappingName);
692 if ($blkCnt >= $blockCount) {
693 $blockCount = $blkCnt +
1;
695 for ($x = 1; $x < $blockCount; $x++
) {
696 if (isset($mappingName[$x])) {
697 $colCnt = count($mappingName[$x]);
698 if ($colCnt >= $columnCount[$x]) {
699 $columnCount[$x] = $colCnt;
705 $form->_blockCount
= $blockCount;
706 $form->_columnCount
= $columnCount;
708 $form->set('blockCount', $form->_blockCount
);
709 $form->set('columnCount', $form->_columnCount
);
711 $defaults = $noneArray = $nullArray = array();
713 //used to warn for mismatch column count or mismatch mapping
715 for ($x = 1; $x < $blockCount; $x++
) {
717 for ($i = 0; $i < $columnCount[$x]; $i++
) {
719 $sel = &$form->addElement('hierselect', "mapper[$x][$i]", ts('Mapper for Field %1', array(1 => $i)), NULL);
722 if (isset($mappingId)) {
723 $locationId = isset($mappingLocation[$x][$i]) ?
$mappingLocation[$x][$i] : 0;
724 if (isset($mappingName[$x][$i])) {
725 if (is_array($mapperFields[$mappingContactType[$x][$i]])) {
727 if (isset($mappingRelation[$x][$i])) {
729 $contactDetails = strtolower(str_replace(" ", "_", $mappingName[$x][$i]));
730 $relLocationId = isset($mappingLocation[$x][$i]) ?
$mappingLocation[$x][$i] : 0;
731 if (!$relLocationId && in_array($mappingName[$x][$i], $specialFields)) {
732 $relLocationId = " ";
735 $relPhoneType = isset($mappingPhoneType[$x][$i]) ?
$mappingPhoneType[$x][$i] : NULL;
737 $defaults["mapper[$x][$i]"] = array(
738 $mappingContactType[$x][$i],
739 $mappingRelation[$x][$i],
742 $mappingName[$x][$i],
748 $noneArray[] = array($x, $i, 2);
750 if (!$phoneType && !$imProvider) {
751 $noneArray[] = array($x, $i, 3);
753 if (!$mappingName[$x][$i]) {
754 $noneArray[] = array($x, $i, 4);
756 if (!$relLocationId) {
757 $noneArray[] = array($x, $i, 5);
759 if (!$relPhoneType) {
760 $noneArray[] = array($x, $i, 6);
762 $noneArray[] = array($x, $i, 2);
765 $phoneType = isset($mappingPhoneType[$x][$i]) ?
$mappingPhoneType[$x][$i] : NULL;
766 $imProvider = isset($mappingImProvider[$x][$i]) ?
$mappingImProvider[$x][$i] : NULL;
767 if (!$locationId && in_array($mappingName[$x][$i], $specialFields)) {
771 $defaults["mapper[$x][$i]"] = array(
772 $mappingContactType[$x][$i],
773 $mappingName[$x][$i],
777 if (!$mappingName[$x][$i]) {
778 $noneArray[] = array($x, $i, 1);
781 $noneArray[] = array($x, $i, 2);
783 if (!$phoneType && !$imProvider) {
784 $noneArray[] = array($x, $i, 3);
787 $noneArray[] = array($x, $i, 4);
788 $noneArray[] = array($x, $i, 5);
789 $noneArray[] = array($x, $i, 6);
794 if (CRM_Utils_Array
::value($i, CRM_Utils_Array
::value($x, $mappingOperator))) {
795 $defaults["operator[$x][$i]"] = CRM_Utils_Array
::value($i, $mappingOperator[$x]);
798 if (CRM_Utils_Array
::value($i, CRM_Utils_Array
::value($x, $mappingValue))) {
799 $defaults["value[$x][$i]"] = CRM_Utils_Array
::value($i, $mappingValue[$x]);
804 //Fix for Search Builder
805 if ($mappingType == 'Export') {
812 $formValues = $form->exportValues();
814 if (empty($formValues)) {
815 // Incremented length for third select box(relationship type)
816 for ($k = 1; $k < $j; $k++
) {
817 $noneArray[] = array($x, $i, $k);
821 if (!empty($formValues['mapper'][$x])) {
822 foreach ($formValues['mapper'][$x] as $value) {
823 for ($k = 1; $k < $j; $k++
) {
824 if (!isset($formValues['mapper'][$x][$i][$k]) ||
825 (!$formValues['mapper'][$x][$i][$k])
827 $noneArray[] = array($x, $i, $k);
830 $nullArray[] = array($x, $i, $k);
836 for ($k = 1; $k < $j; $k++
) {
837 $noneArray[] = array($x, $i, $k);
842 //Fix for Search Builder
843 if ($mappingType == 'Export') {
844 if (!isset($mappingId) ||
$i >= count(reset($mappingName))) {
845 if (isset($formValues['mapper']) &&
846 isset($formValues['mapper'][$x][$i][1]) &&
847 array_key_exists($formValues['mapper'][$x][$i][1], $relationshipTypes)
849 $sel->setOptions(array($sel1, $sel2, $sel5, $sel6, $sel7, $sel3, $sel4));
852 $sel->setOptions(array($sel1, $sel2, $sel3, $sel4, $sel5, $sel6, $sel7));
856 $sel->setOptions(array($sel1, $sel2, $sel3, $sel4, $sel5, $sel6, $sel7));
860 $sel->setOptions(array($sel1, $sel2, $sel3, $sel4));
863 if ($mappingType == 'Search Builder') {
864 //CRM -2292, restricted array set
865 $operatorArray = array('' => ts('-operator-')) + CRM_Core_SelectValues
::getSearchBuilderOperators();
867 $form->add('select', "operator[$x][$i]", '', $operatorArray);
868 $form->add('text', "value[$x][$i]", '');
871 //end of columnCnt for
872 if ($mappingType == 'Search Builder') {
873 $title = ts('Another search field');
876 $title = ts('Select more fields');
879 $form->addElement('submit', "addMore[$x]", $title, array('class' => 'submit-link'));
883 $js = "<script type='text/javascript'>\n";
884 $formName = "document.{$name}";
885 if (!empty($nullArray)) {
886 $js .= "var nullArray = [";
889 foreach ($nullArray as $element) {
890 $key = "{$element[0]}, {$element[1]}, {$element[2]}";
891 if (!isset($seen[$key])) {
892 $elements[] = "[$key]";
896 $js .= implode(', ', $elements);
899 for(var i=0;i<nullArray.length;i++) {
900 if ( {$formName}['mapper['+nullArray[i][0]+']['+nullArray[i][1]+']['+nullArray[i][2]+']'] ) {
901 {$formName}['mapper['+nullArray[i][0]+']['+nullArray[i][1]+']['+nullArray[i][2]+']'].style.display = '';
906 if (!empty($noneArray)) {
907 $js .= "var noneArray = [";
910 foreach ($noneArray as $element) {
911 $key = "{$element[0]}, {$element[1]}, {$element[2]}";
912 if (!isset($seen[$key])) {
913 $elements[] = "[$key]";
917 $js .= implode(', ', $elements);
920 for(var i=0;i<noneArray.length;i++) {
921 if ( {$formName}['mapper['+noneArray[i][0]+']['+noneArray[i][1]+']['+noneArray[i][2]+']'] ) {
922 {$formName}['mapper['+noneArray[i][0]+']['+noneArray[i][1]+']['+noneArray[i][2]+']'].style.display = 'none';
927 $js .= "</script>\n";
929 $form->assign('initHideBoxes', $js);
930 $form->assign('columnCount', $columnCount);
931 $form->assign('blockCount', $blockCount);
932 $form->setDefaults($defaults);
934 $form->setDefaultAction('refresh');
937 /* Function returns all custom fields with group title and
939 * @relationshipTypeId related relationship type id
940 * @return $groupTitle all custom field titles
943 * @param $relationshipTypeId
947 function getRelationTypeCustomGroupData($relationshipTypeId) {
949 $customFields = CRM_Core_BAO_CustomField
::getFields('Relationship', NULL, NULL, $relationshipTypeId, NULL, NULL);
950 $groupTitle = array();
951 foreach ($customFields as $krelation => $vrelation) {
952 $groupTitle[$vrelation['label']] = $vrelation['groupTitle'] . '...' . $vrelation['label'];
959 * Function returns all Custom group Names
961 * @param related $customfieldId
963 * @internal param \related $customfieldId custom field id
964 * @return null|string $customGroupName all custom group names@static
966 static function getCustomGroupName($customfieldId) {
967 if ($customFieldId = CRM_Core_BAO_CustomField
::getKeyID($customfieldId)) {
968 $customGroupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', $customFieldId, 'custom_group_id');
969 $customGroupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $customGroupId, 'title');
971 if (strlen($customGroupName) > 13) {
972 $customGroupName = substr($customGroupName, 0, 10) . '...';
975 return $customGroupName;
980 * Function returns associated array of elements, that will be passed for search
982 * @params array $params associated array of submitted values
983 * @params boolean $row row no of the fields
988 * @return array $returnFields formatted associated array of elements@static
991 static function formattedFields(&$params, $row = FALSE) {
994 if (empty($params) ||
!isset($params['mapper'])) {
998 $types = array('Individual', 'Organization', 'Household');
999 foreach ($params['mapper'] as $key => $value) {
1000 $contactType = NULL;
1001 foreach ($value as $k => $v) {
1002 if (in_array($v[0], $types)) {
1003 if ($contactType && $contactType != $v[0]) {
1004 CRM_Core_Error
::fatal(ts("Cannot have two clauses with different types: %1, %2",
1005 array(1 => $contactType, 2 => $v[0])
1008 $contactType = $v[0];
1010 if (!empty($v['1'])) {
1012 $v2 = CRM_Utils_Array
::value('2', $v);
1013 if ($v2 && trim($v2)) {
1014 $fldName .= "-{$v[2]}";
1017 $v3 = CRM_Utils_Array
::value('3', $v);
1018 if ($v3 && trim($v3)) {
1019 $fldName .= "-{$v[3]}";
1022 $value = $params['value'][$key][$k];
1023 if ($fldName == 'group' ||
$fldName == 'tag') {
1024 $value = trim($value);
1025 $value = str_replace('(', '', $value);
1026 $value = str_replace(')', '', $value);
1028 $v = explode(',', $value);
1030 foreach ($v as $i) {
1035 if ($v[0] == 'Contribution' && substr($fldName, 0, 7) != 'custom_'
1036 && substr($fldName, 0, 10) != 'financial_') {
1037 if (substr($fldName, 0, 13) != 'contribution_') {
1038 $fldName = 'contribution_' . $fldName;
1042 // CRM-14563: we store checkbox, multi-select and adv-multi select custom field using separator, hence it
1043 // needs special handling.
1044 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($v[1])) {
1045 $customFieldType = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', $cfID, 'html_type');
1046 $specialHTMLType = array(
1050 'Multi-Select State/Province',
1051 'Multi-Select Country'
1054 // override the operator to handle separator ( note: this might have some performance issues )
1055 if (in_array($customFieldType, $specialHTMLType)) {
1056 // FIX ME: != and few other operators are not handled
1057 $specialOperators = array('=', 'IN', 'LIKE');
1059 if (in_array($params['operator'][$key][$k], $specialOperators)) {
1060 $params['operator'][$key][$k] = 'RLIKE';
1068 $params['operator'][$key][$k],
1077 $params['operator'][$key][$k],
1096 //add sortByCharacter values
1097 if (isset($params['sortByCharacter'])) {
1101 $params['sortByCharacter'],
1116 static function &returnProperties(&$params) {
1118 'contact_type' => 1,
1119 'contact_sub_type' => 1,
1123 if (empty($params) ||
empty($params['mapper'])) {
1127 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
1128 foreach ($params['mapper'] as $key => $value) {
1129 foreach ($value as $k => $v) {
1131 if ($v[1] == 'groups' ||
$v[1] == 'tags') {
1135 if (isset($v[2]) && is_numeric($v[2])) {
1136 if (!array_key_exists('location', $fields)) {
1137 $fields['location'] = array();
1140 // make sure that we have a location fields and a location type for this
1141 $locationName = $locationTypes[$v[2]];
1142 if (!array_key_exists($locationName, $fields['location'])) {
1143 $fields['location'][$locationName] = array();
1144 $fields['location'][$locationName]['location_type'] = $v[2];
1147 if ($v[1] == 'phone' ||
$v[1] == 'email' ||
$v[1] == 'im') {
1148 // phone type handling
1150 $fields['location'][$locationName][$v[1] . "-" . $v[3]] = 1;
1153 $fields['location'][$locationName][$v[1]] = 1;
1157 $fields['location'][$locationName][$v[1]] = 1;
1171 * save the mapping field info for search builder / export given the formvalues
1173 * @param array $params asscociated array of formvalues
1174 * @param int $mappingId mapping id
1180 static function saveMappingFields(&$params, $mappingId) {
1181 //delete mapping fields records for exixting mapping
1182 $mappingFields = new CRM_Core_DAO_MappingField();
1183 $mappingFields->mapping_id
= $mappingId;
1184 $mappingFields->delete();
1186 if (empty($params['mapper'])) {
1190 //save record in mapping field table
1191 foreach ($params['mapper'] as $key => $value) {
1193 foreach ($value as $k => $v) {
1195 if (!empty($v['1'])) {
1196 $saveMappingFields = new CRM_Core_DAO_MappingField();
1198 $saveMappingFields->mapping_id
= $mappingId;
1199 $saveMappingFields->name
= CRM_Utils_Array
::value('1', $v);
1200 $saveMappingFields->contact_type
= CRM_Utils_Array
::value('0', $v);
1201 $locationId = CRM_Utils_Array
::value('2', $v);
1202 $saveMappingFields->location_type_id
= is_numeric($locationId) ?
$locationId : NULL;
1204 if ($v[1] == 'phone') {
1205 $saveMappingFields->phone_type_id
= CRM_Utils_Array
::value('3', $v);
1207 elseif ($v[1] == 'im') {
1208 $saveMappingFields->im_provider_id
= CRM_Utils_Array
::value('3', $v);
1211 if (!empty($params['operator'])) {
1212 $saveMappingFields->operator
= CRM_Utils_Array
::value($k, $params['operator'][$key]);
1214 if (!empty($params['value'])) {
1215 $saveMappingFields->value
= CRM_Utils_Array
::value($k, $params['value'][$key]);
1217 // Handle mapping for 'related contact' fields
1218 if (count(explode('_', CRM_Utils_Array
::value('1', $v))) > 2) {
1219 list($id, $first, $second) = explode('_', CRM_Utils_Array
::value('1', $v));
1220 if (($first == 'a' && $second == 'b') ||
($first == 'b' && $second == 'a')) {
1222 if (!empty($v['2'])) {
1223 $saveMappingFields->name
= CRM_Utils_Array
::value('2', $v);
1225 elseif (!empty($v['4'])) {
1226 $saveMappingFields->name
= CRM_Utils_Array
::value('4', $v);
1229 if (is_numeric(CRM_Utils_Array
::value('3', $v))) {
1230 $locationTypeid = CRM_Utils_Array
::value('3', $v);
1232 elseif (is_numeric(CRM_Utils_Array
::value('5', $v))) {
1233 $locationTypeid = CRM_Utils_Array
::value('5', $v);
1236 if (is_numeric(CRM_Utils_Array
::value('4', $v))) {
1237 $phoneTypeid = CRM_Utils_Array
::value('4', $v);
1239 elseif (is_numeric(CRM_Utils_Array
::value('6', $v))) {
1240 $phoneTypeid = CRM_Utils_Array
::value('6', $v);
1243 $saveMappingFields->location_type_id
= is_numeric($locationTypeid) ?
$locationTypeid : NULL;
1244 $saveMappingFields->phone_type_id
= is_numeric($phoneTypeid) ?
$phoneTypeid : NULL;
1245 $saveMappingFields->relationship_type_id
= $id;
1246 $saveMappingFields->relationship_direction
= "{$first}_{$second}";
1250 $saveMappingFields->grouping
= $key;
1251 $saveMappingFields->column_number
= $colCnt;
1252 $saveMappingFields->save();
1254 $locationTypeid = $phoneTypeid = NULL;