3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
37 * This class contains the funtions for Component export
40 class CRM_Export_BAO_Export
{
41 // increase this number a lot to avoid making too many queries
42 // LIMIT is not much faster than a no LIMIT query
44 CONST EXPORT_ROW_COUNT
= 10000;
47 * Function to get the list the export fields
49 * @param int $selectAll user preference while export
50 * @param array $ids contact ids
51 * @param array $params associated array of fields
52 * @param string $order order by clause
53 * @param array $fields associated array of fields
54 * @param array $moreReturnProperties additional return fields
55 * @param int $exportMode export mode
56 * @param string $componentClause component clause
57 * @param string $componentTable component table
58 * @param bool $mergeSameAddress merge records if they have same address
59 * @param bool $mergeSameHousehold merge records if they belong to the same household
64 static function exportComponents($selectAll,
69 $moreReturnProperties = NULL,
70 $exportMode = CRM_Export_Form_Select
::CONTACT_EXPORT
,
71 $componentClause = NULL,
72 $componentTable = NULL,
73 $mergeSameAddress = FALSE,
74 $mergeSameHousehold = FALSE,
75 $exportParams = array(),
76 $queryOperator = 'AND'
78 $headerRows = $returnProperties = array();
79 $primary = $paymentFields = $selectedPaymentFields = FALSE;
80 $origFields = $fields;
81 $queryMode = $relationField = NULL;
83 $allCampaigns = array();
84 $exportCampaign = FALSE;
86 $phoneTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id');
87 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
88 $contactRelationshipTypes = CRM_Contact_BAO_Relationship
::getContactRelationshipType(
97 $queryMode = CRM_Contact_BAO_Query
::MODE_CONTACTS
;
99 switch ($exportMode) {
100 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
101 $queryMode = CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
;
104 case CRM_Export_Form_Select
::EVENT_EXPORT
:
105 $queryMode = CRM_Contact_BAO_Query
::MODE_EVENT
;
108 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
109 $queryMode = CRM_Contact_BAO_Query
::MODE_MEMBER
;
112 case CRM_Export_Form_Select
::PLEDGE_EXPORT
:
113 $queryMode = CRM_Contact_BAO_Query
::MODE_PLEDGE
;
116 case CRM_Export_Form_Select
::CASE_EXPORT
:
117 $queryMode = CRM_Contact_BAO_Query
::MODE_CASE
;
120 case CRM_Export_Form_Select
::GRANT_EXPORT
:
121 $queryMode = CRM_Contact_BAO_Query
::MODE_GRANT
;
124 case CRM_Export_Form_Select
::ACTIVITY_EXPORT
:
125 $queryMode = CRM_Contact_BAO_Query
::MODE_ACTIVITY
;
129 //construct return properties
130 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
131 $locationTypeFields = array(
133 'supplemental_address_1',
134 'supplemental_address_2',
137 'postal_code_suffix',
147 foreach ($fields as $key => $value) {
148 $phoneTypeId = $imProviderId = NULL;
149 $relationshipTypes = $fieldName = CRM_Utils_Array
::value(1, $value);
153 // get phoneType id and IM service provider id seperately
154 if ($fieldName == 'phone') {
155 $phoneTypeId = CRM_Utils_Array
::value(3, $value);
157 elseif ($fieldName == 'im') {
158 $imProviderId = CRM_Utils_Array
::value(3, $value);
160 elseif (substr($fieldName, -8) == 'campaign') {
161 $exportCampaign = TRUE;
164 if (array_key_exists($relationshipTypes, $contactRelationshipTypes)) {
165 if (CRM_Utils_Array
::value(2, $value)) {
166 $relationField = CRM_Utils_Array
::value(2, $value);
167 if (trim(CRM_Utils_Array
::value(3, $value))) {
168 $relLocTypeId = CRM_Utils_Array
::value(3, $value);
171 $relLocTypeId = 'Primary';
174 if ($relationField == 'phone') {
175 $relPhoneTypeId = CRM_Utils_Array
::value(4, $value);
177 elseif ($relationField == 'im') {
178 $relIMProviderId = CRM_Utils_Array
::value(4, $value);
181 elseif (CRM_Utils_Array
::value(4, $value)) {
182 $relationField = CRM_Utils_Array
::value(4, $value);
183 $relLocTypeId = CRM_Utils_Array
::value(5, $value);
184 if ($relationField == 'phone') {
185 $relPhoneTypeId = CRM_Utils_Array
::value(6, $value);
187 elseif ($relationField == 'im') {
188 $relIMProviderId = CRM_Utils_Array
::value(6, $value);
193 $contactType = CRM_Utils_Array
::value(0, $value);
194 $locTypeId = CRM_Utils_Array
::value(2, $value);
196 if ($relationField) {
197 if (in_array($relationField, $locationTypeFields) && is_numeric($relLocTypeId)) {
198 if ($relPhoneTypeId) {
199 $returnProperties[$relationshipTypes]['location'][$locationTypes[$relLocTypeId]]['phone-' . $relPhoneTypeId] = 1;
201 elseif ($relIMProviderId) {
202 $returnProperties[$relationshipTypes]['location'][$locationTypes[$relLocTypeId]]['im-' . $relIMProviderId] = 1;
205 $returnProperties[$relationshipTypes]['location'][$locationTypes[$relLocTypeId]][$relationField] = 1;
207 $relPhoneTypeId = $relIMProviderId = NULL;
210 $returnProperties[$relationshipTypes][$relationField] = 1;
213 elseif (is_numeric($locTypeId)) {
215 $returnProperties['location'][$locationTypes[$locTypeId]]['phone-' . $phoneTypeId] = 1;
217 elseif ($imProviderId) {
218 $returnProperties['location'][$locationTypes[$locTypeId]]['im-' . $imProviderId] = 1;
221 $returnProperties['location'][$locationTypes[$locTypeId]][$fieldName] = 1;
225 //hack to fix component fields
226 if ($fieldName == 'event_id') {
227 $returnProperties['event_title'] = 1;
230 $exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
&&
231 array_key_exists( $fieldName, self
::componentPaymentFields())
233 $selectedPaymentFields = true;
234 $paymentTableId = 'participant_id';
235 $returnProperties[$fieldName] = 1;
238 $returnProperties[$fieldName] = 1;
240 //campaign field export.
241 if (substr($fieldName, -8) == 'campaign') {
242 $fldNames = explode('_', $fieldName);
243 $returnProperties["{$fldNames[0]}_campaign_id"] = 1;
249 // hack to add default returnproperty based on export mode
250 if ($exportMode == CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
) {
251 $returnProperties['contribution_id'] = 1;
253 elseif ($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
) {
254 $returnProperties['participant_id'] = 1;
255 if (CRM_Utils_Array
::value('participant_role', $returnProperties)) {
256 unset($returnProperties['participant_role']);
257 $returnProperties['participant_role_id'] = 1;
260 elseif ($exportMode == CRM_Export_Form_Select
::MEMBER_EXPORT
) {
261 $returnProperties['membership_id'] = 1;
263 elseif ($exportMode == CRM_Export_Form_Select
::PLEDGE_EXPORT
) {
264 $returnProperties['pledge_id'] = 1;
266 elseif ($exportMode == CRM_Export_Form_Select
::CASE_EXPORT
) {
267 $returnProperties['case_id'] = 1;
269 elseif ($exportMode == CRM_Export_Form_Select
::GRANT_EXPORT
) {
270 $returnProperties['grant_id'] = 1;
272 elseif ($exportMode == CRM_Export_Form_Select
::ACTIVITY_EXPORT
) {
273 $returnProperties['activity_id'] = 1;
278 $fields = CRM_Contact_BAO_Contact
::exportableFields('All', TRUE, TRUE);
279 foreach ($fields as $key => $var) {
280 if ($key && (substr($key, 0, 6) != 'custom')) {
282 $returnProperties[$key] = 1;
287 $returnProperties['location_type'] = 1;
288 $returnProperties['im_provider'] = 1;
289 $returnProperties['phone_type_id'] = 1;
290 $returnProperties['provider_id'] = 1;
291 $returnProperties['current_employer'] = 1;
294 $extraReturnProperties = array();
295 $paymentFields = FALSE;
297 switch ($queryMode) {
298 case CRM_Contact_BAO_Query
::MODE_EVENT
:
299 $paymentFields = TRUE;
300 $paymentTableId = 'participant_id';
303 case CRM_Contact_BAO_Query
::MODE_MEMBER
:
304 $paymentFields = TRUE;
305 $paymentTableId = 'membership_id';
308 case CRM_Contact_BAO_Query
::MODE_PLEDGE
:
309 $extraReturnProperties = CRM_Pledge_BAO_Query
::extraReturnProperties($queryMode);
310 $paymentFields = TRUE;
311 $paymentTableId = 'pledge_payment_id';
314 case CRM_Contact_BAO_Query
::MODE_CASE
:
315 $extraReturnProperties = CRM_Case_BAO_Query
::extraReturnProperties($queryMode);
319 if ($queryMode != CRM_Contact_BAO_Query
::MODE_CONTACTS
) {
320 $componentReturnProperties = CRM_Contact_BAO_Query
::defaultReturnProperties($queryMode);
322 $campaignReturnProperties = array();;
323 foreach ($componentReturnProperties as $fld => $true) {
324 $campaignReturnProperties[$fld] = $true;
325 if (substr($fld, -11) == 'campaign_id') {
326 $exportCampaign = TRUE;
327 $campaignReturnProperties[substr($fld, 0, -3)] = 1;
330 $componentReturnProperties = $campaignReturnProperties;
332 $returnProperties = array_merge($returnProperties, $componentReturnProperties);
334 if (!empty($extraReturnProperties)) {
335 $returnProperties = array_merge($returnProperties, $extraReturnProperties);
338 // unset non exportable fields for components
339 $nonExpoFields = array(
340 'groups', 'tags', 'notes', 'contribution_status_id',
341 'pledge_status_id', 'pledge_payment_status_id',
343 foreach ($nonExpoFields as $value) {
344 unset($returnProperties[$value]);
349 if ($mergeSameAddress) {
350 //make sure the addressee fields are selected
351 //while using merge same address feature
352 $returnProperties['addressee'] = 1;
353 $returnProperties['postal_greeting'] = 1;
354 $returnProperties['email_greeting'] = 1;
355 $returnProperties['street_name'] = 1;
356 $returnProperties['household_name'] = 1;
357 $returnProperties['street_address'] = 1;
358 $returnProperties['city'] = 1;
359 $returnProperties['state_province'] = 1;
361 // some columns are required for assistance incase they are not already present
362 $exportParams['merge_same_address']['temp_columns'] = array();
363 $tempColumns = array('id', 'master_id', 'state_province_id', 'postal_greeting_id', 'addressee_id');
364 foreach ($tempColumns as $column) {
365 if (!array_key_exists($column, $returnProperties)) {
366 $returnProperties[$column] = 1;
367 $column = $column == 'id' ?
'civicrm_primary_id' : $column;
368 $exportParams['merge_same_address']['temp_columns'][$column] = 1;
373 if ($componentTable &&
374 CRM_Utils_Array
::value('additional_group', $exportParams)
376 // If an Additional Group is selected, then all contacts in that group are
377 // added to the export set (filtering out duplicates).
379 INSERT INTO {$componentTable} SELECT distinct gc.contact_id FROM civicrm_group_contact gc WHERE gc.group_id = {$exportParams['additional_group']} ON DUPLICATE KEY UPDATE {$componentTable}.contact_id = gc.contact_id";
380 CRM_Core_DAO
::executeQuery($query);
383 if ($moreReturnProperties) {
385 if (CRM_Utils_Array
::value('group', $moreReturnProperties)) {
386 unset($moreReturnProperties['group']);
387 $moreReturnProperties['groups'] = 1;
389 $returnProperties = array_merge($returnProperties, $moreReturnProperties);
392 $exportParams['postal_mailing_export']['temp_columns'] = array();
393 if ($exportParams['exportOption'] == 2 &&
394 isset($exportParams['postal_mailing_export']) &&
395 CRM_Utils_Array
::value('postal_mailing_export', $exportParams['postal_mailing_export']) == 1
397 $postalColumns = array('is_deceased', 'do_not_mail', 'street_address', 'supplemental_address_1');
398 foreach ($postalColumns as $column) {
399 if (!array_key_exists($column, $returnProperties)) {
400 $returnProperties[$column] = 1;
401 $exportParams['postal_mailing_export']['temp_columns'][$column] = 1;
406 $query = new CRM_Contact_BAO_Query(NULL, $returnProperties, NULL,
407 FALSE, FALSE, $queryMode,
408 FALSE, TRUE, TRUE, NULL, $queryOperator
411 list($select, $from, $where, $having) = $query->query();
413 if ($mergeSameHousehold == 1) {
414 if (!$returnProperties['id']) {
415 $returnProperties['id'] = 1;
418 //also merge Head of Household
419 $relationKeyMOH = CRM_Utils_Array
::key('Household Member of', $contactRelationshipTypes);
420 $relationKeyHOH = CRM_Utils_Array
::key('Head of Household for', $contactRelationshipTypes);
422 foreach ($returnProperties as $key => $value) {
423 if (!array_key_exists($key, $contactRelationshipTypes)) {
424 $returnProperties[$relationKeyMOH][$key] = $value;
425 $returnProperties[$relationKeyHOH][$key] = $value;
429 unset($returnProperties[$relationKeyMOH]['location_type']);
430 unset($returnProperties[$relationKeyMOH]['im_provider']);
431 unset($returnProperties[$relationKeyHOH]['location_type']);
432 unset($returnProperties[$relationKeyHOH]['im_provider']);
435 $allRelContactArray = $relationQuery = array();
437 foreach ($contactRelationshipTypes as $rel => $dnt) {
438 if ($relationReturnProperties = CRM_Utils_Array
::value($rel, $returnProperties)) {
439 $allRelContactArray[$rel] = array();
440 // build Query for each relationship
441 $relationQuery[$rel] = new CRM_Contact_BAO_Query(NULL, $relationReturnProperties,
442 NULL, FALSE, FALSE, $queryMode
444 list($relationSelect, $relationFrom, $relationWhere, $relationHaving) = $relationQuery[$rel]->query();
446 list($id, $direction) = explode('_', $rel, 2);
447 // identify the relationship direction
448 $contactA = 'contact_id_a';
449 $contactB = 'contact_id_b';
450 if ($direction == 'b_a') {
451 $contactA = 'contact_id_b';
452 $contactB = 'contact_id_a';
454 if ($exportMode == CRM_Export_Form_Select
::CONTACT_EXPORT
) {
457 elseif ($exportMode == CRM_Export_Form_Select
::ACTIVITY_EXPORT
) {
458 $activityContacts = CRM_Core_PseudoConstant
::activityContacts('name');
459 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
460 $query = "SELECT contact_id FROM civicrm_activity_contact
461 WHERE activity_id IN ( " . implode(',', $ids) . ") AND
462 record_type_id = {$sourceID}";
463 $dao = CRM_Core_DAO
::executeQuery($query);
464 while ($dao->fetch()) {
465 $relIDs[] = $dao->contact_id
;
469 switch ($exportMode) {
470 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
471 $component = 'civicrm_contribution';
474 case CRM_Export_Form_Select
::EVENT_EXPORT
:
475 $component = 'civicrm_participant';
478 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
479 $component = 'civicrm_membership';
482 case CRM_Export_Form_Select
::PLEDGE_EXPORT
:
483 $component = 'civicrm_pledge';
486 case CRM_Export_Form_Select
::CASE_EXPORT
:
487 $component = 'civicrm_case';
490 case CRM_Export_Form_Select
::GRANT_EXPORT
:
491 $component = 'civicrm_grant';
494 $relIDs = CRM_Core_DAO
::getContactIDsFromComponent($ids, $component);
497 $relationshipJoin = $relationshipClause = '';
498 if ($componentTable) {
499 $relationshipJoin = " INNER JOIN $componentTable ctTable ON ctTable.contact_id = {$contactA}";
502 $relID = implode(',', $relIDs);
503 $relationshipClause = " AND crel.{$contactA} IN ( {$relID} )";
506 $relationFrom = " {$relationFrom}
507 INNER JOIN civicrm_relationship crel ON crel.{$contactB} = contact_a.id AND crel.relationship_type_id = {$id}
508 {$relationshipJoin} ";
510 //check for active relationship status only
511 $today = date('Ymd');
512 $relationActive = " AND (crel.is_active = 1 AND ( crel.end_date is NULL OR crel.end_date >= {$today} ) )";
513 $relationWhere = " WHERE contact_a.is_deleted = 0 {$relationshipClause} {$relationActive}";
514 $relationGroupBy = " GROUP BY crel.{$contactA}";
515 $relationSelect = "{$relationSelect}, {$contactA} as refContact ";
516 $relationQueryString = "$relationSelect $relationFrom $relationWhere $relationHaving $relationGroupBy";
518 $allRelContactDAO = CRM_Core_DAO
::executeQuery($relationQueryString);
519 while ($allRelContactDAO->fetch()) {
520 //FIX Me: Migrate this to table rather than array
521 // build the array of all related contacts
522 $allRelContactArray[$rel][$allRelContactDAO->refContact
] = clone($allRelContactDAO);
524 $allRelContactDAO->free();
528 // make sure the groups stuff is included only if specifically specified
529 // by the fields param (CRM-1969), else we limit the contacts outputted to only
530 // ones that are part of a group
531 if (CRM_Utils_Array
::value('groups', $returnProperties)) {
532 $oldClause = "( contact_a.id = civicrm_group_contact.contact_id )";
533 $newClause = " ( $oldClause AND ( civicrm_group_contact.status = 'Added' OR civicrm_group_contact.status IS NULL ) )";
534 // total hack for export, CRM-3618
535 $from = str_replace($oldClause,
541 if ($componentTable) {
542 $from .= " INNER JOIN $componentTable ctTable ON ctTable.contact_id = contact_a.id ";
544 elseif ($componentClause) {
546 $where = "WHERE $componentClause";
549 $where .= " AND $componentClause";
553 $queryString = "$select $from $where $having";
556 if (CRM_Utils_Array
::value('tags', $returnProperties) ||
557 CRM_Utils_Array
::value('groups', $returnProperties) ||
558 CRM_Utils_Array
::value('notes', $returnProperties) ||
560 ($queryMode & CRM_Contact_BAO_Query
::MODE_CONTACTS
&& $query->_useGroupBy
)
562 $groupBy = " GROUP BY contact_a.id";
565 if ($queryMode & CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
566 $groupBy = " GROUP BY civicrm_activity.id ";
568 $queryString .= $groupBy;
570 list($field, $dir) = explode(' ', $order, 2);
571 $field = trim($field);
572 if (CRM_Utils_Array
::value($field, $returnProperties)) {
573 // $queryString .= " ORDER BY $order";
577 $multipleSelectFields = array('preferred_communication_method' => 1);
579 $addPaymentHeader = FALSE;
581 $paymentDetails = array();
582 if ($paymentFields ||
$selectedPaymentFields) {
584 // get payment related in for event and members
585 $paymentDetails = CRM_Contribute_BAO_Contribution
::getContributionDetails($exportMode, $ids);
586 //get all payment headers.
587 // If we haven't selected specific payment fields, load in all the
589 if (!$selectedPaymentFields) {
590 $paymentHeaders = self
::componentPaymentFields();
591 if (!empty($paymentDetails)) {
592 $addPaymentHeader = TRUE;
595 // If we have seleted specific payment fields, leave the payment headers
596 // as an empty array; the headers for each selected field will be added
599 $paymentHeaders = array();
601 $nullContributionDetails = array_fill_keys(array_keys($paymentHeaders), NULL);
605 if ($exportCampaign) {
606 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
609 $componentDetails = $headerRows = $sqlColumns = array();
612 $rowCount = self
::EXPORT_ROW_COUNT
;
614 // we write to temp table often to avoid using too much memory
619 // for CRM-3157 purposes
620 $i18n = CRM_Core_I18n
::singleton();
623 $limitQuery = "{$queryString} LIMIT {$offset}, {$rowCount}";
624 $dao = CRM_Core_DAO
::executeQuery($limitQuery);
629 while ($dao->fetch()) {
633 //first loop through returnproperties so that we return what is required, and in same order.
634 $relationshipField = 0;
635 foreach ($returnProperties as $field => $value) {
636 //we should set header only once
639 if (isset($query->_fields
[$field]['title'])) {
640 $headerRows[] = $query->_fields
[$field]['title'];
642 elseif ($field == 'phone_type_id') {
643 $headerRows[] = ts('Phone Type');
645 elseif ($field == 'provider_id') {
646 $headerRows[] = ts('IM Service Provider');
648 elseif (is_array($value) && $field == 'location') {
649 // fix header for location type case
650 foreach ($value as $ltype => $val) {
651 foreach (array_keys($val) as $fld) {
652 $type = explode('-', $fld);
653 $hdr = "{$ltype}-" . $query->_fields
[$type[0]]['title'];
655 if (CRM_Utils_Array
::value(1, $type)) {
656 if (CRM_Utils_Array
::value(0, $type) == 'phone') {
657 $hdr .= "-" . CRM_Utils_Array
::value($type[1], $phoneTypes);
659 elseif (CRM_Utils_Array
::value(0, $type) == 'im') {
660 $hdr .= "-" . CRM_Utils_Array
::value($type[1], $imProviders);
663 $headerRows[] = $hdr;
664 self
::sqlColumnDefn($query, $sqlColumns, $hdr);
669 elseif (substr($field, 0, 5) == 'case_') {
670 if ($query->_fields
['case'][$field]['title']) {
671 $headerRows[] = $query->_fields
['case'][$field]['title'];
673 elseif ($query->_fields
['activity'][$field]['title']) {
674 $headerRows[] = $query->_fields
['activity'][$field]['title'];
677 elseif (array_key_exists($field, $contactRelationshipTypes)) {
679 foreach ($value as $relationField => $relationValue) {
680 // below block is same as primary block (duplicate)
681 if (isset($relationQuery[$field]->_fields
[$relationField]['title'])) {
682 if ($relationQuery[$field]->_fields
[$relationField]['name'] == 'name') {
683 $headerName = $field . '-' . $relationField;
686 if ($relationField == 'current_employer') {
687 $headerName = $field . '-' . 'current_employer';
690 $headerName = $field . '-' . $relationQuery[$field]->_fields
[$relationField]['name'];
694 $headerRows[] = $headerName;
696 self
::sqlColumnDefn($query, $sqlColumns, $headerName);
698 elseif ($relationField == 'phone_type_id') {
699 $headerName = $field . '-' . 'Phone Type';
700 $headerRows[] = $headerName;
701 self
::sqlColumnDefn($query, $sqlColumns, $headerName);
703 elseif ($relationField == 'provider_id') {
704 $headerName = $field . '-' . 'Im Service Provider';
705 $headerRows[] = $headerName;
706 self
::sqlColumnDefn($query, $sqlColumns, $headerName);
708 elseif ($relationField == 'state_province_id') {
709 $headerName = $field . '-' . 'state_province_id';
710 $headerRows[] = $headerName;
711 self
::sqlColumnDefn($query, $sqlColumns, $headerName);
713 elseif (is_array($relationValue) && $relationField == 'location') {
714 // fix header for location type case
715 foreach ($relationValue as $ltype => $val) {
716 foreach (array_keys($val) as $fld) {
717 $type = explode('-', $fld);
719 $hdr = "{$ltype}-" . $relationQuery[$field]->_fields
[$type[0]]['title'];
721 if (CRM_Utils_Array
::value(1, $type)) {
722 if (CRM_Utils_Array
::value(0, $type) == 'phone') {
723 $hdr .= "-" . CRM_Utils_Array
::value($type[1], $phoneTypes);
725 elseif (CRM_Utils_Array
::value(0, $type) == 'im') {
726 $hdr .= "-" . CRM_Utils_Array
::value($type[1], $imProviders);
729 $headerName = $field . '-' . $hdr;
730 $headerRows[] = $headerName;
731 self
::sqlColumnDefn($query, $sqlColumns, $headerName);
737 elseif ($selectedPaymentFields && array_key_exists($field, self
::componentPaymentFields())) {
738 $headerRows[] = CRM_Utils_Array
::value($field, self
::componentPaymentFields());
741 $headerRows[] = $field;
745 self
::sqlColumnDefn($query, $sqlColumns, $field);
749 // add im_provider to $dao object
750 if ($field == 'im_provider' && property_exists($dao, 'provider_id')) {
751 $dao->im_provider
= $dao->provider_id
;
754 //build row values (data)
756 if (property_exists($dao, $field)) {
757 $fieldValue = $dao->$field;
758 // to get phone type from phone type id
759 if ($field == 'phone_type_id' && isset($phoneTypes[$fieldValue])) {
760 $fieldValue = $phoneTypes[$fieldValue];
762 elseif ($field == 'provider_id' ||
$field == 'im_provider') {
763 $fieldValue = CRM_Utils_Array
::value($fieldValue, $imProviders);
765 elseif ($field == 'participant_role_id') {
766 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
767 $sep = CRM_Core_DAO
::VALUE_SEPARATOR
;
768 $viewRoles = array();
769 foreach (explode($sep, $dao->$field) as $k => $v) {
770 $viewRoles[] = $participantRoles[$v];
772 $fieldValue = implode(',', $viewRoles);
774 elseif ($field == 'master_id') {
775 $masterAddressId = NULL;
776 if (isset($dao->master_id
)) {
777 $masterAddressId = $dao->master_id
;
779 // get display name of contact that address is shared.
780 $fieldValue = CRM_Contact_BAO_Contact
::getMasterDisplayName($masterAddressId, $dao->contact_id
);
784 if ($field == 'id') {
785 $row[$field] = $dao->contact_id
;
786 // special case for calculated field
788 elseif ($field == 'pledge_balance_amount') {
789 $row[$field] = $dao->pledge_amount
- $dao->pledge_total_paid
;
790 // special case for calculated field
792 elseif ($field == 'pledge_next_pay_amount') {
793 $row[$field] = $dao->pledge_next_pay_amount +
$dao->pledge_outstanding_amount
;
795 elseif (is_array($value) && $field == 'location') {
796 // fix header for location type case
797 foreach ($value as $ltype => $val) {
798 foreach (array_keys($val) as $fld) {
799 $type = explode('-', $fld);
800 $fldValue = "{$ltype}-" . $type[0];
802 if (CRM_Utils_Array
::value(1, $type)) {
803 $fldValue .= "-" . $type[1];
806 // CRM-3157: localise country, region (both have ‘country’ context) and state_province (‘province’ context)
810 $row[$fldValue] = $i18n->crm_translate($dao->$fldValue, array('context' => 'country'));
813 case 'state_province':
814 $row[$fldValue] = $i18n->crm_translate($dao->$fldValue, array('context' => 'province'));
818 $imFieldvalue = $fldValue . "-provider_id";
819 $row[$fldValue] = CRM_Utils_Array
::value($dao->$imFieldvalue, $imProviders);
823 $row[$fldValue] = $dao->$fldValue;
829 elseif (array_key_exists($field, $contactRelationshipTypes)) {
830 $relDAO = CRM_Utils_Array
::value($dao->contact_id
, $allRelContactArray[$field]);
831 foreach ($value as $relationField => $relationValue) {
832 if (is_object($relDAO) && property_exists($relDAO, $relationField)) {
833 $fieldValue = $relDAO->$relationField;
834 if ($relationField == 'phone_type_id') {
835 $fieldValue = $phoneTypes[$relationValue];
837 elseif ($relationField == 'provider_id') {
838 $fieldValue = CRM_Utils_Array
::value($relationValue, $imProviders);
844 $field = $field . '_';
845 if (is_object($relDAO) && $relationField == 'id') {
846 $row[$field . $relationField] = $relDAO->contact_id
;
847 } else if ( is_object( $relDAO ) && is_array( $relationValue ) && $relationField == 'location' ) {
848 foreach ($relationValue as $ltype => $val) {
849 foreach (array_keys($val) as $fld) {
850 $type = explode('-', $fld);
851 $fldValue = "{$ltype}-" . $type[0];
852 if (CRM_Utils_Array
::value(1, $type)) {
853 $fldValue .= "-" . $type[1];
855 // CRM-3157: localise country, region (both have ‘country’ context)
856 // and state_province (‘province’ context)
858 case (!is_object($relDAO)):
859 $row[$field . '_' . $fldValue] = '';
862 case in_array('country', $type):
863 case in_array('world_region', $type):
864 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
865 array('context' => 'country')
869 case in_array('state_province', $type):
870 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
871 array('context' => 'province')
876 $row[$field . '_' . $fldValue] = $relDAO->$fldValue;
882 elseif (isset($fieldValue) && $fieldValue != '') {
883 //check for custom data
884 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($relationField)) {
885 $row[$field . $relationField] = CRM_Core_BAO_CustomField
::getDisplayValue($fieldValue, $cfID,
886 $relationQuery[$field]->_options
889 elseif (in_array($relationField, array(
890 'email_greeting', 'postal_greeting', 'addressee'))) {
891 //special case for greeting replacement
892 $fldValue = "{$relationField}_display";
893 $row[$field . $relationField] = $relDAO->$fldValue;
896 //normal relationship fields
897 // CRM-3157: localise country, region (both have ‘country’ context) and state_province (‘province’ context)
898 switch ($relationField) {
901 $row[$field . $relationField] = $i18n->crm_translate($fieldValue, array('context' => 'country'));
904 case 'state_province':
905 $row[$field . $relationField] = $i18n->crm_translate($fieldValue, array('context' => 'province'));
909 $row[$field . $relationField] = $fieldValue;
915 // if relation field is empty or null
916 $row[$field . $relationField] = '';
920 elseif (isset($fieldValue) &&
923 //check for custom data
924 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($field)) {
925 $row[$field] = CRM_Core_BAO_CustomField
::getDisplayValue($fieldValue, $cfID, $query->_options
);
927 elseif (array_key_exists($field, $multipleSelectFields)) {
929 $paramsNew = array($field => $fieldValue);
930 if ($field == 'test_tutoring') {
931 $name = array($field => array('newName' => $field, 'groupName' => 'test'));
934 elseif (substr($field, 0, 4) == 'cmr_') {
935 $name = array($field => array('newName' => $field, 'groupName' => substr($field, 0, -3)));
938 $name = array($field => array('newName' => $field, 'groupName' => $field));
940 CRM_Core_OptionGroup
::lookupValues($paramsNew, $name, FALSE);
941 $row[$field] = $paramsNew[$field];
943 elseif (in_array($field, array(
944 'email_greeting', 'postal_greeting', 'addressee'))) {
945 //special case for greeting replacement
946 $fldValue = "{$field}_display";
947 $row[$field] = $dao->$fldValue;
950 //normal fields with a touch of CRM-3157
954 $row[$field] = $i18n->crm_translate($fieldValue, array('context' => 'country'));
957 case 'state_province':
958 $row[$field] = $i18n->crm_translate($fieldValue, array('context' => 'province'));
962 case 'preferred_communication_method':
963 case 'preferred_mail_format':
964 $row[$field] = $i18n->crm_translate($fieldValue);
968 $row[$field] = $fieldValue;
973 elseif (substr($field, -8) == 'campaign') {
974 $campIdFld = "{$field}_id";
975 $row[$field] = CRM_Utils_Array
::value($dao->$campIdFld, $allCampaigns, '');
977 elseif ($selectedPaymentFields && array_key_exists($field, self
::componentPaymentFields())) {
978 $paymentData = CRM_Utils_Array
::value($dao->$paymentTableId, $paymentDetails);
979 $payFieldMapper = array(
980 'componentPaymentField_total_amount' => 'total_amount',
981 'componentPaymentField_contribution_status' => 'contribution_status',
982 'componentPaymentField_payment_instrument' => 'pay_instru',
983 'componentPaymentField_transaction_id' => 'trxn_id',
984 'componentPaymentField_received_date' => 'receive_date',
986 $row[$field] = CRM_Utils_Array
::value($payFieldMapper[$field], $paymentData, '');
989 // if field is empty or null
994 // add payment headers if required
995 if ($addPaymentHeader && $paymentFields) {
996 $headerRows = array_merge($headerRows, $paymentHeaders);
997 foreach (array_keys($paymentHeaders) as $paymentHdr) {
998 self
::sqlColumnDefn($query, $sqlColumns, $paymentHdr);
1003 $exportTempTable = self
::createTempTable($sqlColumns);
1006 //build header only once
1009 // If specific payment fields have been selected for export, payment
1010 // data will already be in $row. Otherwise, add payment related
1011 // information, if appropriate.
1012 if ($addPaymentHeader) {
1013 if (!$selectedPaymentFields) {
1014 if ($paymentFields) {
1015 $paymentData = CRM_Utils_Array
::value($row[$paymentTableId], $paymentDetails);
1016 if (!is_array($paymentData) ||
empty($paymentData)) {
1017 $paymentData = $nullContributionDetails;
1019 $row = array_merge($row, $paymentData);
1021 elseif (!empty($paymentDetails)) {
1022 $row = array_merge($row, $nullContributionDetails);
1026 //remove organization name for individuals if it is set for current employer
1027 if (CRM_Utils_Array
::value('contact_type', $row) &&
1028 $row['contact_type'] == 'Individual' && array_key_exists('organization_name', $row)
1030 $row['organization_name'] = '';
1033 // add component info
1034 // write the row to a file
1035 $componentDetails[] = $row;
1037 // output every $tempRowCount rows
1038 if ($count %
$tempRowCount == 0) {
1039 self
::writeDetailsToTable($exportTempTable, $componentDetails, $sqlColumns);
1040 $componentDetails = array();
1044 $offset +
= $rowCount;
1047 if ($exportTempTable) {
1048 self
::writeDetailsToTable($exportTempTable, $componentDetails, $sqlColumns);
1050 // do merge same address and merge same household processing
1051 if ($mergeSameAddress) {
1052 self
::mergeSameAddress($exportTempTable, $headerRows, $sqlColumns, $exportParams);
1055 // merge the records if they have corresponding households
1056 if ($mergeSameHousehold) {
1057 self
::mergeSameHousehold($exportTempTable, $headerRows, $sqlColumns, $relationKeyMOH);
1058 self
::mergeSameHousehold($exportTempTable, $headerRows, $sqlColumns, $relationKeyHOH);
1061 // fix the headers for rows with relationship type
1062 if (!empty($relName)) {
1063 self
::manipulateHeaderRows($headerRows, $contactRelationshipTypes);
1066 // if postalMailing option is checked, exclude contacts who are deceased, have
1067 // "Do not mail" privacy setting, or have no street address
1068 if (isset($exportParams['postal_mailing_export']['postal_mailing_export']) &&
1069 $exportParams['postal_mailing_export']['postal_mailing_export'] == 1
1071 self
::postalMailingFormat($exportTempTable, $headerRows, $sqlColumns, $exportMode);
1075 CRM_Utils_Hook
::export($exportTempTable, $headerRows, $sqlColumns, $exportMode);
1077 // now write the CSV file
1078 self
::writeCSVFromTable($exportTempTable, $headerRows, $sqlColumns, $exportMode);
1080 // delete the export temp table and component table
1081 $sql = "DROP TABLE IF EXISTS {$exportTempTable}";
1082 CRM_Core_DAO
::executeQuery($sql);
1084 CRM_Utils_System
::civiExit();
1087 CRM_Core_Error
::fatal(ts('No records to export'));
1092 * name of the export file based on mode
1094 * @param string $output type of output
1095 * @param int $mode export mode
1097 * @return string name of the file
1099 static function getExportFileName($output = 'csv', $mode = CRM_Export_Form_Select
::CONTACT_EXPORT
) {
1101 case CRM_Export_Form_Select
::CONTACT_EXPORT
:
1102 return ts('CiviCRM Contact Search');
1104 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
1105 return ts('CiviCRM Contribution Search');
1107 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
1108 return ts('CiviCRM Member Search');
1110 case CRM_Export_Form_Select
::EVENT_EXPORT
:
1111 return ts('CiviCRM Participant Search');
1113 case CRM_Export_Form_Select
::PLEDGE_EXPORT
:
1114 return ts('CiviCRM Pledge Search');
1116 case CRM_Export_Form_Select
::CASE_EXPORT
:
1117 return ts('CiviCRM Case Search');
1119 case CRM_Export_Form_Select
::GRANT_EXPORT
:
1120 return ts('CiviCRM Grant Search');
1122 case CRM_Export_Form_Select
::ACTIVITY_EXPORT
:
1123 return ts('CiviCRM Activity Search');
1128 * Function to handle import error file creation.
1132 $type = CRM_Utils_Request
::retrieve('type', 'Positive', CRM_Core_DAO
::$_nullObject);
1133 $parserName = CRM_Utils_Request
::retrieve('parser', 'String', CRM_Core_DAO
::$_nullObject);
1134 if (empty($parserName) ||
empty($type)) {
1138 // clean and ensure parserName is a valid string
1139 $parserName = CRM_Utils_String
::munge($parserName);
1140 $parserClass = explode('_', $parserName);
1142 // make sure parserClass is in the CRM namespace and
1143 // at least 3 levels deep
1144 if ($parserClass[0] == 'CRM' &&
1145 count($parserClass) >= 3
1147 require_once (str_replace('_', DIRECTORY_SEPARATOR
, $parserName) . ".php");
1148 // ensure the functions exists
1149 if (method_exists($parserName, 'errorFileName') &&
1150 method_exists($parserName, 'saveFileName')
1152 $errorFileName = $parserName::errorFileName($type);
1153 $saveFileName = $parserName::saveFileName($type);
1154 if (!empty($errorFileName) && !empty($saveFileName)) {
1155 header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
1156 header('Content-Description: File Transfer');
1157 header('Content-Type: text/csv');
1158 header('Content-Length: ' . filesize($errorFileName));
1159 header('Content-Disposition: attachment; filename=' . $saveFileName);
1161 readfile($errorFileName);
1165 CRM_Utils_System
::civiExit();
1168 function exportCustom($customSearchClass, $formValues, $order) {
1169 $ext = CRM_Extension_System
::singleton()->getMapper();
1170 if (!$ext->isExtensionClass($customSearchClass)) {
1171 require_once (str_replace('_', DIRECTORY_SEPARATOR
, $customSearchClass) . '.php');
1174 require_once ($ext->classToPath($customSearchClass));
1176 $search = new $customSearchClass($formValues);
1178 $includeContactIDs = FALSE;
1179 if ($formValues['radio_ts'] == 'ts_sel') {
1180 $includeContactIDs = TRUE;
1183 $sql = $search->all(0, 0, $order, $includeContactIDs);
1185 $columns = $search->columns();
1187 $header = array_keys($columns);
1188 $fields = array_values($columns);
1191 $dao = CRM_Core_DAO
::executeQuery($sql);
1193 if (method_exists($search, 'alterRow')) {
1196 while ($dao->fetch()) {
1199 foreach ($fields as $field) {
1200 $row[$field] = $dao->$field;
1203 $search->alterRow($row);
1208 CRM_Core_Report_Excel
::writeCSVFile(self
::getExportFileName(), $header, $rows);
1209 CRM_Utils_System
::civiExit();
1212 static function sqlColumnDefn(&$query, &$sqlColumns, $field) {
1213 if (substr($field, -4) == '_a_b' ||
substr($field, -4) == '_b_a') {
1217 $fieldName = CRM_Utils_String
::munge(strtolower($field), '_', 64);
1218 if ($fieldName == 'id') {
1219 $fieldName = 'civicrm_primary_id';
1222 // early exit for master_id, CRM-12100
1223 // in the DB it is an ID, but in the export, we retrive the display_name of the master record
1224 if ($fieldName == 'master_id') {
1225 $sqlColumns[$fieldName] = "$fieldName varchar(128)";
1229 // set the sql columns
1230 if (isset($query->_fields
[$field]['type'])) {
1231 switch ($query->_fields
[$field]['type']) {
1232 case CRM_Utils_Type
::T_INT
:
1233 case CRM_Utils_Type
::T_BOOLEAN
:
1234 $sqlColumns[$fieldName] = "$fieldName varchar(16)";
1237 case CRM_Utils_Type
::T_STRING
:
1238 if (isset($query->_fields
[$field]['maxlength'])) {
1239 $sqlColumns[$fieldName] = "$fieldName varchar({$query->_fields[$field]['maxlength']})";
1242 $sqlColumns[$fieldName] = "$fieldName varchar(64)";
1246 case CRM_Utils_Type
::T_TEXT
:
1247 case CRM_Utils_Type
::T_LONGTEXT
:
1248 case CRM_Utils_Type
::T_BLOB
:
1249 case CRM_Utils_Type
::T_MEDIUMBLOB
:
1250 $sqlColumns[$fieldName] = "$fieldName longtext";
1253 case CRM_Utils_Type
::T_FLOAT
:
1254 case CRM_Utils_Type
::T_ENUM
:
1255 case CRM_Utils_Type
::T_DATE
:
1256 case CRM_Utils_Type
::T_TIME
:
1257 case CRM_Utils_Type
::T_TIMESTAMP
:
1258 case CRM_Utils_Type
::T_MONEY
:
1259 case CRM_Utils_Type
::T_EMAIL
:
1260 case CRM_Utils_Type
::T_URL
:
1261 case CRM_Utils_Type
::T_CCNUM
:
1263 $sqlColumns[$fieldName] = "$fieldName varchar(32)";
1268 if (substr($fieldName, -3, 3) == '_id') {
1269 $sqlColumns[$fieldName] = "$fieldName varchar(16)";
1272 $changeFields = array(
1278 if (in_array($fieldName, $changeFields)) {
1279 $sqlColumns[$fieldName] = "$fieldName text";
1282 // set the sql columns for custom data
1283 if (isset($query->_fields
[$field]['data_type'])) {
1285 switch ($query->_fields
[$field]['data_type']) {
1287 case 'StateProvince':
1290 $sqlColumns[$fieldName] = "$fieldName varchar(255)";
1294 $sqlColumns[$fieldName] = "$fieldName text";
1298 $sqlColumns[$fieldName] = "$fieldName varchar(64)";
1303 $sqlColumns[$fieldName] = "$fieldName varchar(64)";
1310 static function writeDetailsToTable($tableName, &$details, &$sqlColumns) {
1311 if (empty($details)) {
1320 $id = CRM_Core_DAO
::singleValueQuery($sql);
1325 $sqlClause = array();
1327 foreach ($details as $dontCare => $row) {
1329 $valueString = array($id);
1330 foreach ($row as $dontCare => $value) {
1331 if (empty($value)) {
1332 $valueString[] = "''";
1335 $valueString[] = "'" . CRM_Core_DAO
::escapeString($value) . "'";
1338 $sqlClause[] = '(' . implode(',', $valueString) . ')';
1341 $sqlColumnString = '(id, ' . implode(',', array_keys($sqlColumns)) . ')';
1343 $sqlValueString = implode(",\n", $sqlClause);
1346 INSERT INTO $tableName $sqlColumnString
1347 VALUES $sqlValueString
1350 CRM_Core_DAO
::executeQuery($sql);
1353 static function createTempTable(&$sqlColumns) {
1354 //creating a temporary table for the search result that need be exported
1355 $exportTempTable = CRM_Core_DAO
::createTempTableName('civicrm_export', TRUE);
1357 // also create the sql table
1358 $sql = "DROP TABLE IF EXISTS {$exportTempTable}";
1359 CRM_Core_DAO
::executeQuery($sql);
1362 CREATE TABLE {$exportTempTable} (
1363 id int unsigned NOT NULL AUTO_INCREMENT,
1365 $sql .= implode(",\n", array_values($sqlColumns));
1370 // add indexes for street_address and household_name if present
1371 $addIndices = array(
1374 'civicrm_primary_id',
1377 foreach ($addIndices as $index) {
1378 if (isset($sqlColumns[$index])) {
1380 INDEX index_{$index}( $index )
1386 ) ENGINE=MyISAM DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci
1389 CRM_Core_DAO
::executeQuery($sql);
1390 return $exportTempTable;
1393 static function mergeSameAddress($tableName, &$headerRows, &$sqlColumns, $exportParams) {
1394 // check if any records are present based on if they have used shared address feature,
1395 // and not based on if city / state .. matches.
1397 SELECT r1.id as copy_id,
1398 r1.civicrm_primary_id as copy_contact_id,
1399 r1.addressee as copy_addressee,
1400 r1.addressee_id as copy_addressee_id,
1401 r1.postal_greeting as copy_postal_greeting,
1402 r1.postal_greeting_id as copy_postal_greeting_id,
1404 r2.civicrm_primary_id as master_contact_id,
1405 r2.postal_greeting as master_postal_greeting,
1406 r2.postal_greeting_id as master_postal_greeting_id,
1407 r2.addressee as master_addressee,
1408 r2.addressee_id as master_addressee_id
1410 INNER JOIN civicrm_address adr ON r1.master_id = adr.id
1411 INNER JOIN $tableName r2 ON adr.contact_id = r2.civicrm_primary_id
1413 $linkedMerge = self
::_buildMasterCopyArray($sql, $exportParams, TRUE);
1415 // find all the records that have the same street address BUT not in a household
1416 // require match on city and state as well
1418 SELECT r1.id as master_id,
1419 r1.civicrm_primary_id as master_contact_id,
1420 r1.postal_greeting as master_postal_greeting,
1421 r1.postal_greeting_id as master_postal_greeting_id,
1422 r1.addressee as master_addressee,
1423 r1.addressee_id as master_addressee_id,
1425 r2.civicrm_primary_id as copy_contact_id,
1426 r2.postal_greeting as copy_postal_greeting,
1427 r2.postal_greeting_id as copy_postal_greeting_id,
1428 r2.addressee as copy_addressee,
1429 r2.addressee_id as copy_addressee_id
1431 LEFT JOIN $tableName r2 ON ( r1.street_address = r2.street_address AND
1432 r1.city = r2.city AND
1433 r1.state_province_id = r2.state_province_id )
1434 WHERE ( r1.household_name IS NULL OR r1.household_name = '' )
1435 AND ( r2.household_name IS NULL OR r2.household_name = '' )
1436 AND ( r1.street_address != '' )
1440 $merge = self
::_buildMasterCopyArray($sql, $exportParams);
1442 // unset ids from $merge already present in $linkedMerge
1443 foreach ($linkedMerge as $masterID => $values) {
1444 $keys = array($masterID);
1445 $keys = array_merge($keys, array_keys($values['copy']));
1446 foreach ($merge as $mid => $vals) {
1447 if (in_array($mid, $keys)) {
1448 unset($merge[$mid]);
1451 foreach ($values['copy'] as $copyId) {
1452 if (in_array($copyId, $keys)) {
1453 unset($merge[$mid]['copy'][$copyId]);
1459 $merge = $merge +
$linkedMerge;
1461 foreach ($merge as $masterID => $values) {
1464 SET addressee = %1, postal_greeting = %2, email_greeting = %3
1467 $params = array(1 => array($values['addressee'], 'String'),
1468 2 => array($values['postalGreeting'], 'String'),
1469 3 => array($values['emailGreeting'], 'String'),
1470 4 => array($masterID, 'Integer'),
1472 CRM_Core_DAO
::executeQuery($sql, $params);
1474 // delete all copies
1475 $deleteIDs = array_keys($values['copy']);
1476 $deleteIDString = implode(',', $deleteIDs);
1478 DELETE FROM $tableName
1479 WHERE id IN ( $deleteIDString )
1481 CRM_Core_DAO
::executeQuery($sql);
1484 // unset temporary columns that were added for postal mailing format
1485 if (!empty($exportParams['merge_same_address']['temp_columns'])) {
1486 $unsetKeys = array_keys($sqlColumns);
1487 foreach ($unsetKeys as $headerKey => $sqlColKey) {
1488 if (array_key_exists($sqlColKey, $exportParams['merge_same_address']['temp_columns'])) {
1489 unset($sqlColumns[$sqlColKey], $headerRows[$headerKey]);
1495 static function _replaceMergeTokens($contactId, $exportParams) {
1496 $greetings = array();
1499 $greetingFields = array(
1503 foreach ($greetingFields as $greeting) {
1504 if (CRM_Utils_Array
::value($greeting, $exportParams)) {
1505 $greetingLabel = $exportParams[$greeting];
1506 if (empty($contact)) {
1511 $contact = civicrm_api('contact', 'get', $values);
1513 if (CRM_Utils_Array
::value('is_error', $contact)) {
1516 $contact = $contact['values'][$contact['id']];
1519 $tokens = array('contact' => $greetingLabel);
1520 $greetings[$greeting] = CRM_Utils_Token
::replaceContactTokens($greetingLabel, $contact, NULL, $tokens);
1527 * The function unsets static part of the string, if token is the dynamic part.
1528 * Example: 'Hello {contact.first_name}' => converted to => '{contact.first_name}'
1529 * i.e 'Hello Alan' => converted to => 'Alan'
1532 static function _trimNonTokens(&$parsedString, $defaultGreeting,
1533 $addressMergeGreetings, $greetingType = 'postal_greeting'
1535 if (CRM_Utils_Array
::value($greetingType, $addressMergeGreetings)) {
1536 $greetingLabel = $addressMergeGreetings[$greetingType];
1538 $greetingLabel = empty($greetingLabel) ?
$defaultGreeting : $greetingLabel;
1540 $stringsToBeReplaced = preg_replace('/(\{[a-zA-Z._ ]+\})/', ';;', $greetingLabel);
1541 $stringsToBeReplaced = explode(';;', $stringsToBeReplaced);
1542 foreach ($stringsToBeReplaced as $key => $string) {
1543 // to keep one space
1544 $stringsToBeReplaced[$key] = ltrim($string);
1546 $parsedString = str_replace($stringsToBeReplaced, "", $parsedString);
1548 return $parsedString;
1551 static function _buildMasterCopyArray($sql, $exportParams, $sharedAddress = FALSE) {
1552 static $contactGreetingTokens = array();
1554 $addresseeOptions = CRM_Core_OptionGroup
::values('addressee');
1555 $postalOptions = CRM_Core_OptionGroup
::values('postal_greeting');
1557 $merge = $parents = array();
1558 $dao = CRM_Core_DAO
::executeQuery($sql);
1560 while ($dao->fetch()) {
1561 $masterID = $dao->master_id
;
1562 $copyID = $dao->copy_id
;
1563 $masterPostalGreeting = $dao->master_postal_greeting
;
1564 $masterAddressee = $dao->master_addressee
;
1565 $copyAddressee = $dao->copy_addressee
;
1567 if (!$sharedAddress) {
1568 if (!isset($contactGreetingTokens[$dao->master_contact_id
])) {
1569 $contactGreetingTokens[$dao->master_contact_id
] = self
::_replaceMergeTokens($dao->master_contact_id
, $exportParams);
1571 $masterPostalGreeting = CRM_Utils_Array
::value('postal_greeting',
1572 $contactGreetingTokens[$dao->master_contact_id
], $dao->master_postal_greeting
1574 $masterAddressee = CRM_Utils_Array
::value('addressee',
1575 $contactGreetingTokens[$dao->master_contact_id
], $dao->master_addressee
1578 if (!isset($contactGreetingTokens[$dao->copy_contact_id
])) {
1579 $contactGreetingTokens[$dao->copy_contact_id
] = self
::_replaceMergeTokens($dao->copy_contact_id
, $exportParams);
1581 $copyPostalGreeting = CRM_Utils_Array
::value('postal_greeting',
1582 $contactGreetingTokens[$dao->copy_contact_id
], $dao->copy_postal_greeting
1584 $copyAddressee = CRM_Utils_Array
::value('addressee',
1585 $contactGreetingTokens[$dao->copy_contact_id
], $dao->copy_addressee
1589 if (!isset($merge[$masterID])) {
1590 // check if this is an intermediate child
1591 // this happens if there are 3 or more matches a,b, c
1592 // the above query will return a, b / a, c / b, c
1593 // we might be doing a bit more work, but for now its ok, unless someone
1594 // knows how to fix the query above
1595 if (isset($parents[$masterID])) {
1596 $masterID = $parents[$masterID];
1599 $merge[$masterID] = array(
1600 'addressee' => $masterAddressee,
1602 'postalGreeting' => $masterPostalGreeting,
1604 $merge[$masterID]['emailGreeting'] = &$merge[$masterID]['postalGreeting'];
1607 $parents[$copyID] = $masterID;
1609 if (!$sharedAddress && !array_key_exists($copyID, $merge[$masterID]['copy'])) {
1611 if (CRM_Utils_Array
::value('postal_greeting_other', $exportParams) &&
1612 count($merge[$masterID]['copy']) >= 1
1614 // use static greetings specified if no of contacts > 2
1615 $merge[$masterID]['postalGreeting'] = $exportParams['postal_greeting_other'];
1617 elseif ($copyPostalGreeting) {
1618 self
::_trimNonTokens($copyPostalGreeting,
1619 $postalOptions[$dao->copy_postal_greeting_id
],
1622 $merge[$masterID]['postalGreeting'] = "{$merge[$masterID]['postalGreeting']}, {$copyPostalGreeting}";
1623 // if there happens to be a duplicate, remove it
1624 $merge[$masterID]['postalGreeting'] = str_replace(" {$copyPostalGreeting},", "", $merge[$masterID]['postalGreeting']);
1627 if (CRM_Utils_Array
::value('addressee_other', $exportParams) &&
1628 count($merge[$masterID]['copy']) >= 1
1630 // use static greetings specified if no of contacts > 2
1631 $merge[$masterID]['addressee'] = $exportParams['addressee_other'];
1633 elseif ($copyAddressee) {
1634 self
::_trimNonTokens($copyAddressee,
1635 $addresseeOptions[$dao->copy_addressee_id
],
1636 $exportParams, 'addressee'
1638 $merge[$masterID]['addressee'] = "{$merge[$masterID]['addressee']}, " . trim($copyAddressee);
1641 $merge[$masterID]['copy'][$copyID] = $copyAddressee;
1648 * Function to merge household record into the individual record
1651 * @param string $exportTempTable temporary temp table that stores the records
1652 * @param array $headerRows array of headers for the export file
1653 * @param array $sqlColumns array of names of the table columns of the temp table
1654 * @param string $prefix name of the relationship type that is prefixed to the table columns
1656 static function mergeSameHousehold($exportTempTable, &$headerRows, &$sqlColumns, $prefix) {
1657 $prefixColumn = $prefix . '_';
1658 $allKeys = array_keys($sqlColumns);
1659 $replaced = array();
1660 $headerRows = array_values($headerRows);
1662 // name map of the non standard fields in header rows & sql columns
1663 $mappingFields = array(
1664 'civicrm_primary_id' => 'id',
1665 'contact_source' => 'source',
1666 'current_employer_id' => 'employer_id',
1667 'contact_is_deleted' => 'is_deleted',
1668 'name' => 'address_name',
1669 'provider_id' => 'im_service_provider',
1670 'phone_type_id' => 'phone_type'
1673 //figure out which columns are to be replaced by which ones
1674 foreach ($sqlColumns as $columnNames => $dontCare) {
1675 if ($rep = CRM_Utils_Array
::value($columnNames, $mappingFields)) {
1676 $replaced[$columnNames] = CRM_Utils_String
::munge($prefixColumn . $rep, '_', 64);
1679 $householdColName = CRM_Utils_String
::munge($prefixColumn . $columnNames, '_', 64);
1681 if (CRM_Utils_Array
::value($householdColName, $sqlColumns)) {
1682 $replaced[$columnNames] = $householdColName;
1686 $query = "UPDATE $exportTempTable SET ";
1689 foreach ($replaced as $from => $to) {
1690 $clause[] = "$from = $to ";
1691 unset($sqlColumns[$to]);
1692 if ($key = CRM_Utils_Array
::key($to, $allKeys)) {
1693 unset($headerRows[$key]);
1696 $query .= implode(",\n", $clause);
1697 $query .= " WHERE {$replaced['civicrm_primary_id']} != ''";
1699 CRM_Core_DAO
::executeQuery($query);
1701 //drop the table columns that store redundant household info
1702 $dropQuery = "ALTER TABLE $exportTempTable ";
1703 foreach ($replaced as $householdColumns) {
1704 $dropClause[] = " DROP $householdColumns ";
1706 $dropQuery .= implode(",\n", $dropClause);
1708 CRM_Core_DAO
::executeQuery($dropQuery);
1710 // also drop the temp table if exists
1711 $sql = "DROP TABLE IF EXISTS {$exportTempTable}_temp";
1712 CRM_Core_DAO
::executeQuery($sql);
1714 // clean up duplicate records
1716 CREATE TABLE {$exportTempTable}_temp SELECT *
1717 FROM {$exportTempTable}
1718 GROUP BY civicrm_primary_id ";
1720 CRM_Core_DAO
::executeQuery($query);
1722 $query = "DROP TABLE $exportTempTable";
1723 CRM_Core_DAO
::executeQuery($query);
1725 $query = "ALTER TABLE {$exportTempTable}_temp RENAME TO {$exportTempTable}";
1726 CRM_Core_DAO
::executeQuery($query);
1729 static function writeCSVFromTable($exportTempTable, $headerRows, $sqlColumns, $exportMode, $saveFile = null, $batchItems = '') {
1730 $writeHeader = TRUE;
1732 $limit = self
::EXPORT_ROW_COUNT
;
1734 $query = "SELECT * FROM $exportTempTable";
1737 $limitQuery = $query . "
1738 LIMIT $offset, $limit
1740 $dao = CRM_Core_DAO
::executeQuery($limitQuery);
1746 $componentDetails = array();
1747 while ($dao->fetch()) {
1750 foreach ($sqlColumns as $column => $dontCare) {
1751 $row[$column] = $dao->$column;
1753 $componentDetails[] = $row;
1755 if ( $exportMode == 'financial' ) {
1756 $getExportFileName = 'CiviCRM Contribution Search';
1759 $getExportFileName =self
::getExportFileName( 'csv', $exportMode );
1761 $csvRows = CRM_Core_Report_Excel
::writeCSVFile( $getExportFileName,
1768 if ($saveFile && !empty($csvRows)) {
1769 $batchItems .= $csvRows;
1772 $writeHeader = false;
1778 * Function to manipulate header rows for relationship fields
1781 function manipulateHeaderRows(&$headerRows, $contactRelationshipTypes) {
1782 foreach ($headerRows as & $header) {
1783 $split = explode('-', $header);
1784 if ($relationTypeName = CRM_Utils_Array
::value($split[0], $contactRelationshipTypes)) {
1785 $split[0] = $relationTypeName;
1786 $header = implode('-', $split);
1792 * Function to exclude contacts who are deceased, have "Do not mail" privacy setting,
1793 * or have no street address
1796 function postalMailingFormat($exportTempTable, &$headerRows, &$sqlColumns, $exportParams) {
1797 $whereClause = array();
1799 if (array_key_exists('is_deceased', $sqlColumns)) {
1800 $whereClause[] = 'is_deceased = 1';
1803 if (array_key_exists('do_not_mail', $sqlColumns)) {
1804 $whereClause[] = 'do_not_mail = 1';
1807 if (array_key_exists('street_address', $sqlColumns)) {
1808 $addressWhereClause = " ( (street_address IS NULL) OR (street_address = '') ) ";
1810 // check for supplemental_address_1
1811 if (array_key_exists('supplemental_address_1', $sqlColumns)) {
1812 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1813 'address_options', TRUE, NULL, TRUE
1815 if (CRM_Utils_Array
::value('supplemental_address_1', $addressOptions)) {
1816 $addressWhereClause .= " AND ( (supplemental_address_1 IS NULL) OR (supplemental_address_1 = '') ) ";
1817 // enclose it again, since we are doing an AND in between a set of ORs
1818 $addressWhereClause = "( $addressWhereClause )";
1822 $whereClause[] = $addressWhereClause;
1825 if (!empty($whereClause)) {
1826 $whereClause = implode(' OR ', $whereClause);
1829 FROM $exportTempTable
1830 WHERE {$whereClause}";
1831 CRM_Core_DAO
::singleValueQuery($query);
1834 // unset temporary columns that were added for postal mailing format
1835 if (!empty($exportParams['postal_mailing_export']['temp_columns'])) {
1836 $unsetKeys = array_keys($sqlColumns);
1837 foreach ($unsetKeys as $headerKey => $sqlColKey) {
1838 if (array_key_exists($sqlColKey, $exportParams['postal_mailing_export']['temp_columns'])) {
1839 unset($sqlColumns[$sqlColKey], $headerRows[$headerKey]);
1846 * Build componentPayment fields.
1848 static function componentPaymentFields() {
1849 static $componentPaymentFields;
1850 if (!isset( $componentPaymentFields)) {
1851 $componentPaymentFields = array(
1852 'componentPaymentField_total_amount' => ts('Total Amount'),
1853 'componentPaymentField_contribution_status' => ts('Contribution Status'),
1854 'componentPaymentField_received_date' => ts('Received Date'),
1855 'componentPaymentField_payment_instrument' => ts('Payment Instrument'),
1856 'componentPaymentField_transaction_id' => ts('Transaction ID'),
1859 return $componentPaymentFields;