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 * Get additional non-visible fields for address merge purposes.
108 public function getAdditionalFieldsForSameAddressMerge(): array {
109 return $this->additionalFieldsForSameAddressMerge
;
113 * Set additional non-visible fields for address merge purposes.
115 public function setAdditionalFieldsForSameAddressMerge() {
116 if ($this->isMergeSameAddress
) {
117 $fields = ['id', 'master_id', 'state_province_id', 'postal_greeting_id', 'addressee_id'];
118 foreach ($fields as $index => $field) {
119 if (!empty($this->getReturnProperties()[$field])) {
120 unset($fields[$index]);
123 $this->additionalFieldsForSameAddressMerge
= array_fill_keys($fields, 1);
128 * Should contacts with the same address be merged.
132 public function isMergeSameAddress(): bool {
133 return $this->isMergeSameAddress
;
137 * Set same address is to be merged.
139 * @param bool $isMergeSameAddress
141 public function setIsMergeSameAddress(bool $isMergeSameAddress) {
142 $this->isMergeSameAddress
= $isMergeSameAddress;
146 * Additional fields required to export postal fields.
150 protected $additionalFieldsForPostalExport = [];
153 * Get additional fields required to do a postal export.
157 public function getAdditionalFieldsForPostalExport() {
158 return $this->additionalFieldsForPostalExport
;
162 * Set additional fields required for a postal export.
164 public function setAdditionalFieldsForPostalExport() {
165 if ($this->getRequestedFields() && $this->isPostalableOnly()) {
166 $fields = ['is_deceased', 'do_not_mail', 'street_address', 'supplemental_address_1'];
167 foreach ($fields as $index => $field) {
168 if (!empty($this->getReturnProperties()[$field])) {
169 unset($field[$index]);
172 $this->additionalFieldsForPostalExport
= array_fill_keys($fields, 1);
177 * Only export contacts that can receive postal mail.
179 * Includes being alive, having an address & not having do_not_mail.
183 protected $isPostalableOnly;
186 * Key representing the head of household in the relationship array.
188 * e.g. ['8_b_a' => 'Household Member Is', '8_a_b = 'Household Member Of'.....]
192 protected $relationshipTypes = [];
195 * Array of properties to retrieve for relationships.
199 protected $relationshipReturnProperties = [];
202 * IDs of households that have already been exported.
206 protected $exportedHouseholds = [];
209 * Households to skip during export as they will be exported via their relationships anyway.
213 protected $householdsToSkip = [];
216 * Additional fields to return.
218 * This doesn't make much sense when we have a fields set but search build add it's own onto
219 * the 'Primary fields' (all) option.
223 protected $additionalRequestedReturnProperties = [];
226 * Get additional return properties.
230 public function getAdditionalRequestedReturnProperties() {
231 return $this->additionalRequestedReturnProperties
;
235 * Set additional return properties.
237 * @param array $value
239 public function setAdditionalRequestedReturnProperties($value) {
241 if (!empty($value['group'])) {
242 unset($value['group']);
243 $value['groups'] = 1;
245 $this->additionalRequestedReturnProperties
= $value;
249 * Get return properties by relationship.
252 public function getRelationshipReturnProperties() {
253 return $this->relationshipReturnProperties
;
257 * Export values for related contacts.
261 protected $relatedContactValues = [];
266 protected $returnProperties = [];
271 protected $outputSpecification = [];
276 protected $componentTable = '';
281 public function getComponentTable() {
282 return $this->componentTable
;
286 * Set the component table (if any).
288 * @param string $componentTable
290 public function setComponentTable($componentTable) {
291 $this->componentTable
= $componentTable;
295 * Clause from component search.
299 protected $componentClause = '';
304 public function getComponentClause() {
305 return $this->componentClause
;
309 * @param string $componentClause
311 public function setComponentClause($componentClause) {
312 $this->componentClause
= $componentClause;
316 * Name of a temporary table created to hold the results.
318 * Current decision making on when to create a temp table is kinda bad so this might change
319 * a bit as it is reviewed but basically we need a temp table or similar to calculate merging
320 * addresses. Merging households is handled in php. We create a temp table even when we don't need them.
324 protected $temporaryTable;
329 public function getTemporaryTable(): string {
330 return $this->temporaryTable
;
334 * @param string $temporaryTable
336 public function setTemporaryTable(string $temporaryTable) {
337 $this->temporaryTable
= $temporaryTable;
340 protected $postalGreetingTemplate;
345 public function getPostalGreetingTemplate() {
346 return $this->postalGreetingTemplate
;
350 * @param mixed $postalGreetingTemplate
352 public function setPostalGreetingTemplate($postalGreetingTemplate) {
353 $this->postalGreetingTemplate
= $postalGreetingTemplate;
359 public function getAddresseeGreetingTemplate() {
360 return $this->addresseeGreetingTemplate
;
364 * @param mixed $addresseeGreetingTemplate
366 public function setAddresseeGreetingTemplate($addresseeGreetingTemplate) {
367 $this->addresseeGreetingTemplate
= $addresseeGreetingTemplate;
370 protected $addresseeGreetingTemplate;
373 * CRM_Export_BAO_ExportProcessor constructor.
375 * @param int $exportMode
376 * @param array|null $requestedFields
377 * @param string $queryOperator
378 * @param bool $isMergeSameHousehold
379 * @param bool $isPostalableOnly
380 * @param bool $isMergeSameAddress
381 * @param array $formValues
382 * Values from the export options form on contact export. We currently support these keys
385 * - addresee_greeting
388 public function __construct($exportMode, $requestedFields, $queryOperator, $isMergeSameHousehold = FALSE, $isPostalableOnly = FALSE, $isMergeSameAddress = FALSE, $formValues = []) {
389 $this->setExportMode($exportMode);
390 $this->setQueryMode();
391 $this->setQueryOperator($queryOperator);
392 $this->setRequestedFields($requestedFields);
393 $this->setRelationshipTypes();
394 $this->setIsMergeSameHousehold($isMergeSameHousehold);
395 $this->setIsPostalableOnly($isPostalableOnly);
396 $this->setIsMergeSameAddress($isMergeSameAddress);
397 $this->setReturnProperties($this->determineReturnProperties());
398 $this->setAdditionalFieldsForSameAddressMerge();
399 $this->setAdditionalFieldsForPostalExport();
400 $this->setHouseholdMergeReturnProperties();
401 $this->setGreetingStringsForSameAddressMerge($formValues);
407 public function isPostalableOnly() {
408 return $this->isPostalableOnly
;
412 * @param bool $isPostalableOnly
414 public function setIsPostalableOnly($isPostalableOnly) {
415 $this->isPostalableOnly
= $isPostalableOnly;
421 public function getRequestedFields() {
422 return empty($this->requestedFields
) ?
NULL : $this->requestedFields
;
426 * @param array|null $requestedFields
428 public function setRequestedFields($requestedFields) {
429 $this->requestedFields
= $requestedFields;
435 public function getReturnProperties() {
436 return array_merge($this->returnProperties
, $this->getAdditionalRequestedReturnProperties(), $this->getAdditionalFieldsForSameAddressMerge(), $this->getAdditionalFieldsForPostalExport());
440 * @param array $returnProperties
442 public function setReturnProperties($returnProperties) {
443 $this->returnProperties
= $returnProperties;
449 public function getRelationshipTypes() {
450 return $this->relationshipTypes
;
455 public function setRelationshipTypes() {
456 $this->relationshipTypes
= CRM_Contact_BAO_Relationship
::getContactRelationshipType(
468 * Set the value for a relationship type field.
470 * In this case we are building up an array of properties for a related contact.
472 * These may be used for direct exporting or for merge to household depending on the
475 * @param string $relationshipType
476 * @param int $contactID
477 * @param string $field
478 * @param string $value
480 public function setRelationshipValue($relationshipType, $contactID, $field, $value) {
481 $this->relatedContactValues
[$relationshipType][$contactID][$field] = $value;
482 if ($field === 'id') {
483 $this->householdsToSkip
[] = $value;
488 * Get the value for a relationship type field.
490 * In this case we are building up an array of properties for a related contact.
492 * These may be used for direct exporting or for merge to household depending on the
495 * @param string $relationshipType
496 * @param int $contactID
497 * @param string $field
501 public function getRelationshipValue($relationshipType, $contactID, $field) {
502 return isset($this->relatedContactValues
[$relationshipType][$contactID][$field]) ?
$this->relatedContactValues
[$relationshipType][$contactID][$field] : '';
506 * Get the id of the related household.
508 * @param int $contactID
509 * @param string $relationshipType
513 public function getRelatedHouseholdID($contactID, $relationshipType) {
514 return $this->relatedContactValues
[$relationshipType][$contactID]['id'];
518 * Has the household already been exported.
520 * @param int $housholdContactID
524 public function isHouseholdExported($housholdContactID) {
525 return isset($this->exportedHouseholds
[$housholdContactID]);
532 public function isMergeSameHousehold() {
533 return $this->isMergeSameHousehold
;
537 * @param bool $isMergeSameHousehold
539 public function setIsMergeSameHousehold($isMergeSameHousehold) {
540 $this->isMergeSameHousehold
= $isMergeSameHousehold;
544 * Return relationship types for household merge.
548 public function getHouseholdRelationshipTypes() {
549 if (!$this->isMergeSameHousehold()) {
553 CRM_Utils_Array
::key('Household Member of', $this->getRelationshipTypes()),
554 CRM_Utils_Array
::key('Head of Household for', $this->getRelationshipTypes()),
562 public function isRelationshipTypeKey($fieldName) {
563 return array_key_exists($fieldName, $this->relationshipTypes
);
570 public function isHouseholdMergeRelationshipTypeKey($fieldName) {
571 return in_array($fieldName, $this->getHouseholdRelationshipTypes());
577 public function getQueryOperator() {
578 return $this->queryOperator
;
582 * @param string $queryOperator
584 public function setQueryOperator($queryOperator) {
585 $this->queryOperator
= $queryOperator;
591 public function getQueryFields() {
592 return $this->queryFields
;
596 * @param array $queryFields
598 public function setQueryFields($queryFields) {
599 // legacy hacks - we add these to queryFields because this
600 // pseudometadata is currently required.
601 $queryFields['im_provider']['pseudoconstant']['var'] = 'imProviders';
602 $queryFields['country']['context'] = 'country';
603 $queryFields['world_region']['context'] = 'country';
604 $queryFields['state_province']['context'] = 'province';
605 $queryFields['contact_id'] = ['title' => ts('Contact ID'), 'type' => CRM_Utils_Type
::T_INT
];
606 $this->queryFields
= $queryFields;
612 public function getQueryMode() {
613 return $this->queryMode
;
617 * Set the query mode based on the export mode.
619 public function setQueryMode() {
621 switch ($this->getExportMode()) {
622 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
623 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
;
626 case CRM_Export_Form_Select
::EVENT_EXPORT
:
627 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_EVENT
;
630 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
631 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_MEMBER
;
634 case CRM_Export_Form_Select
::PLEDGE_EXPORT
:
635 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_PLEDGE
;
638 case CRM_Export_Form_Select
::CASE_EXPORT
:
639 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_CASE
;
642 case CRM_Export_Form_Select
::GRANT_EXPORT
:
643 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_GRANT
;
646 case CRM_Export_Form_Select
::ACTIVITY_EXPORT
:
647 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_ACTIVITY
;
651 $this->queryMode
= CRM_Contact_BAO_Query
::MODE_CONTACTS
;
658 public function getExportMode() {
659 return $this->exportMode
;
663 * @param int $exportMode
665 public function setExportMode($exportMode) {
666 $this->exportMode
= $exportMode;
670 * Get the name for the export file.
674 public function getExportFileName() {
675 switch ($this->getExportMode()) {
676 case CRM_Export_Form_Select
::CONTACT_EXPORT
:
677 return ts('CiviCRM Contact Search');
679 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
680 return ts('CiviCRM Contribution Search');
682 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
683 return ts('CiviCRM Member Search');
685 case CRM_Export_Form_Select
::EVENT_EXPORT
:
686 return ts('CiviCRM Participant Search');
688 case CRM_Export_Form_Select
::PLEDGE_EXPORT
:
689 return ts('CiviCRM Pledge Search');
691 case CRM_Export_Form_Select
::CASE_EXPORT
:
692 return ts('CiviCRM Case Search');
694 case CRM_Export_Form_Select
::GRANT_EXPORT
:
695 return ts('CiviCRM Grant Search');
697 case CRM_Export_Form_Select
::ACTIVITY_EXPORT
:
698 return ts('CiviCRM Activity Search');
701 // Legacy code suggests the value could be 'financial' - ie. something
702 // other than what should be accepted. However, I suspect that this line is
704 return ts('CiviCRM Search');
709 * Get the label for the header row based on the field to output.
711 * @param string $field
715 public function getHeaderForRow($field) {
716 if (substr($field, -11) == 'campaign_id') {
717 // @todo - set this correctly in the xml rather than here.
718 // This will require a generalised handling cleanup
719 return ts('Campaign ID');
721 if ($this->isMergeSameHousehold() && $field === 'id') {
722 return ts('Household ID');
724 elseif (isset($this->getQueryFields()[$field]['title'])) {
725 return $this->getQueryFields()[$field]['title'];
727 elseif ($this->isExportPaymentFields() && array_key_exists($field, $this->getcomponentPaymentFields())) {
728 return CRM_Utils_Array
::value($field, $this->getcomponentPaymentFields());
741 public function runQuery($params, $order) {
742 $returnProperties = $this->getReturnProperties();
743 $params = array_merge($params, $this->getWhereParams());
745 $query = new CRM_Contact_BAO_Query($params, $returnProperties, NULL,
746 FALSE, FALSE, $this->getQueryMode(),
747 FALSE, TRUE, TRUE, NULL, $this->getQueryOperator()
752 $query->_sort
= $order;
753 list($select, $from, $where, $having) = $query->query();
754 $this->setQueryFields($query->_fields
);
755 $whereClauses = ['trash_clause' => "contact_a.is_deleted != 1"];
756 if ($this->getRequestedFields() && ($this->getComponentTable())) {
757 $from .= " INNER JOIN " . $this->getComponentTable() . " ctTable ON ctTable.contact_id = contact_a.id ";
759 elseif ($this->getComponentClause()) {
760 $whereClauses[] = $this->getComponentClause();
763 // CRM-13982 - check if is deleted
764 foreach ($params as $value) {
765 if ($value[0] == 'contact_is_deleted') {
766 unset($whereClauses['trash_clause']);
770 if ($this->isPostalableOnly
) {
771 if (array_key_exists('street_address', $returnProperties)) {
772 $addressWhere = " civicrm_address.street_address <> ''";
773 if (array_key_exists('supplemental_address_1', $returnProperties)) {
774 // We need this to be an OR rather than AND on the street_address so, hack it in.
775 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
776 'address_options', TRUE, NULL, TRUE
778 if (!empty($addressOptions['supplemental_address_1'])) {
779 $addressWhere .= " OR civicrm_address.supplemental_address_1 <> ''";
782 $whereClauses['address'] = $addressWhere;
787 $where = "WHERE " . implode(' AND ', $whereClauses);
790 $where .= " AND " . implode(' AND ', $whereClauses);
793 $groupBy = $this->getGroupBy($query);
794 $queryString = "$select $from $where $having $groupBy";
796 // always add contact_a.id to the ORDER clause
797 // so the order is deterministic
799 if (strpos('contact_a.id', $order) === FALSE) {
800 $order .= ", contact_a.id";
803 list($field, $dir) = explode(' ', $order, 2);
804 $field = trim($field);
805 if (!empty($this->getReturnProperties()[$field])) {
807 $queryString .= " ORDER BY $order";
810 return [$query, $queryString];
814 * Add a row to the specification for how to output data.
817 * @param string $relationshipType
818 * @param string $locationType
819 * @param int $entityTypeID phone_type_id or provider_id for phone or im fields.
821 public function addOutputSpecification($key, $relationshipType = NULL, $locationType = NULL, $entityTypeID = NULL) {
824 if ($key === 'phone') {
825 $entityLabel = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_Phone', 'phone_type_id', $entityTypeID);
828 $entityLabel = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_IM', 'provider_id', $entityTypeID);
832 // These oddly constructed keys are for legacy reasons. Altering them will affect test success
833 // but in time it may be good to rationalise them.
834 $label = $this->getOutputSpecificationLabel($key, $relationshipType, $locationType, $entityLabel);
835 $index = $this->getOutputSpecificationIndex($key, $relationshipType, $locationType, $entityLabel);
836 $fieldKey = $this->getOutputSpecificationFieldKey($key, $relationshipType, $locationType, $entityLabel);
838 $this->outputSpecification
[$index]['header'] = $label;
839 $this->outputSpecification
[$index]['sql_columns'] = $this->getSqlColumnDefinition($fieldKey, $key);
841 if ($relationshipType && $this->isHouseholdMergeRelationshipTypeKey($relationshipType)) {
842 $this->setColumnAsCalculationOnly($index);
844 $this->outputSpecification
[$index]['metadata'] = $this->getMetaDataForField($key);
848 * Get the metadata for the given field.
854 public function getMetaDataForField($key) {
855 $mappings = ['contact_id' => 'id'];
856 if (isset($this->getQueryFields()[$key])) {
857 return $this->getQueryFields()[$key];
859 if (isset($mappings[$key])) {
860 return $this->getQueryFields()[$mappings[$key]];
868 public function setSqlColumnDefn($key) {
869 $this->outputSpecification
[$this->getMungedFieldName($key)]['sql_columns'] = $this->getSqlColumnDefinition($key, $this->getMungedFieldName($key));
873 * Mark a column as only required for calculations.
875 * Do not include the row with headers.
877 * @param string $column
879 public function setColumnAsCalculationOnly($column) {
880 $this->outputSpecification
[$column]['do_not_output_to_csv'] = TRUE;
886 public function getHeaderRows() {
888 foreach ($this->outputSpecification
as $key => $spec) {
889 if (empty($spec['do_not_output_to_csv'])) {
890 $headerRows[] = $spec['header'];
899 public function getSQLColumns() {
901 foreach ($this->outputSpecification
as $key => $spec) {
902 if (empty($spec['do_not_output_to_sql'])) {
903 $sqlColumns[$key] = $spec['sql_columns'];
912 public function getMetadata() {
914 foreach ($this->outputSpecification
as $key => $spec) {
915 $metadata[$key] = $spec['metadata'];
921 * Build the row for output.
923 * @param \CRM_Contact_BAO_Query $query
924 * @param CRM_Core_DAO $iterationDAO
925 * @param array $outputColumns
927 * @param $paymentDetails
928 * @param $addPaymentHeader
932 public function buildRow($query, $iterationDAO, $outputColumns, $metadata, $paymentDetails, $addPaymentHeader) {
933 $paymentTableId = $this->getPaymentTableID();
934 if ($this->isHouseholdToSkip($iterationDAO->contact_id
)) {
937 $phoneTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id');
938 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
941 $householdMergeRelationshipType = $this->getHouseholdMergeTypeForRow($iterationDAO->contact_id
);
942 if ($householdMergeRelationshipType) {
943 $householdID = $this->getRelatedHouseholdID($iterationDAO->contact_id
, $householdMergeRelationshipType);
944 if ($this->isHouseholdExported($householdID)) {
947 foreach (array_keys($outputColumns) as $column) {
948 $row[$column] = $this->getRelationshipValue($householdMergeRelationshipType, $iterationDAO->contact_id
, $column);
950 $this->markHouseholdExported($householdID);
954 $query->convertToPseudoNames($iterationDAO);
956 //first loop through output columns so that we return what is required, and in same order.
957 foreach ($outputColumns as $field => $value) {
958 // add im_provider to $dao object
959 if ($field == 'im_provider' && property_exists($iterationDAO, 'provider_id')) {
960 $iterationDAO->im_provider
= $iterationDAO->provider_id
;
963 //build row values (data)
965 if (property_exists($iterationDAO, $field)) {
966 $fieldValue = $iterationDAO->$field;
967 // to get phone type from phone type id
968 if ($field == 'phone_type_id' && isset($phoneTypes[$fieldValue])) {
969 $fieldValue = $phoneTypes[$fieldValue];
971 elseif ($field == 'provider_id' ||
$field == 'im_provider') {
972 $fieldValue = CRM_Utils_Array
::value($fieldValue, $imProviders);
974 elseif (strstr($field, 'master_id')) {
975 // @todo - why not just $field === 'master_id' - what else would it be?
976 $masterAddressId = $iterationDAO->$field ??
NULL;
977 // get display name of contact that address is shared.
978 $fieldValue = CRM_Contact_BAO_Contact
::getMasterDisplayName($masterAddressId);
982 if ($this->isRelationshipTypeKey($field)) {
983 $this->buildRelationshipFieldsForRow($row, $iterationDAO->contact_id
, $value, $field);
986 $row[$field] = $this->getTransformedFieldValue($field, $iterationDAO, $fieldValue, $metadata, $paymentDetails);
990 // If specific payment fields have been selected for export, payment
991 // data will already be in $row. Otherwise, add payment related
992 // information, if appropriate.
993 if ($addPaymentHeader) {
994 if (!$this->isExportSpecifiedPaymentFields()) {
995 $nullContributionDetails = array_fill_keys(array_keys($this->getPaymentHeaders()), NULL);
996 if ($this->isExportPaymentFields()) {
997 $paymentData = CRM_Utils_Array
::value($row[$paymentTableId], $paymentDetails);
998 if (!is_array($paymentData) ||
empty($paymentData)) {
999 $paymentData = $nullContributionDetails;
1001 $row = array_merge($row, $paymentData);
1003 elseif (!empty($paymentDetails)) {
1004 $row = array_merge($row, $nullContributionDetails);
1008 //remove organization name for individuals if it is set for current employer
1009 if (!empty($row['contact_type']) &&
1010 $row['contact_type'] == 'Individual' && array_key_exists('organization_name', $row)
1012 $row['organization_name'] = '';
1018 * If this row has a household whose details we should use get the relationship type key.
1024 public function getHouseholdMergeTypeForRow($contactID) {
1025 if (!$this->isMergeSameHousehold()) {
1028 foreach ($this->getHouseholdRelationshipTypes() as $relationshipType) {
1029 if (isset($this->relatedContactValues
[$relationshipType][$contactID])) {
1030 return $relationshipType;
1036 * Mark the given household as already exported.
1038 * @param $householdID
1040 public function markHouseholdExported($householdID) {
1041 $this->exportedHouseholds
[$householdID] = $householdID;
1046 * @param $iterationDAO
1047 * @param $fieldValue
1049 * @param $paymentDetails
1053 public function getTransformedFieldValue($field, $iterationDAO, $fieldValue, $metadata, $paymentDetails) {
1055 $i18n = CRM_Core_I18n
::singleton();
1056 if ($field == 'id') {
1057 return $iterationDAO->contact_id
;
1058 // special case for calculated field
1060 elseif ($field == 'source_contact_id') {
1061 return $iterationDAO->contact_id
;
1063 elseif ($field == 'pledge_balance_amount') {
1064 return $iterationDAO->pledge_amount
- $iterationDAO->pledge_total_paid
;
1065 // special case for calculated field
1067 elseif ($field == 'pledge_next_pay_amount') {
1068 return $iterationDAO->pledge_next_pay_amount +
$iterationDAO->pledge_outstanding_amount
;
1070 elseif (isset($fieldValue) &&
1073 //check for custom data
1074 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($field)) {
1075 return CRM_Core_BAO_CustomField
::displayValue($fieldValue, $cfID);
1078 elseif (in_array($field, [
1083 //special case for greeting replacement
1084 $fldValue = "{$field}_display";
1085 return $iterationDAO->$fldValue;
1088 //normal fields with a touch of CRM-3157
1091 case 'world_region':
1092 return $i18n->crm_translate($fieldValue, ['context' => 'country']);
1094 case 'state_province':
1095 return $i18n->crm_translate($fieldValue, ['context' => 'province']);
1098 case 'preferred_communication_method':
1099 case 'preferred_mail_format':
1100 case 'communication_style':
1101 return $i18n->crm_translate($fieldValue);
1104 if (isset($metadata[$field])) {
1105 // No I don't know why we do it this way & whether we could
1106 // make better use of pseudoConstants.
1107 if (!empty($metadata[$field]['context'])) {
1108 return $i18n->crm_translate($fieldValue, $metadata[$field]);
1110 if (!empty($metadata[$field]['pseudoconstant'])) {
1111 if (!empty($metadata[$field]['bao'])) {
1112 return CRM_Core_PseudoConstant
::getLabel($metadata[$field]['bao'], $metadata[$field]['name'], $fieldValue);
1114 // This is not our normal syntax for pseudoconstants but I am a bit loath to
1115 // call an external function until sure it is not increasing php processing given this
1116 // may be iterated 100,000 times & we already have the $imProvider var loaded.
1117 // That can be next refactor...
1118 // Yes - definitely feeling hatred for this bit of code - I know you will beat me up over it's awfulness
1119 // but I have to reach a stable point....
1120 $varName = $metadata[$field]['pseudoconstant']['var'];
1121 if ($varName === 'imProviders') {
1122 return CRM_Core_PseudoConstant
::getLabel('CRM_Core_DAO_IM', 'provider_id', $fieldValue);
1124 if ($varName === 'phoneTypes') {
1125 return CRM_Core_PseudoConstant
::getLabel('CRM_Core_DAO_Phone', 'phone_type_id', $fieldValue);
1134 elseif ($this->isExportSpecifiedPaymentFields() && array_key_exists($field, $this->getcomponentPaymentFields())) {
1135 $paymentTableId = $this->getPaymentTableID();
1136 $paymentData = CRM_Utils_Array
::value($iterationDAO->$paymentTableId, $paymentDetails);
1138 'componentPaymentField_total_amount' => 'total_amount',
1139 'componentPaymentField_contribution_status' => 'contribution_status',
1140 'componentPaymentField_payment_instrument' => 'pay_instru',
1141 'componentPaymentField_transaction_id' => 'trxn_id',
1142 'componentPaymentField_received_date' => 'receive_date',
1144 return CRM_Utils_Array
::value($payFieldMapper[$field], $paymentData, '');
1147 // if field is empty or null
1153 * Get array of fields to return, over & above those defined in the main contact exportable fields.
1155 * These include export mode specific fields & some fields apparently required as 'exportableFields'
1156 * but not returned by the function of the same name.
1159 * Array of fields to return in the format ['field_name' => 1,...]
1161 public function getAdditionalReturnProperties() {
1162 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_CONTACTS
) {
1163 $componentSpecificFields = [];
1166 $componentSpecificFields = CRM_Contact_BAO_Query
::defaultReturnProperties($this->getQueryMode());
1168 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_PLEDGE
) {
1169 $componentSpecificFields = array_merge($componentSpecificFields, CRM_Pledge_BAO_Query
::extraReturnProperties($this->getQueryMode()));
1170 unset($componentSpecificFields['contribution_status_id']);
1171 unset($componentSpecificFields['pledge_status_id']);
1172 unset($componentSpecificFields['pledge_payment_status_id']);
1174 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_CASE
) {
1175 $componentSpecificFields = array_merge($componentSpecificFields, CRM_Case_BAO_Query
::extraReturnProperties($this->getQueryMode()));
1177 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
1178 $componentSpecificFields = array_merge($componentSpecificFields, CRM_Contribute_BAO_Query
::softCreditReturnProperties(TRUE));
1179 unset($componentSpecificFields['contribution_status_id']);
1181 return $componentSpecificFields;
1185 * Should payment fields be appended to the export.
1187 * (This is pretty hacky so hopefully this function won't last long - notice
1188 * how obviously it should be part of the above function!).
1190 public function isExportPaymentFields() {
1191 if ($this->getRequestedFields() === NULL
1192 && in_array($this->getQueryMode(), [
1193 CRM_Contact_BAO_Query
::MODE_EVENT
,
1194 CRM_Contact_BAO_Query
::MODE_MEMBER
,
1195 CRM_Contact_BAO_Query
::MODE_PLEDGE
,
1199 elseif ($this->isExportSpecifiedPaymentFields()) {
1206 * Has specific payment fields been requested (as opposed to via all fields).
1208 * If specific fields have been requested then they get added at various points.
1212 public function isExportSpecifiedPaymentFields() {
1213 if ($this->getRequestedFields() !== NULL && $this->hasRequestedComponentPaymentFields()) {
1219 * Get the name of the id field in the table that connects contributions to the export entity.
1221 public function getPaymentTableID() {
1222 if ($this->getRequestedFields() === NULL) {
1224 CRM_Contact_BAO_Query
::MODE_EVENT
=> 'participant_id',
1225 CRM_Contact_BAO_Query
::MODE_MEMBER
=> 'membership_id',
1226 CRM_Contact_BAO_Query
::MODE_PLEDGE
=> 'pledge_payment_id',
1228 return isset($mapping[$this->getQueryMode()]) ?
$mapping[$this->getQueryMode()] : '';
1230 elseif ($this->hasRequestedComponentPaymentFields()) {
1231 return 'participant_id';
1237 * Have component payment fields been requested.
1241 protected function hasRequestedComponentPaymentFields() {
1242 if ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_EVENT
) {
1243 $participantPaymentFields = array_intersect_key($this->getComponentPaymentFields(), $this->getReturnProperties());
1244 if (!empty($participantPaymentFields)) {
1252 * Get fields that indicate payment fields have been requested for a component.
1254 * Ideally this should be protected but making it temporarily public helps refactoring..
1258 public function getComponentPaymentFields() {
1260 'componentPaymentField_total_amount' => ts('Total Amount'),
1261 'componentPaymentField_contribution_status' => ts('Contribution Status'),
1262 'componentPaymentField_received_date' => ts('Date Received'),
1263 'componentPaymentField_payment_instrument' => ts('Payment Method'),
1264 'componentPaymentField_transaction_id' => ts('Transaction ID'),
1269 * Get headers for payment fields.
1271 * Returns an array of contribution fields when the entity supports payment fields and specific fields
1272 * are not specified. This is a transitional function for refactoring legacy code.
1274 public function getPaymentHeaders() {
1275 if ($this->isExportPaymentFields() && !$this->isExportSpecifiedPaymentFields()) {
1276 return $this->getcomponentPaymentFields();
1282 * Get the default properties when not specified.
1284 * In the UI this appears as 'Primary fields only' but in practice it's
1285 * most of the kitchen sink and the hallway closet thrown in.
1287 * Since CRM-952 custom fields are excluded, but no other form of mercy is shown.
1291 public function getDefaultReturnProperties() {
1292 $returnProperties = [];
1293 $fields = CRM_Contact_BAO_Contact
::exportableFields('All', TRUE, TRUE);
1294 $skippedFields = ($this->getQueryMode() === CRM_Contact_BAO_Query
::MODE_CONTACTS
) ?
[] : [
1300 foreach ($fields as $key => $var) {
1301 if ($key && (substr($key, 0, 6) != 'custom') && !in_array($key, $skippedFields)) {
1302 $returnProperties[$key] = 1;
1305 $returnProperties = array_merge($returnProperties, $this->getAdditionalReturnProperties());
1306 return $returnProperties;
1310 * Add the field to relationship return properties & return it.
1312 * This function is doing both setting & getting which is yuck but it is an interim
1315 * @param array $value
1316 * @param string $relationshipKey
1320 public function setRelationshipReturnProperties($value, $relationshipKey) {
1321 $relationField = $value['name'];
1322 $relIMProviderId = NULL;
1323 $relLocTypeId = CRM_Utils_Array
::value('location_type_id', $value);
1324 $locationName = CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_Address', 'location_type_id', $relLocTypeId);
1325 $relPhoneTypeId = CRM_Utils_Array
::value('phone_type_id', $value, ($locationName ?
'Primary' : NULL));
1326 $relIMProviderId = CRM_Utils_Array
::value('im_provider_id', $value, ($locationName ?
'Primary' : NULL));
1327 if (in_array($relationField, $this->getValidLocationFields()) && $locationName) {
1328 if ($relationField === 'phone') {
1329 $this->relationshipReturnProperties
[$relationshipKey]['location'][$locationName]['phone-' . $relPhoneTypeId] = 1;
1331 elseif ($relationField === 'im') {
1332 $this->relationshipReturnProperties
[$relationshipKey]['location'][$locationName]['im-' . $relIMProviderId] = 1;
1335 $this->relationshipReturnProperties
[$relationshipKey]['location'][$locationName][$relationField] = 1;
1339 $this->relationshipReturnProperties
[$relationshipKey][$relationField] = 1;
1341 return $this->relationshipReturnProperties
[$relationshipKey];
1345 * Add the main return properties to the household merge properties if needed for merging.
1347 * If we are using household merge we need to add these to the relationship properties to
1350 public function setHouseholdMergeReturnProperties() {
1351 if ($this->isMergeSameHousehold()) {
1352 $returnProperties = $this->getReturnProperties();
1353 $returnProperties = array_diff_key($returnProperties, array_fill_keys(['location_type', 'im_provider'], 1));
1354 foreach ($this->getHouseholdRelationshipTypes() as $householdRelationshipType) {
1355 $this->relationshipReturnProperties
[$householdRelationshipType] = $returnProperties;
1361 * Get the default location fields to request.
1365 public function getValidLocationFields() {
1368 'supplemental_address_1',
1369 'supplemental_address_2',
1370 'supplemental_address_3',
1373 'postal_code_suffix',
1385 * Get the sql column definition for the given field.
1387 * @param string $fieldName
1388 * @param string $columnName
1392 public function getSqlColumnDefinition($fieldName, $columnName) {
1394 // early exit for master_id, CRM-12100
1395 // in the DB it is an ID, but in the export, we retrive the display_name of the master record
1396 // also for current_employer, CRM-16939
1397 if ($columnName == 'master_id' ||
$columnName == 'current_employer') {
1398 return "$fieldName varchar(128)";
1401 $queryFields = $this->getQueryFields();
1402 // @todo remove the enotice avoidance here, ensure all columns are declared.
1403 // tests will fail on the enotices until they all are & then all the 'else'
1405 $fieldSpec = $queryFields[$columnName] ??
[];
1407 // set the sql columns
1408 if (isset($fieldSpec['type'])) {
1409 switch ($fieldSpec['type']) {
1410 case CRM_Utils_Type
::T_INT
:
1411 case CRM_Utils_Type
::T_BOOLEAN
:
1412 if (in_array(CRM_Utils_Array
::value('data_type', $fieldSpec), ['Country', 'StateProvince', 'ContactReference'])) {
1413 return "$fieldName varchar(255)";
1415 return "$fieldName varchar(16)";
1417 case CRM_Utils_Type
::T_STRING
:
1418 if (isset($queryFields[$columnName]['maxlength'])) {
1419 return "$fieldName varchar({$queryFields[$columnName]['maxlength']})";
1422 return "$fieldName varchar(255)";
1425 case CRM_Utils_Type
::T_TEXT
:
1426 case CRM_Utils_Type
::T_LONGTEXT
:
1427 case CRM_Utils_Type
::T_BLOB
:
1428 case CRM_Utils_Type
::T_MEDIUMBLOB
:
1429 return "$fieldName longtext";
1431 case CRM_Utils_Type
::T_FLOAT
:
1432 case CRM_Utils_Type
::T_ENUM
:
1433 case CRM_Utils_Type
::T_DATE
:
1434 case CRM_Utils_Type
::T_TIME
:
1435 case CRM_Utils_Type
::T_TIMESTAMP
:
1436 case CRM_Utils_Type
::T_MONEY
:
1437 case CRM_Utils_Type
::T_EMAIL
:
1438 case CRM_Utils_Type
::T_URL
:
1439 case CRM_Utils_Type
::T_CCNUM
:
1441 return "$fieldName varchar(32)";
1445 if (substr($fieldName, -3, 3) == '_id') {
1446 return "$fieldName varchar(255)";
1448 elseif (substr($fieldName, -5, 5) == '_note') {
1449 return "$fieldName text";
1458 if (in_array($fieldName, $changeFields)) {
1459 return "$fieldName text";
1462 // set the sql columns for custom data
1463 if (isset($queryFields[$columnName]['data_type'])) {
1465 switch ($queryFields[$columnName]['data_type']) {
1467 // May be option labels, which could be up to 512 characters
1468 $length = max(512, CRM_Utils_Array
::value('text_length', $queryFields[$columnName]));
1469 return "$fieldName varchar($length)";
1472 return "$fieldName varchar(255)";
1475 return "$fieldName text";
1478 return "$fieldName varchar(255)";
1482 return "$fieldName text";
1490 * Get the munged field name.
1492 * @param string $field
1495 public function getMungedFieldName($field) {
1496 $fieldName = CRM_Utils_String
::munge(strtolower($field), '_', 64);
1497 if ($fieldName == 'id') {
1498 $fieldName = 'civicrm_primary_id';
1504 * In order to respect the history of this class we need to index kinda illogically.
1506 * On the bright side - this stuff is tested within a nano-byte of it's life.
1508 * e.g '2-a-b_Home-City'
1510 * @param string $key
1511 * @param string $relationshipType
1512 * @param string $locationType
1513 * @param $entityLabel
1517 protected function getOutputSpecificationIndex($key, $relationshipType, $locationType, $entityLabel) {
1518 if ($entityLabel ||
$key === 'im') {
1519 // Just cos that's the history...
1520 if ($key !== 'master_id') {
1521 $key = $this->getHeaderForRow($key);
1524 if (!$relationshipType ||
$key !== 'id') {
1525 $key = $this->getMungedFieldName($key);
1527 return $this->getMungedFieldName(
1528 ($relationshipType ?
($relationshipType . '_') : '')
1529 . ($locationType ?
($locationType . '_') : '')
1531 . ($entityLabel ?
('_' . $entityLabel) : '')
1536 * Get the compiled label for the column.
1538 * e.g 'Gender', 'Employee Of-Home-city'
1540 * @param string $key
1541 * @param string $relationshipType
1542 * @param string $locationType
1543 * @param string $entityLabel
1547 protected function getOutputSpecificationLabel($key, $relationshipType, $locationType, $entityLabel) {
1548 return ($relationshipType ?
$this->getRelationshipTypes()[$relationshipType] . '-' : '')
1549 . ($locationType ?
$locationType . '-' : '')
1550 . $this->getHeaderForRow($key)
1551 . ($entityLabel ?
'-' . $entityLabel : '');
1555 * Get the mysql field name key.
1557 * This key is locked in by tests but the reasons for the specific conventions -
1558 * ie. headings are used for keying fields in some cases, are likely
1559 * accidental rather than deliberate.
1561 * This key is used for the output sql array.
1563 * @param string $key
1564 * @param $relationshipType
1565 * @param $locationType
1566 * @param $entityLabel
1570 protected function getOutputSpecificationFieldKey($key, $relationshipType, $locationType, $entityLabel) {
1571 if ($entityLabel ||
$key === 'im') {
1572 if ($key !== 'state_province' && $key !== 'id') {
1573 // @todo - test removing this - indexing by $key should be fine...
1574 $key = $this->getHeaderForRow($key);
1577 if (!$relationshipType ||
$key !== 'id') {
1578 $key = $this->getMungedFieldName($key);
1580 $fieldKey = $this->getMungedFieldName(
1581 ($relationshipType ?
($relationshipType . '_') : '')
1582 . ($locationType ?
($locationType . '_') : '')
1584 . ($entityLabel ?
('_' . $entityLabel) : '')
1590 * Get params for the where criteria.
1594 public function getWhereParams() {
1595 if (!$this->isPostalableOnly()) {
1598 $params['is_deceased'] = ['is_deceased', '=', 0, CRM_Contact_BAO_Query
::MODE_CONTACTS
];
1599 $params['do_not_mail'] = ['do_not_mail', '=', 0, CRM_Contact_BAO_Query
::MODE_CONTACTS
];
1609 protected function buildRelationshipFieldsForRow(&$row, $contactID, $value, $field) {
1610 foreach (array_keys($value) as $property) {
1611 if ($property === 'location') {
1612 // @todo just undo all this nasty location wrangling!
1613 foreach ($value['location'] as $locationKey => $locationFields) {
1614 foreach (array_keys($locationFields) as $locationField) {
1615 $fieldKey = str_replace(' ', '_', $locationKey . '-' . $locationField);
1616 $row[$field . '_' . $fieldKey] = $this->getRelationshipValue($field, $contactID, $fieldKey);
1621 $row[$field . '_' . $property] = $this->getRelationshipValue($field, $contactID, $property);
1627 * Is this contact a household that is already set to be exported by virtue of it's household members.
1629 * @param int $contactID
1633 protected function isHouseholdToSkip($contactID) {
1634 return in_array($contactID, $this->householdsToSkip
);
1638 * Get the various arrays that we use to structure our output.
1640 * The extraction of these has been moved to a separate function for clarity and so that
1641 * tests can be added - in particular on the $outputHeaders array.
1643 * However it still feels a bit like something that I'm too polite to write down and this should be seen
1644 * as a step on the refactoring path rather than how it should be.
1647 * - outputColumns Array of columns to be exported. The values don't matter but the key must match the
1648 * alias for the field generated by BAO_Query object.
1649 * - headerRows Array of the column header strings to put in the csv header - non-associative.
1650 * - sqlColumns Array of column names for the temp table. Not too sure why outputColumns can't be used here.
1651 * - metadata Array of fields with specific parameters to pass to the translate function or another hacky nasty solution
1652 * I'm too embarassed to discuss here.
1654 * - to match the outputColumns keys (yes, the fact we ignore the output columns values & then pass another array with values
1655 * we could use does suggest further refactors. However, you future improver, do remember that every check you do
1656 * in the main DAO loop is done once per row & that coule be 100,000 times.)
1657 * Finally a pop quiz: We need the translate context because we use a function other than ts() - is this because
1658 * - a) the function used is more efficient or
1659 * - b) this code is old & outdated. Submit your answers to circular bin or better
1660 * yet find a way to comment them for posterity.
1662 public function getExportStructureArrays() {
1663 $outputColumns = $metadata = [];
1664 $queryFields = $this->getQueryFields();
1665 foreach ($this->getReturnProperties() as $key => $value) {
1666 if (($key != 'location' ||
!is_array($value)) && !$this->isRelationshipTypeKey($key)) {
1667 $outputColumns[$key] = $value;
1668 $this->addOutputSpecification($key);
1670 elseif ($this->isRelationshipTypeKey($key)) {
1671 $outputColumns[$key] = $value;
1672 foreach ($value as $relationField => $relationValue) {
1673 // below block is same as primary block (duplicate)
1674 if (isset($queryFields[$relationField]['title'])) {
1675 $this->addOutputSpecification($relationField, $key);
1677 elseif (is_array($relationValue) && $relationField == 'location') {
1678 // fix header for location type case
1679 foreach ($relationValue as $ltype => $val) {
1680 foreach (array_keys($val) as $fld) {
1681 $type = explode('-', $fld);
1682 $this->addOutputSpecification($type[0], $key, $ltype, CRM_Utils_Array
::value(1, $type));
1689 foreach ($value as $locationType => $locationFields) {
1690 foreach (array_keys($locationFields) as $locationFieldName) {
1691 $type = explode('-', $locationFieldName);
1693 $actualDBFieldName = $type[0];
1694 $daoFieldName = CRM_Utils_String
::munge($locationType) . '-' . $actualDBFieldName;
1696 if (!empty($type[1])) {
1697 $daoFieldName .= "-" . $type[1];
1699 $this->addOutputSpecification($actualDBFieldName, NULL, $locationType, CRM_Utils_Array
::value(1, $type));
1700 $metadata[$daoFieldName] = $this->getMetaDataForField($actualDBFieldName);
1701 $outputColumns[$daoFieldName] = TRUE;
1706 return [$outputColumns, $metadata];
1710 * Get default return property for export based on mode
1713 * Default Return property
1715 public function defaultReturnProperty() {
1716 // hack to add default return property based on export mode
1718 $exportMode = $this->getExportMode();
1719 if ($exportMode == CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
) {
1720 $property = 'contribution_id';
1722 elseif ($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
) {
1723 $property = 'participant_id';
1725 elseif ($exportMode == CRM_Export_Form_Select
::MEMBER_EXPORT
) {
1726 $property = 'membership_id';
1728 elseif ($exportMode == CRM_Export_Form_Select
::PLEDGE_EXPORT
) {
1729 $property = 'pledge_id';
1731 elseif ($exportMode == CRM_Export_Form_Select
::CASE_EXPORT
) {
1732 $property = 'case_id';
1734 elseif ($exportMode == CRM_Export_Form_Select
::GRANT_EXPORT
) {
1735 $property = 'grant_id';
1737 elseif ($exportMode == CRM_Export_Form_Select
::ACTIVITY_EXPORT
) {
1738 $property = 'activity_id';
1744 * Determine the required return properties from the input parameters.
1748 public function determineReturnProperties() {
1749 if ($this->getRequestedFields()) {
1750 $returnProperties = [];
1751 foreach ($this->getRequestedFields() as $key => $value) {
1752 $fieldName = $value['name'];
1753 $locationName = !empty($value['location_type_id']) ? CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_Address', 'location_type_id', $value['location_type_id']) : NULL;
1754 $relationshipTypeKey = !empty($value['relationship_type_id']) ?
$value['relationship_type_id'] . '_' . $value['relationship_direction'] : NULL;
1755 if (!$fieldName ||
$this->isHouseholdMergeRelationshipTypeKey($relationshipTypeKey)) {
1759 if ($this->isRelationshipTypeKey($relationshipTypeKey)) {
1760 $returnProperties[$relationshipTypeKey] = $this->setRelationshipReturnProperties($value, $relationshipTypeKey);
1762 elseif ($locationName) {
1763 if ($fieldName === 'phone') {
1764 $returnProperties['location'][$locationName]['phone-' . $value['phone_type_id'] ??
NULL] = 1;
1766 elseif ($fieldName === 'im') {
1767 $returnProperties['location'][$locationName]['im-' . $value['im_provider_id'] ??
NULL] = 1;
1770 $returnProperties['location'][$locationName][$fieldName] = 1;
1774 //hack to fix component fields
1775 //revert mix of event_id and title
1776 if ($fieldName == 'event_id') {
1777 $returnProperties['event_id'] = 1;
1780 $returnProperties[$fieldName] = 1;
1784 $defaultExportMode = $this->defaultReturnProperty();
1785 if ($defaultExportMode) {
1786 $returnProperties[$defaultExportMode] = 1;
1790 $returnProperties = $this->getDefaultReturnProperties();
1792 if ($this->isMergeSameHousehold()) {
1793 $returnProperties['id'] = 1;
1795 if ($this->isMergeSameAddress()) {
1796 $returnProperties['addressee'] = 1;
1797 $returnProperties['postal_greeting'] = 1;
1798 $returnProperties['email_greeting'] = 1;
1799 $returnProperties['street_name'] = 1;
1800 $returnProperties['household_name'] = 1;
1801 $returnProperties['street_address'] = 1;
1802 $returnProperties['city'] = 1;
1803 $returnProperties['state_province'] = 1;
1806 return $returnProperties;
1810 * @param object $query
1811 * CRM_Contact_BAO_Query
1816 public function getGroupBy($query) {
1818 $returnProperties = $this->getReturnProperties();
1819 $exportMode = $this->getExportMode();
1820 $queryMode = $this->getQueryMode();
1821 if (!empty($returnProperties['tags']) ||
!empty($returnProperties['groups']) ||
1822 CRM_Utils_Array
::value('notes', $returnProperties) ||
1824 ($queryMode & CRM_Contact_BAO_Query
::MODE_CONTACTS
&& $query->_useGroupBy
)
1826 $groupBy = "contact_a.id";
1829 switch ($exportMode) {
1830 case CRM_Export_Form_Select
::CONTRIBUTE_EXPORT
:
1831 $groupBy = 'civicrm_contribution.id';
1832 if (CRM_Contribute_BAO_Query
::isSoftCreditOptionEnabled()) {
1833 // especial group by when soft credit columns are included
1834 $groupBy = ['contribution_search_scredit_combined.id', 'contribution_search_scredit_combined.scredit_id'];
1838 case CRM_Export_Form_Select
::EVENT_EXPORT
:
1839 $groupBy = 'civicrm_participant.id';
1842 case CRM_Export_Form_Select
::MEMBER_EXPORT
:
1843 $groupBy = "civicrm_membership.id";
1847 if ($queryMode & CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
1848 $groupBy = "civicrm_activity.id ";
1851 return $groupBy ?
' GROUP BY ' . implode(', ', (array) $groupBy) : '';
1855 * @param int $contactId
1859 public function replaceMergeTokens($contactId) {
1864 'postal_greeting' => $this->getPostalGreetingTemplate(),
1865 'addressee' => $this->getAddresseeGreetingTemplate(),
1867 foreach ($greetingFields as $greeting => $greetingLabel) {
1868 $tokens = CRM_Utils_Token
::getTokens($greetingLabel);
1869 if (!empty($tokens)) {
1870 if (empty($contact)) {
1875 $contact = civicrm_api('contact', 'get', $values);
1877 if (!empty($contact['is_error'])) {
1880 $contact = $contact['values'][$contact['id']];
1883 $tokens = ['contact' => $greetingLabel];
1884 $greetings[$greeting] = CRM_Utils_Token
::replaceContactTokens($greetingLabel, $contact, NULL, $tokens);
1891 * Build array for merging same addresses.
1894 * @param bool $sharedAddress
1898 public function buildMasterCopyArray($sql, $sharedAddress = FALSE) {
1900 $addresseeOptions = CRM_Core_OptionGroup
::values('addressee');
1901 $postalOptions = CRM_Core_OptionGroup
::values('postal_greeting');
1903 $merge = $parents = [];
1904 $dao = CRM_Core_DAO
::executeQuery($sql);
1906 while ($dao->fetch()) {
1907 $masterID = $dao->master_id
;
1908 $copyID = $dao->copy_id
;
1909 $masterPostalGreeting = $dao->master_postal_greeting
;
1910 $masterAddressee = $dao->master_addressee
;
1911 $copyAddressee = $dao->copy_addressee
;
1913 if (!$sharedAddress) {
1914 if (!isset($this->contactGreetingFields
[$dao->master_contact_id
])) {
1915 $this->contactGreetingFields
[$dao->master_contact_id
] = $this->replaceMergeTokens($dao->master_contact_id
);
1917 $masterPostalGreeting = CRM_Utils_Array
::value('postal_greeting',
1918 $this->contactGreetingFields
[$dao->master_contact_id
], $dao->master_postal_greeting
1920 $masterAddressee = CRM_Utils_Array
::value('addressee',
1921 $this->contactGreetingFields
[$dao->master_contact_id
], $dao->master_addressee
1924 if (!isset($contactGreetingTokens[$dao->copy_contact_id
])) {
1925 $this->contactGreetingFields
[$dao->copy_contact_id
] = $this->replaceMergeTokens($dao->copy_contact_id
);
1927 $copyPostalGreeting = CRM_Utils_Array
::value('postal_greeting',
1928 $this->contactGreetingFields
[$dao->copy_contact_id
], $dao->copy_postal_greeting
1930 $copyAddressee = CRM_Utils_Array
::value('addressee',
1931 $this->contactGreetingFields
[$dao->copy_contact_id
], $dao->copy_addressee
1935 if (!isset($merge[$masterID])) {
1936 // check if this is an intermediate child
1937 // this happens if there are 3 or more matches a,b, c
1938 // the above query will return a, b / a, c / b, c
1939 // we might be doing a bit more work, but for now its ok, unless someone
1940 // knows how to fix the query above
1941 if (isset($parents[$masterID])) {
1942 $masterID = $parents[$masterID];
1945 $merge[$masterID] = [
1946 'addressee' => $masterAddressee,
1948 'postalGreeting' => $masterPostalGreeting,
1950 $merge[$masterID]['emailGreeting'] = &$merge[$masterID]['postalGreeting'];
1953 $parents[$copyID] = $masterID;
1955 if (!$sharedAddress && !array_key_exists($copyID, $merge[$masterID]['copy'])) {
1957 if ($copyPostalGreeting) {
1958 $this->trimNonTokensFromAddressString($copyPostalGreeting,
1959 $postalOptions[$dao->copy_postal_greeting_id
],
1960 $this->getPostalGreetingTemplate()
1962 $merge[$masterID]['postalGreeting'] = "{$merge[$masterID]['postalGreeting']}, {$copyPostalGreeting}";
1963 // if there happens to be a duplicate, remove it
1964 $merge[$masterID]['postalGreeting'] = str_replace(" {$copyPostalGreeting},", "", $merge[$masterID]['postalGreeting']);
1967 if ($copyAddressee) {
1968 $this->trimNonTokensFromAddressString($copyAddressee,
1969 $addresseeOptions[$dao->copy_addressee_id
],
1970 $this->getAddresseeGreetingTemplate()
1972 $merge[$masterID]['addressee'] = "{$merge[$masterID]['addressee']}, " . trim($copyAddressee);
1975 $merge[$masterID]['copy'][$copyID] = $copyAddressee;
1982 * Merge contacts with the same address.
1984 public function mergeSameAddress() {
1986 $tableName = $this->getTemporaryTable();
1987 // check if any records are present based on if they have used shared address feature,
1988 // and not based on if city / state .. matches.
1990 SELECT r1.id as copy_id,
1991 r1.civicrm_primary_id as copy_contact_id,
1992 r1.addressee as copy_addressee,
1993 r1.addressee_id as copy_addressee_id,
1994 r1.postal_greeting as copy_postal_greeting,
1995 r1.postal_greeting_id as copy_postal_greeting_id,
1997 r2.civicrm_primary_id as master_contact_id,
1998 r2.postal_greeting as master_postal_greeting,
1999 r2.postal_greeting_id as master_postal_greeting_id,
2000 r2.addressee as master_addressee,
2001 r2.addressee_id as master_addressee_id
2003 INNER JOIN civicrm_address adr ON r1.master_id = adr.id
2004 INNER JOIN $tableName r2 ON adr.contact_id = r2.civicrm_primary_id
2006 $linkedMerge = $this->buildMasterCopyArray($sql, TRUE);
2008 // find all the records that have the same street address BUT not in a household
2009 // require match on city and state as well
2011 SELECT r1.id as master_id,
2012 r1.civicrm_primary_id as master_contact_id,
2013 r1.postal_greeting as master_postal_greeting,
2014 r1.postal_greeting_id as master_postal_greeting_id,
2015 r1.addressee as master_addressee,
2016 r1.addressee_id as master_addressee_id,
2018 r2.civicrm_primary_id as copy_contact_id,
2019 r2.postal_greeting as copy_postal_greeting,
2020 r2.postal_greeting_id as copy_postal_greeting_id,
2021 r2.addressee as copy_addressee,
2022 r2.addressee_id as copy_addressee_id
2024 LEFT JOIN $tableName r2 ON ( r1.street_address = r2.street_address AND
2025 r1.city = r2.city AND
2026 r1.state_province_id = r2.state_province_id )
2027 WHERE ( r1.household_name IS NULL OR r1.household_name = '' )
2028 AND ( r2.household_name IS NULL OR r2.household_name = '' )
2029 AND ( r1.street_address != '' )
2033 $merge = $this->buildMasterCopyArray($sql);
2035 // unset ids from $merge already present in $linkedMerge
2036 foreach ($linkedMerge as $masterID => $values) {
2037 $keys = [$masterID];
2038 $keys = array_merge($keys, array_keys($values['copy']));
2039 foreach ($merge as $mid => $vals) {
2040 if (in_array($mid, $keys)) {
2041 unset($merge[$mid]);
2044 foreach ($values['copy'] as $copyId) {
2045 if (in_array($copyId, $keys)) {
2046 unset($merge[$mid]['copy'][$copyId]);
2052 $merge = $merge +
$linkedMerge;
2054 foreach ($merge as $masterID => $values) {
2057 SET addressee = %1, postal_greeting = %2, email_greeting = %3
2061 1 => [$values['addressee'], 'String'],
2062 2 => [$values['postalGreeting'], 'String'],
2063 3 => [$values['emailGreeting'], 'String'],
2064 4 => [$masterID, 'Integer'],
2066 CRM_Core_DAO
::executeQuery($sql, $params);
2068 // delete all copies
2069 $deleteIDs = array_keys($values['copy']);
2070 $deleteIDString = implode(',', $deleteIDs);
2072 DELETE FROM $tableName
2073 WHERE id IN ( $deleteIDString )
2075 CRM_Core_DAO
::executeQuery($sql);
2080 * The function unsets static part of the string, if token is the dynamic part.
2082 * Example: 'Hello {contact.first_name}' => converted to => '{contact.first_name}'
2083 * i.e 'Hello Alan' => converted to => 'Alan'
2085 * @param string $parsedString
2086 * @param string $defaultGreeting
2087 * @param string $greetingLabel
2091 public function trimNonTokensFromAddressString(
2092 &$parsedString, $defaultGreeting,
2095 $greetingLabel = empty($greetingLabel) ?
$defaultGreeting : $greetingLabel;
2097 $stringsToBeReplaced = preg_replace('/(\{[a-zA-Z._ ]+\})/', ';;', $greetingLabel);
2098 $stringsToBeReplaced = explode(';;', $stringsToBeReplaced);
2099 foreach ($stringsToBeReplaced as $key => $string) {
2100 // to keep one space
2101 $stringsToBeReplaced[$key] = ltrim($string);
2103 $parsedString = str_replace($stringsToBeReplaced, "", $parsedString);
2105 return $parsedString;
2109 * Preview export output.
2114 public function getPreview($limit) {
2116 list($outputColumns, $metadata) = $this->getExportStructureArrays();
2117 $query = $this->runQuery([], '');
2118 CRM_Core_DAO
::disableFullGroupByMode();
2119 $result = CRM_Core_DAO
::executeQuery($query[1] . ' LIMIT ' . (int) $limit);
2120 CRM_Core_DAO
::reenableFullGroupByMode();
2121 while ($result->fetch()) {
2122 $rows[] = $this->buildRow($query[0], $result, $outputColumns, $metadata, [], []);
2128 * Set the template strings to be used when merging two contacts with the same address.
2130 * @param array $formValues
2131 * Values from first form. In this case we care about the keys
2134 * - address_greeting
2139 protected function setGreetingStringsForSameAddressMerge($formValues) {
2140 $greetingOptions = CRM_Export_Form_Select
::getGreetingOptions();
2142 if (!empty($greetingOptions)) {
2143 // Greeting options is keyed by 'postal_greeting' or 'addressee'.
2144 foreach ($greetingOptions as $key => $value) {
2145 $option = CRM_Utils_Array
::value($key, $formValues);
2147 if ($greetingOptions[$key][$option] == ts('Other')) {
2148 $formValues[$key] = $formValues["{$key}_other"];
2150 elseif ($greetingOptions[$key][$option] == ts('List of names')) {
2151 $formValues[$key] = '';
2154 $formValues[$key] = $greetingOptions[$key][$option];
2159 if (!empty($formValues['postal_greeting'])) {
2160 $this->setPostalGreetingTemplate($formValues['postal_greeting']);
2162 if (!empty($formValues['addressee'])) {
2163 $this->setAddresseeGreetingTemplate($formValues['addressee']);
2168 * Create the temporary table for output.
2170 public function createTempTable() {
2171 //creating a temporary table for the search result that need be exported
2172 $exportTempTable = CRM_Utils_SQL_TempTable
::build()->setDurable()->setCategory('export');
2173 $sqlColumns = $this->getSQLColumns();
2174 // also create the sql table
2175 $exportTempTable->drop();
2177 $sql = " id int unsigned NOT NULL AUTO_INCREMENT, ";
2178 if (!empty($sqlColumns)) {
2179 $sql .= implode(",\n", array_values($sqlColumns)) . ',';
2182 $sql .= "\n PRIMARY KEY ( id )";
2184 // add indexes for street_address and household_name if present
2188 'civicrm_primary_id',
2191 foreach ($addIndices as $index) {
2192 if (isset($sqlColumns[$index])) {
2194 INDEX index_{$index}( $index )
2199 $exportTempTable->createWithColumns($sql);
2200 $this->setTemporaryTable($exportTempTable->getName());
2204 * Get the values of linked household contact.
2206 * @param CRM_Core_DAO $relDAO
2207 * @param array $value
2208 * @param string $field
2211 * @throws \Exception
2213 public function fetchRelationshipDetails($relDAO, $value, $field, &$row) {
2214 $phoneTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id');
2215 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
2216 $i18n = CRM_Core_I18n
::singleton();
2217 $field = $field . '_';
2219 foreach ($value as $relationField => $relationValue) {
2220 if (is_object($relDAO) && property_exists($relDAO, $relationField)) {
2221 $fieldValue = $relDAO->$relationField;
2222 if ($relationField == 'phone_type_id') {
2223 $fieldValue = $phoneTypes[$relationValue];
2225 elseif ($relationField == 'provider_id') {
2226 $fieldValue = CRM_Utils_Array
::value($relationValue, $imProviders);
2229 elseif (is_object($relDAO) && in_array($relationField, [
2234 //special case for greeting replacement
2235 $fldValue = "{$relationField}_display";
2236 $fieldValue = $relDAO->$fldValue;
2239 elseif (is_object($relDAO) && $relationField == 'state_province') {
2240 $fieldValue = CRM_Core_PseudoConstant
::stateProvince($relDAO->state_province_id
);
2242 elseif (is_object($relDAO) && $relationField == 'country') {
2243 $fieldValue = CRM_Core_PseudoConstant
::country($relDAO->country_id
);
2248 $relPrefix = $field . $relationField;
2250 if (is_object($relDAO) && $relationField == 'id') {
2251 $row[$relPrefix] = $relDAO->contact_id
;
2253 elseif (is_array($relationValue) && $relationField == 'location') {
2254 foreach ($relationValue as $ltype => $val) {
2255 // If the location name has a space in it the we need to handle that. This
2256 // is kinda hacky but specifically covered in the ExportTest so later efforts to
2257 // improve it should be secure in the knowled it will be caught.
2258 $ltype = str_replace(' ', '_', $ltype);
2259 foreach (array_keys($val) as $fld) {
2260 $type = explode('-', $fld);
2261 $fldValue = "{$ltype}-" . $type[0];
2262 if (!empty($type[1])) {
2263 $fldValue .= "-" . $type[1];
2265 // CRM-3157: localise country, region (both have ‘country’ context)
2266 // and state_province (‘province’ context)
2268 case (!is_object($relDAO)):
2269 $row[$field . '_' . $fldValue] = '';
2272 case in_array('country', $type):
2273 case in_array('world_region', $type):
2274 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
2275 ['context' => 'country']
2279 case in_array('state_province', $type):
2280 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
2281 ['context' => 'province']
2286 $row[$field . '_' . $fldValue] = $relDAO->$fldValue;
2292 elseif (isset($fieldValue) && $fieldValue != '') {
2293 //check for custom data
2294 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($relationField)) {
2295 $row[$relPrefix] = CRM_Core_BAO_CustomField
::displayValue($fieldValue, $cfID);
2298 //normal relationship fields
2299 // CRM-3157: localise country, region (both have ‘country’ context) and state_province (‘province’ context)
2300 switch ($relationField) {
2302 case 'world_region':
2303 $row[$relPrefix] = $i18n->crm_translate($fieldValue, ['context' => 'country']);
2306 case 'state_province':
2307 $row[$relPrefix] = $i18n->crm_translate($fieldValue, ['context' => 'province']);
2311 $row[$relPrefix] = $fieldValue;
2317 // if relation field is empty or null
2318 $row[$relPrefix] = '';
2324 * Write to the csv from the temp table.
2326 public function writeCSVFromTable() {
2328 $headerRows = $this->getHeaderRows();
2329 $exportTempTable = $this->getTemporaryTable();
2330 CRM_Utils_Hook
::export($exportTempTable, $headerRows, $sqlColumns, $exportMode, $componentTable, $ids);
2331 if ($exportTempTable !== $this->getTemporaryTable()) {
2332 CRM_Core_Error
::deprecatedFunctionWarning('altering the export table in the hook is deprecated (in some flows the table itself will be)');
2333 $this->setTemporaryTable($exportTempTable);
2335 $exportTempTable = $this->getTemporaryTable();
2336 $writeHeader = TRUE;
2338 // increase this number a lot to avoid making too many queries
2339 // LIMIT is not much faster than a no LIMIT query
2343 $query = "SELECT * FROM $exportTempTable";
2346 $limitQuery = $query . "
2347 LIMIT $offset, $limit
2349 $dao = CRM_Core_DAO
::executeQuery($limitQuery);
2355 $componentDetails = [];
2356 while ($dao->fetch()) {
2359 foreach (array_keys($this->getSQLColumns()) as $column) {
2360 $row[$column] = $dao->$column;
2362 $componentDetails[] = $row;
2364 CRM_Core_Report_Excel
::writeCSVFile($this->getExportFileName(),
2371 $writeHeader = FALSE;