3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * Class CRM_Export_BAO_ExportProcessor
21 * Class to handle logic of export.
23 class CRM_Export_BAO_ExportProcessor
{
33 protected $exportMode;
36 * Array of fields in the main query.
40 protected $queryFields = [];
47 protected $queryOperator;
50 * Requested output fields.
52 * If set to NULL then it is 'primary fields only'
53 * which actually means pretty close to all fields!
57 protected $requestedFields;
60 * Is the contact being merged into a single household.
64 protected $isMergeSameHousehold;
67 * Should contacts with the same address be merged.
71 protected $isMergeSameAddress = FALSE;
74 * Fields that need to be retrieved for address merge purposes but should not be in output.
78 protected $additionalFieldsForSameAddressMerge = [];
81 * Fields used for merging same contacts.
85 protected $contactGreetingFields = [];
88 * An array of primary IDs of the entity being exported.
95 * Greeting options mapping to various greeting ids.
97 * This stores the option values for the addressee, postal_greeting & email_greeting
102 protected $greetingOptions = [];
105 * Get additional non-visible fields for address merge purposes.
109 public function getAdditionalFieldsForSameAddressMerge(): array {
110 return $this->additionalFieldsForSameAddressMerge
;
114 * Set additional non-visible fields for address merge purposes.
116 public function setAdditionalFieldsForSameAddressMerge() {
117 if ($this->isMergeSameAddress
) {
118 $fields = ['id', 'master_id', 'state_province_id', 'postal_greeting_id', 'addressee_id'];
119 foreach ($fields as $index => $field) {
120 if (!empty($this->getReturnProperties()[$field])) {
121 unset($fields[$index]);
124 $this->additionalFieldsForSameAddressMerge
= array_fill_keys($fields, 1);
129 * Should contacts with the same address be merged.
133 public function isMergeSameAddress(): bool {
134 return $this->isMergeSameAddress
;
138 * Set same address is to be merged.
140 * @param bool $isMergeSameAddress
142 public function setIsMergeSameAddress(bool $isMergeSameAddress) {
143 $this->isMergeSameAddress
= $isMergeSameAddress;
147 * Additional fields required to export postal fields.
151 protected $additionalFieldsForPostalExport = [];
154 * Get additional fields required to do a postal export.
158 public function getAdditionalFieldsForPostalExport() {
159 return $this->additionalFieldsForPostalExport
;
163 * Set additional fields required for a postal export.
165 public function setAdditionalFieldsForPostalExport() {
166 if ($this->getRequestedFields() && $this->isPostalableOnly()) {
167 $fields = ['is_deceased', 'do_not_mail', 'street_address', 'supplemental_address_1'];
168 foreach ($fields as $index => $field) {
169 if (!empty($this->getReturnProperties()[$field])) {
170 unset($fields[$index]);
173 $this->additionalFieldsForPostalExport
= array_fill_keys($fields, 1);
178 * Only export contacts that can receive postal mail.
180 * Includes being alive, having an address & not having do_not_mail.
184 protected $isPostalableOnly;
187 * Key representing the head of household in the relationship array.
189 * e.g. ['8_b_a' => 'Household Member Is', '8_a_b = 'Household Member Of'.....]
193 protected $relationshipTypes = [];
196 * Array of properties to retrieve for relationships.
200 protected $relationshipReturnProperties = [];
203 * IDs of households that have already been exported.
207 protected $exportedHouseholds = [];
210 * Contacts to be merged by virtue of their shared address.
214 protected $contactsToMerge = [];
217 * Households to skip during export as they will be exported via their relationships anyway.
221 protected $householdsToSkip = [];
224 * Additional fields to return.
226 * This doesn't make much sense when we have a fields set but search build add it's own onto
227 * the 'Primary fields' (all) option.
231 protected $additionalRequestedReturnProperties = [];
234 * Get additional return properties.
238 public function getAdditionalRequestedReturnProperties() {
239 return $this->additionalRequestedReturnProperties
;
243 * Set additional return properties.
245 * @param array $value
247 public function setAdditionalRequestedReturnProperties($value) {
249 if (!empty($value['group'])) {
250 unset($value['group']);
251 $value['groups'] = 1;
253 $this->additionalRequestedReturnProperties
= $value;
257 * Get return properties by relationship.
260 public function getRelationshipReturnProperties() {
261 return $this->relationshipReturnProperties
;
265 * Export values for related contacts.
269 protected $relatedContactValues = [];
274 protected $returnProperties = [];
279 protected $outputSpecification = [];
284 protected $componentTable = '';
289 public function getComponentTable() {
290 return $this->componentTable
;
294 * Set the component table (if any).
296 * @param string $componentTable
298 public function setComponentTable($componentTable) {
299 $this->componentTable
= $componentTable;
303 * Clause from component search.
307 protected $componentClause = '';
312 public function getComponentClause() {
313 return $this->componentClause
;
317 * @param string $componentClause
319 public function setComponentClause($componentClause) {
320 $this->componentClause
= $componentClause;
324 * Name of a temporary table created to hold the results.
326 * Current decision making on when to create a temp table is kinda bad so this might change
327 * a bit as it is reviewed but basically we need a temp table or similar to calculate merging
328 * addresses. Merging households is handled in php. We create a temp table even when we don't need them.
332 protected $temporaryTable;
337 public function getTemporaryTable(): string {
338 return $this->temporaryTable
;
342 * @param string $temporaryTable
344 public function setTemporaryTable(string $temporaryTable) {
345 $this->temporaryTable
= $temporaryTable;
348 protected $postalGreetingTemplate;
353 public function getPostalGreetingTemplate() {
354 return $this->postalGreetingTemplate
;
358 * @param mixed $postalGreetingTemplate
360 public function setPostalGreetingTemplate($postalGreetingTemplate) {
361 $this->postalGreetingTemplate
= $postalGreetingTemplate;
367 public function getAddresseeGreetingTemplate() {
368 return $this->addresseeGreetingTemplate
;
372 * @param mixed $addresseeGreetingTemplate
374 public function setAddresseeGreetingTemplate($addresseeGreetingTemplate) {
375 $this->addresseeGreetingTemplate
= $addresseeGreetingTemplate;
378 protected $addresseeGreetingTemplate;
381 * CRM_Export_BAO_ExportProcessor constructor.
383 * @param int $exportMode
384 * @param array|null $requestedFields
385 * @param string $queryOperator
386 * @param bool $isMergeSameHousehold
387 * @param bool $isPostalableOnly
388 * @param bool $isMergeSameAddress
389 * @param array $formValues
390 * Values from the export options form on contact export. We currently support these keys
393 * - addresee_greeting
396 public function __construct($exportMode, $requestedFields, $queryOperator, $isMergeSameHousehold = FALSE, $isPostalableOnly = FALSE, $isMergeSameAddress = FALSE, $formValues = []) {
397 $this->setExportMode($exportMode);
398 $this->setQueryMode();
399 $this->setQueryOperator($queryOperator);
400 $this->setRequestedFields($requestedFields);
401 $this->setRelationshipTypes();
402 $this->setIsMergeSameHousehold($isMergeSameHousehold ||
$isMergeSameAddress);
403 $this->setIsPostalableOnly($isPostalableOnly);
404 $this->setIsMergeSameAddress($isMergeSameAddress);
405 $this->setReturnProperties($this->determineReturnProperties());
406 $this->setAdditionalFieldsForSameAddressMerge();
407 $this->setAdditionalFieldsForPostalExport();
408 $this->setHouseholdMergeReturnProperties();
409 $this->setGreetingStringsForSameAddressMerge($formValues);
410 $this->setGreetingOptions();
414 * Set the greeting options, if relevant.
416 public function setGreetingOptions() {
417 if ($this->isMergeSameAddress()) {
418 $this->greetingOptions
['addressee'] = CRM_Core_OptionGroup
::values('addressee');
419 $this->greetingOptions
['postal_greeting'] = CRM_Core_OptionGroup
::values('postal_greeting');
426 public function isPostalableOnly() {
427 return $this->isPostalableOnly
;
431 * @param bool $isPostalableOnly
433 public function setIsPostalableOnly($isPostalableOnly) {
434 $this->isPostalableOnly
= $isPostalableOnly;
440 public function getRequestedFields() {
441 return empty($this->requestedFields
) ?
NULL : $this->requestedFields
;
445 * @param array|null $requestedFields
447 public function setRequestedFields($requestedFields) {
448 $this->requestedFields
= $requestedFields;
454 public function getReturnProperties() {
455 return array_merge($this->returnProperties
, $this->getAdditionalRequestedReturnProperties(), $this->getAdditionalFieldsForSameAddressMerge(), $this->getAdditionalFieldsForPostalExport());
459 * @param array $returnProperties
461 public function setReturnProperties($returnProperties) {
462 $this->returnProperties
= $returnProperties;
468 public function getRelationshipTypes() {
469 return $this->relationshipTypes
;
474 public function setRelationshipTypes() {
475 $this->relationshipTypes
= CRM_Contact_BAO_Relationship
::getContactRelationshipType(
487 * Set the value for a relationship type field.
489 * In this case we are building up an array of properties for a related contact.
491 * These may be used for direct exporting or for merge to household depending on the
494 * @param string $relationshipType
495 * @param int $contactID
496 * @param string $field
497 * @param string $value
499 public function setRelationshipValue($relationshipType, $contactID, $field, $value) {
500 $this->relatedContactValues
[$relationshipType][$contactID][$field] = $value;
501 if ($field === 'id' && $this->isHouseholdMergeRelationshipTypeKey($relationshipType)) {
502 $this->householdsToSkip
[] = $value;
507 * Get the value for a relationship type field.
509 * In this case we are building up an array of properties for a related contact.
511 * These may be used for direct exporting or for merge to household depending on the
514 * @param string $relationshipType
515 * @param int $contactID
516 * @param string $field
520 public function getRelationshipValue($relationshipType, $contactID, $field) {
521 return $this->relatedContactValues
[$relationshipType][$contactID][$field] ??
'';
525 * Get the id of the related household.
527 * @param int $contactID
528 * @param string $relationshipType
532 public function getRelatedHouseholdID($contactID, $relationshipType) {
533 return $this->relatedContactValues
[$relationshipType][$contactID]['id'];
537 * Has the household already been exported.
539 * @param int $housholdContactID
543 public function isHouseholdExported($housholdContactID) {
544 return isset($this->exportedHouseholds
[$housholdContactID]);
551 public function isMergeSameHousehold() {
552 return $this->isMergeSameHousehold
;
556 * @param bool $isMergeSameHousehold
558 public function setIsMergeSameHousehold($isMergeSameHousehold) {
559 $this->isMergeSameHousehold
= $isMergeSameHousehold;
563 * Return relationship types for household merge.
567 public function getHouseholdRelationshipTypes() {
568 if (!$this->isMergeSameHousehold()) {
572 CRM_Utils_Array
::key('Household Member of', $this->getRelationshipTypes()),
573 CRM_Utils_Array
::key('Head of Household for', $this->getRelationshipTypes()),
581 public function isRelationshipTypeKey($fieldName) {
582 return array_key_exists($fieldName, $this->relationshipTypes
);
589 public function isHouseholdMergeRelationshipTypeKey($fieldName) {
590 return in_array($fieldName, $this->getHouseholdRelationshipTypes());
596 public function getQueryOperator() {
597 return $this->queryOperator
;
601 * @param string $queryOperator
603 public function setQueryOperator($queryOperator) {
604 $this->queryOperator
= $queryOperator;
610 public function getIds() {
617 public function setIds($ids) {
624 public function getQueryFields() {
627 $this->getComponentPaymentFields()
632 * @param array $queryFields
634 public function setQueryFields($queryFields) {
635 // legacy hacks - we add these to queryFields because this
636 // pseudometadata is currently required.
637 $queryFields['im_provider']['pseudoconstant']['var'] = 'imProviders';
638 $queryFields['country']['context'] = 'country';
639 $queryFields['world_region']['context'] = 'country';
640 $queryFields['state_province']['context'] = 'province';
641 $queryFields['contact_id'] = ['title' => ts('Contact ID'), 'type' => CRM_Utils_Type
::T_INT
];
642 $this->queryFields
= $queryFields;
648 public function getQueryMode() {
649 return $this->queryMode
;
653 * Set the query mode based on the export mode.
655 public function setQueryMode() {
657 switch ($this->getExportMode()) {
658 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
659 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
;
662 case CRM_Export_Form_Select
::EVENT_EXPORT
:
663 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_EVENT
;
666 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
667 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_MEMBER
;
670 case CRM_Export_Form_Select
::PLEDGE_EXPORT
:
671 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_PLEDGE
;
674 case CRM_Export_Form_Select
::CASE_EXPORT
:
675 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_CASE
;
678 case CRM_Export_Form_Select
::GRANT_EXPORT
:
679 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_GRANT
;
682 case CRM_Export_Form_Select
::ACTIVITY_EXPORT
:
683 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_ACTIVITY
;
687 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_CONTACTS
;
694 public function getExportMode() {
695 return $this->exportMode
;
699 * @param int $exportMode
701 public function setExportMode($exportMode) {
702 $this->exportMode
= $exportMode;
706 * Get the name for the export file.
710 public function getExportFileName() {
711 switch ($this->getExportMode()) {
712 case CRM_Export_Form_Select
::CONTACT_EXPORT
:
713 return ts('CiviCRM Contact Search');
715 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
716 return ts('CiviCRM Contribution Search');
718 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
719 return ts('CiviCRM Member Search');
721 case CRM_Export_Form_Select
::EVENT_EXPORT
:
722 return ts('CiviCRM Participant Search');
724 case CRM_Export_Form_Select
::PLEDGE_EXPORT
:
725 return ts('CiviCRM Pledge Search');
727 case CRM_Export_Form_Select
::CASE_EXPORT
:
728 return ts('CiviCRM Case Search');
730 case CRM_Export_Form_Select
::GRANT_EXPORT
:
731 return ts('CiviCRM Grant Search');
733 case CRM_Export_Form_Select
::ACTIVITY_EXPORT
:
734 return ts('CiviCRM Activity Search');
737 // Legacy code suggests the value could be 'financial' - ie. something
738 // other than what should be accepted. However, I suspect that this line is
740 return ts('CiviCRM Search');
745 * Get the label for the header row based on the field to output.
747 * @param string $field
751 public function getHeaderForRow($field) {
752 if (substr($field, -11) == 'campaign_id') {
753 // @todo - set this correctly in the xml rather than here.
754 // This will require a generalised handling cleanup
755 return ts('Campaign ID');
757 if ($this->isMergeSameHousehold() && !$this->isMergeSameAddress() && $field === 'id') {
758 // This is weird - even if we are merging households not every contact in the export is a household so this would not be accurate.
759 return ts('Household ID');
761 elseif (isset($this->getQueryFields()[$field]['title'])) {
762 return $this->getQueryFields()[$field]['title'];
764 elseif ($this->isExportPaymentFields() && array_key_exists($field, $this->getcomponentPaymentFields())) {
765 return CRM_Utils_Array
::value($field, $this->getcomponentPaymentFields())['title'];
778 public function runQuery($params, $order) {
779 $returnProperties = $this->getReturnProperties();
780 $params = array_merge($params, $this->getWhereParams());
782 $query = new CRM_Contact_BAO_Query($params, $returnProperties, NULL,
783 FALSE, FALSE, $this->getQueryMode(),
784 FALSE, TRUE, TRUE, NULL, $this->getQueryOperator()
789 $query->_sort
= $order;
790 list($select, $from, $where, $having) = $query->query();
791 $this->setQueryFields($query->_fields
);
792 $whereClauses = ['trash_clause' => "contact_a.is_deleted != 1"];
793 if ($this->getRequestedFields() && ($this->getComponentTable())) {
794 $from .= " INNER JOIN " . $this->getComponentTable() . " ctTable ON ctTable.contact_id = contact_a.id ";
796 elseif ($this->getComponentClause()) {
797 $whereClauses[] = $this->getComponentClause();
800 // CRM-13982 - check if is deleted
801 foreach ($params as $value) {
802 if ($value[0] == 'contact_is_deleted') {
803 unset($whereClauses['trash_clause']);
807 if ($this->isPostalableOnly
) {
808 if (array_key_exists('street_address', $returnProperties)) {
809 $addressWhere = " civicrm_address.street_address <> ''";
810 if (array_key_exists('supplemental_address_1', $returnProperties)) {
811 // We need this to be an OR rather than AND on the street_address so, hack it in.
812 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
813 'address_options', TRUE, NULL, TRUE
815 if (!empty($addressOptions['supplemental_address_1'])) {
816 $addressWhere .= " OR civicrm_address.supplemental_address_1 <> ''";
819 $whereClauses['address'] = '(' . $addressWhere . ')';
824 $where = "WHERE " . implode(' AND ', $whereClauses);
827 $where .= " AND " . implode(' AND ', $whereClauses);
830 $groupBy = $this->getGroupBy($query);
831 $queryString = "$select $from $where $having $groupBy";
833 // always add contact_a.id to the ORDER clause
834 // so the order is deterministic
836 if (strpos('contact_a.id', $order) === FALSE) {
837 $order .= ", contact_a.id";
840 list($field, $dir) = explode(' ', $order, 2);
841 $field = trim($field);
842 if (!empty($this->getReturnProperties()[$field])) {
844 $queryString .= " ORDER BY $order";
847 return [$query, $queryString];
851 * Add a row to the specification for how to output data.
854 * @param string $relationshipType
855 * @param string $locationType
856 * @param int $entityTypeID phone_type_id or provider_id for phone or im fields.
858 public function addOutputSpecification($key, $relationshipType = NULL, $locationType = NULL, $entityTypeID = NULL) {
861 if ($key === 'phone') {
862 $entityLabel = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_Phone', 'phone_type_id', $entityTypeID);
865 $entityLabel = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_IM', 'provider_id', $entityTypeID);
869 // These oddly constructed keys are for legacy reasons. Altering them will affect test success
870 // but in time it may be good to rationalise them.
871 $label = $this->getOutputSpecificationLabel($key, $relationshipType, $locationType, $entityLabel);
872 $index = $this->getOutputSpecificationIndex($key, $relationshipType, $locationType, $entityLabel);
873 $fieldKey = $this->getOutputSpecificationFieldKey($key, $relationshipType, $locationType, $entityLabel);
875 $this->outputSpecification
[$index]['header'] = $label;
876 $this->outputSpecification
[$index]['sql_columns'] = $this->getSqlColumnDefinition($fieldKey, $key);
878 if ($relationshipType && $this->isHouseholdMergeRelationshipTypeKey($relationshipType)) {
879 $this->setColumnAsCalculationOnly($index);
881 $this->outputSpecification
[$index]['metadata'] = $this->getMetaDataForField($key);
885 * Get the metadata for the given field.
891 public function getMetaDataForField($key) {
892 $mappings = ['contact_id' => 'id'];
893 if (isset($this->getQueryFields()[$key])) {
894 return $this->getQueryFields()[$key];
896 if (isset($mappings[$key])) {
897 return $this->getQueryFields()[$mappings[$key]];
905 public function setSqlColumnDefn($key) {
906 $this->outputSpecification
[$this->getMungedFieldName($key)]['sql_columns'] = $this->getSqlColumnDefinition($key, $this->getMungedFieldName($key));
910 * Mark a column as only required for calculations.
912 * Do not include the row with headers.
914 * @param string $column
916 public function setColumnAsCalculationOnly($column) {
917 $this->outputSpecification
[$column]['do_not_output_to_csv'] = TRUE;
923 public function getHeaderRows() {
925 foreach ($this->outputSpecification
as $key => $spec) {
926 if (empty($spec['do_not_output_to_csv'])) {
927 $headerRows[] = $spec['header'];
936 public function getSQLColumns() {
938 foreach ($this->outputSpecification
as $key => $spec) {
939 if (empty($spec['do_not_output_to_sql'])) {
940 $sqlColumns[$key] = $spec['sql_columns'];
949 public function getMetadata() {
951 foreach ($this->outputSpecification
as $key => $spec) {
952 $metadata[$key] = $spec['metadata'];
958 * Build the row for output.
960 * @param \CRM_Contact_BAO_Query $query
961 * @param CRM_Core_DAO $iterationDAO
962 * @param array $outputColumns
964 * @param $paymentDetails
965 * @param $addPaymentHeader
969 public function buildRow($query, $iterationDAO, $outputColumns, $metadata, $paymentDetails, $addPaymentHeader) {
970 $paymentTableId = $this->getPaymentTableID();
971 if ($this->isHouseholdToSkip($iterationDAO->contact_id
)) {
974 $phoneTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id');
975 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
978 $householdMergeRelationshipType = $this->getHouseholdMergeTypeForRow($iterationDAO->contact_id
);
979 if ($householdMergeRelationshipType) {
980 $householdID = $this->getRelatedHouseholdID($iterationDAO->contact_id
, $householdMergeRelationshipType);
981 if ($this->isHouseholdExported($householdID)) {
984 foreach (array_keys($outputColumns) as $column) {
985 $row[$column] = $this->getRelationshipValue($householdMergeRelationshipType, $iterationDAO->contact_id
, $column);
987 $this->markHouseholdExported($householdID);
991 $query->convertToPseudoNames($iterationDAO);
993 //first loop through output columns so that we return what is required, and in same order.
994 foreach ($outputColumns as $field => $value) {
995 // add im_provider to $dao object
996 if ($field == 'im_provider' && property_exists($iterationDAO, 'provider_id')) {
997 $iterationDAO->im_provider
= $iterationDAO->provider_id
;
1000 //build row values (data)
1002 if (property_exists($iterationDAO, $field)) {
1003 $fieldValue = $iterationDAO->$field;
1004 // to get phone type from phone type id
1005 if ($field == 'phone_type_id' && isset($phoneTypes[$fieldValue])) {
1006 $fieldValue = $phoneTypes[$fieldValue];
1008 elseif ($field == 'provider_id' ||
$field == 'im_provider') {
1009 $fieldValue = $imProviders[$fieldValue] ??
NULL;
1011 elseif (strstr($field, 'master_id')) {
1012 // @todo - why not just $field === 'master_id' - what else would it be?
1013 $masterAddressId = $iterationDAO->$field ??
NULL;
1014 // get display name of contact that address is shared.
1015 $fieldValue = CRM_Contact_BAO_Contact
::getMasterDisplayName($masterAddressId);
1019 if ($this->isRelationshipTypeKey($field)) {
1020 $this->buildRelationshipFieldsForRow($row, $iterationDAO->contact_id
, $value, $field);
1023 $row[$field] = $this->getTransformedFieldValue($field, $iterationDAO, $fieldValue, $metadata, $paymentDetails);
1027 // If specific payment fields have been selected for export, payment
1028 // data will already be in $row. Otherwise, add payment related
1029 // information, if appropriate.
1030 if ($addPaymentHeader) {
1031 if (!$this->isExportSpecifiedPaymentFields()) {
1032 $nullContributionDetails = array_fill_keys(array_keys($this->getPaymentHeaders()), NULL);
1033 if ($this->isExportPaymentFields()) {
1034 $paymentData = $paymentDetails[$row[$paymentTableId]] ??
NULL;
1035 if (!is_array($paymentData) ||
empty($paymentData)) {
1036 $paymentData = $nullContributionDetails;
1038 $row = array_merge($row, $paymentData);
1040 elseif (!empty($paymentDetails)) {
1041 $row = array_merge($row, $nullContributionDetails);
1045 //remove organization name for individuals if it is set for current employer
1046 if (!empty($row['contact_type']) &&
1047 $row['contact_type'] == 'Individual' && array_key_exists('organization_name', $row)
1049 $row['organization_name'] = '';
1055 * If this row has a household whose details we should use get the relationship type key.
1061 public function getHouseholdMergeTypeForRow($contactID) {
1062 if (!$this->isMergeSameHousehold()) {
1065 foreach ($this->getHouseholdRelationshipTypes() as $relationshipType) {
1066 if (isset($this->relatedContactValues
[$relationshipType][$contactID])) {
1067 return $relationshipType;
1073 * Mark the given household as already exported.
1075 * @param $householdID
1077 public function markHouseholdExported($householdID) {
1078 $this->exportedHouseholds
[$householdID] = $householdID;
1083 * @param $iterationDAO
1084 * @param $fieldValue
1086 * @param $paymentDetails
1090 public function getTransformedFieldValue($field, $iterationDAO, $fieldValue, $metadata, $paymentDetails) {
1092 $i18n = CRM_Core_I18n
::singleton();
1093 if ($field == 'id') {
1094 return $iterationDAO->contact_id
;
1095 // special case for calculated field
1097 elseif ($field == 'source_contact_id') {
1098 return $iterationDAO->contact_id
;
1100 elseif ($field == 'pledge_balance_amount') {
1101 return $iterationDAO->pledge_amount
- $iterationDAO->pledge_total_paid
;
1102 // special case for calculated field
1104 elseif ($field == 'pledge_next_pay_amount') {
1105 return $iterationDAO->pledge_next_pay_amount +
$iterationDAO->pledge_outstanding_amount
;
1107 elseif (isset($fieldValue) &&
1110 //check for custom data
1111 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($field)) {
1112 $html_type = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', $cfID, 'html_type');
1114 //need to calculate the link to the file for file custom data
1115 if ($html_type === 'File' && $fieldValue) {
1116 $result = civicrm_api3('attachment', 'get', ['return' => ['url'], 'id' => $fieldValue]);
1117 return $result['values'][$result['id']]['url'];
1120 return CRM_Core_BAO_CustomField
::displayValue($fieldValue, $cfID);
1122 elseif (in_array($field, [
1127 //special case for greeting replacement
1128 $fldValue = "{$field}_display";
1129 return $iterationDAO->$fldValue;
1132 //normal fields with a touch of CRM-3157
1135 case 'world_region':
1136 return $i18n->crm_translate($fieldValue, ['context' => 'country']);
1138 case 'state_province':
1139 return $i18n->crm_translate($fieldValue, ['context' => 'province']);
1142 case 'preferred_communication_method':
1143 case 'preferred_mail_format':
1144 case 'communication_style':
1145 return $i18n->crm_translate($fieldValue);
1148 if (isset($metadata[$field])) {
1149 // No I don't know why we do it this way & whether we could
1150 // make better use of pseudoConstants.
1151 if (!empty($metadata[$field]['context'])) {
1152 return $i18n->crm_translate($fieldValue, $metadata[$field]);
1154 if (!empty($metadata[$field]['pseudoconstant'])) {
1155 if (!empty($metadata[$field]['bao'])) {
1156 return CRM_Core_PseudoConstant
::getLabel($metadata[$field]['bao'], $metadata[$field]['name'], $fieldValue);
1158 // This is not our normal syntax for pseudoconstants but I am a bit loath to
1159 // call an external function until sure it is not increasing php processing given this
1160 // may be iterated 100,000 times & we already have the $imProvider var loaded.
1161 // That can be next refactor...
1162 // Yes - definitely feeling hatred for this bit of code - I know you will beat me up over it's awfulness
1163 // but I have to reach a stable point....
1164 $varName = $metadata[$field]['pseudoconstant']['var'];
1165 if ($varName === 'imProviders') {
1166 return CRM_Core_PseudoConstant
::getLabel('CRM_Core_DAO_IM', 'provider_id', $fieldValue);
1168 if ($varName === 'phoneTypes') {
1169 return CRM_Core_PseudoConstant
::getLabel('CRM_Core_DAO_Phone', 'phone_type_id', $fieldValue);
1178 elseif ($this->isExportSpecifiedPaymentFields() && array_key_exists($field, $this->getcomponentPaymentFields())) {
1179 $paymentTableId = $this->getPaymentTableID();
1180 $paymentData = $paymentDetails[$iterationDAO->$paymentTableId] ??
NULL;
1182 'componentPaymentField_total_amount' => 'total_amount',
1183 'componentPaymentField_contribution_status' => 'contribution_status',
1184 'componentPaymentField_payment_instrument' => 'pay_instru',
1185 'componentPaymentField_transaction_id' => 'trxn_id',
1186 'componentPaymentField_received_date' => 'receive_date',
1188 return CRM_Utils_Array
::value($payFieldMapper[$field], $paymentData, '');
1191 // if field is empty or null
1197 * Get array of fields to return, over & above those defined in the main contact exportable fields.
1199 * These include export mode specific fields & some fields apparently required as 'exportableFields'
1200 * but not returned by the function of the same name.
1203 * Array of fields to return in the format ['field_name' => 1,...]
1205 public function getAdditionalReturnProperties() {
1206 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_CONTACTS
) {
1207 $componentSpecificFields = [];
1210 $componentSpecificFields = CRM_Contact_BAO_Query
::defaultReturnProperties($this->getQueryMode());
1212 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_PLEDGE
) {
1213 $componentSpecificFields = array_merge($componentSpecificFields, CRM_Pledge_BAO_Query
::extraReturnProperties($this->getQueryMode()));
1214 unset($componentSpecificFields['contribution_status_id']);
1215 unset($componentSpecificFields['pledge_status_id']);
1216 unset($componentSpecificFields['pledge_payment_status_id']);
1218 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_CASE
) {
1219 $componentSpecificFields = array_merge($componentSpecificFields, CRM_Case_BAO_Query
::extraReturnProperties($this->getQueryMode()));
1221 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
1222 $componentSpecificFields = array_merge($componentSpecificFields, CRM_Contribute_BAO_Query
::softCreditReturnProperties(TRUE));
1223 unset($componentSpecificFields['contribution_status_id']);
1225 return $componentSpecificFields;
1229 * Should payment fields be appended to the export.
1231 * (This is pretty hacky so hopefully this function won't last long - notice
1232 * how obviously it should be part of the above function!).
1234 public function isExportPaymentFields() {
1235 if ($this->getRequestedFields() === NULL
1236 && in_array($this->getQueryMode(), [
1237 CRM_Contact_BAO_Query
::MODE_EVENT
,
1238 CRM_Contact_BAO_Query
::MODE_MEMBER
,
1239 CRM_Contact_BAO_Query
::MODE_PLEDGE
,
1243 elseif ($this->isExportSpecifiedPaymentFields()) {
1250 * Has specific payment fields been requested (as opposed to via all fields).
1252 * If specific fields have been requested then they get added at various points.
1256 public function isExportSpecifiedPaymentFields() {
1257 if ($this->getRequestedFields() !== NULL && $this->hasRequestedComponentPaymentFields()) {
1263 * Get the name of the id field in the table that connects contributions to the export entity.
1265 public function getPaymentTableID() {
1266 if ($this->getRequestedFields() === NULL) {
1268 CRM_Contact_BAO_Query
::MODE_EVENT
=> 'participant_id',
1269 CRM_Contact_BAO_Query
::MODE_MEMBER
=> 'membership_id',
1270 CRM_Contact_BAO_Query
::MODE_PLEDGE
=> 'pledge_payment_id',
1272 return isset($mapping[$this->getQueryMode()]) ?
$mapping[$this->getQueryMode()] : '';
1274 elseif ($this->hasRequestedComponentPaymentFields()) {
1275 return 'participant_id';
1281 * Have component payment fields been requested.
1285 protected function hasRequestedComponentPaymentFields() {
1286 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_EVENT
) {
1287 $participantPaymentFields = array_intersect_key($this->getComponentPaymentFields(), $this->getReturnProperties());
1288 if (!empty($participantPaymentFields)) {
1296 * Get fields that indicate payment fields have been requested for a component.
1298 * Ideally this should be protected but making it temporarily public helps refactoring..
1302 public function getComponentPaymentFields() {
1304 'componentPaymentField_total_amount' => ['title' => ts('Total Amount'), 'type' => CRM_Utils_Type
::T_MONEY
],
1305 'componentPaymentField_contribution_status' => ['title' => ts('Contribution Status'), 'type' => CRM_Utils_Type
::T_STRING
],
1306 'componentPaymentField_received_date' => ['title' => ts('Date Received'), 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
],
1307 'componentPaymentField_payment_instrument' => ['title' => ts('Payment Method'), 'type' => CRM_Utils_Type
::T_STRING
],
1308 'componentPaymentField_transaction_id' => ['title' => ts('Transaction ID'), 'type' => CRM_Utils_Type
::T_STRING
],
1313 * Get headers for payment fields.
1315 * Returns an array of contribution fields when the entity supports payment fields and specific fields
1316 * are not specified. This is a transitional function for refactoring legacy code.
1318 public function getPaymentHeaders() {
1319 if ($this->isExportPaymentFields() && !$this->isExportSpecifiedPaymentFields()) {
1320 return CRM_Utils_Array
::collect('title', $this->getcomponentPaymentFields());
1326 * Get the default properties when not specified.
1328 * In the UI this appears as 'Primary fields only' but in practice it's
1329 * most of the kitchen sink and the hallway closet thrown in.
1331 * Since CRM-952 custom fields are excluded, but no other form of mercy is shown.
1335 public function getDefaultReturnProperties() {
1336 $returnProperties = [];
1337 $fields = CRM_Contact_BAO_Contact
::exportableFields('All', TRUE, TRUE);
1338 $skippedFields = ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_CONTACTS
) ?
[] : [
1344 foreach ($fields as $key => $var) {
1345 if ($key && (substr($key, 0, 6) != 'custom') && !in_array($key, $skippedFields)) {
1346 $returnProperties[$key] = 1;
1349 $returnProperties = array_merge($returnProperties, $this->getAdditionalReturnProperties());
1350 return $returnProperties;
1354 * Add the field to relationship return properties & return it.
1356 * This function is doing both setting & getting which is yuck but it is an interim
1359 * @param array $value
1360 * @param string $relationshipKey
1364 public function setRelationshipReturnProperties($value, $relationshipKey) {
1365 $relationField = $value['name'];
1366 $relIMProviderId = NULL;
1367 $relLocTypeId = $value['location_type_id'] ??
NULL;
1368 $locationName = CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_Address', 'location_type_id', $relLocTypeId);
1369 $relPhoneTypeId = CRM_Utils_Array
::value('phone_type_id', $value, ($locationName ?
'Primary' : NULL));
1370 $relIMProviderId = CRM_Utils_Array
::value('im_provider_id', $value, ($locationName ?
'Primary' : NULL));
1371 if (in_array($relationField, $this->getValidLocationFields()) && $locationName) {
1372 if ($relationField === 'phone') {
1373 $this->relationshipReturnProperties
[$relationshipKey]['location'][$locationName]['phone-' . $relPhoneTypeId] = 1;
1375 elseif ($relationField === 'im') {
1376 $this->relationshipReturnProperties
[$relationshipKey]['location'][$locationName]['im-' . $relIMProviderId] = 1;
1379 $this->relationshipReturnProperties
[$relationshipKey]['location'][$locationName][$relationField] = 1;
1383 $this->relationshipReturnProperties
[$relationshipKey][$relationField] = 1;
1385 return $this->relationshipReturnProperties
[$relationshipKey];
1389 * Add the main return properties to the household merge properties if needed for merging.
1391 * If we are using household merge we need to add these to the relationship properties to
1394 public function setHouseholdMergeReturnProperties() {
1395 if ($this->isMergeSameHousehold()) {
1396 $returnProperties = $this->getReturnProperties();
1397 $returnProperties = array_diff_key($returnProperties, array_fill_keys(['location_type', 'im_provider'], 1));
1398 foreach ($this->getHouseholdRelationshipTypes() as $householdRelationshipType) {
1399 $this->relationshipReturnProperties
[$householdRelationshipType] = $returnProperties;
1405 * Get the default location fields to request.
1409 public function getValidLocationFields() {
1412 'supplemental_address_1',
1413 'supplemental_address_2',
1414 'supplemental_address_3',
1417 'postal_code_suffix',
1429 * Get the sql column definition for the given field.
1431 * @param string $fieldName
1432 * @param string $columnName
1436 public function getSqlColumnDefinition($fieldName, $columnName) {
1438 // early exit for master_id, CRM-12100
1439 // in the DB it is an ID, but in the export, we retrive the display_name of the master record
1440 // also for current_employer, CRM-16939
1441 if ($columnName == 'master_id' ||
$columnName == 'current_employer') {
1442 return "`$fieldName` varchar(128)";
1445 $queryFields = $this->getQueryFields();
1446 // @todo remove the enotice avoidance here, ensure all columns are declared.
1447 // tests will fail on the enotices until they all are & then all the 'else'
1449 $fieldSpec = $queryFields[$columnName] ??
[];
1451 // set the sql columns
1452 if (isset($fieldSpec['type'])) {
1453 switch ($fieldSpec['type']) {
1454 case CRM_Utils_Type
::T_INT
:
1455 case CRM_Utils_Type
::T_BOOLEAN
:
1456 if (in_array(CRM_Utils_Array
::value('data_type', $fieldSpec), ['Country', 'StateProvince', 'ContactReference'])) {
1457 return "`$fieldName` varchar(255)";
1459 return "`$fieldName` varchar(16)";
1461 case CRM_Utils_Type
::T_STRING
:
1462 if (isset($queryFields[$columnName]['maxlength'])) {
1463 return "`$fieldName` varchar({$queryFields[$columnName]['maxlength']})";
1466 return "`$fieldName` varchar(255)";
1469 case CRM_Utils_Type
::T_TEXT
:
1470 case CRM_Utils_Type
::T_LONGTEXT
:
1471 case CRM_Utils_Type
::T_BLOB
:
1472 case CRM_Utils_Type
::T_MEDIUMBLOB
:
1473 return "`$fieldName` longtext";
1475 case CRM_Utils_Type
::T_FLOAT
:
1476 case CRM_Utils_Type
::T_ENUM
:
1477 case CRM_Utils_Type
::T_DATE
:
1478 case CRM_Utils_Type
::T_TIME
:
1479 case CRM_Utils_Type
::T_TIMESTAMP
:
1480 case CRM_Utils_Type
::T_MONEY
:
1481 case CRM_Utils_Type
::T_EMAIL
:
1482 case CRM_Utils_Type
::T_URL
:
1483 case CRM_Utils_Type
::T_CCNUM
:
1485 return "`$fieldName` varchar(32)";
1489 if (substr($fieldName, -3, 3) == '_id') {
1490 return "`$fieldName` varchar(255)";
1492 elseif (substr($fieldName, -5, 5) == '_note') {
1493 return "`$fieldName` text";
1502 if (in_array($fieldName, $changeFields)) {
1503 return "`$fieldName` text";
1506 // set the sql columns for custom data
1507 if (isset($queryFields[$columnName]['data_type'])) {
1509 switch ($queryFields[$columnName]['data_type']) {
1511 // May be option labels, which could be up to 512 characters
1512 $length = max(512, CRM_Utils_Array
::value('text_length', $queryFields[$columnName]));
1513 return "`$fieldName` varchar($length)";
1516 return "`$fieldName` varchar(255)";
1519 return "`$fieldName` text";
1522 return "`$fieldName` varchar(255)";
1526 return "`$fieldName` text";
1534 * Get the munged field name.
1536 * @param string $field
1539 public function getMungedFieldName($field) {
1540 $fieldName = CRM_Utils_String
::munge(strtolower($field), '_', 64);
1541 if ($fieldName == 'id') {
1542 $fieldName = 'civicrm_primary_id';
1548 * In order to respect the history of this class we need to index kinda illogically.
1550 * On the bright side - this stuff is tested within a nano-byte of it's life.
1552 * e.g '2-a-b_Home-City'
1554 * @param string $key
1555 * @param string $relationshipType
1556 * @param string $locationType
1557 * @param $entityLabel
1561 protected function getOutputSpecificationIndex($key, $relationshipType, $locationType, $entityLabel) {
1562 if ($entityLabel ||
$key === 'im') {
1563 // Just cos that's the history...
1564 if ($key !== 'master_id') {
1565 $key = $this->getHeaderForRow($key);
1568 if (!$relationshipType ||
$key !== 'id') {
1569 $key = $this->getMungedFieldName($key);
1571 return $this->getMungedFieldName(
1572 ($relationshipType ?
($relationshipType . '_') : '')
1573 . ($locationType ?
($locationType . '_') : '')
1575 . ($entityLabel ?
('_' . $entityLabel) : '')
1580 * Get the compiled label for the column.
1582 * e.g 'Gender', 'Employee Of-Home-city'
1584 * @param string $key
1585 * @param string $relationshipType
1586 * @param string $locationType
1587 * @param string $entityLabel
1591 protected function getOutputSpecificationLabel($key, $relationshipType, $locationType, $entityLabel) {
1592 return ($relationshipType ?
$this->getRelationshipTypes()[$relationshipType] . '-' : '')
1593 . ($locationType ?
$locationType . '-' : '')
1594 . $this->getHeaderForRow($key)
1595 . ($entityLabel ?
'-' . $entityLabel : '');
1599 * Get the mysql field name key.
1601 * This key is locked in by tests but the reasons for the specific conventions -
1602 * ie. headings are used for keying fields in some cases, are likely
1603 * accidental rather than deliberate.
1605 * This key is used for the output sql array.
1607 * @param string $key
1608 * @param $relationshipType
1609 * @param $locationType
1610 * @param $entityLabel
1614 protected function getOutputSpecificationFieldKey($key, $relationshipType, $locationType, $entityLabel) {
1615 if ($entityLabel ||
$key === 'im') {
1616 if ($key !== 'state_province' && $key !== 'id') {
1617 // @todo - test removing this - indexing by $key should be fine...
1618 $key = $this->getHeaderForRow($key);
1621 if (!$relationshipType ||
$key !== 'id') {
1622 $key = $this->getMungedFieldName($key);
1624 $fieldKey = $this->getMungedFieldName(
1625 ($relationshipType ?
($relationshipType . '_') : '')
1626 . ($locationType ?
($locationType . '_') : '')
1628 . ($entityLabel ?
('_' . $entityLabel) : '')
1634 * Get params for the where criteria.
1638 public function getWhereParams() {
1639 if (!$this->isPostalableOnly()) {
1642 $params['is_deceased'] = ['is_deceased', '=', 0, CRM_Contact_BAO_Query
::MODE_CONTACTS
];
1643 $params['do_not_mail'] = ['do_not_mail', '=', 0, CRM_Contact_BAO_Query
::MODE_CONTACTS
];
1653 protected function buildRelationshipFieldsForRow(&$row, $contactID, $value, $field) {
1654 foreach (array_keys($value) as $property) {
1655 if ($property === 'location') {
1656 // @todo just undo all this nasty location wrangling!
1657 foreach ($value['location'] as $locationKey => $locationFields) {
1658 foreach (array_keys($locationFields) as $locationField) {
1659 $fieldKey = str_replace(' ', '_', $locationKey . '-' . $locationField);
1660 $row[$field . '_' . $fieldKey] = $this->getRelationshipValue($field, $contactID, $fieldKey);
1665 $row[$field . '_' . $property] = $this->getRelationshipValue($field, $contactID, $property);
1671 * Is this contact a household that is already set to be exported by virtue of it's household members.
1673 * @param int $contactID
1677 protected function isHouseholdToSkip($contactID) {
1678 return in_array($contactID, $this->householdsToSkip
);
1682 * Get the various arrays that we use to structure our output.
1684 * The extraction of these has been moved to a separate function for clarity and so that
1685 * tests can be added - in particular on the $outputHeaders array.
1687 * However it still feels a bit like something that I'm too polite to write down and this should be seen
1688 * as a step on the refactoring path rather than how it should be.
1691 * - outputColumns Array of columns to be exported. The values don't matter but the key must match the
1692 * alias for the field generated by BAO_Query object.
1693 * - headerRows Array of the column header strings to put in the csv header - non-associative.
1694 * - sqlColumns Array of column names for the temp table. Not too sure why outputColumns can't be used here.
1695 * - metadata Array of fields with specific parameters to pass to the translate function or another hacky nasty solution
1696 * I'm too embarassed to discuss here.
1698 * - to match the outputColumns keys (yes, the fact we ignore the output columns values & then pass another array with values
1699 * we could use does suggest further refactors. However, you future improver, do remember that every check you do
1700 * in the main DAO loop is done once per row & that coule be 100,000 times.)
1701 * Finally a pop quiz: We need the translate context because we use a function other than ts() - is this because
1702 * - a) the function used is more efficient or
1703 * - b) this code is old & outdated. Submit your answers to circular bin or better
1704 * yet find a way to comment them for posterity.
1706 public function getExportStructureArrays() {
1707 $outputColumns = $metadata = [];
1708 $queryFields = $this->getQueryFields();
1709 foreach ($this->getReturnProperties() as $key => $value) {
1710 if (($key != 'location' ||
!is_array($value)) && !$this->isRelationshipTypeKey($key)) {
1711 $outputColumns[$key] = $value;
1712 $this->addOutputSpecification($key);
1714 elseif ($this->isRelationshipTypeKey($key)) {
1715 $outputColumns[$key] = $value;
1716 foreach ($value as $relationField => $relationValue) {
1717 // below block is same as primary block (duplicate)
1718 if (isset($queryFields[$relationField]['title'])) {
1719 $this->addOutputSpecification($relationField, $key);
1721 elseif (is_array($relationValue) && $relationField == 'location') {
1722 // fix header for location type case
1723 foreach ($relationValue as $ltype => $val) {
1724 foreach (array_keys($val) as $fld) {
1725 $type = explode('-', $fld);
1726 $this->addOutputSpecification($type[0], $key, $ltype, CRM_Utils_Array
::value(1, $type));
1733 foreach ($value as $locationType => $locationFields) {
1734 foreach (array_keys($locationFields) as $locationFieldName) {
1735 $type = explode('-', $locationFieldName);
1737 $actualDBFieldName = $type[0];
1738 $daoFieldName = CRM_Utils_String
::munge($locationType) . '-' . $actualDBFieldName;
1740 if (!empty($type[1])) {
1741 $daoFieldName .= "-" . $type[1];
1743 $this->addOutputSpecification($actualDBFieldName, NULL, $locationType, CRM_Utils_Array
::value(1, $type));
1744 $metadata[$daoFieldName] = $this->getMetaDataForField($actualDBFieldName);
1745 $outputColumns[$daoFieldName] = TRUE;
1750 return [$outputColumns, $metadata];
1754 * Get default return property for export based on mode
1757 * Default Return property
1759 public function defaultReturnProperty() {
1760 // hack to add default return property based on export mode
1762 $exportMode = $this->getExportMode();
1763 if ($exportMode == CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
) {
1764 $property = 'contribution_id';
1766 elseif ($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
) {
1767 $property = 'participant_id';
1769 elseif ($exportMode == CRM_Export_Form_Select
::MEMBER_EXPORT
) {
1770 $property = 'membership_id';
1772 elseif ($exportMode == CRM_Export_Form_Select
::PLEDGE_EXPORT
) {
1773 $property = 'pledge_id';
1775 elseif ($exportMode == CRM_Export_Form_Select
::CASE_EXPORT
) {
1776 $property = 'case_id';
1778 elseif ($exportMode == CRM_Export_Form_Select
::GRANT_EXPORT
) {
1779 $property = 'grant_id';
1781 elseif ($exportMode == CRM_Export_Form_Select
::ACTIVITY_EXPORT
) {
1782 $property = 'activity_id';
1788 * Determine the required return properties from the input parameters.
1792 public function determineReturnProperties() {
1793 if ($this->getRequestedFields()) {
1794 $returnProperties = [];
1795 foreach ($this->getRequestedFields() as $key => $value) {
1796 $fieldName = $value['name'];
1797 $locationName = !empty($value['location_type_id']) ? CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_Address', 'location_type_id', $value['location_type_id']) : NULL;
1798 $relationshipTypeKey = !empty($value['relationship_type_id']) ?
$value['relationship_type_id'] . '_' . $value['relationship_direction'] : NULL;
1799 if (!$fieldName ||
$this->isHouseholdMergeRelationshipTypeKey($relationshipTypeKey)) {
1803 if ($this->isRelationshipTypeKey($relationshipTypeKey)) {
1804 $returnProperties[$relationshipTypeKey] = $this->setRelationshipReturnProperties($value, $relationshipTypeKey);
1806 elseif ($locationName) {
1807 if ($fieldName === 'phone') {
1808 $returnProperties['location'][$locationName]['phone-' . $value['phone_type_id'] ??
NULL] = 1;
1810 elseif ($fieldName === 'im') {
1811 $returnProperties['location'][$locationName]['im-' . $value['im_provider_id'] ??
NULL] = 1;
1814 $returnProperties['location'][$locationName][$fieldName] = 1;
1818 //hack to fix component fields
1819 //revert mix of event_id and title
1820 if ($fieldName == 'event_id') {
1821 $returnProperties['event_id'] = 1;
1824 $returnProperties[$fieldName] = 1;
1828 $defaultExportMode = $this->defaultReturnProperty();
1829 if ($defaultExportMode) {
1830 $returnProperties[$defaultExportMode] = 1;
1834 $returnProperties = $this->getDefaultReturnProperties();
1836 if ($this->isMergeSameHousehold()) {
1837 $returnProperties['id'] = 1;
1839 if ($this->isMergeSameAddress()) {
1840 $returnProperties['addressee'] = 1;
1841 $returnProperties['postal_greeting'] = 1;
1842 $returnProperties['email_greeting'] = 1;
1843 $returnProperties['street_name'] = 1;
1844 $returnProperties['household_name'] = 1;
1845 $returnProperties['street_address'] = 1;
1846 $returnProperties['city'] = 1;
1847 $returnProperties['state_province'] = 1;
1850 return $returnProperties;
1854 * @param object $query
1855 * CRM_Contact_BAO_Query
1860 public function getGroupBy($query) {
1862 $returnProperties = $this->getReturnProperties();
1863 $exportMode = $this->getExportMode();
1864 $queryMode = $this->getQueryMode();
1865 if (!empty($returnProperties['tags']) ||
!empty($returnProperties['groups']) ||
1866 CRM_Utils_Array
::value('notes', $returnProperties) ||
1868 ($queryMode & CRM_Contact_BAO_Query
::MODE_CONTACTS
&& $query->_useGroupBy
)
1870 $groupBy = "contact_a.id";
1873 switch ($exportMode) {
1874 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
1875 $groupBy = 'civicrm_contribution.id';
1876 if (CRM_Contribute_BAO_Query
::isSoftCreditOptionEnabled()) {
1877 // especial group by when soft credit columns are included
1878 $groupBy = ['contribution_search_scredit_combined.id', 'contribution_search_scredit_combined.scredit_id'];
1882 case CRM_Export_Form_Select
::EVENT_EXPORT
:
1883 $groupBy = 'civicrm_participant.id';
1886 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
1887 $groupBy = "civicrm_membership.id";
1891 if ($queryMode & CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
1892 $groupBy = "civicrm_activity.id ";
1895 return $groupBy ?
' GROUP BY ' . implode(', ', (array) $groupBy) : '';
1899 * @param int $contactId
1903 public function replaceMergeTokens($contactId) {
1908 'postal_greeting' => $this->getPostalGreetingTemplate(),
1909 'addressee' => $this->getAddresseeGreetingTemplate(),
1911 foreach ($greetingFields as $greeting => $greetingLabel) {
1912 $tokens = CRM_Utils_Token
::getTokens($greetingLabel);
1913 if (!empty($tokens)) {
1914 if (empty($contact)) {
1919 $contact = civicrm_api('contact', 'get', $values);
1921 if (!empty($contact['is_error'])) {
1924 $contact = $contact['values'][$contact['id']];
1927 $tokens = ['contact' => $greetingLabel];
1928 $greetings[$greeting] = CRM_Utils_Token
::replaceContactTokens($greetingLabel, $contact, NULL, $tokens);
1935 * Build array for merging same addresses.
1937 * @param string $sql
1939 public function buildMasterCopyArray($sql) {
1942 $dao = CRM_Core_DAO
::executeQuery($sql);
1944 while ($dao->fetch()) {
1945 $masterID = $dao->master_id
;
1946 $copyID = $dao->copy_id
;
1948 $this->cacheContactGreetings((int) $dao->master_contact_id
);
1949 $this->cacheContactGreetings((int) $dao->copy_contact_id
);
1951 if (!isset($this->contactsToMerge
[$masterID])) {
1952 // check if this is an intermediate child
1953 // this happens if there are 3 or more matches a,b, c
1954 // the above query will return a, b / a, c / b, c
1955 // we might be doing a bit more work, but for now its ok, unless someone
1956 // knows how to fix the query above
1957 if (isset($parents[$masterID])) {
1958 $masterID = $parents[$masterID];
1961 $this->contactsToMerge
[$masterID] = [
1962 'addressee' => $this->getContactGreeting((int) $dao->master_contact_id
, 'addressee', $dao->master_addressee
),
1964 'postalGreeting' => $this->getContactGreeting((int) $dao->master_contact_id
, 'postal_greeting', $dao->master_postal_greeting
),
1966 $this->contactsToMerge
[$masterID]['emailGreeting'] = &$this->contactsToMerge
[$masterID]['postalGreeting'];
1969 $parents[$copyID] = $masterID;
1971 if (!array_key_exists($copyID, $this->contactsToMerge
[$masterID]['copy'])) {
1972 $copyPostalGreeting = $this->getContactPortionOfGreeting((int) $dao->copy_contact_id
, (int) $dao->copy_postal_greeting_id
, 'postal_greeting', $dao->copy_postal_greeting
);
1973 if ($copyPostalGreeting) {
1974 $this->contactsToMerge
[$masterID]['postalGreeting'] = "{$this->contactsToMerge[$masterID]['postalGreeting']}, {$copyPostalGreeting}";
1975 // if there happens to be a duplicate, remove it
1976 $this->contactsToMerge
[$masterID]['postalGreeting'] = str_replace(" {$copyPostalGreeting},", "", $this->contactsToMerge
[$masterID]['postalGreeting']);
1979 $copyAddressee = $this->getContactPortionOfGreeting((int) $dao->copy_contact_id
, (int) $dao->copy_addressee_id
, 'addressee', $dao->copy_addressee
);
1980 if ($copyAddressee) {
1981 $this->contactsToMerge
[$masterID]['addressee'] = "{$this->contactsToMerge[$masterID]['addressee']}, " . trim($copyAddressee);
1984 if (!isset($this->contactsToMerge
[$masterID]['copy'][$copyID])) {
1985 // If it was set in the first run through - share routine, don't subsequently clobber.
1986 $this->contactsToMerge
[$masterID]['copy'][$copyID] = $copyAddressee ??
$dao->copy_addressee
;
1992 * Merge contacts with the same address.
1994 public function mergeSameAddress() {
1996 $tableName = $this->getTemporaryTable();
1998 // find all the records that have the same street address BUT not in a household
1999 // require match on city and state as well
2001 SELECT r1.id as master_id,
2002 r1.civicrm_primary_id as master_contact_id,
2003 r1.postal_greeting as master_postal_greeting,
2004 r1.postal_greeting_id as master_postal_greeting_id,
2005 r1.addressee as master_addressee,
2006 r1.addressee_id as master_addressee_id,
2008 r2.civicrm_primary_id as copy_contact_id,
2009 r2.postal_greeting as copy_postal_greeting,
2010 r2.postal_greeting_id as copy_postal_greeting_id,
2011 r2.addressee as copy_addressee,
2012 r2.addressee_id as copy_addressee_id
2014 LEFT JOIN $tableName r2 ON ( r1.street_address = r2.street_address AND
2015 r1.city = r2.city AND
2016 r1.state_province_id = r2.state_province_id )
2017 WHERE ( r1.street_address != '' )
2021 $this->buildMasterCopyArray($sql);
2023 foreach ($this->contactsToMerge
as $masterID => $values) {
2026 SET addressee = %1, postal_greeting = %2, email_greeting = %3
2030 1 => [$values['addressee'], 'String'],
2031 2 => [$values['postalGreeting'], 'String'],
2032 3 => [$values['emailGreeting'], 'String'],
2033 4 => [$masterID, 'Integer'],
2035 CRM_Core_DAO
::executeQuery($sql, $params);
2037 // delete all copies
2038 $deleteIDs = array_keys($values['copy']);
2039 $deleteIDString = implode(',', $deleteIDs);
2041 DELETE FROM $tableName
2042 WHERE id IN ( $deleteIDString )
2044 CRM_Core_DAO
::executeQuery($sql);
2049 * The function unsets static part of the string, if token is the dynamic part.
2051 * Example: 'Hello {contact.first_name}' => converted to => '{contact.first_name}'
2052 * i.e 'Hello Alan' => converted to => 'Alan'
2054 * @param string $parsedString
2055 * @param string $defaultGreeting
2056 * @param string $greetingLabel
2060 public function trimNonTokensFromAddressString(
2061 &$parsedString, $defaultGreeting,
2064 $greetingLabel = empty($greetingLabel) ?
$defaultGreeting : $greetingLabel;
2066 $stringsToBeReplaced = preg_replace('/(\{[a-zA-Z._ ]+\})/', ';;', $greetingLabel);
2067 $stringsToBeReplaced = explode(';;', $stringsToBeReplaced);
2068 foreach ($stringsToBeReplaced as $key => $string) {
2069 // to keep one space
2070 $stringsToBeReplaced[$key] = ltrim($string);
2072 $parsedString = str_replace($stringsToBeReplaced, "", $parsedString);
2074 return $parsedString;
2078 * Preview export output.
2083 public function getPreview($limit) {
2085 list($outputColumns, $metadata) = $this->getExportStructureArrays();
2086 $query = $this->runQuery([], '');
2087 CRM_Core_DAO
::disableFullGroupByMode();
2088 $result = CRM_Core_DAO
::executeQuery($query[1] . ' LIMIT ' . (int) $limit);
2089 CRM_Core_DAO
::reenableFullGroupByMode();
2090 while ($result->fetch()) {
2091 $rows[] = $this->buildRow($query[0], $result, $outputColumns, $metadata, [], []);
2097 * Set the template strings to be used when merging two contacts with the same address.
2099 * @param array $formValues
2100 * Values from first form. In this case we care about the keys
2103 * - address_greeting
2108 protected function setGreetingStringsForSameAddressMerge($formValues) {
2109 $greetingOptions = CRM_Export_Form_Select
::getGreetingOptions();
2111 if (!empty($greetingOptions)) {
2112 // Greeting options is keyed by 'postal_greeting' or 'addressee'.
2113 foreach ($greetingOptions as $key => $value) {
2114 $option = $formValues[$key] ??
NULL;
2116 if ($greetingOptions[$key][$option] == ts('Other')) {
2117 $formValues[$key] = $formValues["{$key}_other"];
2119 elseif ($greetingOptions[$key][$option] == ts('List of names')) {
2120 $formValues[$key] = '';
2123 $formValues[$key] = $greetingOptions[$key][$option];
2128 if (!empty($formValues['postal_greeting'])) {
2129 $this->setPostalGreetingTemplate($formValues['postal_greeting']);
2131 if (!empty($formValues['addressee'])) {
2132 $this->setAddresseeGreetingTemplate($formValues['addressee']);
2137 * Create the temporary table for output.
2139 public function createTempTable() {
2140 //creating a temporary table for the search result that need be exported
2141 $exportTempTable = CRM_Utils_SQL_TempTable
::build()->setDurable()->setCategory('export');
2142 $sqlColumns = $this->getSQLColumns();
2143 // also create the sql table
2144 $exportTempTable->drop();
2146 $sql = " id int unsigned NOT NULL AUTO_INCREMENT, ";
2147 if (!empty($sqlColumns)) {
2148 $sql .= implode(",\n", array_values($sqlColumns)) . ',';
2151 $sql .= "\n PRIMARY KEY ( id )";
2153 // add indexes for street_address and household_name if present
2157 'civicrm_primary_id',
2160 foreach ($addIndices as $index) {
2161 if (isset($sqlColumns[$index])) {
2163 INDEX index_{$index}( $index )
2168 $exportTempTable->createWithColumns($sql);
2169 $this->setTemporaryTable($exportTempTable->getName());
2173 * Get the values of linked household contact.
2175 * @param CRM_Core_DAO $relDAO
2176 * @param array $value
2177 * @param string $field
2180 * @throws \Exception
2182 public function fetchRelationshipDetails($relDAO, $value, $field, &$row) {
2183 $phoneTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id');
2184 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
2185 $i18n = CRM_Core_I18n
::singleton();
2186 $field = $field . '_';
2188 foreach ($value as $relationField => $relationValue) {
2189 if (is_object($relDAO) && property_exists($relDAO, $relationField)) {
2190 $fieldValue = $relDAO->$relationField;
2191 if ($relationField == 'phone_type_id') {
2192 $fieldValue = $phoneTypes[$relationValue];
2194 elseif ($relationField == 'provider_id') {
2195 $fieldValue = $imProviders[$relationValue] ??
NULL;
2198 elseif (is_object($relDAO) && in_array($relationField, [
2203 //special case for greeting replacement
2204 $fldValue = "{$relationField}_display";
2205 $fieldValue = $relDAO->$fldValue;
2208 elseif (is_object($relDAO) && $relationField == 'state_province') {
2209 $fieldValue = CRM_Core_PseudoConstant
::stateProvince($relDAO->state_province_id
);
2211 elseif (is_object($relDAO) && $relationField == 'country') {
2212 $fieldValue = CRM_Core_PseudoConstant
::country($relDAO->country_id
);
2217 $relPrefix = $field . $relationField;
2219 if (is_object($relDAO) && $relationField == 'id') {
2220 $row[$relPrefix] = $relDAO->contact_id
;
2222 elseif (is_array($relationValue) && $relationField == 'location') {
2223 foreach ($relationValue as $ltype => $val) {
2224 // If the location name has a space in it the we need to handle that. This
2225 // is kinda hacky but specifically covered in the ExportTest so later efforts to
2226 // improve it should be secure in the knowled it will be caught.
2227 $ltype = str_replace(' ', '_', $ltype);
2228 foreach (array_keys($val) as $fld) {
2229 $type = explode('-', $fld);
2230 $fldValue = "{$ltype}-" . $type[0];
2231 if (!empty($type[1])) {
2232 $fldValue .= "-" . $type[1];
2234 // CRM-3157: localise country, region (both have ‘country’ context)
2235 // and state_province (‘province’ context)
2237 case (!is_object($relDAO)):
2238 $row[$field . '_' . $fldValue] = '';
2241 case in_array('country', $type):
2242 case in_array('world_region', $type):
2243 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
2244 ['context' => 'country']
2248 case in_array('state_province', $type):
2249 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
2250 ['context' => 'province']
2255 $row[$field . '_' . $fldValue] = $relDAO->$fldValue;
2261 elseif (isset($fieldValue) && $fieldValue != '') {
2262 //check for custom data
2263 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($relationField)) {
2264 $row[$relPrefix] = CRM_Core_BAO_CustomField
::displayValue($fieldValue, $cfID);
2267 //normal relationship fields
2268 // CRM-3157: localise country, region (both have ‘country’ context) and state_province (‘province’ context)
2269 switch ($relationField) {
2271 case 'world_region':
2272 $row[$relPrefix] = $i18n->crm_translate($fieldValue, ['context' => 'country']);
2275 case 'state_province':
2276 $row[$relPrefix] = $i18n->crm_translate($fieldValue, ['context' => 'province']);
2280 $row[$relPrefix] = $fieldValue;
2286 // if relation field is empty or null
2287 $row[$relPrefix] = '';
2293 * Write to the csv from the temp table.
2295 public function writeCSVFromTable() {
2297 $headerRows = $this->getHeaderRows();
2298 $exportTempTable = $this->getTemporaryTable();
2299 $exportMode = $this->getExportMode();
2300 $sqlColumns = $this->getSQLColumns();
2301 $componentTable = $this->getComponentTable();
2302 $ids = $this->getIds();
2303 CRM_Utils_Hook
::export($exportTempTable, $headerRows, $sqlColumns, $exportMode, $componentTable, $ids);
2304 if ($exportMode !== $this->getExportMode() ||
$componentTable !== $this->getComponentTable()) {
2305 CRM_Core_Error
::deprecatedFunctionWarning('altering the export mode and/or component table in the hook is no longer supported.');
2307 if ($ids !== $this->getIds()) {
2308 CRM_Core_Error
::deprecatedFunctionWarning('altering the ids in the hook is no longer supported.');
2310 if ($exportTempTable !== $this->getTemporaryTable()) {
2311 CRM_Core_Error
::deprecatedFunctionWarning('altering the export table in the hook is deprecated (in some flows the table itself will be)');
2312 $this->setTemporaryTable($exportTempTable);
2314 $exportTempTable = $this->getTemporaryTable();
2315 $writeHeader = TRUE;
2317 // increase this number a lot to avoid making too many queries
2318 // LIMIT is not much faster than a no LIMIT query
2322 $query = "SELECT * FROM $exportTempTable";
2324 $this->instantiateTempTable($headerRows);
2326 $limitQuery = $query . "
2327 LIMIT $offset, $limit
2329 $dao = CRM_Core_DAO
::executeQuery($limitQuery);
2335 $componentDetails = [];
2336 while ($dao->fetch()) {
2339 foreach (array_keys($sqlColumns) as $column) {
2340 $row[$column] = $dao->$column;
2342 $componentDetails[] = $row;
2344 $this->writeRows($headerRows, $componentDetails);
2351 * Set up the temp table.
2353 * @param array $headerRows
2355 protected function instantiateTempTable(array $headerRows) {
2356 CRM_Utils_System
::download(CRM_Utils_String
::munge($this->getExportFileName()),
2358 CRM_Core_DAO
::$_nullObject,
2362 // Output UTF BOM so that MS Excel copes with diacritics. This is recommended as
2363 // the Windows variant but is tested with MS Excel for Mac (Office 365 v 16.31)
2364 // and it continues to work on Libre Office, Numbers, Notes etc.
2365 echo "\xEF\xBB\xBF";
2366 CRM_Core_Report_Excel
::makeCSVTable($headerRows, [], TRUE);
2370 * Write rows to the csv.
2372 * @param array $headerRows
2373 * @param array $rows
2375 protected function writeRows(array $headerRows, array $rows) {
2376 if (!empty($rows)) {
2377 CRM_Core_Report_Excel
::makeCSVTable($headerRows, $rows, FALSE);
2382 * Cache the greeting fields for the given contact.
2384 * @param int $contactID
2386 protected function cacheContactGreetings(int $contactID) {
2387 if (!isset($this->contactGreetingFields
[$contactID])) {
2388 $this->contactGreetingFields
[$contactID] = $this->replaceMergeTokens($contactID);
2393 * Get the greeting value for the given contact.
2395 * The values have already been cached so we are grabbing the value at this point.
2397 * @param int $contactID
2398 * @param string $type
2399 * postal_greeting|addressee|email_greeting
2400 * @param string $default
2404 protected function getContactGreeting(int $contactID, string $type, string $default) {
2405 return CRM_Utils_Array
::value($type,
2406 $this->contactGreetingFields
[$contactID], $default
2411 * Get the portion of the greeting string that relates to the contact.
2413 * For example if the greeting id 'Dear Sarah' we are going to combine it with 'Dear Mike'
2414 * so we want to strip the 'Dear ' and just get 'Sarah
2415 * @param int $contactID
2416 * @param int $greetingID
2417 * @param string $type
2418 * postal_greeting, addressee (email_greeting not currently implemented for unknown reasons.
2419 * @param string $defaultGreeting
2421 * @return mixed|string
2423 protected function getContactPortionOfGreeting(int $contactID, int $greetingID, string $type, string $defaultGreeting) {
2424 $copyPostalGreeting = $this->getContactGreeting($contactID, $type, $defaultGreeting);
2425 $template = $type === 'postal_greeting' ?
$this->getPostalGreetingTemplate() : $this->getAddresseeGreetingTemplate();
2426 if ($copyPostalGreeting) {
2427 $copyPostalGreeting = $this->trimNonTokensFromAddressString($copyPostalGreeting,
2428 $this->greetingOptions
[$type][$greetingID],
2432 return $copyPostalGreeting;