3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
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();
85 $phoneTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id');
86 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
87 $contactRelationshipTypes = CRM_Contact_BAO_Relationship
::getContactRelationshipType(
96 $queryMode = CRM_Contact_BAO_Query
::MODE_CONTACTS
;
98 switch ($exportMode) {
99 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
100 $queryMode = CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
;
103 case CRM_Export_Form_Select
::EVENT_EXPORT
:
104 $queryMode = CRM_Contact_BAO_Query
::MODE_EVENT
;
107 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
108 $queryMode = CRM_Contact_BAO_Query
::MODE_MEMBER
;
111 case CRM_Export_Form_Select
::PLEDGE_EXPORT
:
112 $queryMode = CRM_Contact_BAO_Query
::MODE_PLEDGE
;
115 case CRM_Export_Form_Select
::CASE_EXPORT
:
116 $queryMode = CRM_Contact_BAO_Query
::MODE_CASE
;
119 case CRM_Export_Form_Select
::GRANT_EXPORT
:
120 $queryMode = CRM_Contact_BAO_Query
::MODE_GRANT
;
123 case CRM_Export_Form_Select
::ACTIVITY_EXPORT
:
124 $queryMode = CRM_Contact_BAO_Query
::MODE_ACTIVITY
;
128 //construct return properties
129 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
130 $locationTypeFields = array(
132 'supplemental_address_1',
133 'supplemental_address_2',
136 'postal_code_suffix',
146 foreach ($fields as $key => $value) {
147 $phoneTypeId = $imProviderId = NULL;
148 $relationshipTypes = $fieldName = CRM_Utils_Array
::value(1, $value);
152 // get phoneType id and IM service provider id seperately
153 if ($fieldName == 'phone') {
154 $phoneTypeId = CRM_Utils_Array
::value(3, $value);
156 elseif ($fieldName == 'im') {
157 $imProviderId = CRM_Utils_Array
::value(3, $value);
160 if (array_key_exists($relationshipTypes, $contactRelationshipTypes)) {
161 if (CRM_Utils_Array
::value(2, $value)) {
162 $relationField = CRM_Utils_Array
::value(2, $value);
163 if (trim(CRM_Utils_Array
::value(3, $value))) {
164 $relLocTypeId = CRM_Utils_Array
::value(3, $value);
167 $relLocTypeId = 'Primary';
170 if ($relationField == 'phone') {
171 $relPhoneTypeId = CRM_Utils_Array
::value(4, $value);
173 elseif ($relationField == 'im') {
174 $relIMProviderId = CRM_Utils_Array
::value(4, $value);
177 elseif (CRM_Utils_Array
::value(4, $value)) {
178 $relationField = CRM_Utils_Array
::value(4, $value);
179 $relLocTypeId = CRM_Utils_Array
::value(5, $value);
180 if ($relationField == 'phone') {
181 $relPhoneTypeId = CRM_Utils_Array
::value(6, $value);
183 elseif ($relationField == 'im') {
184 $relIMProviderId = CRM_Utils_Array
::value(6, $value);
189 $contactType = CRM_Utils_Array
::value(0, $value);
190 $locTypeId = CRM_Utils_Array
::value(2, $value);
192 if ($relationField) {
193 if (in_array($relationField, $locationTypeFields) && is_numeric($relLocTypeId)) {
194 if ($relPhoneTypeId) {
195 $returnProperties[$relationshipTypes]['location'][$locationTypes[$relLocTypeId]]['phone-' . $relPhoneTypeId] = 1;
197 elseif ($relIMProviderId) {
198 $returnProperties[$relationshipTypes]['location'][$locationTypes[$relLocTypeId]]['im-' . $relIMProviderId] = 1;
201 $returnProperties[$relationshipTypes]['location'][$locationTypes[$relLocTypeId]][$relationField] = 1;
203 $relPhoneTypeId = $relIMProviderId = NULL;
206 $returnProperties[$relationshipTypes][$relationField] = 1;
209 elseif (is_numeric($locTypeId)) {
211 $returnProperties['location'][$locationTypes[$locTypeId]]['phone-' . $phoneTypeId] = 1;
213 elseif ($imProviderId) {
214 $returnProperties['location'][$locationTypes[$locTypeId]]['im-' . $imProviderId] = 1;
217 $returnProperties['location'][$locationTypes[$locTypeId]][$fieldName] = 1;
221 //hack to fix component fields
222 if ($fieldName == 'event_id') {
223 $returnProperties['event_title'] = 1;
226 $exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
&&
227 array_key_exists( $fieldName, self
::componentPaymentFields())
229 $selectedPaymentFields = true;
230 $paymentTableId = 'participant_id';
231 $returnProperties[$fieldName] = 1;
234 $returnProperties[$fieldName] = 1;
239 // hack to add default returnproperty based on export mode
240 if ($exportMode == CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
) {
241 $returnProperties['contribution_id'] = 1;
243 elseif ($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
) {
244 $returnProperties['participant_id'] = 1;
245 if (CRM_Utils_Array
::value('participant_role', $returnProperties)) {
246 unset($returnProperties['participant_role']);
247 $returnProperties['participant_role_id'] = 1;
250 elseif ($exportMode == CRM_Export_Form_Select
::MEMBER_EXPORT
) {
251 $returnProperties['membership_id'] = 1;
253 elseif ($exportMode == CRM_Export_Form_Select
::PLEDGE_EXPORT
) {
254 $returnProperties['pledge_id'] = 1;
256 elseif ($exportMode == CRM_Export_Form_Select
::CASE_EXPORT
) {
257 $returnProperties['case_id'] = 1;
259 elseif ($exportMode == CRM_Export_Form_Select
::GRANT_EXPORT
) {
260 $returnProperties['grant_id'] = 1;
262 elseif ($exportMode == CRM_Export_Form_Select
::ACTIVITY_EXPORT
) {
263 $returnProperties['activity_id'] = 1;
268 $fields = CRM_Contact_BAO_Contact
::exportableFields('All', TRUE, TRUE);
269 foreach ($fields as $key => $var) {
270 if ($key && (substr($key, 0, 6) != 'custom')) {
272 $returnProperties[$key] = 1;
277 $returnProperties['location_type'] = 1;
278 $returnProperties['im_provider'] = 1;
279 $returnProperties['phone_type_id'] = 1;
280 $returnProperties['provider_id'] = 1;
281 $returnProperties['current_employer'] = 1;
284 $extraReturnProperties = array();
285 $paymentFields = FALSE;
287 switch ($queryMode) {
288 case CRM_Contact_BAO_Query
::MODE_EVENT
:
289 $paymentFields = TRUE;
290 $paymentTableId = 'participant_id';
293 case CRM_Contact_BAO_Query
::MODE_MEMBER
:
294 $paymentFields = TRUE;
295 $paymentTableId = 'membership_id';
298 case CRM_Contact_BAO_Query
::MODE_PLEDGE
:
299 $extraReturnProperties = CRM_Pledge_BAO_Query
::extraReturnProperties($queryMode);
300 $paymentFields = TRUE;
301 $paymentTableId = 'pledge_payment_id';
304 case CRM_Contact_BAO_Query
::MODE_CASE
:
305 $extraReturnProperties = CRM_Case_BAO_Query
::extraReturnProperties($queryMode);
309 if ($queryMode != CRM_Contact_BAO_Query
::MODE_CONTACTS
) {
310 $componentReturnProperties = CRM_Contact_BAO_Query
::defaultReturnProperties($queryMode);
311 $returnProperties = array_merge($returnProperties, $componentReturnProperties);
313 if (!empty($extraReturnProperties)) {
314 $returnProperties = array_merge($returnProperties, $extraReturnProperties);
317 // unset non exportable fields for components
318 $nonExpoFields = array(
319 'groups', 'tags', 'notes', 'contribution_status_id',
320 'pledge_status_id', 'pledge_payment_status_id',
322 foreach ($nonExpoFields as $value) {
323 unset($returnProperties[$value]);
328 if ($mergeSameAddress) {
329 //make sure the addressee fields are selected
330 //while using merge same address feature
331 $returnProperties['addressee'] = 1;
332 $returnProperties['postal_greeting'] = 1;
333 $returnProperties['email_greeting'] = 1;
334 $returnProperties['street_name'] = 1;
335 $returnProperties['household_name'] = 1;
336 $returnProperties['street_address'] = 1;
337 $returnProperties['city'] = 1;
338 $returnProperties['state_province'] = 1;
340 // some columns are required for assistance incase they are not already present
341 $exportParams['merge_same_address']['temp_columns'] = array();
342 $tempColumns = array('id', 'master_id', 'state_province_id', 'postal_greeting_id', 'addressee_id');
343 foreach ($tempColumns as $column) {
344 if (!array_key_exists($column, $returnProperties)) {
345 $returnProperties[$column] = 1;
346 $column = $column == 'id' ?
'civicrm_primary_id' : $column;
347 $exportParams['merge_same_address']['temp_columns'][$column] = 1;
352 if (!$selectAll && $componentTable && CRM_Utils_Array
::value('additional_group', $exportParams)) {
353 // If an Additional Group is selected, then all contacts in that group are
354 // added to the export set (filtering out duplicates).
356 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";
357 CRM_Core_DAO
::executeQuery($query);
360 if ($moreReturnProperties) {
362 if (CRM_Utils_Array
::value('group', $moreReturnProperties)) {
363 unset($moreReturnProperties['group']);
364 $moreReturnProperties['groups'] = 1;
366 $returnProperties = array_merge($returnProperties, $moreReturnProperties);
369 $exportParams['postal_mailing_export']['temp_columns'] = array();
370 if ($exportParams['exportOption'] == 2 &&
371 isset($exportParams['postal_mailing_export']) &&
372 CRM_Utils_Array
::value('postal_mailing_export', $exportParams['postal_mailing_export']) == 1
374 $postalColumns = array('is_deceased', 'do_not_mail', 'street_address', 'supplemental_address_1');
375 foreach ($postalColumns as $column) {
376 if (!array_key_exists($column, $returnProperties)) {
377 $returnProperties[$column] = 1;
378 $exportParams['postal_mailing_export']['temp_columns'][$column] = 1;
383 $query = new CRM_Contact_BAO_Query($params, $returnProperties, NULL,
384 FALSE, FALSE, $queryMode,
385 FALSE, TRUE, TRUE, NULL, $queryOperator
388 list($select, $from, $where, $having) = $query->query();
390 if ($mergeSameHousehold == 1) {
391 if (!$returnProperties['id']) {
392 $returnProperties['id'] = 1;
395 //also merge Head of Household
396 $relationKeyMOH = CRM_Utils_Array
::key('Household Member of', $contactRelationshipTypes);
397 $relationKeyHOH = CRM_Utils_Array
::key('Head of Household for', $contactRelationshipTypes);
399 foreach ($returnProperties as $key => $value) {
400 if (!array_key_exists($key, $contactRelationshipTypes)) {
401 $returnProperties[$relationKeyMOH][$key] = $value;
402 $returnProperties[$relationKeyHOH][$key] = $value;
406 unset($returnProperties[$relationKeyMOH]['location_type']);
407 unset($returnProperties[$relationKeyMOH]['im_provider']);
408 unset($returnProperties[$relationKeyHOH]['location_type']);
409 unset($returnProperties[$relationKeyHOH]['im_provider']);
412 $allRelContactArray = $relationQuery = array();
414 foreach ($contactRelationshipTypes as $rel => $dnt) {
415 if ($relationReturnProperties = CRM_Utils_Array
::value($rel, $returnProperties)) {
416 $allRelContactArray[$rel] = array();
417 // build Query for each relationship
418 $relationQuery[$rel] = new CRM_Contact_BAO_Query(NULL, $relationReturnProperties,
419 NULL, FALSE, FALSE, $queryMode
421 list($relationSelect, $relationFrom, $relationWhere, $relationHaving) = $relationQuery[$rel]->query();
423 list($id, $direction) = explode('_', $rel, 2);
424 // identify the relationship direction
425 $contactA = 'contact_id_a';
426 $contactB = 'contact_id_b';
427 if ($direction == 'b_a') {
428 $contactA = 'contact_id_b';
429 $contactB = 'contact_id_a';
431 if ($exportMode == CRM_Export_Form_Select
::CONTACT_EXPORT
) {
434 elseif ($exportMode == CRM_Export_Form_Select
::ACTIVITY_EXPORT
) {
435 $sourceID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Source');
436 $query = "SELECT contact_id FROM civicrm_activity_contact
437 WHERE activity_id IN ( " . implode(',', $ids) . ") AND
438 record_type_id = {$sourceID}";
439 $dao = CRM_Core_DAO
::executeQuery($query);
440 while ($dao->fetch()) {
441 $relIDs[] = $dao->contact_id
;
445 switch ($exportMode) {
446 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
447 $component = 'civicrm_contribution';
450 case CRM_Export_Form_Select
::EVENT_EXPORT
:
451 $component = 'civicrm_participant';
454 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
455 $component = 'civicrm_membership';
458 case CRM_Export_Form_Select
::PLEDGE_EXPORT
:
459 $component = 'civicrm_pledge';
462 case CRM_Export_Form_Select
::GRANT_EXPORT
:
463 $component = 'civicrm_grant';
467 if ($exportMode == CRM_Export_Form_Select
::CASE_EXPORT
) {
468 $relIDs = CRM_Case_BAO_Case
::retrieveContactIdsByCaseId($ids);
471 $relIDs = CRM_Core_DAO
::getContactIDsFromComponent($ids, $component);
475 $relationshipJoin = $relationshipClause = '';
476 if (!$selectAll && $componentTable) {
477 $relationshipJoin = " INNER JOIN {$componentTable} ctTable ON ctTable.contact_id = {$contactA}";
479 elseif (!empty($relIDs)) {
480 $relID = implode(',', $relIDs);
481 $relationshipClause = " AND crel.{$contactA} IN ( {$relID} )";
484 $relationFrom = " {$relationFrom}
485 INNER JOIN civicrm_relationship crel ON crel.{$contactB} = contact_a.id AND crel.relationship_type_id = {$id}
486 {$relationshipJoin} ";
488 //check for active relationship status only
489 $today = date('Ymd');
490 $relationActive = " AND (crel.is_active = 1 AND ( crel.end_date is NULL OR crel.end_date >= {$today} ) )";
491 $relationWhere = " WHERE contact_a.is_deleted = 0 {$relationshipClause} {$relationActive}";
492 $relationGroupBy = " GROUP BY crel.{$contactA}";
493 $relationSelect = "{$relationSelect}, {$contactA} as refContact ";
494 $relationQueryString = "$relationSelect $relationFrom $relationWhere $relationHaving $relationGroupBy";
496 $allRelContactDAO = CRM_Core_DAO
::executeQuery($relationQueryString);
497 while ($allRelContactDAO->fetch()) {
498 //FIX Me: Migrate this to table rather than array
499 // build the array of all related contacts
500 $allRelContactArray[$rel][$allRelContactDAO->refContact
] = clone($allRelContactDAO);
502 $allRelContactDAO->free();
506 // make sure the groups stuff is included only if specifically specified
507 // by the fields param (CRM-1969), else we limit the contacts outputted to only
508 // ones that are part of a group
509 if (CRM_Utils_Array
::value('groups', $returnProperties)) {
510 $oldClause = "( contact_a.id = civicrm_group_contact.contact_id )";
511 $newClause = " ( $oldClause AND ( civicrm_group_contact.status = 'Added' OR civicrm_group_contact.status IS NULL ) )";
512 // total hack for export, CRM-3618
513 $from = str_replace($oldClause,
519 if (!$selectAll && $componentTable) {
520 $from .= " INNER JOIN $componentTable ctTable ON ctTable.contact_id = contact_a.id ";
522 elseif ($componentClause) {
524 $where = "WHERE $componentClause";
527 $where .= " AND $componentClause";
531 // CRM-13982 - check if is deleted
532 $excludeTrashed = TRUE;
533 foreach ($params as $value) {
534 if ($value[0] == 'contact_is_deleted') {
535 $excludeTrashed = FALSE;
538 if (empty($where) && $excludeTrashed) {
539 $where = "WHERE contact_a.is_deleted != 1";
541 elseif ($excludeTrashed) {
542 $where .= " AND contact_a.is_deleted != 1";
545 $queryString = "$select $from $where $having";
548 if (CRM_Utils_Array
::value('tags', $returnProperties) ||
549 CRM_Utils_Array
::value('groups', $returnProperties) ||
550 CRM_Utils_Array
::value('notes', $returnProperties) ||
552 ($queryMode & CRM_Contact_BAO_Query
::MODE_CONTACTS
&& $query->_useGroupBy
)
554 $groupBy = " GROUP BY contact_a.id";
557 switch ($exportMode) {
558 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
559 $groupBy = 'GROUP BY civicrm_contribution.id';
562 case CRM_Export_Form_Select
::EVENT_EXPORT
:
563 $groupBy = 'GROUP BY civicrm_participant.id';
566 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
567 $groupBy = " GROUP BY civicrm_membership.id";
571 if ($queryMode & CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
572 $groupBy = " GROUP BY civicrm_activity.id ";
574 $queryString .= $groupBy;
576 list($field, $dir) = explode(' ', $order, 2);
577 $field = trim($field);
578 if (CRM_Utils_Array
::value($field, $returnProperties)) {
579 // $queryString .= " ORDER BY $order";
583 $multipleSelectFields = array('preferred_communication_method' => 1);
585 $addPaymentHeader = FALSE;
587 $paymentDetails = array();
588 if ($paymentFields ||
$selectedPaymentFields) {
590 // get payment related in for event and members
591 $paymentDetails = CRM_Contribute_BAO_Contribution
::getContributionDetails($exportMode, $ids);
592 //get all payment headers.
593 // If we haven't selected specific payment fields, load in all the
595 if (!$selectedPaymentFields) {
596 $paymentHeaders = self
::componentPaymentFields();
597 if (!empty($paymentDetails)) {
598 $addPaymentHeader = TRUE;
601 // If we have seleted specific payment fields, leave the payment headers
602 // as an empty array; the headers for each selected field will be added
605 $paymentHeaders = array();
607 $nullContributionDetails = array_fill_keys(array_keys($paymentHeaders), NULL);
610 // Split campaign into 2 fields for id and title
611 $campaignReturnProperties = array();
612 foreach ($returnProperties as $fld => $true) {
613 $campaignReturnProperties[$fld] = $true;
614 if (substr($fld, -11) == 'campaign_id') {
615 $exportCampaign = TRUE;
616 $campaignReturnProperties[substr($fld, 0, -3)] = 1;
619 $returnProperties = $campaignReturnProperties;
621 if (isset($exportCampaign)) {
622 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
625 $componentDetails = $headerRows = $sqlColumns = array();
628 $rowCount = self
::EXPORT_ROW_COUNT
;
630 // we write to temp table often to avoid using too much memory
635 // for CRM-3157 purposes
636 $i18n = CRM_Core_I18n
::singleton();
639 $limitQuery = "{$queryString} LIMIT {$offset}, {$rowCount}";
640 $dao = CRM_Core_DAO
::executeQuery($limitQuery);
645 while ($dao->fetch()) {
649 //convert the pseudo constants
650 $query->convertToPseudoNames($dao);
652 //first loop through returnproperties so that we return what is required, and in same order.
653 $relationshipField = 0;
654 foreach ($returnProperties as $field => $value) {
655 //we should set header only once
658 // Split campaign into 2 fields for id and title
659 if (substr($field, -8) == 'campaign') {
660 $headerRows[] = ts('Campaign Title');
662 elseif (substr($field, -11) == 'campaign_id') {
663 $headerRows[] = ts('Campaign ID');
665 elseif (isset($query->_fields
[$field]['title'])) {
666 $headerRows[] = $query->_fields
[$field]['title'];
668 elseif ($field == 'phone_type_id') {
669 $headerRows[] = ts('Phone Type');
671 elseif ($field == 'provider_id') {
672 $headerRows[] = ts('IM Service Provider');
674 elseif (is_array($value) && $field == 'location') {
675 // fix header for location type case
676 foreach ($value as $ltype => $val) {
677 foreach (array_keys($val) as $fld) {
678 $type = explode('-', $fld);
679 $hdr = "{$ltype}-" . $query->_fields
[$type[0]]['title'];
681 if (CRM_Utils_Array
::value(1, $type)) {
682 if (CRM_Utils_Array
::value(0, $type) == 'phone') {
683 $hdr .= "-" . CRM_Utils_Array
::value($type[1], $phoneTypes);
685 elseif (CRM_Utils_Array
::value(0, $type) == 'im') {
686 $hdr .= "-" . CRM_Utils_Array
::value($type[1], $imProviders);
689 $headerRows[] = $hdr;
690 self
::sqlColumnDefn($query, $sqlColumns, $hdr);
695 elseif (substr($field, 0, 5) == 'case_') {
696 if ($query->_fields
['case'][$field]['title']) {
697 $headerRows[] = $query->_fields
['case'][$field]['title'];
699 elseif ($query->_fields
['activity'][$field]['title']) {
700 $headerRows[] = $query->_fields
['activity'][$field]['title'];
703 elseif (array_key_exists($field, $contactRelationshipTypes)) {
705 foreach ($value as $relationField => $relationValue) {
706 // below block is same as primary block (duplicate)
707 if (isset($relationQuery[$field]->_fields
[$relationField]['title'])) {
708 if ($relationQuery[$field]->_fields
[$relationField]['name'] == 'name') {
709 $headerName = $field . '-' . $relationField;
712 if ($relationField == 'current_employer') {
713 $headerName = $field . '-' . 'current_employer';
716 $headerName = $field . '-' . $relationQuery[$field]->_fields
[$relationField]['name'];
720 $headerRows[] = $headerName;
722 self
::sqlColumnDefn($query, $sqlColumns, $headerName);
724 elseif ($relationField == 'phone_type_id') {
725 $headerName = $field . '-' . 'Phone Type';
726 $headerRows[] = $headerName;
727 self
::sqlColumnDefn($query, $sqlColumns, $headerName);
729 elseif ($relationField == 'provider_id') {
730 $headerName = $field . '-' . 'Im Service Provider';
731 $headerRows[] = $headerName;
732 self
::sqlColumnDefn($query, $sqlColumns, $headerName);
734 elseif ($relationField == 'state_province_id') {
735 $headerName = $field . '-' . 'state_province_id';
736 $headerRows[] = $headerName;
737 self
::sqlColumnDefn($query, $sqlColumns, $headerName);
739 elseif (is_array($relationValue) && $relationField == 'location') {
740 // fix header for location type case
741 foreach ($relationValue as $ltype => $val) {
742 foreach (array_keys($val) as $fld) {
743 $type = explode('-', $fld);
745 $hdr = "{$ltype}-" . $relationQuery[$field]->_fields
[$type[0]]['title'];
747 if (CRM_Utils_Array
::value(1, $type)) {
748 if (CRM_Utils_Array
::value(0, $type) == 'phone') {
749 $hdr .= "-" . CRM_Utils_Array
::value($type[1], $phoneTypes);
751 elseif (CRM_Utils_Array
::value(0, $type) == 'im') {
752 $hdr .= "-" . CRM_Utils_Array
::value($type[1], $imProviders);
755 $headerName = $field . '-' . $hdr;
756 $headerRows[] = $headerName;
757 self
::sqlColumnDefn($query, $sqlColumns, $headerName);
763 elseif ($selectedPaymentFields && array_key_exists($field, self
::componentPaymentFields())) {
764 $headerRows[] = CRM_Utils_Array
::value($field, self
::componentPaymentFields());
767 $headerRows[] = $field;
771 self
::sqlColumnDefn($query, $sqlColumns, $field);
775 // add im_provider to $dao object
776 if ($field == 'im_provider' && property_exists($dao, 'provider_id')) {
777 $dao->im_provider
= $dao->provider_id
;
780 //build row values (data)
782 if (property_exists($dao, $field)) {
783 $fieldValue = $dao->$field;
784 // to get phone type from phone type id
785 if ($field == 'phone_type_id' && isset($phoneTypes[$fieldValue])) {
786 $fieldValue = $phoneTypes[$fieldValue];
788 elseif ($field == 'provider_id' ||
$field == 'im_provider') {
789 $fieldValue = CRM_Utils_Array
::value($fieldValue, $imProviders);
791 elseif ($field == 'participant_role_id') {
792 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
793 $sep = CRM_Core_DAO
::VALUE_SEPARATOR
;
794 $viewRoles = array();
795 foreach (explode($sep, $dao->$field) as $k => $v) {
796 $viewRoles[] = $participantRoles[$v];
798 $fieldValue = implode(',', $viewRoles);
800 elseif ($field == 'master_id') {
801 $masterAddressId = NULL;
802 if (isset($dao->master_id
)) {
803 $masterAddressId = $dao->master_id
;
805 // get display name of contact that address is shared.
806 $fieldValue = CRM_Contact_BAO_Contact
::getMasterDisplayName($masterAddressId, $dao->contact_id
);
810 if ($field == 'id') {
811 $row[$field] = $dao->contact_id
;
812 // special case for calculated field
814 elseif ($field == 'source_contact_id') {
815 $row[$field] = $dao->contact_id
;
817 elseif ($field == 'pledge_balance_amount') {
818 $row[$field] = $dao->pledge_amount
- $dao->pledge_total_paid
;
819 // special case for calculated field
821 elseif ($field == 'pledge_next_pay_amount') {
822 $row[$field] = $dao->pledge_next_pay_amount +
$dao->pledge_outstanding_amount
;
824 elseif (is_array($value) && $field == 'location') {
825 // fix header for location type case
826 foreach ($value as $ltype => $val) {
827 foreach (array_keys($val) as $fld) {
828 $type = explode('-', $fld);
829 $fldValue = "{$ltype}-" . $type[0];
830 // CRM-14076 - fix label to work as the query object expects
831 // FIXME: We should not be using labels as keys!
832 $daoField = CRM_Utils_String
::munge($ltype) . '-' . $type[0];
834 if (CRM_Utils_Array
::value(1, $type)) {
835 $fldValue .= "-" . $type[1];
836 $daoField .= "-" . $type[1];
839 // CRM-3157: localise country, region (both have ‘country’ context) and state_province (‘province’ context)
843 $row[$fldValue] = $i18n->crm_translate($dao->$daoField, array('context' => 'country'));
846 case 'state_province':
847 $row[$fldValue] = $i18n->crm_translate($dao->$daoField, array('context' => 'province'));
851 $imFieldvalue = $daoField . "-provider_id";
852 $row[$fldValue] = CRM_Utils_Array
::value($dao->$imFieldvalue, $imProviders);
856 $row[$fldValue] = $dao->$daoField;
862 elseif (array_key_exists($field, $contactRelationshipTypes)) {
863 $relDAO = CRM_Utils_Array
::value($dao->contact_id
, $allRelContactArray[$field]);
864 foreach ($value as $relationField => $relationValue) {
865 if (is_object($relDAO) && property_exists($relDAO, $relationField)) {
866 $fieldValue = $relDAO->$relationField;
867 if ($relationField == 'phone_type_id') {
868 $fieldValue = $phoneTypes[$relationValue];
870 elseif ($relationField == 'provider_id') {
871 $fieldValue = CRM_Utils_Array
::value($relationValue, $imProviders);
875 elseif (is_object($relDAO) && in_array($relationField, array(
876 'email_greeting', 'postal_greeting', 'addressee'))) {
877 //special case for greeting replacement
878 $fldValue = "{$relationField}_display";
879 $fieldValue = $relDAO->$fldValue;
881 elseif ( is_object($relDAO) && $relationField == 'state_province' ) {
882 $fieldValue = CRM_Core_PseudoConstant
::stateProvince($relDAO->state_province_id
);
884 elseif ( is_object($relDAO) && $relationField == 'country' ) {
885 $fieldValue = CRM_Core_PseudoConstant
::country($relDAO->country_id
);
890 $field = $field . '_';
892 if (is_object($relDAO) && $relationField == 'id') {
893 $row[$field . $relationField] = $relDAO->contact_id
;
895 elseif ( is_object( $relDAO ) && is_array( $relationValue ) && $relationField == 'location' ) {
896 foreach ($relationValue as $ltype => $val) {
897 foreach (array_keys($val) as $fld) {
898 $type = explode('-', $fld);
899 $fldValue = "{$ltype}-" . $type[0];
900 if (CRM_Utils_Array
::value(1, $type)) {
901 $fldValue .= "-" . $type[1];
903 // CRM-3157: localise country, region (both have ‘country’ context)
904 // and state_province (‘province’ context)
906 case (!is_object($relDAO)):
907 $row[$field . '_' . $fldValue] = '';
910 case in_array('country', $type):
911 case in_array('world_region', $type):
912 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
913 array('context' => 'country')
917 case in_array('state_province', $type):
918 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
919 array('context' => 'province')
924 $row[$field . '_' . $fldValue] = $relDAO->$fldValue;
930 elseif (isset($fieldValue) && $fieldValue != '') {
931 //check for custom data
932 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($relationField)) {
933 $row[$field . $relationField] = CRM_Core_BAO_CustomField
::getDisplayValue($fieldValue, $cfID,
934 $relationQuery[$field]->_options
938 //normal relationship fields
939 // CRM-3157: localise country, region (both have ‘country’ context) and state_province (‘province’ context)
940 switch ($relationField) {
943 $row[$field . $relationField] = $i18n->crm_translate($fieldValue, array('context' => 'country'));
946 case 'state_province':
947 $row[$field . $relationField] = $i18n->crm_translate($fieldValue, array('context' => 'province'));
951 $row[$field . $relationField] = $fieldValue;
957 // if relation field is empty or null
958 $row[$field . $relationField] = '';
962 elseif (isset($fieldValue) &&
965 //check for custom data
966 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($field)) {
967 $row[$field] = CRM_Core_BAO_CustomField
::getDisplayValue($fieldValue, $cfID, $query->_options
);
969 elseif (array_key_exists($field, $multipleSelectFields)) {
971 $paramsNew = array($field => $fieldValue);
972 if ($field == 'test_tutoring') {
973 $name = array($field => array('newName' => $field, 'groupName' => 'test'));
976 elseif (substr($field, 0, 4) == 'cmr_') {
977 $name = array($field => array('newName' => $field, 'groupName' => substr($field, 0, -3)));
980 $name = array($field => array('newName' => $field, 'groupName' => $field));
982 CRM_Core_OptionGroup
::lookupValues($paramsNew, $name, FALSE);
983 $row[$field] = $paramsNew[$field];
985 elseif (in_array($field, array(
986 'email_greeting', 'postal_greeting', 'addressee'))) {
987 //special case for greeting replacement
988 $fldValue = "{$field}_display";
989 $row[$field] = $dao->$fldValue;
992 //normal fields with a touch of CRM-3157
996 $row[$field] = $i18n->crm_translate($fieldValue, array('context' => 'country'));
999 case 'state_province':
1000 $row[$field] = $i18n->crm_translate($fieldValue, array('context' => 'province'));
1004 case 'preferred_communication_method':
1005 case 'preferred_mail_format':
1006 $row[$field] = $i18n->crm_translate($fieldValue);
1010 $row[$field] = $fieldValue;
1015 elseif (substr($field, -8) == 'campaign') {
1016 $campIdFld = "{$field}_id";
1017 $row[$field] = CRM_Utils_Array
::value($dao->$campIdFld, $allCampaigns, '');
1019 elseif ($selectedPaymentFields && array_key_exists($field, self
::componentPaymentFields())) {
1020 $paymentData = CRM_Utils_Array
::value($dao->$paymentTableId, $paymentDetails);
1021 $payFieldMapper = array(
1022 'componentPaymentField_total_amount' => 'total_amount',
1023 'componentPaymentField_contribution_status' => 'contribution_status',
1024 'componentPaymentField_payment_instrument' => 'pay_instru',
1025 'componentPaymentField_transaction_id' => 'trxn_id',
1026 'componentPaymentField_received_date' => 'receive_date',
1028 $row[$field] = CRM_Utils_Array
::value($payFieldMapper[$field], $paymentData, '');
1031 // if field is empty or null
1036 // add payment headers if required
1037 if ($addPaymentHeader && $paymentFields) {
1038 $headerRows = array_merge($headerRows, $paymentHeaders);
1039 foreach (array_keys($paymentHeaders) as $paymentHdr) {
1040 self
::sqlColumnDefn($query, $sqlColumns, $paymentHdr);
1045 $exportTempTable = self
::createTempTable($sqlColumns);
1048 //build header only once
1051 // If specific payment fields have been selected for export, payment
1052 // data will already be in $row. Otherwise, add payment related
1053 // information, if appropriate.
1054 if ($addPaymentHeader) {
1055 if (!$selectedPaymentFields) {
1056 if ($paymentFields) {
1057 $paymentData = CRM_Utils_Array
::value($row[$paymentTableId], $paymentDetails);
1058 if (!is_array($paymentData) ||
empty($paymentData)) {
1059 $paymentData = $nullContributionDetails;
1061 $row = array_merge($row, $paymentData);
1063 elseif (!empty($paymentDetails)) {
1064 $row = array_merge($row, $nullContributionDetails);
1068 //remove organization name for individuals if it is set for current employer
1069 if (CRM_Utils_Array
::value('contact_type', $row) &&
1070 $row['contact_type'] == 'Individual' && array_key_exists('organization_name', $row)
1072 $row['organization_name'] = '';
1075 // add component info
1076 // write the row to a file
1077 $componentDetails[] = $row;
1079 // output every $tempRowCount rows
1080 if ($count %
$tempRowCount == 0) {
1081 self
::writeDetailsToTable($exportTempTable, $componentDetails, $sqlColumns);
1082 $componentDetails = array();
1086 $offset +
= $rowCount;
1089 if ($exportTempTable) {
1090 self
::writeDetailsToTable($exportTempTable, $componentDetails, $sqlColumns);
1092 // do merge same address and merge same household processing
1093 if ($mergeSameAddress) {
1094 self
::mergeSameAddress($exportTempTable, $headerRows, $sqlColumns, $exportParams);
1097 // merge the records if they have corresponding households
1098 if ($mergeSameHousehold) {
1099 self
::mergeSameHousehold($exportTempTable, $headerRows, $sqlColumns, $relationKeyMOH);
1100 self
::mergeSameHousehold($exportTempTable, $headerRows, $sqlColumns, $relationKeyHOH);
1103 // fix the headers for rows with relationship type
1104 if (!empty($relName)) {
1105 self
::manipulateHeaderRows($headerRows, $contactRelationshipTypes);
1108 // if postalMailing option is checked, exclude contacts who are deceased, have
1109 // "Do not mail" privacy setting, or have no street address
1110 if (isset($exportParams['postal_mailing_export']['postal_mailing_export']) &&
1111 $exportParams['postal_mailing_export']['postal_mailing_export'] == 1
1113 self
::postalMailingFormat($exportTempTable, $headerRows, $sqlColumns, $exportMode);
1117 CRM_Utils_Hook
::export($exportTempTable, $headerRows, $sqlColumns, $exportMode);
1119 // now write the CSV file
1120 self
::writeCSVFromTable($exportTempTable, $headerRows, $sqlColumns, $exportMode);
1122 // delete the export temp table and component table
1123 $sql = "DROP TABLE IF EXISTS {$exportTempTable}";
1124 CRM_Core_DAO
::executeQuery($sql);
1126 CRM_Utils_System
::civiExit();
1129 CRM_Core_Error
::fatal(ts('No records to export'));
1134 * name of the export file based on mode
1136 * @param string $output type of output
1137 * @param int $mode export mode
1139 * @return string name of the file
1141 static function getExportFileName($output = 'csv', $mode = CRM_Export_Form_Select
::CONTACT_EXPORT
) {
1143 case CRM_Export_Form_Select
::CONTACT_EXPORT
:
1144 return ts('CiviCRM Contact Search');
1146 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
1147 return ts('CiviCRM Contribution Search');
1149 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
1150 return ts('CiviCRM Member Search');
1152 case CRM_Export_Form_Select
::EVENT_EXPORT
:
1153 return ts('CiviCRM Participant Search');
1155 case CRM_Export_Form_Select
::PLEDGE_EXPORT
:
1156 return ts('CiviCRM Pledge Search');
1158 case CRM_Export_Form_Select
::CASE_EXPORT
:
1159 return ts('CiviCRM Case Search');
1161 case CRM_Export_Form_Select
::GRANT_EXPORT
:
1162 return ts('CiviCRM Grant Search');
1164 case CRM_Export_Form_Select
::ACTIVITY_EXPORT
:
1165 return ts('CiviCRM Activity Search');
1170 * Function to handle import error file creation.
1173 static function invoke() {
1174 $type = CRM_Utils_Request
::retrieve('type', 'Positive', CRM_Core_DAO
::$_nullObject);
1175 $parserName = CRM_Utils_Request
::retrieve('parser', 'String', CRM_Core_DAO
::$_nullObject);
1176 if (empty($parserName) ||
empty($type)) {
1180 // clean and ensure parserName is a valid string
1181 $parserName = CRM_Utils_String
::munge($parserName);
1182 $parserClass = explode('_', $parserName);
1184 // make sure parserClass is in the CRM namespace and
1185 // at least 3 levels deep
1186 if ($parserClass[0] == 'CRM' &&
1187 count($parserClass) >= 3
1189 require_once (str_replace('_', DIRECTORY_SEPARATOR
, $parserName) . ".php");
1190 // ensure the functions exists
1191 if (method_exists($parserName, 'errorFileName') &&
1192 method_exists($parserName, 'saveFileName')
1194 $errorFileName = $parserName::errorFileName($type);
1195 $saveFileName = $parserName::saveFileName($type);
1196 if (!empty($errorFileName) && !empty($saveFileName)) {
1197 header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
1198 header('Content-Description: File Transfer');
1199 header('Content-Type: text/csv');
1200 header('Content-Length: ' . filesize($errorFileName));
1201 header('Content-Disposition: attachment; filename=' . $saveFileName);
1203 readfile($errorFileName);
1207 CRM_Utils_System
::civiExit();
1210 static function exportCustom($customSearchClass, $formValues, $order) {
1211 $ext = CRM_Extension_System
::singleton()->getMapper();
1212 if (!$ext->isExtensionClass($customSearchClass)) {
1213 require_once (str_replace('_', DIRECTORY_SEPARATOR
, $customSearchClass) . '.php');
1216 require_once ($ext->classToPath($customSearchClass));
1218 $search = new $customSearchClass($formValues);
1220 $includeContactIDs = FALSE;
1221 if ($formValues['radio_ts'] == 'ts_sel') {
1222 $includeContactIDs = TRUE;
1225 $sql = $search->all(0, 0, $order, $includeContactIDs);
1227 $columns = $search->columns();
1229 $header = array_keys($columns);
1230 $fields = array_values($columns);
1233 $dao = CRM_Core_DAO
::executeQuery($sql);
1235 if (method_exists($search, 'alterRow')) {
1238 while ($dao->fetch()) {
1241 foreach ($fields as $field) {
1242 $row[$field] = $dao->$field;
1245 $search->alterRow($row);
1250 CRM_Core_Report_Excel
::writeCSVFile(self
::getExportFileName(), $header, $rows);
1251 CRM_Utils_System
::civiExit();
1254 static function sqlColumnDefn(&$query, &$sqlColumns, $field) {
1255 if (substr($field, -4) == '_a_b' ||
substr($field, -4) == '_b_a') {
1259 $fieldName = CRM_Utils_String
::munge(strtolower($field), '_', 64);
1260 if ($fieldName == 'id') {
1261 $fieldName = 'civicrm_primary_id';
1264 // early exit for master_id, CRM-12100
1265 // in the DB it is an ID, but in the export, we retrive the display_name of the master record
1266 if ($fieldName == 'master_id') {
1267 $sqlColumns[$fieldName] = "$fieldName varchar(128)";
1271 // set the sql columns
1272 if (isset($query->_fields
[$field]['type'])) {
1273 switch ($query->_fields
[$field]['type']) {
1274 case CRM_Utils_Type
::T_INT
:
1275 case CRM_Utils_Type
::T_BOOLEAN
:
1276 $sqlColumns[$fieldName] = "$fieldName varchar(16)";
1279 case CRM_Utils_Type
::T_STRING
:
1280 if (isset($query->_fields
[$field]['maxlength'])) {
1281 $sqlColumns[$fieldName] = "$fieldName varchar({$query->_fields[$field]['maxlength']})";
1284 $sqlColumns[$fieldName] = "$fieldName varchar(64)";
1288 case CRM_Utils_Type
::T_TEXT
:
1289 case CRM_Utils_Type
::T_LONGTEXT
:
1290 case CRM_Utils_Type
::T_BLOB
:
1291 case CRM_Utils_Type
::T_MEDIUMBLOB
:
1292 $sqlColumns[$fieldName] = "$fieldName longtext";
1295 case CRM_Utils_Type
::T_FLOAT
:
1296 case CRM_Utils_Type
::T_ENUM
:
1297 case CRM_Utils_Type
::T_DATE
:
1298 case CRM_Utils_Type
::T_TIME
:
1299 case CRM_Utils_Type
::T_TIMESTAMP
:
1300 case CRM_Utils_Type
::T_MONEY
:
1301 case CRM_Utils_Type
::T_EMAIL
:
1302 case CRM_Utils_Type
::T_URL
:
1303 case CRM_Utils_Type
::T_CCNUM
:
1305 $sqlColumns[$fieldName] = "$fieldName varchar(32)";
1310 if (substr($fieldName, -3, 3) == '_id') {
1311 // for trxn_id and its variants use a longer buffer
1312 // to accomodate different systems - CRM-13739
1313 static $notRealIDFields = NULL;
1314 if ($notRealIDFields == NULL) {
1315 $notRealIDFields = array( 'trxn_id', 'componentpaymentfield_transaction_id' );
1318 if (in_array($fieldName, $notRealIDFields)) {
1319 $sqlColumns[$fieldName] = "$fieldName varchar(255)";
1322 $sqlColumns[$fieldName] = "$fieldName varchar(16)";
1326 $changeFields = array(
1332 if (in_array($fieldName, $changeFields)) {
1333 $sqlColumns[$fieldName] = "$fieldName text";
1336 // set the sql columns for custom data
1337 if (isset($query->_fields
[$field]['data_type'])) {
1339 switch ($query->_fields
[$field]['data_type']) {
1341 case 'StateProvince':
1344 $sqlColumns[$fieldName] = "$fieldName varchar(255)";
1348 $sqlColumns[$fieldName] = "$fieldName text";
1352 $sqlColumns[$fieldName] = "$fieldName varchar(64)";
1357 $sqlColumns[$fieldName] = "$fieldName varchar(64)";
1364 static function writeDetailsToTable($tableName, &$details, &$sqlColumns) {
1365 if (empty($details)) {
1374 $id = CRM_Core_DAO
::singleValueQuery($sql);
1379 $sqlClause = array();
1381 foreach ($details as $dontCare => $row) {
1383 $valueString = array($id);
1384 foreach ($row as $dontCare => $value) {
1385 if (empty($value)) {
1386 $valueString[] = "''";
1389 $valueString[] = "'" . CRM_Core_DAO
::escapeString($value) . "'";
1392 $sqlClause[] = '(' . implode(',', $valueString) . ')';
1395 $sqlColumnString = '(id, ' . implode(',', array_keys($sqlColumns)) . ')';
1397 $sqlValueString = implode(",\n", $sqlClause);
1400 INSERT INTO $tableName $sqlColumnString
1401 VALUES $sqlValueString
1404 CRM_Core_DAO
::executeQuery($sql);
1407 static function createTempTable(&$sqlColumns) {
1408 //creating a temporary table for the search result that need be exported
1409 $exportTempTable = CRM_Core_DAO
::createTempTableName('civicrm_export', TRUE);
1411 // also create the sql table
1412 $sql = "DROP TABLE IF EXISTS {$exportTempTable}";
1413 CRM_Core_DAO
::executeQuery($sql);
1416 CREATE TABLE {$exportTempTable} (
1417 id int unsigned NOT NULL AUTO_INCREMENT,
1419 $sql .= implode(",\n", array_values($sqlColumns));
1424 // add indexes for street_address and household_name if present
1425 $addIndices = array(
1428 'civicrm_primary_id',
1431 foreach ($addIndices as $index) {
1432 if (isset($sqlColumns[$index])) {
1434 INDEX index_{$index}( $index )
1440 ) ENGINE=MyISAM DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci
1443 CRM_Core_DAO
::executeQuery($sql);
1444 return $exportTempTable;
1447 static function mergeSameAddress($tableName, &$headerRows, &$sqlColumns, $exportParams) {
1448 // check if any records are present based on if they have used shared address feature,
1449 // and not based on if city / state .. matches.
1451 SELECT r1.id as copy_id,
1452 r1.civicrm_primary_id as copy_contact_id,
1453 r1.addressee as copy_addressee,
1454 r1.addressee_id as copy_addressee_id,
1455 r1.postal_greeting as copy_postal_greeting,
1456 r1.postal_greeting_id as copy_postal_greeting_id,
1458 r2.civicrm_primary_id as master_contact_id,
1459 r2.postal_greeting as master_postal_greeting,
1460 r2.postal_greeting_id as master_postal_greeting_id,
1461 r2.addressee as master_addressee,
1462 r2.addressee_id as master_addressee_id
1464 INNER JOIN civicrm_address adr ON r1.master_id = adr.id
1465 INNER JOIN $tableName r2 ON adr.contact_id = r2.civicrm_primary_id
1467 $linkedMerge = self
::_buildMasterCopyArray($sql, $exportParams, TRUE);
1469 // find all the records that have the same street address BUT not in a household
1470 // require match on city and state as well
1472 SELECT r1.id as master_id,
1473 r1.civicrm_primary_id as master_contact_id,
1474 r1.postal_greeting as master_postal_greeting,
1475 r1.postal_greeting_id as master_postal_greeting_id,
1476 r1.addressee as master_addressee,
1477 r1.addressee_id as master_addressee_id,
1479 r2.civicrm_primary_id as copy_contact_id,
1480 r2.postal_greeting as copy_postal_greeting,
1481 r2.postal_greeting_id as copy_postal_greeting_id,
1482 r2.addressee as copy_addressee,
1483 r2.addressee_id as copy_addressee_id
1485 LEFT JOIN $tableName r2 ON ( r1.street_address = r2.street_address AND
1486 r1.city = r2.city AND
1487 r1.state_province_id = r2.state_province_id )
1488 WHERE ( r1.household_name IS NULL OR r1.household_name = '' )
1489 AND ( r2.household_name IS NULL OR r2.household_name = '' )
1490 AND ( r1.street_address != '' )
1494 $merge = self
::_buildMasterCopyArray($sql, $exportParams);
1496 // unset ids from $merge already present in $linkedMerge
1497 foreach ($linkedMerge as $masterID => $values) {
1498 $keys = array($masterID);
1499 $keys = array_merge($keys, array_keys($values['copy']));
1500 foreach ($merge as $mid => $vals) {
1501 if (in_array($mid, $keys)) {
1502 unset($merge[$mid]);
1505 foreach ($values['copy'] as $copyId) {
1506 if (in_array($copyId, $keys)) {
1507 unset($merge[$mid]['copy'][$copyId]);
1513 $merge = $merge +
$linkedMerge;
1515 foreach ($merge as $masterID => $values) {
1518 SET addressee = %1, postal_greeting = %2, email_greeting = %3
1521 $params = array(1 => array($values['addressee'], 'String'),
1522 2 => array($values['postalGreeting'], 'String'),
1523 3 => array($values['emailGreeting'], 'String'),
1524 4 => array($masterID, 'Integer'),
1526 CRM_Core_DAO
::executeQuery($sql, $params);
1528 // delete all copies
1529 $deleteIDs = array_keys($values['copy']);
1530 $deleteIDString = implode(',', $deleteIDs);
1532 DELETE FROM $tableName
1533 WHERE id IN ( $deleteIDString )
1535 CRM_Core_DAO
::executeQuery($sql);
1538 // unset temporary columns that were added for postal mailing format
1539 if (!empty($exportParams['merge_same_address']['temp_columns'])) {
1540 $unsetKeys = array_keys($sqlColumns);
1541 foreach ($unsetKeys as $headerKey => $sqlColKey) {
1542 if (array_key_exists($sqlColKey, $exportParams['merge_same_address']['temp_columns'])) {
1543 unset($sqlColumns[$sqlColKey], $headerRows[$headerKey]);
1549 static function _replaceMergeTokens($contactId, $exportParams) {
1550 $greetings = array();
1553 $greetingFields = array(
1557 foreach ($greetingFields as $greeting) {
1558 if (CRM_Utils_Array
::value($greeting, $exportParams)) {
1559 $greetingLabel = $exportParams[$greeting];
1560 if (empty($contact)) {
1565 $contact = civicrm_api('contact', 'get', $values);
1567 if (CRM_Utils_Array
::value('is_error', $contact)) {
1570 $contact = $contact['values'][$contact['id']];
1573 $tokens = array('contact' => $greetingLabel);
1574 $greetings[$greeting] = CRM_Utils_Token
::replaceContactTokens($greetingLabel, $contact, NULL, $tokens);
1581 * The function unsets static part of the string, if token is the dynamic part.
1582 * Example: 'Hello {contact.first_name}' => converted to => '{contact.first_name}'
1583 * i.e 'Hello Alan' => converted to => 'Alan'
1586 static function _trimNonTokens(&$parsedString, $defaultGreeting,
1587 $addressMergeGreetings, $greetingType = 'postal_greeting'
1589 if (CRM_Utils_Array
::value($greetingType, $addressMergeGreetings)) {
1590 $greetingLabel = $addressMergeGreetings[$greetingType];
1592 $greetingLabel = empty($greetingLabel) ?
$defaultGreeting : $greetingLabel;
1594 $stringsToBeReplaced = preg_replace('/(\{[a-zA-Z._ ]+\})/', ';;', $greetingLabel);
1595 $stringsToBeReplaced = explode(';;', $stringsToBeReplaced);
1596 foreach ($stringsToBeReplaced as $key => $string) {
1597 // to keep one space
1598 $stringsToBeReplaced[$key] = ltrim($string);
1600 $parsedString = str_replace($stringsToBeReplaced, "", $parsedString);
1602 return $parsedString;
1605 static function _buildMasterCopyArray($sql, $exportParams, $sharedAddress = FALSE) {
1606 static $contactGreetingTokens = array();
1608 $addresseeOptions = CRM_Core_OptionGroup
::values('addressee');
1609 $postalOptions = CRM_Core_OptionGroup
::values('postal_greeting');
1611 $merge = $parents = array();
1612 $dao = CRM_Core_DAO
::executeQuery($sql);
1614 while ($dao->fetch()) {
1615 $masterID = $dao->master_id
;
1616 $copyID = $dao->copy_id
;
1617 $masterPostalGreeting = $dao->master_postal_greeting
;
1618 $masterAddressee = $dao->master_addressee
;
1619 $copyAddressee = $dao->copy_addressee
;
1621 if (!$sharedAddress) {
1622 if (!isset($contactGreetingTokens[$dao->master_contact_id
])) {
1623 $contactGreetingTokens[$dao->master_contact_id
] = self
::_replaceMergeTokens($dao->master_contact_id
, $exportParams);
1625 $masterPostalGreeting = CRM_Utils_Array
::value('postal_greeting',
1626 $contactGreetingTokens[$dao->master_contact_id
], $dao->master_postal_greeting
1628 $masterAddressee = CRM_Utils_Array
::value('addressee',
1629 $contactGreetingTokens[$dao->master_contact_id
], $dao->master_addressee
1632 if (!isset($contactGreetingTokens[$dao->copy_contact_id
])) {
1633 $contactGreetingTokens[$dao->copy_contact_id
] = self
::_replaceMergeTokens($dao->copy_contact_id
, $exportParams);
1635 $copyPostalGreeting = CRM_Utils_Array
::value('postal_greeting',
1636 $contactGreetingTokens[$dao->copy_contact_id
], $dao->copy_postal_greeting
1638 $copyAddressee = CRM_Utils_Array
::value('addressee',
1639 $contactGreetingTokens[$dao->copy_contact_id
], $dao->copy_addressee
1643 if (!isset($merge[$masterID])) {
1644 // check if this is an intermediate child
1645 // this happens if there are 3 or more matches a,b, c
1646 // the above query will return a, b / a, c / b, c
1647 // we might be doing a bit more work, but for now its ok, unless someone
1648 // knows how to fix the query above
1649 if (isset($parents[$masterID])) {
1650 $masterID = $parents[$masterID];
1653 $merge[$masterID] = array(
1654 'addressee' => $masterAddressee,
1656 'postalGreeting' => $masterPostalGreeting,
1658 $merge[$masterID]['emailGreeting'] = &$merge[$masterID]['postalGreeting'];
1661 $parents[$copyID] = $masterID;
1663 if (!$sharedAddress && !array_key_exists($copyID, $merge[$masterID]['copy'])) {
1665 if (CRM_Utils_Array
::value('postal_greeting_other', $exportParams) &&
1666 count($merge[$masterID]['copy']) >= 1
1668 // use static greetings specified if no of contacts > 2
1669 $merge[$masterID]['postalGreeting'] = $exportParams['postal_greeting_other'];
1671 elseif ($copyPostalGreeting) {
1672 self
::_trimNonTokens($copyPostalGreeting,
1673 $postalOptions[$dao->copy_postal_greeting_id
],
1676 $merge[$masterID]['postalGreeting'] = "{$merge[$masterID]['postalGreeting']}, {$copyPostalGreeting}";
1677 // if there happens to be a duplicate, remove it
1678 $merge[$masterID]['postalGreeting'] = str_replace(" {$copyPostalGreeting},", "", $merge[$masterID]['postalGreeting']);
1681 if (CRM_Utils_Array
::value('addressee_other', $exportParams) &&
1682 count($merge[$masterID]['copy']) >= 1
1684 // use static greetings specified if no of contacts > 2
1685 $merge[$masterID]['addressee'] = $exportParams['addressee_other'];
1687 elseif ($copyAddressee) {
1688 self
::_trimNonTokens($copyAddressee,
1689 $addresseeOptions[$dao->copy_addressee_id
],
1690 $exportParams, 'addressee'
1692 $merge[$masterID]['addressee'] = "{$merge[$masterID]['addressee']}, " . trim($copyAddressee);
1695 $merge[$masterID]['copy'][$copyID] = $copyAddressee;
1702 * Function to merge household record into the individual record
1705 * @param string $exportTempTable temporary temp table that stores the records
1706 * @param array $headerRows array of headers for the export file
1707 * @param array $sqlColumns array of names of the table columns of the temp table
1708 * @param string $prefix name of the relationship type that is prefixed to the table columns
1710 static function mergeSameHousehold($exportTempTable, &$headerRows, &$sqlColumns, $prefix) {
1711 $prefixColumn = $prefix . '_';
1712 $allKeys = array_keys($sqlColumns);
1713 $replaced = array();
1714 $headerRows = array_values($headerRows);
1716 // name map of the non standard fields in header rows & sql columns
1717 $mappingFields = array(
1718 'civicrm_primary_id' => 'id',
1719 'contact_source' => 'source',
1720 'current_employer_id' => 'employer_id',
1721 'contact_is_deleted' => 'is_deleted',
1722 'name' => 'address_name',
1723 'provider_id' => 'im_service_provider',
1724 'phone_type_id' => 'phone_type'
1727 //figure out which columns are to be replaced by which ones
1728 foreach ($sqlColumns as $columnNames => $dontCare) {
1729 if ($rep = CRM_Utils_Array
::value($columnNames, $mappingFields)) {
1730 $replaced[$columnNames] = CRM_Utils_String
::munge($prefixColumn . $rep, '_', 64);
1733 $householdColName = CRM_Utils_String
::munge($prefixColumn . $columnNames, '_', 64);
1735 if (CRM_Utils_Array
::value($householdColName, $sqlColumns)) {
1736 $replaced[$columnNames] = $householdColName;
1740 $query = "UPDATE $exportTempTable SET ";
1743 foreach ($replaced as $from => $to) {
1744 $clause[] = "$from = $to ";
1745 unset($sqlColumns[$to]);
1746 if ($key = CRM_Utils_Array
::key($to, $allKeys)) {
1747 unset($headerRows[$key]);
1750 $query .= implode(",\n", $clause);
1751 $query .= " WHERE {$replaced['civicrm_primary_id']} != ''";
1753 CRM_Core_DAO
::executeQuery($query);
1755 //drop the table columns that store redundant household info
1756 $dropQuery = "ALTER TABLE $exportTempTable ";
1757 foreach ($replaced as $householdColumns) {
1758 $dropClause[] = " DROP $householdColumns ";
1760 $dropQuery .= implode(",\n", $dropClause);
1762 CRM_Core_DAO
::executeQuery($dropQuery);
1764 // also drop the temp table if exists
1765 $sql = "DROP TABLE IF EXISTS {$exportTempTable}_temp";
1766 CRM_Core_DAO
::executeQuery($sql);
1768 // clean up duplicate records
1770 CREATE TABLE {$exportTempTable}_temp SELECT *
1771 FROM {$exportTempTable}
1772 GROUP BY civicrm_primary_id ";
1774 CRM_Core_DAO
::executeQuery($query);
1776 $query = "DROP TABLE $exportTempTable";
1777 CRM_Core_DAO
::executeQuery($query);
1779 $query = "ALTER TABLE {$exportTempTable}_temp RENAME TO {$exportTempTable}";
1780 CRM_Core_DAO
::executeQuery($query);
1783 static function writeCSVFromTable($exportTempTable, $headerRows, $sqlColumns, $exportMode, $saveFile = null, $batchItems = '') {
1784 $writeHeader = TRUE;
1786 $limit = self
::EXPORT_ROW_COUNT
;
1788 $query = "SELECT * FROM $exportTempTable";
1791 $limitQuery = $query . "
1792 LIMIT $offset, $limit
1794 $dao = CRM_Core_DAO
::executeQuery($limitQuery);
1800 $componentDetails = array();
1801 while ($dao->fetch()) {
1804 foreach ($sqlColumns as $column => $dontCare) {
1805 $row[$column] = $dao->$column;
1807 $componentDetails[] = $row;
1809 if ( $exportMode == 'financial' ) {
1810 $getExportFileName = 'CiviCRM Contribution Search';
1813 $getExportFileName =self
::getExportFileName( 'csv', $exportMode );
1815 $csvRows = CRM_Core_Report_Excel
::writeCSVFile( $getExportFileName,
1822 if ($saveFile && !empty($csvRows)) {
1823 $batchItems .= $csvRows;
1826 $writeHeader = false;
1832 * Function to manipulate header rows for relationship fields
1835 public static function manipulateHeaderRows(&$headerRows, $contactRelationshipTypes) {
1836 foreach ($headerRows as & $header) {
1837 $split = explode('-', $header);
1838 if ($relationTypeName = CRM_Utils_Array
::value($split[0], $contactRelationshipTypes)) {
1839 $split[0] = $relationTypeName;
1840 $header = implode('-', $split);
1846 * Function to exclude contacts who are deceased, have "Do not mail" privacy setting,
1847 * or have no street address
1850 static function postalMailingFormat($exportTempTable, &$headerRows, &$sqlColumns, $exportParams) {
1851 $whereClause = array();
1853 if (array_key_exists('is_deceased', $sqlColumns)) {
1854 $whereClause[] = 'is_deceased = 1';
1857 if (array_key_exists('do_not_mail', $sqlColumns)) {
1858 $whereClause[] = 'do_not_mail = 1';
1861 if (array_key_exists('street_address', $sqlColumns)) {
1862 $addressWhereClause = " ( (street_address IS NULL) OR (street_address = '') ) ";
1864 // check for supplemental_address_1
1865 if (array_key_exists('supplemental_address_1', $sqlColumns)) {
1866 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1867 'address_options', TRUE, NULL, TRUE
1869 if (CRM_Utils_Array
::value('supplemental_address_1', $addressOptions)) {
1870 $addressWhereClause .= " AND ( (supplemental_address_1 IS NULL) OR (supplemental_address_1 = '') ) ";
1871 // enclose it again, since we are doing an AND in between a set of ORs
1872 $addressWhereClause = "( $addressWhereClause )";
1876 $whereClause[] = $addressWhereClause;
1879 if (!empty($whereClause)) {
1880 $whereClause = implode(' OR ', $whereClause);
1883 FROM $exportTempTable
1884 WHERE {$whereClause}";
1885 CRM_Core_DAO
::singleValueQuery($query);
1888 // unset temporary columns that were added for postal mailing format
1889 if (!empty($exportParams['postal_mailing_export']['temp_columns'])) {
1890 $unsetKeys = array_keys($sqlColumns);
1891 foreach ($unsetKeys as $headerKey => $sqlColKey) {
1892 if (array_key_exists($sqlColKey, $exportParams['postal_mailing_export']['temp_columns'])) {
1893 unset($sqlColumns[$sqlColKey], $headerRows[$headerKey]);
1900 * Build componentPayment fields.
1902 static function componentPaymentFields() {
1903 static $componentPaymentFields;
1904 if (!isset( $componentPaymentFields)) {
1905 $componentPaymentFields = array(
1906 'componentPaymentField_total_amount' => ts('Total Amount'),
1907 'componentPaymentField_contribution_status' => ts('Contribution Status'),
1908 'componentPaymentField_received_date' => ts('Received Date'),
1909 'componentPaymentField_payment_instrument' => ts('Payment Instrument'),
1910 'componentPaymentField_transaction_id' => ts('Transaction ID'),
1913 return $componentPaymentFields;