3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
35 * Class CRM_Export_BAO_ExportProcessor
37 * Class to handle logic of export.
39 class CRM_Export_BAO_ExportProcessor
{
49 protected $exportMode;
52 * Array of fields in the main query.
56 protected $queryFields = [];
63 protected $queryOperator;
66 * Requested output fields.
68 * If set to NULL then it is 'primary fields only'
69 * which actually means pretty close to all fields!
73 protected $requestedFields;
76 * Is the contact being merged into a single household.
80 protected $isMergeSameHousehold;
83 * Should contacts with the same address be merged.
87 protected $isMergeSameAddress = FALSE;
90 * Fields that need to be retrieved for address merge purposes but should not be in output.
94 protected $additionalFieldsForSameAddressMerge = [];
97 * Fields used for merging same contacts.
101 protected $contactGreetingFields = [];
104 * An array of primary IDs of the entity being exported.
111 * Get additional non-visible fields for address merge purposes.
115 public function getAdditionalFieldsForSameAddressMerge(): array {
116 return $this->additionalFieldsForSameAddressMerge
;
120 * Set additional non-visible fields for address merge purposes.
122 public function setAdditionalFieldsForSameAddressMerge() {
123 if ($this->isMergeSameAddress
) {
124 $fields = ['id', 'master_id', 'state_province_id', 'postal_greeting_id', 'addressee_id'];
125 foreach ($fields as $index => $field) {
126 if (!empty($this->getReturnProperties()[$field])) {
127 unset($fields[$index]);
130 $this->additionalFieldsForSameAddressMerge
= array_fill_keys($fields, 1);
135 * Should contacts with the same address be merged.
139 public function isMergeSameAddress(): bool {
140 return $this->isMergeSameAddress
;
144 * Set same address is to be merged.
146 * @param bool $isMergeSameAddress
148 public function setIsMergeSameAddress(bool $isMergeSameAddress) {
149 $this->isMergeSameAddress
= $isMergeSameAddress;
153 * Additional fields required to export postal fields.
157 protected $additionalFieldsForPostalExport = [];
160 * Get additional fields required to do a postal export.
164 public function getAdditionalFieldsForPostalExport() {
165 return $this->additionalFieldsForPostalExport
;
169 * Set additional fields required for a postal export.
171 public function setAdditionalFieldsForPostalExport() {
172 if ($this->getRequestedFields() && $this->isPostalableOnly()) {
173 $fields = ['is_deceased', 'do_not_mail', 'street_address', 'supplemental_address_1'];
174 foreach ($fields as $index => $field) {
175 if (!empty($this->getReturnProperties()[$field])) {
176 unset($field[$index]);
179 $this->additionalFieldsForPostalExport
= array_fill_keys($fields, 1);
184 * Only export contacts that can receive postal mail.
186 * Includes being alive, having an address & not having do_not_mail.
190 protected $isPostalableOnly;
193 * Key representing the head of household in the relationship array.
195 * e.g. ['8_b_a' => 'Household Member Is', '8_a_b = 'Household Member Of'.....]
199 protected $relationshipTypes = [];
202 * Array of properties to retrieve for relationships.
206 protected $relationshipReturnProperties = [];
209 * IDs of households that have already been exported.
213 protected $exportedHouseholds = [];
216 * Households to skip during export as they will be exported via their relationships anyway.
220 protected $householdsToSkip = [];
223 * Additional fields to return.
225 * This doesn't make much sense when we have a fields set but search build add it's own onto
226 * the 'Primary fields' (all) option.
230 protected $additionalRequestedReturnProperties = [];
233 * Get additional return properties.
237 public function getAdditionalRequestedReturnProperties() {
238 return $this->additionalRequestedReturnProperties
;
242 * Set additional return properties.
244 * @param array $value
246 public function setAdditionalRequestedReturnProperties($value) {
248 if (!empty($value['group'])) {
249 unset($value['group']);
250 $value['groups'] = 1;
252 $this->additionalRequestedReturnProperties
= $value;
256 * Get return properties by relationship.
259 public function getRelationshipReturnProperties() {
260 return $this->relationshipReturnProperties
;
264 * Export values for related contacts.
268 protected $relatedContactValues = [];
273 protected $returnProperties = [];
278 protected $outputSpecification = [];
283 protected $componentTable = '';
288 public function getComponentTable() {
289 return $this->componentTable
;
293 * Set the component table (if any).
295 * @param string $componentTable
297 public function setComponentTable($componentTable) {
298 $this->componentTable
= $componentTable;
302 * Clause from component search.
306 protected $componentClause = '';
311 public function getComponentClause() {
312 return $this->componentClause
;
316 * @param string $componentClause
318 public function setComponentClause($componentClause) {
319 $this->componentClause
= $componentClause;
323 * Name of a temporary table created to hold the results.
325 * Current decision making on when to create a temp table is kinda bad so this might change
326 * a bit as it is reviewed but basically we need a temp table or similar to calculate merging
327 * addresses. Merging households is handled in php. We create a temp table even when we don't need them.
331 protected $temporaryTable;
336 public function getTemporaryTable(): string {
337 return $this->temporaryTable
;
341 * @param string $temporaryTable
343 public function setTemporaryTable(string $temporaryTable) {
344 $this->temporaryTable
= $temporaryTable;
347 protected $postalGreetingTemplate;
352 public function getPostalGreetingTemplate() {
353 return $this->postalGreetingTemplate
;
357 * @param mixed $postalGreetingTemplate
359 public function setPostalGreetingTemplate($postalGreetingTemplate) {
360 $this->postalGreetingTemplate
= $postalGreetingTemplate;
366 public function getAddresseeGreetingTemplate() {
367 return $this->addresseeGreetingTemplate
;
371 * @param mixed $addresseeGreetingTemplate
373 public function setAddresseeGreetingTemplate($addresseeGreetingTemplate) {
374 $this->addresseeGreetingTemplate
= $addresseeGreetingTemplate;
377 protected $addresseeGreetingTemplate;
380 * CRM_Export_BAO_ExportProcessor constructor.
382 * @param int $exportMode
383 * @param array|null $requestedFields
384 * @param string $queryOperator
385 * @param bool $isMergeSameHousehold
386 * @param bool $isPostalableOnly
387 * @param bool $isMergeSameAddress
388 * @param array $formValues
389 * Values from the export options form on contact export. We currently support these keys
392 * - addresee_greeting
395 public function __construct($exportMode, $requestedFields, $queryOperator, $isMergeSameHousehold = FALSE, $isPostalableOnly = FALSE, $isMergeSameAddress = FALSE, $formValues = []) {
396 $this->setExportMode($exportMode);
397 $this->setQueryMode();
398 $this->setQueryOperator($queryOperator);
399 $this->setRequestedFields($requestedFields);
400 $this->setRelationshipTypes();
401 $this->setIsMergeSameHousehold($isMergeSameHousehold);
402 $this->setIsPostalableOnly($isPostalableOnly);
403 $this->setIsMergeSameAddress($isMergeSameAddress);
404 $this->setReturnProperties($this->determineReturnProperties());
405 $this->setAdditionalFieldsForSameAddressMerge();
406 $this->setAdditionalFieldsForPostalExport();
407 $this->setHouseholdMergeReturnProperties();
408 $this->setGreetingStringsForSameAddressMerge($formValues);
414 public function isPostalableOnly() {
415 return $this->isPostalableOnly
;
419 * @param bool $isPostalableOnly
421 public function setIsPostalableOnly($isPostalableOnly) {
422 $this->isPostalableOnly
= $isPostalableOnly;
428 public function getRequestedFields() {
429 return empty($this->requestedFields
) ?
NULL : $this->requestedFields
;
433 * @param array|null $requestedFields
435 public function setRequestedFields($requestedFields) {
436 $this->requestedFields
= $requestedFields;
442 public function getReturnProperties() {
443 return array_merge($this->returnProperties
, $this->getAdditionalRequestedReturnProperties(), $this->getAdditionalFieldsForSameAddressMerge(), $this->getAdditionalFieldsForPostalExport());
447 * @param array $returnProperties
449 public function setReturnProperties($returnProperties) {
450 $this->returnProperties
= $returnProperties;
456 public function getRelationshipTypes() {
457 return $this->relationshipTypes
;
462 public function setRelationshipTypes() {
463 $this->relationshipTypes
= CRM_Contact_BAO_Relationship
::getContactRelationshipType(
475 * Set the value for a relationship type field.
477 * In this case we are building up an array of properties for a related contact.
479 * These may be used for direct exporting or for merge to household depending on the
482 * @param string $relationshipType
483 * @param int $contactID
484 * @param string $field
485 * @param string $value
487 public function setRelationshipValue($relationshipType, $contactID, $field, $value) {
488 $this->relatedContactValues
[$relationshipType][$contactID][$field] = $value;
489 if ($field === 'id') {
490 $this->householdsToSkip
[] = $value;
495 * Get the value for a relationship type field.
497 * In this case we are building up an array of properties for a related contact.
499 * These may be used for direct exporting or for merge to household depending on the
502 * @param string $relationshipType
503 * @param int $contactID
504 * @param string $field
508 public function getRelationshipValue($relationshipType, $contactID, $field) {
509 return isset($this->relatedContactValues
[$relationshipType][$contactID][$field]) ?
$this->relatedContactValues
[$relationshipType][$contactID][$field] : '';
513 * Get the id of the related household.
515 * @param int $contactID
516 * @param string $relationshipType
520 public function getRelatedHouseholdID($contactID, $relationshipType) {
521 return $this->relatedContactValues
[$relationshipType][$contactID]['id'];
525 * Has the household already been exported.
527 * @param int $housholdContactID
531 public function isHouseholdExported($housholdContactID) {
532 return isset($this->exportedHouseholds
[$housholdContactID]);
539 public function isMergeSameHousehold() {
540 return $this->isMergeSameHousehold
;
544 * @param bool $isMergeSameHousehold
546 public function setIsMergeSameHousehold($isMergeSameHousehold) {
547 $this->isMergeSameHousehold
= $isMergeSameHousehold;
551 * Return relationship types for household merge.
555 public function getHouseholdRelationshipTypes() {
556 if (!$this->isMergeSameHousehold()) {
560 CRM_Utils_Array
::key('Household Member of', $this->getRelationshipTypes()),
561 CRM_Utils_Array
::key('Head of Household for', $this->getRelationshipTypes()),
569 public function isRelationshipTypeKey($fieldName) {
570 return array_key_exists($fieldName, $this->relationshipTypes
);
577 public function isHouseholdMergeRelationshipTypeKey($fieldName) {
578 return in_array($fieldName, $this->getHouseholdRelationshipTypes());
584 public function getQueryOperator() {
585 return $this->queryOperator
;
589 * @param string $queryOperator
591 public function setQueryOperator($queryOperator) {
592 $this->queryOperator
= $queryOperator;
598 public function getIds() {
605 public function setIds($ids) {
612 public function getQueryFields() {
615 $this->getComponentPaymentFields()
620 * @param array $queryFields
622 public function setQueryFields($queryFields) {
623 // legacy hacks - we add these to queryFields because this
624 // pseudometadata is currently required.
625 $queryFields['im_provider']['pseudoconstant']['var'] = 'imProviders';
626 $queryFields['country']['context'] = 'country';
627 $queryFields['world_region']['context'] = 'country';
628 $queryFields['state_province']['context'] = 'province';
629 $queryFields['contact_id'] = ['title' => ts('Contact ID'), 'type' => CRM_Utils_Type
::T_INT
];
630 $this->queryFields
= $queryFields;
636 public function getQueryMode() {
637 return $this->queryMode
;
641 * Set the query mode based on the export mode.
643 public function setQueryMode() {
645 switch ($this->getExportMode()) {
646 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
647 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
;
650 case CRM_Export_Form_Select
::EVENT_EXPORT
:
651 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_EVENT
;
654 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
655 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_MEMBER
;
658 case CRM_Export_Form_Select
::PLEDGE_EXPORT
:
659 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_PLEDGE
;
662 case CRM_Export_Form_Select
::CASE_EXPORT
:
663 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_CASE
;
666 case CRM_Export_Form_Select
::GRANT_EXPORT
:
667 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_GRANT
;
670 case CRM_Export_Form_Select
::ACTIVITY_EXPORT
:
671 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_ACTIVITY
;
675 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_CONTACTS
;
682 public function getExportMode() {
683 return $this->exportMode
;
687 * @param int $exportMode
689 public function setExportMode($exportMode) {
690 $this->exportMode
= $exportMode;
694 * Get the name for the export file.
698 public function getExportFileName() {
699 switch ($this->getExportMode()) {
700 case CRM_Export_Form_Select
::CONTACT_EXPORT
:
701 return ts('CiviCRM Contact Search');
703 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
704 return ts('CiviCRM Contribution Search');
706 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
707 return ts('CiviCRM Member Search');
709 case CRM_Export_Form_Select
::EVENT_EXPORT
:
710 return ts('CiviCRM Participant Search');
712 case CRM_Export_Form_Select
::PLEDGE_EXPORT
:
713 return ts('CiviCRM Pledge Search');
715 case CRM_Export_Form_Select
::CASE_EXPORT
:
716 return ts('CiviCRM Case Search');
718 case CRM_Export_Form_Select
::GRANT_EXPORT
:
719 return ts('CiviCRM Grant Search');
721 case CRM_Export_Form_Select
::ACTIVITY_EXPORT
:
722 return ts('CiviCRM Activity Search');
725 // Legacy code suggests the value could be 'financial' - ie. something
726 // other than what should be accepted. However, I suspect that this line is
728 return ts('CiviCRM Search');
733 * Get the label for the header row based on the field to output.
735 * @param string $field
739 public function getHeaderForRow($field) {
740 if (substr($field, -11) == 'campaign_id') {
741 // @todo - set this correctly in the xml rather than here.
742 // This will require a generalised handling cleanup
743 return ts('Campaign ID');
745 if ($this->isMergeSameHousehold() && $field === 'id') {
746 return ts('Household ID');
748 elseif (isset($this->getQueryFields()[$field]['title'])) {
749 return $this->getQueryFields()[$field]['title'];
751 elseif ($this->isExportPaymentFields() && array_key_exists($field, $this->getcomponentPaymentFields())) {
752 return CRM_Utils_Array
::value($field, $this->getcomponentPaymentFields())['title'];
765 public function runQuery($params, $order) {
766 $returnProperties = $this->getReturnProperties();
767 $params = array_merge($params, $this->getWhereParams());
769 $query = new CRM_Contact_BAO_Query($params, $returnProperties, NULL,
770 FALSE, FALSE, $this->getQueryMode(),
771 FALSE, TRUE, TRUE, NULL, $this->getQueryOperator()
776 $query->_sort
= $order;
777 list($select, $from, $where, $having) = $query->query();
778 $this->setQueryFields($query->_fields
);
779 $whereClauses = ['trash_clause' => "contact_a.is_deleted != 1"];
780 if ($this->getRequestedFields() && ($this->getComponentTable())) {
781 $from .= " INNER JOIN " . $this->getComponentTable() . " ctTable ON ctTable.contact_id = contact_a.id ";
783 elseif ($this->getComponentClause()) {
784 $whereClauses[] = $this->getComponentClause();
787 // CRM-13982 - check if is deleted
788 foreach ($params as $value) {
789 if ($value[0] == 'contact_is_deleted') {
790 unset($whereClauses['trash_clause']);
794 if ($this->isPostalableOnly
) {
795 if (array_key_exists('street_address', $returnProperties)) {
796 $addressWhere = " civicrm_address.street_address <> ''";
797 if (array_key_exists('supplemental_address_1', $returnProperties)) {
798 // We need this to be an OR rather than AND on the street_address so, hack it in.
799 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
800 'address_options', TRUE, NULL, TRUE
802 if (!empty($addressOptions['supplemental_address_1'])) {
803 $addressWhere .= " OR civicrm_address.supplemental_address_1 <> ''";
806 $whereClauses['address'] = $addressWhere;
811 $where = "WHERE " . implode(' AND ', $whereClauses);
814 $where .= " AND " . implode(' AND ', $whereClauses);
817 $groupBy = $this->getGroupBy($query);
818 $queryString = "$select $from $where $having $groupBy";
820 // always add contact_a.id to the ORDER clause
821 // so the order is deterministic
823 if (strpos('contact_a.id', $order) === FALSE) {
824 $order .= ", contact_a.id";
827 list($field, $dir) = explode(' ', $order, 2);
828 $field = trim($field);
829 if (!empty($this->getReturnProperties()[$field])) {
831 $queryString .= " ORDER BY $order";
834 return [$query, $queryString];
838 * Add a row to the specification for how to output data.
841 * @param string $relationshipType
842 * @param string $locationType
843 * @param int $entityTypeID phone_type_id or provider_id for phone or im fields.
845 public function addOutputSpecification($key, $relationshipType = NULL, $locationType = NULL, $entityTypeID = NULL) {
848 if ($key === 'phone') {
849 $entityLabel = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_Phone', 'phone_type_id', $entityTypeID);
852 $entityLabel = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_IM', 'provider_id', $entityTypeID);
856 // These oddly constructed keys are for legacy reasons. Altering them will affect test success
857 // but in time it may be good to rationalise them.
858 $label = $this->getOutputSpecificationLabel($key, $relationshipType, $locationType, $entityLabel);
859 $index = $this->getOutputSpecificationIndex($key, $relationshipType, $locationType, $entityLabel);
860 $fieldKey = $this->getOutputSpecificationFieldKey($key, $relationshipType, $locationType, $entityLabel);
862 $this->outputSpecification
[$index]['header'] = $label;
863 $this->outputSpecification
[$index]['sql_columns'] = $this->getSqlColumnDefinition($fieldKey, $key);
865 if ($relationshipType && $this->isHouseholdMergeRelationshipTypeKey($relationshipType)) {
866 $this->setColumnAsCalculationOnly($index);
868 $this->outputSpecification
[$index]['metadata'] = $this->getMetaDataForField($key);
872 * Get the metadata for the given field.
878 public function getMetaDataForField($key) {
879 $mappings = ['contact_id' => 'id'];
880 if (isset($this->getQueryFields()[$key])) {
881 return $this->getQueryFields()[$key];
883 if (isset($mappings[$key])) {
884 return $this->getQueryFields()[$mappings[$key]];
892 public function setSqlColumnDefn($key) {
893 $this->outputSpecification
[$this->getMungedFieldName($key)]['sql_columns'] = $this->getSqlColumnDefinition($key, $this->getMungedFieldName($key));
897 * Mark a column as only required for calculations.
899 * Do not include the row with headers.
901 * @param string $column
903 public function setColumnAsCalculationOnly($column) {
904 $this->outputSpecification
[$column]['do_not_output_to_csv'] = TRUE;
910 public function getHeaderRows() {
912 foreach ($this->outputSpecification
as $key => $spec) {
913 if (empty($spec['do_not_output_to_csv'])) {
914 $headerRows[] = $spec['header'];
923 public function getSQLColumns() {
925 foreach ($this->outputSpecification
as $key => $spec) {
926 if (empty($spec['do_not_output_to_sql'])) {
927 $sqlColumns[$key] = $spec['sql_columns'];
936 public function getMetadata() {
938 foreach ($this->outputSpecification
as $key => $spec) {
939 $metadata[$key] = $spec['metadata'];
945 * Build the row for output.
947 * @param \CRM_Contact_BAO_Query $query
948 * @param CRM_Core_DAO $iterationDAO
949 * @param array $outputColumns
951 * @param $paymentDetails
952 * @param $addPaymentHeader
956 public function buildRow($query, $iterationDAO, $outputColumns, $metadata, $paymentDetails, $addPaymentHeader) {
957 $paymentTableId = $this->getPaymentTableID();
958 if ($this->isHouseholdToSkip($iterationDAO->contact_id
)) {
961 $phoneTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id');
962 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
965 $householdMergeRelationshipType = $this->getHouseholdMergeTypeForRow($iterationDAO->contact_id
);
966 if ($householdMergeRelationshipType) {
967 $householdID = $this->getRelatedHouseholdID($iterationDAO->contact_id
, $householdMergeRelationshipType);
968 if ($this->isHouseholdExported($householdID)) {
971 foreach (array_keys($outputColumns) as $column) {
972 $row[$column] = $this->getRelationshipValue($householdMergeRelationshipType, $iterationDAO->contact_id
, $column);
974 $this->markHouseholdExported($householdID);
978 $query->convertToPseudoNames($iterationDAO);
980 //first loop through output columns so that we return what is required, and in same order.
981 foreach ($outputColumns as $field => $value) {
982 // add im_provider to $dao object
983 if ($field == 'im_provider' && property_exists($iterationDAO, 'provider_id')) {
984 $iterationDAO->im_provider
= $iterationDAO->provider_id
;
987 //build row values (data)
989 if (property_exists($iterationDAO, $field)) {
990 $fieldValue = $iterationDAO->$field;
991 // to get phone type from phone type id
992 if ($field == 'phone_type_id' && isset($phoneTypes[$fieldValue])) {
993 $fieldValue = $phoneTypes[$fieldValue];
995 elseif ($field == 'provider_id' ||
$field == 'im_provider') {
996 $fieldValue = CRM_Utils_Array
::value($fieldValue, $imProviders);
998 elseif (strstr($field, 'master_id')) {
999 // @todo - why not just $field === 'master_id' - what else would it be?
1000 $masterAddressId = $iterationDAO->$field ??
NULL;
1001 // get display name of contact that address is shared.
1002 $fieldValue = CRM_Contact_BAO_Contact
::getMasterDisplayName($masterAddressId);
1006 if ($this->isRelationshipTypeKey($field)) {
1007 $this->buildRelationshipFieldsForRow($row, $iterationDAO->contact_id
, $value, $field);
1010 $row[$field] = $this->getTransformedFieldValue($field, $iterationDAO, $fieldValue, $metadata, $paymentDetails);
1014 // If specific payment fields have been selected for export, payment
1015 // data will already be in $row. Otherwise, add payment related
1016 // information, if appropriate.
1017 if ($addPaymentHeader) {
1018 if (!$this->isExportSpecifiedPaymentFields()) {
1019 $nullContributionDetails = array_fill_keys(array_keys($this->getPaymentHeaders()), NULL);
1020 if ($this->isExportPaymentFields()) {
1021 $paymentData = CRM_Utils_Array
::value($row[$paymentTableId], $paymentDetails);
1022 if (!is_array($paymentData) ||
empty($paymentData)) {
1023 $paymentData = $nullContributionDetails;
1025 $row = array_merge($row, $paymentData);
1027 elseif (!empty($paymentDetails)) {
1028 $row = array_merge($row, $nullContributionDetails);
1032 //remove organization name for individuals if it is set for current employer
1033 if (!empty($row['contact_type']) &&
1034 $row['contact_type'] == 'Individual' && array_key_exists('organization_name', $row)
1036 $row['organization_name'] = '';
1042 * If this row has a household whose details we should use get the relationship type key.
1048 public function getHouseholdMergeTypeForRow($contactID) {
1049 if (!$this->isMergeSameHousehold()) {
1052 foreach ($this->getHouseholdRelationshipTypes() as $relationshipType) {
1053 if (isset($this->relatedContactValues
[$relationshipType][$contactID])) {
1054 return $relationshipType;
1060 * Mark the given household as already exported.
1062 * @param $householdID
1064 public function markHouseholdExported($householdID) {
1065 $this->exportedHouseholds
[$householdID] = $householdID;
1070 * @param $iterationDAO
1071 * @param $fieldValue
1073 * @param $paymentDetails
1077 public function getTransformedFieldValue($field, $iterationDAO, $fieldValue, $metadata, $paymentDetails) {
1079 $i18n = CRM_Core_I18n
::singleton();
1080 if ($field == 'id') {
1081 return $iterationDAO->contact_id
;
1082 // special case for calculated field
1084 elseif ($field == 'source_contact_id') {
1085 return $iterationDAO->contact_id
;
1087 elseif ($field == 'pledge_balance_amount') {
1088 return $iterationDAO->pledge_amount
- $iterationDAO->pledge_total_paid
;
1089 // special case for calculated field
1091 elseif ($field == 'pledge_next_pay_amount') {
1092 return $iterationDAO->pledge_next_pay_amount +
$iterationDAO->pledge_outstanding_amount
;
1094 elseif (isset($fieldValue) &&
1097 //check for custom data
1098 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($field)) {
1099 return CRM_Core_BAO_CustomField
::displayValue($fieldValue, $cfID);
1102 elseif (in_array($field, [
1107 //special case for greeting replacement
1108 $fldValue = "{$field}_display";
1109 return $iterationDAO->$fldValue;
1112 //normal fields with a touch of CRM-3157
1115 case 'world_region':
1116 return $i18n->crm_translate($fieldValue, ['context' => 'country']);
1118 case 'state_province':
1119 return $i18n->crm_translate($fieldValue, ['context' => 'province']);
1122 case 'preferred_communication_method':
1123 case 'preferred_mail_format':
1124 case 'communication_style':
1125 return $i18n->crm_translate($fieldValue);
1128 if (isset($metadata[$field])) {
1129 // No I don't know why we do it this way & whether we could
1130 // make better use of pseudoConstants.
1131 if (!empty($metadata[$field]['context'])) {
1132 return $i18n->crm_translate($fieldValue, $metadata[$field]);
1134 if (!empty($metadata[$field]['pseudoconstant'])) {
1135 if (!empty($metadata[$field]['bao'])) {
1136 return CRM_Core_PseudoConstant
::getLabel($metadata[$field]['bao'], $metadata[$field]['name'], $fieldValue);
1138 // This is not our normal syntax for pseudoconstants but I am a bit loath to
1139 // call an external function until sure it is not increasing php processing given this
1140 // may be iterated 100,000 times & we already have the $imProvider var loaded.
1141 // That can be next refactor...
1142 // Yes - definitely feeling hatred for this bit of code - I know you will beat me up over it's awfulness
1143 // but I have to reach a stable point....
1144 $varName = $metadata[$field]['pseudoconstant']['var'];
1145 if ($varName === 'imProviders') {
1146 return CRM_Core_PseudoConstant
::getLabel('CRM_Core_DAO_IM', 'provider_id', $fieldValue);
1148 if ($varName === 'phoneTypes') {
1149 return CRM_Core_PseudoConstant
::getLabel('CRM_Core_DAO_Phone', 'phone_type_id', $fieldValue);
1158 elseif ($this->isExportSpecifiedPaymentFields() && array_key_exists($field, $this->getcomponentPaymentFields())) {
1159 $paymentTableId = $this->getPaymentTableID();
1160 $paymentData = CRM_Utils_Array
::value($iterationDAO->$paymentTableId, $paymentDetails);
1162 'componentPaymentField_total_amount' => 'total_amount',
1163 'componentPaymentField_contribution_status' => 'contribution_status',
1164 'componentPaymentField_payment_instrument' => 'pay_instru',
1165 'componentPaymentField_transaction_id' => 'trxn_id',
1166 'componentPaymentField_received_date' => 'receive_date',
1168 return CRM_Utils_Array
::value($payFieldMapper[$field], $paymentData, '');
1171 // if field is empty or null
1177 * Get array of fields to return, over & above those defined in the main contact exportable fields.
1179 * These include export mode specific fields & some fields apparently required as 'exportableFields'
1180 * but not returned by the function of the same name.
1183 * Array of fields to return in the format ['field_name' => 1,...]
1185 public function getAdditionalReturnProperties() {
1186 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_CONTACTS
) {
1187 $componentSpecificFields = [];
1190 $componentSpecificFields = CRM_Contact_BAO_Query
::defaultReturnProperties($this->getQueryMode());
1192 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_PLEDGE
) {
1193 $componentSpecificFields = array_merge($componentSpecificFields, CRM_Pledge_BAO_Query
::extraReturnProperties($this->getQueryMode()));
1194 unset($componentSpecificFields['contribution_status_id']);
1195 unset($componentSpecificFields['pledge_status_id']);
1196 unset($componentSpecificFields['pledge_payment_status_id']);
1198 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_CASE
) {
1199 $componentSpecificFields = array_merge($componentSpecificFields, CRM_Case_BAO_Query
::extraReturnProperties($this->getQueryMode()));
1201 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
1202 $componentSpecificFields = array_merge($componentSpecificFields, CRM_Contribute_BAO_Query
::softCreditReturnProperties(TRUE));
1203 unset($componentSpecificFields['contribution_status_id']);
1205 return $componentSpecificFields;
1209 * Should payment fields be appended to the export.
1211 * (This is pretty hacky so hopefully this function won't last long - notice
1212 * how obviously it should be part of the above function!).
1214 public function isExportPaymentFields() {
1215 if ($this->getRequestedFields() === NULL
1216 && in_array($this->getQueryMode(), [
1217 CRM_Contact_BAO_Query
::MODE_EVENT
,
1218 CRM_Contact_BAO_Query
::MODE_MEMBER
,
1219 CRM_Contact_BAO_Query
::MODE_PLEDGE
,
1223 elseif ($this->isExportSpecifiedPaymentFields()) {
1230 * Has specific payment fields been requested (as opposed to via all fields).
1232 * If specific fields have been requested then they get added at various points.
1236 public function isExportSpecifiedPaymentFields() {
1237 if ($this->getRequestedFields() !== NULL && $this->hasRequestedComponentPaymentFields()) {
1243 * Get the name of the id field in the table that connects contributions to the export entity.
1245 public function getPaymentTableID() {
1246 if ($this->getRequestedFields() === NULL) {
1248 CRM_Contact_BAO_Query
::MODE_EVENT
=> 'participant_id',
1249 CRM_Contact_BAO_Query
::MODE_MEMBER
=> 'membership_id',
1250 CRM_Contact_BAO_Query
::MODE_PLEDGE
=> 'pledge_payment_id',
1252 return isset($mapping[$this->getQueryMode()]) ?
$mapping[$this->getQueryMode()] : '';
1254 elseif ($this->hasRequestedComponentPaymentFields()) {
1255 return 'participant_id';
1261 * Have component payment fields been requested.
1265 protected function hasRequestedComponentPaymentFields() {
1266 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_EVENT
) {
1267 $participantPaymentFields = array_intersect_key($this->getComponentPaymentFields(), $this->getReturnProperties());
1268 if (!empty($participantPaymentFields)) {
1276 * Get fields that indicate payment fields have been requested for a component.
1278 * Ideally this should be protected but making it temporarily public helps refactoring..
1282 public function getComponentPaymentFields() {
1284 'componentPaymentField_total_amount' => ['title' => ts('Total Amount'), 'type' => CRM_Utils_Type
::T_MONEY
],
1285 'componentPaymentField_contribution_status' => ['title' => ts('Contribution Status'), 'type' => CRM_Utils_Type
::T_STRING
],
1286 'componentPaymentField_received_date' => ['title' => ts('Date Received'), 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
],
1287 'componentPaymentField_payment_instrument' => ['title' => ts('Payment Method'), 'type' => CRM_Utils_Type
::T_STRING
],
1288 'componentPaymentField_transaction_id' => ['title' => ts('Transaction ID'), 'type' => CRM_Utils_Type
::T_STRING
],
1293 * Get headers for payment fields.
1295 * Returns an array of contribution fields when the entity supports payment fields and specific fields
1296 * are not specified. This is a transitional function for refactoring legacy code.
1298 public function getPaymentHeaders() {
1299 if ($this->isExportPaymentFields() && !$this->isExportSpecifiedPaymentFields()) {
1300 return CRM_Utils_Array
::collect('title', $this->getcomponentPaymentFields());
1306 * Get the default properties when not specified.
1308 * In the UI this appears as 'Primary fields only' but in practice it's
1309 * most of the kitchen sink and the hallway closet thrown in.
1311 * Since CRM-952 custom fields are excluded, but no other form of mercy is shown.
1315 public function getDefaultReturnProperties() {
1316 $returnProperties = [];
1317 $fields = CRM_Contact_BAO_Contact
::exportableFields('All', TRUE, TRUE);
1318 $skippedFields = ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_CONTACTS
) ?
[] : [
1324 foreach ($fields as $key => $var) {
1325 if ($key && (substr($key, 0, 6) != 'custom') && !in_array($key, $skippedFields)) {
1326 $returnProperties[$key] = 1;
1329 $returnProperties = array_merge($returnProperties, $this->getAdditionalReturnProperties());
1330 return $returnProperties;
1334 * Add the field to relationship return properties & return it.
1336 * This function is doing both setting & getting which is yuck but it is an interim
1339 * @param array $value
1340 * @param string $relationshipKey
1344 public function setRelationshipReturnProperties($value, $relationshipKey) {
1345 $relationField = $value['name'];
1346 $relIMProviderId = NULL;
1347 $relLocTypeId = CRM_Utils_Array
::value('location_type_id', $value);
1348 $locationName = CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_Address', 'location_type_id', $relLocTypeId);
1349 $relPhoneTypeId = CRM_Utils_Array
::value('phone_type_id', $value, ($locationName ?
'Primary' : NULL));
1350 $relIMProviderId = CRM_Utils_Array
::value('im_provider_id', $value, ($locationName ?
'Primary' : NULL));
1351 if (in_array($relationField, $this->getValidLocationFields()) && $locationName) {
1352 if ($relationField === 'phone') {
1353 $this->relationshipReturnProperties
[$relationshipKey]['location'][$locationName]['phone-' . $relPhoneTypeId] = 1;
1355 elseif ($relationField === 'im') {
1356 $this->relationshipReturnProperties
[$relationshipKey]['location'][$locationName]['im-' . $relIMProviderId] = 1;
1359 $this->relationshipReturnProperties
[$relationshipKey]['location'][$locationName][$relationField] = 1;
1363 $this->relationshipReturnProperties
[$relationshipKey][$relationField] = 1;
1365 return $this->relationshipReturnProperties
[$relationshipKey];
1369 * Add the main return properties to the household merge properties if needed for merging.
1371 * If we are using household merge we need to add these to the relationship properties to
1374 public function setHouseholdMergeReturnProperties() {
1375 if ($this->isMergeSameHousehold()) {
1376 $returnProperties = $this->getReturnProperties();
1377 $returnProperties = array_diff_key($returnProperties, array_fill_keys(['location_type', 'im_provider'], 1));
1378 foreach ($this->getHouseholdRelationshipTypes() as $householdRelationshipType) {
1379 $this->relationshipReturnProperties
[$householdRelationshipType] = $returnProperties;
1385 * Get the default location fields to request.
1389 public function getValidLocationFields() {
1392 'supplemental_address_1',
1393 'supplemental_address_2',
1394 'supplemental_address_3',
1397 'postal_code_suffix',
1409 * Get the sql column definition for the given field.
1411 * @param string $fieldName
1412 * @param string $columnName
1416 public function getSqlColumnDefinition($fieldName, $columnName) {
1418 // early exit for master_id, CRM-12100
1419 // in the DB it is an ID, but in the export, we retrive the display_name of the master record
1420 // also for current_employer, CRM-16939
1421 if ($columnName == 'master_id' ||
$columnName == 'current_employer') {
1422 return "$fieldName varchar(128)";
1425 $queryFields = $this->getQueryFields();
1426 // @todo remove the enotice avoidance here, ensure all columns are declared.
1427 // tests will fail on the enotices until they all are & then all the 'else'
1429 $fieldSpec = $queryFields[$columnName] ??
[];
1431 // set the sql columns
1432 if (isset($fieldSpec['type'])) {
1433 switch ($fieldSpec['type']) {
1434 case CRM_Utils_Type
::T_INT
:
1435 case CRM_Utils_Type
::T_BOOLEAN
:
1436 if (in_array(CRM_Utils_Array
::value('data_type', $fieldSpec), ['Country', 'StateProvince', 'ContactReference'])) {
1437 return "$fieldName varchar(255)";
1439 return "$fieldName varchar(16)";
1441 case CRM_Utils_Type
::T_STRING
:
1442 if (isset($queryFields[$columnName]['maxlength'])) {
1443 return "$fieldName varchar({$queryFields[$columnName]['maxlength']})";
1446 return "$fieldName varchar(255)";
1449 case CRM_Utils_Type
::T_TEXT
:
1450 case CRM_Utils_Type
::T_LONGTEXT
:
1451 case CRM_Utils_Type
::T_BLOB
:
1452 case CRM_Utils_Type
::T_MEDIUMBLOB
:
1453 return "$fieldName longtext";
1455 case CRM_Utils_Type
::T_FLOAT
:
1456 case CRM_Utils_Type
::T_ENUM
:
1457 case CRM_Utils_Type
::T_DATE
:
1458 case CRM_Utils_Type
::T_TIME
:
1459 case CRM_Utils_Type
::T_TIMESTAMP
:
1460 case CRM_Utils_Type
::T_MONEY
:
1461 case CRM_Utils_Type
::T_EMAIL
:
1462 case CRM_Utils_Type
::T_URL
:
1463 case CRM_Utils_Type
::T_CCNUM
:
1465 return "$fieldName varchar(32)";
1469 if (substr($fieldName, -3, 3) == '_id') {
1470 return "$fieldName varchar(255)";
1472 elseif (substr($fieldName, -5, 5) == '_note') {
1473 return "$fieldName text";
1482 if (in_array($fieldName, $changeFields)) {
1483 return "$fieldName text";
1486 // set the sql columns for custom data
1487 if (isset($queryFields[$columnName]['data_type'])) {
1489 switch ($queryFields[$columnName]['data_type']) {
1491 // May be option labels, which could be up to 512 characters
1492 $length = max(512, CRM_Utils_Array
::value('text_length', $queryFields[$columnName]));
1493 return "$fieldName varchar($length)";
1496 return "$fieldName varchar(255)";
1499 return "$fieldName text";
1502 return "$fieldName varchar(255)";
1506 return "$fieldName text";
1514 * Get the munged field name.
1516 * @param string $field
1519 public function getMungedFieldName($field) {
1520 $fieldName = CRM_Utils_String
::munge(strtolower($field), '_', 64);
1521 if ($fieldName == 'id') {
1522 $fieldName = 'civicrm_primary_id';
1528 * In order to respect the history of this class we need to index kinda illogically.
1530 * On the bright side - this stuff is tested within a nano-byte of it's life.
1532 * e.g '2-a-b_Home-City'
1534 * @param string $key
1535 * @param string $relationshipType
1536 * @param string $locationType
1537 * @param $entityLabel
1541 protected function getOutputSpecificationIndex($key, $relationshipType, $locationType, $entityLabel) {
1542 if ($entityLabel ||
$key === 'im') {
1543 // Just cos that's the history...
1544 if ($key !== 'master_id') {
1545 $key = $this->getHeaderForRow($key);
1548 if (!$relationshipType ||
$key !== 'id') {
1549 $key = $this->getMungedFieldName($key);
1551 return $this->getMungedFieldName(
1552 ($relationshipType ?
($relationshipType . '_') : '')
1553 . ($locationType ?
($locationType . '_') : '')
1555 . ($entityLabel ?
('_' . $entityLabel) : '')
1560 * Get the compiled label for the column.
1562 * e.g 'Gender', 'Employee Of-Home-city'
1564 * @param string $key
1565 * @param string $relationshipType
1566 * @param string $locationType
1567 * @param string $entityLabel
1571 protected function getOutputSpecificationLabel($key, $relationshipType, $locationType, $entityLabel) {
1572 return ($relationshipType ?
$this->getRelationshipTypes()[$relationshipType] . '-' : '')
1573 . ($locationType ?
$locationType . '-' : '')
1574 . $this->getHeaderForRow($key)
1575 . ($entityLabel ?
'-' . $entityLabel : '');
1579 * Get the mysql field name key.
1581 * This key is locked in by tests but the reasons for the specific conventions -
1582 * ie. headings are used for keying fields in some cases, are likely
1583 * accidental rather than deliberate.
1585 * This key is used for the output sql array.
1587 * @param string $key
1588 * @param $relationshipType
1589 * @param $locationType
1590 * @param $entityLabel
1594 protected function getOutputSpecificationFieldKey($key, $relationshipType, $locationType, $entityLabel) {
1595 if ($entityLabel ||
$key === 'im') {
1596 if ($key !== 'state_province' && $key !== 'id') {
1597 // @todo - test removing this - indexing by $key should be fine...
1598 $key = $this->getHeaderForRow($key);
1601 if (!$relationshipType ||
$key !== 'id') {
1602 $key = $this->getMungedFieldName($key);
1604 $fieldKey = $this->getMungedFieldName(
1605 ($relationshipType ?
($relationshipType . '_') : '')
1606 . ($locationType ?
($locationType . '_') : '')
1608 . ($entityLabel ?
('_' . $entityLabel) : '')
1614 * Get params for the where criteria.
1618 public function getWhereParams() {
1619 if (!$this->isPostalableOnly()) {
1622 $params['is_deceased'] = ['is_deceased', '=', 0, CRM_Contact_BAO_Query
::MODE_CONTACTS
];
1623 $params['do_not_mail'] = ['do_not_mail', '=', 0, CRM_Contact_BAO_Query
::MODE_CONTACTS
];
1633 protected function buildRelationshipFieldsForRow(&$row, $contactID, $value, $field) {
1634 foreach (array_keys($value) as $property) {
1635 if ($property === 'location') {
1636 // @todo just undo all this nasty location wrangling!
1637 foreach ($value['location'] as $locationKey => $locationFields) {
1638 foreach (array_keys($locationFields) as $locationField) {
1639 $fieldKey = str_replace(' ', '_', $locationKey . '-' . $locationField);
1640 $row[$field . '_' . $fieldKey] = $this->getRelationshipValue($field, $contactID, $fieldKey);
1645 $row[$field . '_' . $property] = $this->getRelationshipValue($field, $contactID, $property);
1651 * Is this contact a household that is already set to be exported by virtue of it's household members.
1653 * @param int $contactID
1657 protected function isHouseholdToSkip($contactID) {
1658 return in_array($contactID, $this->householdsToSkip
);
1662 * Get the various arrays that we use to structure our output.
1664 * The extraction of these has been moved to a separate function for clarity and so that
1665 * tests can be added - in particular on the $outputHeaders array.
1667 * However it still feels a bit like something that I'm too polite to write down and this should be seen
1668 * as a step on the refactoring path rather than how it should be.
1671 * - outputColumns Array of columns to be exported. The values don't matter but the key must match the
1672 * alias for the field generated by BAO_Query object.
1673 * - headerRows Array of the column header strings to put in the csv header - non-associative.
1674 * - sqlColumns Array of column names for the temp table. Not too sure why outputColumns can't be used here.
1675 * - metadata Array of fields with specific parameters to pass to the translate function or another hacky nasty solution
1676 * I'm too embarassed to discuss here.
1678 * - to match the outputColumns keys (yes, the fact we ignore the output columns values & then pass another array with values
1679 * we could use does suggest further refactors. However, you future improver, do remember that every check you do
1680 * in the main DAO loop is done once per row & that coule be 100,000 times.)
1681 * Finally a pop quiz: We need the translate context because we use a function other than ts() - is this because
1682 * - a) the function used is more efficient or
1683 * - b) this code is old & outdated. Submit your answers to circular bin or better
1684 * yet find a way to comment them for posterity.
1686 public function getExportStructureArrays() {
1687 $outputColumns = $metadata = [];
1688 $queryFields = $this->getQueryFields();
1689 foreach ($this->getReturnProperties() as $key => $value) {
1690 if (($key != 'location' ||
!is_array($value)) && !$this->isRelationshipTypeKey($key)) {
1691 $outputColumns[$key] = $value;
1692 $this->addOutputSpecification($key);
1694 elseif ($this->isRelationshipTypeKey($key)) {
1695 $outputColumns[$key] = $value;
1696 foreach ($value as $relationField => $relationValue) {
1697 // below block is same as primary block (duplicate)
1698 if (isset($queryFields[$relationField]['title'])) {
1699 $this->addOutputSpecification($relationField, $key);
1701 elseif (is_array($relationValue) && $relationField == 'location') {
1702 // fix header for location type case
1703 foreach ($relationValue as $ltype => $val) {
1704 foreach (array_keys($val) as $fld) {
1705 $type = explode('-', $fld);
1706 $this->addOutputSpecification($type[0], $key, $ltype, CRM_Utils_Array
::value(1, $type));
1713 foreach ($value as $locationType => $locationFields) {
1714 foreach (array_keys($locationFields) as $locationFieldName) {
1715 $type = explode('-', $locationFieldName);
1717 $actualDBFieldName = $type[0];
1718 $daoFieldName = CRM_Utils_String
::munge($locationType) . '-' . $actualDBFieldName;
1720 if (!empty($type[1])) {
1721 $daoFieldName .= "-" . $type[1];
1723 $this->addOutputSpecification($actualDBFieldName, NULL, $locationType, CRM_Utils_Array
::value(1, $type));
1724 $metadata[$daoFieldName] = $this->getMetaDataForField($actualDBFieldName);
1725 $outputColumns[$daoFieldName] = TRUE;
1730 return [$outputColumns, $metadata];
1734 * Get default return property for export based on mode
1737 * Default Return property
1739 public function defaultReturnProperty() {
1740 // hack to add default return property based on export mode
1742 $exportMode = $this->getExportMode();
1743 if ($exportMode == CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
) {
1744 $property = 'contribution_id';
1746 elseif ($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
) {
1747 $property = 'participant_id';
1749 elseif ($exportMode == CRM_Export_Form_Select
::MEMBER_EXPORT
) {
1750 $property = 'membership_id';
1752 elseif ($exportMode == CRM_Export_Form_Select
::PLEDGE_EXPORT
) {
1753 $property = 'pledge_id';
1755 elseif ($exportMode == CRM_Export_Form_Select
::CASE_EXPORT
) {
1756 $property = 'case_id';
1758 elseif ($exportMode == CRM_Export_Form_Select
::GRANT_EXPORT
) {
1759 $property = 'grant_id';
1761 elseif ($exportMode == CRM_Export_Form_Select
::ACTIVITY_EXPORT
) {
1762 $property = 'activity_id';
1768 * Determine the required return properties from the input parameters.
1772 public function determineReturnProperties() {
1773 if ($this->getRequestedFields()) {
1774 $returnProperties = [];
1775 foreach ($this->getRequestedFields() as $key => $value) {
1776 $fieldName = $value['name'];
1777 $locationName = !empty($value['location_type_id']) ? CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_Address', 'location_type_id', $value['location_type_id']) : NULL;
1778 $relationshipTypeKey = !empty($value['relationship_type_id']) ?
$value['relationship_type_id'] . '_' . $value['relationship_direction'] : NULL;
1779 if (!$fieldName ||
$this->isHouseholdMergeRelationshipTypeKey($relationshipTypeKey)) {
1783 if ($this->isRelationshipTypeKey($relationshipTypeKey)) {
1784 $returnProperties[$relationshipTypeKey] = $this->setRelationshipReturnProperties($value, $relationshipTypeKey);
1786 elseif ($locationName) {
1787 if ($fieldName === 'phone') {
1788 $returnProperties['location'][$locationName]['phone-' . $value['phone_type_id'] ??
NULL] = 1;
1790 elseif ($fieldName === 'im') {
1791 $returnProperties['location'][$locationName]['im-' . $value['im_provider_id'] ??
NULL] = 1;
1794 $returnProperties['location'][$locationName][$fieldName] = 1;
1798 //hack to fix component fields
1799 //revert mix of event_id and title
1800 if ($fieldName == 'event_id') {
1801 $returnProperties['event_id'] = 1;
1804 $returnProperties[$fieldName] = 1;
1808 $defaultExportMode = $this->defaultReturnProperty();
1809 if ($defaultExportMode) {
1810 $returnProperties[$defaultExportMode] = 1;
1814 $returnProperties = $this->getDefaultReturnProperties();
1816 if ($this->isMergeSameHousehold()) {
1817 $returnProperties['id'] = 1;
1819 if ($this->isMergeSameAddress()) {
1820 $returnProperties['addressee'] = 1;
1821 $returnProperties['postal_greeting'] = 1;
1822 $returnProperties['email_greeting'] = 1;
1823 $returnProperties['street_name'] = 1;
1824 $returnProperties['household_name'] = 1;
1825 $returnProperties['street_address'] = 1;
1826 $returnProperties['city'] = 1;
1827 $returnProperties['state_province'] = 1;
1830 return $returnProperties;
1834 * @param object $query
1835 * CRM_Contact_BAO_Query
1840 public function getGroupBy($query) {
1842 $returnProperties = $this->getReturnProperties();
1843 $exportMode = $this->getExportMode();
1844 $queryMode = $this->getQueryMode();
1845 if (!empty($returnProperties['tags']) ||
!empty($returnProperties['groups']) ||
1846 CRM_Utils_Array
::value('notes', $returnProperties) ||
1848 ($queryMode & CRM_Contact_BAO_Query
::MODE_CONTACTS
&& $query->_useGroupBy
)
1850 $groupBy = "contact_a.id";
1853 switch ($exportMode) {
1854 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
1855 $groupBy = 'civicrm_contribution.id';
1856 if (CRM_Contribute_BAO_Query
::isSoftCreditOptionEnabled()) {
1857 // especial group by when soft credit columns are included
1858 $groupBy = ['contribution_search_scredit_combined.id', 'contribution_search_scredit_combined.scredit_id'];
1862 case CRM_Export_Form_Select
::EVENT_EXPORT
:
1863 $groupBy = 'civicrm_participant.id';
1866 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
1867 $groupBy = "civicrm_membership.id";
1871 if ($queryMode & CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
1872 $groupBy = "civicrm_activity.id ";
1875 return $groupBy ?
' GROUP BY ' . implode(', ', (array) $groupBy) : '';
1879 * @param int $contactId
1883 public function replaceMergeTokens($contactId) {
1888 'postal_greeting' => $this->getPostalGreetingTemplate(),
1889 'addressee' => $this->getAddresseeGreetingTemplate(),
1891 foreach ($greetingFields as $greeting => $greetingLabel) {
1892 $tokens = CRM_Utils_Token
::getTokens($greetingLabel);
1893 if (!empty($tokens)) {
1894 if (empty($contact)) {
1899 $contact = civicrm_api('contact', 'get', $values);
1901 if (!empty($contact['is_error'])) {
1904 $contact = $contact['values'][$contact['id']];
1907 $tokens = ['contact' => $greetingLabel];
1908 $greetings[$greeting] = CRM_Utils_Token
::replaceContactTokens($greetingLabel, $contact, NULL, $tokens);
1915 * Build array for merging same addresses.
1918 * @param bool $sharedAddress
1922 public function buildMasterCopyArray($sql, $sharedAddress = FALSE) {
1924 $addresseeOptions = CRM_Core_OptionGroup
::values('addressee');
1925 $postalOptions = CRM_Core_OptionGroup
::values('postal_greeting');
1927 $merge = $parents = [];
1928 $dao = CRM_Core_DAO
::executeQuery($sql);
1930 while ($dao->fetch()) {
1931 $masterID = $dao->master_id
;
1932 $copyID = $dao->copy_id
;
1933 $masterPostalGreeting = $dao->master_postal_greeting
;
1934 $masterAddressee = $dao->master_addressee
;
1935 $copyAddressee = $dao->copy_addressee
;
1937 if (!$sharedAddress) {
1938 if (!isset($this->contactGreetingFields
[$dao->master_contact_id
])) {
1939 $this->contactGreetingFields
[$dao->master_contact_id
] = $this->replaceMergeTokens($dao->master_contact_id
);
1941 $masterPostalGreeting = CRM_Utils_Array
::value('postal_greeting',
1942 $this->contactGreetingFields
[$dao->master_contact_id
], $dao->master_postal_greeting
1944 $masterAddressee = CRM_Utils_Array
::value('addressee',
1945 $this->contactGreetingFields
[$dao->master_contact_id
], $dao->master_addressee
1948 if (!isset($contactGreetingTokens[$dao->copy_contact_id
])) {
1949 $this->contactGreetingFields
[$dao->copy_contact_id
] = $this->replaceMergeTokens($dao->copy_contact_id
);
1951 $copyPostalGreeting = CRM_Utils_Array
::value('postal_greeting',
1952 $this->contactGreetingFields
[$dao->copy_contact_id
], $dao->copy_postal_greeting
1954 $copyAddressee = CRM_Utils_Array
::value('addressee',
1955 $this->contactGreetingFields
[$dao->copy_contact_id
], $dao->copy_addressee
1959 if (!isset($merge[$masterID])) {
1960 // check if this is an intermediate child
1961 // this happens if there are 3 or more matches a,b, c
1962 // the above query will return a, b / a, c / b, c
1963 // we might be doing a bit more work, but for now its ok, unless someone
1964 // knows how to fix the query above
1965 if (isset($parents[$masterID])) {
1966 $masterID = $parents[$masterID];
1969 $merge[$masterID] = [
1970 'addressee' => $masterAddressee,
1972 'postalGreeting' => $masterPostalGreeting,
1974 $merge[$masterID]['emailGreeting'] = &$merge[$masterID]['postalGreeting'];
1977 $parents[$copyID] = $masterID;
1979 if (!$sharedAddress && !array_key_exists($copyID, $merge[$masterID]['copy'])) {
1981 if ($copyPostalGreeting) {
1982 $this->trimNonTokensFromAddressString($copyPostalGreeting,
1983 $postalOptions[$dao->copy_postal_greeting_id
],
1984 $this->getPostalGreetingTemplate()
1986 $merge[$masterID]['postalGreeting'] = "{$merge[$masterID]['postalGreeting']}, {$copyPostalGreeting}";
1987 // if there happens to be a duplicate, remove it
1988 $merge[$masterID]['postalGreeting'] = str_replace(" {$copyPostalGreeting},", "", $merge[$masterID]['postalGreeting']);
1991 if ($copyAddressee) {
1992 $this->trimNonTokensFromAddressString($copyAddressee,
1993 $addresseeOptions[$dao->copy_addressee_id
],
1994 $this->getAddresseeGreetingTemplate()
1996 $merge[$masterID]['addressee'] = "{$merge[$masterID]['addressee']}, " . trim($copyAddressee);
1999 $merge[$masterID]['copy'][$copyID] = $copyAddressee;
2006 * Merge contacts with the same address.
2008 public function mergeSameAddress() {
2010 $tableName = $this->getTemporaryTable();
2011 // check if any records are present based on if they have used shared address feature,
2012 // and not based on if city / state .. matches.
2014 SELECT r1.id as copy_id,
2015 r1.civicrm_primary_id as copy_contact_id,
2016 r1.addressee as copy_addressee,
2017 r1.addressee_id as copy_addressee_id,
2018 r1.postal_greeting as copy_postal_greeting,
2019 r1.postal_greeting_id as copy_postal_greeting_id,
2021 r2.civicrm_primary_id as master_contact_id,
2022 r2.postal_greeting as master_postal_greeting,
2023 r2.postal_greeting_id as master_postal_greeting_id,
2024 r2.addressee as master_addressee,
2025 r2.addressee_id as master_addressee_id
2027 INNER JOIN civicrm_address adr ON r1.master_id = adr.id
2028 INNER JOIN $tableName r2 ON adr.contact_id = r2.civicrm_primary_id
2030 $linkedMerge = $this->buildMasterCopyArray($sql, TRUE);
2032 // find all the records that have the same street address BUT not in a household
2033 // require match on city and state as well
2035 SELECT r1.id as master_id,
2036 r1.civicrm_primary_id as master_contact_id,
2037 r1.postal_greeting as master_postal_greeting,
2038 r1.postal_greeting_id as master_postal_greeting_id,
2039 r1.addressee as master_addressee,
2040 r1.addressee_id as master_addressee_id,
2042 r2.civicrm_primary_id as copy_contact_id,
2043 r2.postal_greeting as copy_postal_greeting,
2044 r2.postal_greeting_id as copy_postal_greeting_id,
2045 r2.addressee as copy_addressee,
2046 r2.addressee_id as copy_addressee_id
2048 LEFT JOIN $tableName r2 ON ( r1.street_address = r2.street_address AND
2049 r1.city = r2.city AND
2050 r1.state_province_id = r2.state_province_id )
2051 WHERE ( r1.household_name IS NULL OR r1.household_name = '' )
2052 AND ( r2.household_name IS NULL OR r2.household_name = '' )
2053 AND ( r1.street_address != '' )
2057 $merge = $this->buildMasterCopyArray($sql);
2059 // unset ids from $merge already present in $linkedMerge
2060 foreach ($linkedMerge as $masterID => $values) {
2061 $keys = [$masterID];
2062 $keys = array_merge($keys, array_keys($values['copy']));
2063 foreach ($merge as $mid => $vals) {
2064 if (in_array($mid, $keys)) {
2065 unset($merge[$mid]);
2068 foreach ($values['copy'] as $copyId) {
2069 if (in_array($copyId, $keys)) {
2070 unset($merge[$mid]['copy'][$copyId]);
2076 $merge = $merge +
$linkedMerge;
2078 foreach ($merge as $masterID => $values) {
2081 SET addressee = %1, postal_greeting = %2, email_greeting = %3
2085 1 => [$values['addressee'], 'String'],
2086 2 => [$values['postalGreeting'], 'String'],
2087 3 => [$values['emailGreeting'], 'String'],
2088 4 => [$masterID, 'Integer'],
2090 CRM_Core_DAO
::executeQuery($sql, $params);
2092 // delete all copies
2093 $deleteIDs = array_keys($values['copy']);
2094 $deleteIDString = implode(',', $deleteIDs);
2096 DELETE FROM $tableName
2097 WHERE id IN ( $deleteIDString )
2099 CRM_Core_DAO
::executeQuery($sql);
2104 * The function unsets static part of the string, if token is the dynamic part.
2106 * Example: 'Hello {contact.first_name}' => converted to => '{contact.first_name}'
2107 * i.e 'Hello Alan' => converted to => 'Alan'
2109 * @param string $parsedString
2110 * @param string $defaultGreeting
2111 * @param string $greetingLabel
2115 public function trimNonTokensFromAddressString(
2116 &$parsedString, $defaultGreeting,
2119 $greetingLabel = empty($greetingLabel) ?
$defaultGreeting : $greetingLabel;
2121 $stringsToBeReplaced = preg_replace('/(\{[a-zA-Z._ ]+\})/', ';;', $greetingLabel);
2122 $stringsToBeReplaced = explode(';;', $stringsToBeReplaced);
2123 foreach ($stringsToBeReplaced as $key => $string) {
2124 // to keep one space
2125 $stringsToBeReplaced[$key] = ltrim($string);
2127 $parsedString = str_replace($stringsToBeReplaced, "", $parsedString);
2129 return $parsedString;
2133 * Preview export output.
2138 public function getPreview($limit) {
2140 list($outputColumns, $metadata) = $this->getExportStructureArrays();
2141 $query = $this->runQuery([], '');
2142 CRM_Core_DAO
::disableFullGroupByMode();
2143 $result = CRM_Core_DAO
::executeQuery($query[1] . ' LIMIT ' . (int) $limit);
2144 CRM_Core_DAO
::reenableFullGroupByMode();
2145 while ($result->fetch()) {
2146 $rows[] = $this->buildRow($query[0], $result, $outputColumns, $metadata, [], []);
2152 * Set the template strings to be used when merging two contacts with the same address.
2154 * @param array $formValues
2155 * Values from first form. In this case we care about the keys
2158 * - address_greeting
2163 protected function setGreetingStringsForSameAddressMerge($formValues) {
2164 $greetingOptions = CRM_Export_Form_Select
::getGreetingOptions();
2166 if (!empty($greetingOptions)) {
2167 // Greeting options is keyed by 'postal_greeting' or 'addressee'.
2168 foreach ($greetingOptions as $key => $value) {
2169 $option = CRM_Utils_Array
::value($key, $formValues);
2171 if ($greetingOptions[$key][$option] == ts('Other')) {
2172 $formValues[$key] = $formValues["{$key}_other"];
2174 elseif ($greetingOptions[$key][$option] == ts('List of names')) {
2175 $formValues[$key] = '';
2178 $formValues[$key] = $greetingOptions[$key][$option];
2183 if (!empty($formValues['postal_greeting'])) {
2184 $this->setPostalGreetingTemplate($formValues['postal_greeting']);
2186 if (!empty($formValues['addressee'])) {
2187 $this->setAddresseeGreetingTemplate($formValues['addressee']);
2192 * Create the temporary table for output.
2194 public function createTempTable() {
2195 //creating a temporary table for the search result that need be exported
2196 $exportTempTable = CRM_Utils_SQL_TempTable
::build()->setDurable()->setCategory('export');
2197 $sqlColumns = $this->getSQLColumns();
2198 // also create the sql table
2199 $exportTempTable->drop();
2201 $sql = " id int unsigned NOT NULL AUTO_INCREMENT, ";
2202 if (!empty($sqlColumns)) {
2203 $sql .= implode(",\n", array_values($sqlColumns)) . ',';
2206 $sql .= "\n PRIMARY KEY ( id )";
2208 // add indexes for street_address and household_name if present
2212 'civicrm_primary_id',
2215 foreach ($addIndices as $index) {
2216 if (isset($sqlColumns[$index])) {
2218 INDEX index_{$index}( $index )
2223 $exportTempTable->createWithColumns($sql);
2224 $this->setTemporaryTable($exportTempTable->getName());
2228 * Get the values of linked household contact.
2230 * @param CRM_Core_DAO $relDAO
2231 * @param array $value
2232 * @param string $field
2235 * @throws \Exception
2237 public function fetchRelationshipDetails($relDAO, $value, $field, &$row) {
2238 $phoneTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id');
2239 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
2240 $i18n = CRM_Core_I18n
::singleton();
2241 $field = $field . '_';
2243 foreach ($value as $relationField => $relationValue) {
2244 if (is_object($relDAO) && property_exists($relDAO, $relationField)) {
2245 $fieldValue = $relDAO->$relationField;
2246 if ($relationField == 'phone_type_id') {
2247 $fieldValue = $phoneTypes[$relationValue];
2249 elseif ($relationField == 'provider_id') {
2250 $fieldValue = CRM_Utils_Array
::value($relationValue, $imProviders);
2253 elseif (is_object($relDAO) && in_array($relationField, [
2258 //special case for greeting replacement
2259 $fldValue = "{$relationField}_display";
2260 $fieldValue = $relDAO->$fldValue;
2263 elseif (is_object($relDAO) && $relationField == 'state_province') {
2264 $fieldValue = CRM_Core_PseudoConstant
::stateProvince($relDAO->state_province_id
);
2266 elseif (is_object($relDAO) && $relationField == 'country') {
2267 $fieldValue = CRM_Core_PseudoConstant
::country($relDAO->country_id
);
2272 $relPrefix = $field . $relationField;
2274 if (is_object($relDAO) && $relationField == 'id') {
2275 $row[$relPrefix] = $relDAO->contact_id
;
2277 elseif (is_array($relationValue) && $relationField == 'location') {
2278 foreach ($relationValue as $ltype => $val) {
2279 // If the location name has a space in it the we need to handle that. This
2280 // is kinda hacky but specifically covered in the ExportTest so later efforts to
2281 // improve it should be secure in the knowled it will be caught.
2282 $ltype = str_replace(' ', '_', $ltype);
2283 foreach (array_keys($val) as $fld) {
2284 $type = explode('-', $fld);
2285 $fldValue = "{$ltype}-" . $type[0];
2286 if (!empty($type[1])) {
2287 $fldValue .= "-" . $type[1];
2289 // CRM-3157: localise country, region (both have ‘country’ context)
2290 // and state_province (‘province’ context)
2292 case (!is_object($relDAO)):
2293 $row[$field . '_' . $fldValue] = '';
2296 case in_array('country', $type):
2297 case in_array('world_region', $type):
2298 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
2299 ['context' => 'country']
2303 case in_array('state_province', $type):
2304 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
2305 ['context' => 'province']
2310 $row[$field . '_' . $fldValue] = $relDAO->$fldValue;
2316 elseif (isset($fieldValue) && $fieldValue != '') {
2317 //check for custom data
2318 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($relationField)) {
2319 $row[$relPrefix] = CRM_Core_BAO_CustomField
::displayValue($fieldValue, $cfID);
2322 //normal relationship fields
2323 // CRM-3157: localise country, region (both have ‘country’ context) and state_province (‘province’ context)
2324 switch ($relationField) {
2326 case 'world_region':
2327 $row[$relPrefix] = $i18n->crm_translate($fieldValue, ['context' => 'country']);
2330 case 'state_province':
2331 $row[$relPrefix] = $i18n->crm_translate($fieldValue, ['context' => 'province']);
2335 $row[$relPrefix] = $fieldValue;
2341 // if relation field is empty or null
2342 $row[$relPrefix] = '';
2348 * Write to the csv from the temp table.
2350 public function writeCSVFromTable() {
2352 $headerRows = $this->getHeaderRows();
2353 $exportTempTable = $this->getTemporaryTable();
2354 $exportMode = $this->getExportMode();
2355 $sqlColumns = $this->getSQLColumns();
2356 $componentTable = $this->getComponentTable();
2357 $ids = $this->getIds();
2358 CRM_Utils_Hook
::export($exportTempTable, $headerRows, $sqlColumns, $exportMode, $componentTable, $ids);
2359 if ($exportMode !== $this->getExportMode() ||
$componentTable !== $this->getComponentTable()) {
2360 CRM_Core_Error
::deprecatedFunctionWarning('altering the export mode and/or component table in the hook is no longer supported.');
2362 if ($ids !== $this->getIds()) {
2363 CRM_Core_Error
::deprecatedFunctionWarning('altering the ids in the hook is no longer supported.');
2365 if ($exportTempTable !== $this->getTemporaryTable()) {
2366 CRM_Core_Error
::deprecatedFunctionWarning('altering the export table in the hook is deprecated (in some flows the table itself will be)');
2367 $this->setTemporaryTable($exportTempTable);
2369 $exportTempTable = $this->getTemporaryTable();
2370 $writeHeader = TRUE;
2372 // increase this number a lot to avoid making too many queries
2373 // LIMIT is not much faster than a no LIMIT query
2377 $query = "SELECT * FROM $exportTempTable";
2380 $limitQuery = $query . "
2381 LIMIT $offset, $limit
2383 $dao = CRM_Core_DAO
::executeQuery($limitQuery);
2389 $componentDetails = [];
2390 while ($dao->fetch()) {
2393 foreach (array_keys($sqlColumns) as $column) {
2394 $row[$column] = $dao->$column;
2396 $componentDetails[] = $row;
2398 CRM_Core_Report_Excel
::writeCSVFile($this->getExportFileName(),
2405 $writeHeader = FALSE;