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
17 class CRM_Contribute_BAO_Query
extends CRM_Core_BAO_Query
{
19 public static $_contribOrSoftCredit = "only_contribs";
21 public static $_contribRecurPayment = NULL;
24 * Function get the searchable fields for contribution.
26 * This is basically the contribution fields plus some related entity fields.
28 * @param bool $checkPermission
31 * Associative array of contribution fields
33 public static function getFields($checkPermission = TRUE) {
34 if (!isset(\Civi
::$statics[__CLASS__
]) ||
!isset(\Civi
::$statics[__CLASS__
]['fields']) ||
!isset(\Civi
::$statics[__CLASS__
]['fields']['contribution'])) {
35 $recurFields = CRM_Contribute_DAO_ContributionRecur
::fields();
36 foreach ($recurFields as $fieldKey => $field) {
37 // We can only safely add in those with unique names as those without could clobber others.
38 // The array is keyed by unique names so if it doesn't match the key there is no unique name & we unset
39 // Refer to CRM_Contribute_Form_SearchTest for existing tests ... and to add more!
40 if ($field['name'] === $fieldKey) {
41 unset($recurFields[$fieldKey]);
44 $fields = array_merge($recurFields, CRM_Contribute_BAO_Contribution
::exportableFields($checkPermission));
45 CRM_Contribute_BAO_Contribution
::appendPseudoConstantsToFields($fields);
46 unset($fields['contribution_contact_id']);
47 \Civi
::$statics[__CLASS__
]['fields']['contribution'] = $fields;
49 return \Civi
::$statics[__CLASS__
]['fields']['contribution'];
53 * If contributions are involved, add the specific contribute fields.
55 * @param CRM_Contact_BAO_Query $query
57 public static function select(&$query) {
58 // if contribute mode add contribution id
59 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
60 $query->_select
['contribution_id'] = "civicrm_contribution.id as contribution_id";
61 $query->_element
['contribution_id'] = 1;
62 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
65 // get accounting code
66 if (!empty($query->_returnProperties
['accounting_code'])) {
67 $query->_select
['accounting_code'] = "civicrm_financial_account.accounting_code as accounting_code";
68 $query->_element
['accounting_code'] = 1;
69 $query->_tables
['civicrm_accounting_code'] = 1;
70 $query->_tables
['civicrm_financial_account'] = 1;
73 if (!empty($query->_returnProperties
['contribution_note'])) {
74 $query->_select
['contribution_note'] = "civicrm_note.note as contribution_note";
75 $query->_element
['contribution_note'] = 1;
76 $query->_tables
['contribution_note'] = 1;
77 $query->_tables
['civicrm_contribution'] = 1;
80 if (!empty($query->_returnProperties
['contribution_batch'])) {
81 $query->_select
['contribution_batch'] = "civicrm_batch.title as contribution_batch";
82 $query->_element
['contribution_batch'] = 1;
83 $query->_tables
['civicrm_financial_trxn'] = 1;
84 $query->_tables
['contribution_batch'] = 1;
87 if (!empty($query->_returnProperties
['contribution_campaign_title'])) {
88 $query->_select
['contribution_campaign_title'] = "civicrm_campaign.title as contribution_campaign_title";
89 $query->_element
['contribution_campaign_title'] = $query->_tables
['civicrm_campaign'] = 1;
92 self
::addSoftCreditFields($query);
98 * @param CRM_Contact_BAO_Query $query
100 * @throws \CRM_Core_Exception
101 * @throws \CiviCRM_API3_Exception
103 public static function where(&$query) {
104 self
::initializeAnySoftCreditClause($query);
105 foreach (array_keys($query->_params
) as $id) {
106 if (empty($query->_params
[$id][0])) {
109 if (substr($query->_params
[$id][0], 0, 13) == 'contribution_' ||
substr($query->_params
[$id][0], 0, 10) == 'financial_' ||
substr($query->_params
[$id][0], 0, 8) == 'payment_') {
110 if ($query->_mode
== CRM_Contact_BAO_Query
::MODE_CONTACTS
) {
111 $query->_useDistinct
= TRUE;
114 self
::whereClauseSingle($query->_params
[$id], $query);
120 * Get where clause for a single value.
122 * @param array $values
123 * @param CRM_Contact_BAO_Query $query
125 * @throws \CiviCRM_API3_Exception
126 * @throws \CRM_Core_Exception
128 public static function whereClauseSingle(&$values, &$query) {
129 list($name, $op, $value, $grouping, $wildcard) = $values;
132 $fields = self
::getFields();
134 if (!empty($value) && !is_array($value)) {
135 $quoteValue = "\"$value\"";
138 $fieldAliases = self
::getLegacySupportedFields();
140 $fieldName = $name = self
::getFieldName($values);
142 if (in_array($name, $fieldAliases)) {
143 $qillName = array_search($name, $fieldAliases);
145 $pseudoExtraParam = [];
146 $fieldSpec = CRM_Utils_Array
::value($fieldName, $fields, []);
147 $tableName = CRM_Utils_Array
::value('table_name', $fieldSpec, 'civicrm_contribution');
148 $dataType = CRM_Utils_Type
::typeToString(CRM_Utils_Array
::value('type', $fieldSpec));
149 if ($dataType === 'Timestamp' ||
$dataType === 'Date') {
150 $title = empty($fieldSpec['unique_title']) ?
$fieldSpec['title'] : $fieldSpec['unique_title'];
151 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
152 $query->dateQueryBuilder($values,
153 $tableName, $fieldName, $fieldSpec['name'], $title
159 case 'contribution_date':
160 case 'contribution_date_low':
161 case 'contribution_date_low_time':
162 case 'contribution_date_high':
163 case 'contribution_date_high_time':
164 CRM_Core_Error
::deprecatedFunctionWarning('search by receive_date');
165 // process to / from date
166 $query->dateQueryBuilder($values,
167 'civicrm_contribution', 'contribution_date', 'receive_date', ts('Contribution Date')
171 case 'contribution_amount':
172 case 'contribution_amount_low':
173 case 'contribution_amount_high':
174 // process min/max amount
175 $query->numberRangeBuilder($values,
176 'civicrm_contribution', 'contribution_amount',
177 'total_amount', 'Contribution Amount',
182 case 'contribution_thankyou_date_is_not_null':
185 $query->_qill
[$grouping][] = ts('Contribution Thank-you Sent');
189 $query->_qill
[$grouping][] = ts('Contribution Thank-you Not Sent');
191 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.thankyou_date", $op);
192 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
195 case 'contribution_receipt_date_is_not_null':
198 $query->_qill
[$grouping][] = ts('Contribution Receipt Sent');
202 $query->_qill
[$grouping][] = ts('Contribution Receipt Not Sent');
204 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.receipt_date", $op);
205 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
208 case 'financial_type_id':
210 case 'invoice_number':
211 case 'payment_instrument_id':
212 case 'contribution_payment_instrument_id':
213 case 'contribution_page_id':
214 case 'contribution_status_id':
215 case 'contribution_id':
216 case 'contribution_currency_type':
217 case 'contribution_currency':
218 case 'contribution_source':
219 case 'contribution_trxn_id':
220 case 'contribution_check_number':
221 case 'contribution_contact_id':
222 case (strpos($name, '_amount') !== FALSE):
223 case 'contribution_campaign_id':
225 $fieldNamesNotToStripContributionFrom = [
226 'contribution_currency_type',
227 'contribution_status_id',
228 'contribution_page_id',
230 // @todo these are mostly legacy params. Find a better way to deal with them.
231 if (!in_array($name, $fieldNamesNotToStripContributionFrom)
233 if (!isset($fields[$name])) {
234 $qillName = str_replace('contribution_', '', $qillName);
236 $name = str_replace('contribution_', '', $name);
238 if (in_array($name, ['contribution_currency', 'contribution_currency_type'])) {
239 $qillName = $name = 'currency';
240 $pseudoExtraParam = ['labelColumn' => 'name'];
243 $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type
::typeToString($fields[$qillName]['type']) : 'String';
245 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.$name", $op, $value, $dataType);
246 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op, $pseudoExtraParam);
247 if (!($name == 'id' && $value == 0)) {
248 $query->_qill
[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $op, 3 => $value]);
250 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
253 case 'contribution_pcp_made_through_id':
254 case 'contribution_soft_credit_type_id':
256 if ($name == 'contribution_pcp_made_through_id') {
257 $qillName = $name = 'pcp_id';
258 $fields[$name] = ['title' => ts('Personal Campaign Page'), 'type' => 2];
260 if ($name == 'contribution_soft_credit_type_id') {
261 $qillName = str_replace('_id', '', $qillName);
262 $fields[$qillName]['type'] = $fields[$qillName]['data_type'];
263 $name = str_replace('contribution_', '', $name);
265 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution_soft.$name",
266 $op, $value, CRM_Utils_Type
::typeToString($fields[$qillName]['type'])
268 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contribute_DAO_ContributionSoft', $name, $value, $op);
269 $query->_qill
[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $op, 3 => $value]);
270 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
273 case 'contribution_or_softcredits':
274 if ($value == 'only_scredits') {
275 $query->_where
[$grouping][] = "contribution_search_scredit_combined.scredit_id IS NOT NULL";
276 $query->_qill
[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits Only');
277 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
278 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
280 elseif ($value == 'both_related') {
281 $query->_where
[$grouping][] = "contribution_search_scredit_combined.filter_id IS NOT NULL";
282 $query->_qill
[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits with related Hard Credit');
283 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
284 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
286 elseif ($value == 'both') {
287 $query->_qill
[$grouping][] = ts('Contributions OR Soft Credits? - Both');
288 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
289 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
291 // default option: $value == 'only_contribs'
294 case 'contribution_is_test':
295 // By default is Contribution Search form we choose is_test = 0 in otherwords always show active contribution
296 // so in case if any one choose any Yes/No avoid the default clause otherwise it will be conflict in whereClause
297 $key = array_search('civicrm_contribution.is_test = 0', $query->_where
[$grouping]);
299 unset($query->_where
[$grouping][$key]);
301 case 'contribution_test':
302 // We dont want to include all tests for sql OR CRM-7827
303 if (!$value ||
$query->getOperator() != 'OR') {
304 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.is_test", $op, $value, "Boolean");
306 $query->_qill
[$grouping][] = ts("Only Display Test Contributions");
308 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
312 case 'contribution_is_pay_later':
313 case 'contribution_pay_later':
314 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.is_pay_later", $op, $value, "Boolean");
316 $query->_qill
[$grouping][] = ts("Find Pay Later Contributions");
319 $query->_qill
[$grouping][] = ts("Exclude Pay Later Contributions");
321 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
324 case 'contribution_recurring':
326 $query->_where
[$grouping][] = "civicrm_contribution.contribution_recur_id IS NOT NULL";
327 $query->_qill
[$grouping][] = ts("Find Recurring Contributions");
328 $query->_tables
['civicrm_contribution_recur'] = $query->_whereTables
['civicrm_contribution_recur'] = 1;
331 $query->_where
[$grouping][] = "civicrm_contribution.contribution_recur_id IS NULL";
332 $query->_qill
[$grouping][] = ts("Exclude Recurring Contributions");
336 case 'contribution_recur_id':
337 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.contribution_recur_id",
338 $op, $value, "Integer"
340 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
343 case 'contribution_recur_payment_processor_id':
344 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution_recur.payment_processor_id", $op, $value, "String");
345 $paymentProcessors = civicrm_api3('PaymentProcessor', 'get', []);
346 $paymentProcessorNames = [];
347 foreach ($value as $paymentProcessorId) {
348 $paymentProcessorNames[] = $paymentProcessors['values'][$paymentProcessorId]['name'];
350 $query->_qill
[$grouping][] = ts("Recurring Contribution Payment Processor %1 %2", [1 => $op, 2 => implode(', ', $paymentProcessorNames)]);
351 $query->_tables
['civicrm_contribution_recur'] = $query->_whereTables
['civicrm_contribution_recur'] = 1;
354 case 'contribution_recur_processor_id':
355 case 'contribution_recur_trxn_id':
356 $spec = $fields[$name];
357 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($spec['where'],
358 $op, $value, "String"
360 $query->_qill
[$grouping][] = ts("Recurring Contribution %1 %2 '%3'", [1 => $fields[$name]['title'], 2 => $op, 3 => $value]);
361 $query->_tables
[$spec['table_name']] = $query->_whereTables
[$spec['table_name']] = 1;
364 case 'contribution_recur_payment_made':
365 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution_recur.id", 'IS NOT EMPTY');
367 $query->_qill
[$grouping][] = ts("Recurring contributions with at least one payment");
368 self
::$_contribRecurPayment = TRUE;
371 $query->_qill
[$grouping][] = ts("All recurring contributions regardless of payments");
372 self
::$_contribRecurPayment = FALSE;
374 $query->_tables
['civicrm_contribution_recur'] = $query->_whereTables
['civicrm_contribution_recur'] = 1;
377 case 'contribution_recur_contribution_status_id':
378 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution_recur.contribution_status_id", $op, $value, 'String');
379 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contribute_DAO_ContributionRecur', 'contribution_status_id', $value, $op, $pseudoExtraParam);
380 $query->_qill
[$grouping][] = ts("Recurring Contribution Status %1 '%2'", [1 => $op, 2 => $value]);
381 $query->_tables
['civicrm_contribution_recur'] = $query->_whereTables
['civicrm_contribution_recur'] = 1;
384 case 'contribution_note':
385 $value = CRM_Core_DAO
::escapeString($value);
390 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause('civicrm_note.note', $op, $value, "String");
391 $query->_qill
[$grouping][] = ts('Contribution Note %1 %2', [1 => $op, 2 => $quoteValue]);
392 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = $query->_whereTables
['contribution_note'] = 1;
395 case 'contribution_membership_id':
396 $query->_where
[$grouping][] = " civicrm_membership.id $op $value";
397 $query->_tables
['contribution_membership'] = $query->_whereTables
['contribution_membership'] = 1;
401 case 'contribution_participant_id':
402 $query->_where
[$grouping][] = " civicrm_participant.id $op $value";
403 $query->_tables
['contribution_participant'] = $query->_whereTables
['contribution_participant'] = 1;
406 case 'contribution_pcp_display_in_roll':
407 $query->_where
[$grouping][] = " civicrm_contribution_soft.pcp_display_in_roll $op '$value'";
409 $query->_qill
[$grouping][] = ts("Personal Campaign Page Honor Roll");
412 $query->_qill
[$grouping][] = ts("NOT Personal Campaign Page Honor Roll");
414 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
417 case 'contribution_batch_id':
418 list($qillOp, $qillValue) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Batch_BAO_EntityBatch', 'batch_id', $value, $op);
419 $query->_qill
[$grouping][] = ts('Batch Name %1 %2', [1 => $qillOp, 2 => $qillValue]);
420 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause('civicrm_entity_batch.batch_id', $op, $value);
421 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
422 $query->_tables
['civicrm_financial_trxn'] = $query->_whereTables
['civicrm_financial_trxn'] = 1;
423 $query->_tables
['contribution_batch'] = $query->_whereTables
['contribution_batch'] = 1;
426 case 'contribution_product_id':
427 // CRM-16713 - contribution search by premiums on 'Find Contribution' form.
429 list($operator, $productValue) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contribute_DAO_Product', $name, $value, $op);
430 $query->_qill
[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $operator, 3 => $productValue]);
431 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_product.id", $op, $value);
432 $query->_tables
['civicrm_product'] = $query->_whereTables
['civicrm_product'] = 1;
435 case 'contribution_is_payment':
436 $query->_where
[$grouping][] = " civicrm_financial_trxn.is_payment $op $value";
437 $query->_tables
['civicrm_financial_trxn'] = $query->_whereTables
['civicrm_financial_trxn'] = 1;
440 case 'financial_trxn_card_type_id':
441 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause('civicrm_financial_trxn.card_type_id', $op, $value);
442 $query->_tables
['civicrm_financial_trxn'] = $query->_whereTables
['civicrm_financial_trxn'] = 1;
443 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
444 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Financial_DAO_FinancialTrxn', 'card_type_id', $value, $op);
445 $query->_qill
[$grouping][] = ts('Card Type %1 %2', [1 => $op, 2 => $value]);
448 case 'financial_trxn_pan_truncation':
449 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause('civicrm_financial_trxn.pan_truncation', $op, $value);
450 $query->_tables
['civicrm_financial_trxn'] = $query->_whereTables
['civicrm_financial_trxn'] = 1;
451 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
452 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Financial_DAO_FinancialTrxn', 'pan_truncation', $value, $op);
453 $query->_qill
[$grouping][] = ts('Card Number %1 %2', [1 => $op, 2 => $value]);
457 //all other elements are handle in this case
458 $fldName = substr($name, 13);
459 if (!isset($fields[$fldName])) {
462 $whereTable = $fields[$fldName];
463 if (!is_array($value)) {
464 $value = trim($value);
467 $dataType = 'String';
468 if (!empty($whereTable['type'])) {
469 $dataType = CRM_Utils_Type
::typeToString($whereTable['type']);
472 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($whereTable['where'], $op, $value, $dataType);
473 $query->_qill
[$grouping][] = "$whereTable[title] $op $quoteValue";
474 list($tableName) = explode('.', $whereTable['where'], 2);
475 $query->_tables
[$tableName] = $query->_whereTables
[$tableName] = 1;
476 if ($tableName === 'civicrm_contribution_product') {
477 $query->_tables
['civicrm_product'] = $query->_whereTables
['civicrm_product'] = 1;
478 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
481 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
489 * @param string $name
490 * @param string $mode
491 * @param string $side
493 * @return NULL|string
495 public static function from($name, $mode, $side) {
498 case 'civicrm_contribution':
499 $from = " $side JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id ";
500 if (in_array(self
::$_contribOrSoftCredit, ["only_scredits", "both_related", "both"])) {
501 // switch the from table if its only soft credit search
502 $from = " $side JOIN " . \Civi
::$statics[__CLASS__
]['soft_credit_temp_table_name'] . " as contribution_search_scredit_combined ON contribution_search_scredit_combined.contact_id = contact_a.id ";
503 $from .= " $side JOIN civicrm_contribution ON civicrm_contribution.id = contribution_search_scredit_combined.id ";
504 $from .= " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.id = contribution_search_scredit_combined.scredit_id";
508 case 'civicrm_contribution_recur':
510 // 'Made payment for the recurring contributions?' is ticked yes
511 $from = " $side JOIN civicrm_contribution_recur ON contact_a.id = civicrm_contribution_recur.contact_id ";
512 if (self
::$_contribRecurPayment == TRUE) {
513 $from .= " INNER JOIN civicrm_contribution cr ON cr.contribution_recur_id = civicrm_contribution_recur.id ";
517 $from = " $side JOIN civicrm_contribution_recur ON civicrm_contribution.contribution_recur_id = civicrm_contribution_recur.id ";
521 case 'civicrm_financial_type':
522 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
523 $from = " INNER JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
526 $from = " $side JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
530 case 'civicrm_financial_account':
531 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTACTS
) {
532 $from = " $side JOIN civicrm_financial_account ON contact_a.id = civicrm_financial_account.contact_id ";
536 case 'civicrm_accounting_code':
537 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
538 $from = " $side JOIN civicrm_entity_financial_account ON civicrm_entity_financial_account.entity_id = civicrm_contribution.financial_type_id AND civicrm_entity_financial_account.entity_table = 'civicrm_financial_type' ";
539 $from .= " INNER JOIN civicrm_financial_account ON civicrm_financial_account.id = civicrm_entity_financial_account.financial_account_id ";
540 $from .= " INNER JOIN civicrm_option_value cov ON cov.value = civicrm_entity_financial_account.account_relationship AND cov.name = 'Income Account is' ";
541 $from .= " INNER JOIN civicrm_option_group cog ON cog.id = cov.option_group_id AND cog.name = 'account_relationship' ";
545 case 'civicrm_contribution_page':
546 $from = " $side JOIN civicrm_contribution_page ON civicrm_contribution.contribution_page_id = civicrm_contribution_page.id";
549 case 'civicrm_product':
550 $from = " $side JOIN civicrm_contribution_product ON civicrm_contribution_product.contribution_id = civicrm_contribution.id";
551 $from .= " $side JOIN civicrm_product ON civicrm_contribution_product.product_id =civicrm_product.id ";
554 case 'contribution_softcredit_type':
555 $from = " $side JOIN civicrm_option_group option_group_contribution_softcredit_type ON
556 (option_group_contribution_softcredit_type.name = 'soft_credit_type')";
557 $from .= " $side JOIN civicrm_option_value contribution_softcredit_type ON
558 ( civicrm_contribution_soft.soft_credit_type_id = contribution_softcredit_type.value
559 AND option_group_contribution_softcredit_type.id = contribution_softcredit_type.option_group_id )";
562 case 'contribution_note':
563 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contribution' AND
564 civicrm_contribution.id = civicrm_note.entity_id )";
567 case 'contribution_membership':
568 $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.contribution_id = civicrm_contribution.id";
569 $from .= " $side JOIN civicrm_membership ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
572 case 'civicrm_campaign':
573 //CRM-16764 - get survey clause from campaign bao
574 if (!CRM_Campaign_BAO_Query
::$_applySurveyClause) {
575 $from = " $side JOIN civicrm_campaign ON civicrm_campaign.id = civicrm_contribution.campaign_id";
579 case 'contribution_participant':
580 $from = " $side JOIN civicrm_participant_payment ON civicrm_participant_payment.contribution_id = civicrm_contribution.id";
581 $from .= " $side JOIN civicrm_participant ON civicrm_participant_payment.participant_id = civicrm_participant.id ";
584 case 'civicrm_contribution_soft':
585 if (!in_array(self
::$_contribOrSoftCredit, ["only_scredits", "both_related", "both"])) {
586 $from = " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.contribution_id = civicrm_contribution.id";
590 case 'civicrm_contribution_soft_contact':
591 if (in_array(self
::$_contribOrSoftCredit, ["only_scredits", "both_related", "both"])) {
592 $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution.contact_id = civicrm_contact_d.id )
593 AND contribution_search_scredit_combined.scredit_id IS NOT NULL";
596 $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution_soft.contact_id = civicrm_contact_d.id )";
600 case 'civicrm_contribution_soft_email':
601 $from .= " $side JOIN civicrm_email as soft_email ON (civicrm_contact_d.id = soft_email.contact_id )";
604 case 'civicrm_contribution_soft_phone':
605 $from .= " $side JOIN civicrm_phone as soft_phone ON (civicrm_contact_d.id = soft_phone.contact_id )";
608 case 'contribution_batch':
609 $from .= " $side JOIN civicrm_entity_batch ON ( civicrm_entity_batch.entity_table = 'civicrm_financial_trxn'
610 AND civicrm_financial_trxn.id = civicrm_entity_batch.entity_id )";
612 $from .= " $side JOIN civicrm_batch ON civicrm_entity_batch.batch_id = civicrm_batch.id";
615 case 'civicrm_financial_trxn':
616 $from .= " $side JOIN civicrm_entity_financial_trxn ON (
617 civicrm_entity_financial_trxn.entity_table = 'civicrm_contribution'
618 AND civicrm_contribution.id = civicrm_entity_financial_trxn.entity_id )";
620 $from .= " $side JOIN civicrm_financial_trxn ON (
621 civicrm_entity_financial_trxn.financial_trxn_id = civicrm_financial_trxn.id )";
628 * Initialise the soft credit clause.
630 * @param CRM_Contact_BAO_Query $query
632 public static function initializeAnySoftCreditClause(&$query) {
633 // @todo have a generic initialize on all components that gets called every query
634 // & rename this to match that fn name.
635 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
636 if (self
::isSoftCreditOptionEnabled($query->_params
)) {
637 unset($query->_distinctComponentClause
);
638 $query->_rowCountClause
= " count(civicrm_contribution.id)";
639 $query->_groupByComponentClause
= " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
642 $query->_distinctComponentClause
= ' civicrm_contribution.id';
648 * Check if soft credits are enables.
650 * @param array $queryParams
654 public static function isSoftCreditOptionEnabled($queryParams = []) {
655 if (!empty($queryParams)) {
656 foreach (array_keys($queryParams) as $id) {
657 if (empty($queryParams[$id][0])) {
660 if ($queryParams[$id][0] == 'contribution_or_softcredits') {
661 self
::$_contribOrSoftCredit = $queryParams[$id][2];
665 if (in_array(self
::$_contribOrSoftCredit,
666 ["only_scredits", "both_related", "both"])) {
667 if (!isset(\Civi
::$statics[__CLASS__
]['soft_credit_temp_table_name'])) {
668 // build a temp table which is union of contributions and soft credits
669 // note: group-by in first part ensures uniqueness in counts
671 SELECT con.id as id, con.contact_id, cso.id as filter_id, NULL as scredit_id
672 FROM civicrm_contribution con
673 LEFT JOIN civicrm_contribution_soft cso ON con.id = cso.contribution_id
674 GROUP BY id, contact_id, scredit_id, cso.id
676 SELECT scredit.contribution_id as id, scredit.contact_id, scredit.id as filter_id, scredit.id as scredit_id
677 FROM civicrm_contribution_soft as scredit';
678 \Civi
::$statics[__CLASS__
]['soft_credit_temp_table_name'] = CRM_Utils_SQL_TempTable
::build()->createWithQuery(
688 * Get return properties for soft credits.
690 * @param bool $isExportMode
694 public static function softCreditReturnProperties($isExportMode = FALSE) {
696 'contribution_soft_credit_name' => 1,
697 'contribution_soft_credit_amount' => 1,
698 'contribution_soft_credit_type' => 1,
701 $properties['contribution_soft_credit_contact_id'] = 1;
702 $properties['contribution_soft_credit_contribution_id'] = 1;
708 * Get the list of fields required to populate the selector.
710 * The default return properties array returns far too many fields for 'everyday use. Every field you add to this array
711 * kills a small kitten so add carefully.
713 * @param array $queryParams
716 public static function selectorReturnProperties($queryParams) {
719 'contact_sub_type' => 1,
721 'financial_type' => 1,
722 'contribution_source' => 1,
726 'thankyou_date' => 1,
728 // Without this value here we get an e-notice BUT the value does not appear to be rendered anywhere.
729 'contribution_campaign_id' => 1,
730 'contribution_status_id' => 1,
731 // @todo return this & fix query to do pseudoconstant thing.
732 'contribution_status' => 1,
734 'contribution_cancel_date' => 1,
735 'contribution_recur_id' => 1,
737 if (self
::isSiteHasProducts()) {
738 $properties['product_name'] = 1;
739 $properties['contribution_product_id'] = 1;
741 if (self
::isSoftCreditOptionEnabled($queryParams)) {
742 $properties = array_merge($properties, self
::softCreditReturnProperties());
749 * Do any products exist in this site's database.
753 public static function isSiteHasProducts() {
754 if (!isset(\Civi
::$statics[__CLASS__
]['has_products'])) {
755 \Civi
::$statics[__CLASS__
]['has_products'] = (bool) CRM_Core_DAO
::singleValueQuery('SELECT id FROM civicrm_contribution_product LIMIT 1');
757 return \Civi
::$statics[__CLASS__
]['has_products'];
761 * Function you should avoid.
763 * This function returns default properties for contribution queries. However, they are
764 * far more than are required in 'most' cases and you should always try to return the return properties
765 * you actually require.
767 * It would be nice to throw an e-notice when this is called but it would trash the tests :-(.
770 * @param bool $includeCustomFields
774 public static function defaultReturnProperties($mode, $includeCustomFields = TRUE) {
776 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
781 'contact_sub_type' => 1,
787 'financial_type' => 1,
789 'contribution_source' => 1,
793 'thankyou_date' => 1,
795 'contribution_cancel_date' => 1,
799 'accounting_code' => 1,
801 'payment_instrument' => 1,
803 'payment_instrument_id' => 1,
805 'contribution_check_number' => 1,
807 'non_deductible_amount' => 1,
816 'invoice_number' => 1,
820 'cancel_reason' => 1,
834 'contribution_status' => 1,
836 'contribution_status_id' => 1,
838 'contribution_recur_id' => 1,
842 'contribution_note' => 1,
844 'contribution_batch' => 1,
846 'contribution_campaign_title' => 1,
848 'contribution_campaign_id' => 1,
852 if (self
::isSiteHasProducts()) {
853 $properties['fulfilled_date'] = 1;
854 $properties['product_name'] = 1;
855 $properties['contribution_product_id'] = 1;
856 $properties['product_option'] = 1;
857 $properties['sku'] = 1;
858 $properties['contribution_start_date'] = 1;
859 $properties['contribution_end_date'] = 1;
861 if (self
::isSoftCreditOptionEnabled()) {
862 $properties = array_merge($properties, self
::softCreditReturnProperties());
864 if ($includeCustomFields) {
865 // also get all the custom contribution properties
866 $fields = CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution');
867 if (!empty($fields)) {
868 foreach ($fields as $name => $dontCare) {
869 $properties[$name] = 1;
878 * Get the metadata for fields to be included on the search form.
880 * @throws \CiviCRM_API3_Exception
882 public static function getSearchFieldMetadata() {
884 'contribution_source',
888 'contribution_cancel_date',
889 'contribution_page_id',
891 $metadata = civicrm_api3('Contribution', 'getfields', [])['values'];
892 return array_intersect_key($metadata, array_flip($fields));
896 * Add all the elements shared between contribute search and advanced search.
898 * @param \CRM_Contribute_Form_Search $form
900 * @throws \CRM_Core_Exception
901 * @throws \CiviCRM_API3_Exception
903 public static function buildSearchForm(&$form) {
905 $form->addSearchFieldMetadata(['Contribution' => self
::getSearchFieldMetadata()]);
906 $form->addSearchFieldMetadata(['ContributionRecur' => CRM_Contribute_BAO_ContributionRecur
::getContributionRecurSearchFieldMetadata()]);
907 $form->addFormFieldsFromMetadata();
909 $form->add('text', 'contribution_amount_low', ts('From'), ['size' => 8, 'maxlength' => 8]);
910 $form->addRule('contribution_amount_low', ts('Please enter a valid money value (e.g. %1).', [1 => CRM_Utils_Money
::format('9.99', ' ')]), 'money');
912 $form->add('text', 'contribution_amount_high', ts('To'), ['size' => 8, 'maxlength' => 8]);
913 $form->addRule('contribution_amount_high', ts('Please enter a valid money value (e.g. %1).', [1 => CRM_Utils_Money
::format('99.99', ' ')]), 'money');
915 // Adding select option for curreny type -- CRM-4711
916 $form->add('select', 'contribution_currency_type',
921 CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'currency', ['labelColumn' => 'name']),
922 FALSE, ['class' => 'crm-select2']
926 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes, CRM_Core_Action
::VIEW
);
927 $form->addSelect('financial_type_id',
928 ['entity' => 'contribution', 'multiple' => 'multiple', 'context' => 'search', 'options' => $financialTypes]
931 // use contribution_payment_instrument_id instead of payment_instrument_id
932 // Contribution Edit form (pop-up on contribution/Contact(display Result as Contribution) open on search form),
933 // then payment method change action not working properly because of same html ID present two time on one page
934 $form->addSelect('contribution_payment_instrument_id',
935 ['entity' => 'contribution', 'field' => 'payment_instrument_id', 'multiple' => 'multiple', 'label' => ts('Payment Method'), 'option_url' => NULL, 'placeholder' => ts('- any -')]
939 'contribution_pcp_made_through_id',
940 ts('Personal Campaign Page'),
941 CRM_Contribute_PseudoConstant
::pcPage(), FALSE, ['class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -')]);
943 $statusValues = CRM_Contribute_BAO_Contribution
::buildOptions('contribution_status_id', 'search');
944 $form->add('select', 'contribution_status_id',
945 ts('Contribution Status'), $statusValues,
946 FALSE, ['class' => 'crm-select2', 'multiple' => 'multiple']
949 // Add fields for thank you and receipt
950 $form->addYesNo('contribution_thankyou_date_is_not_null', ts('Thank-you sent?'), TRUE);
951 $form->addYesNo('contribution_receipt_date_is_not_null', ts('Receipt sent?'), TRUE);
953 $form->addYesNo('contribution_pay_later', ts('Contribution is Pay Later?'), TRUE);
954 $form->addYesNo('contribution_recurring', ts('Contribution is Recurring?'), TRUE);
956 $form->addYesNo('contribution_test', ts('Contribution is a Test?'), TRUE);
958 // Add field for transaction ID search
959 $form->addElement('text', 'contribution_trxn_id', ts("Transaction ID"));
960 $form->addElement('text', 'contribution_check_number', ts('Check Number'));
962 // Add field for pcp display in roll search
963 $form->addYesNo('contribution_pcp_display_in_roll', ts('Personal Campaign Page Honor Roll?'), TRUE);
965 // Soft credit related fields
967 'only_contribs' => ts('Contributions Only'),
968 'only_scredits' => ts('Soft Credits Only'),
969 'both_related' => ts('Soft Credits with related Hard Credit'),
970 'both' => ts('Both'),
972 $form->add('select', 'contribution_or_softcredits', ts('Contributions OR Soft Credits?'), $options, FALSE, ['class' => "crm-select2"]);
974 'contribution_soft_credit_type_id',
976 'entity' => 'contribution_soft',
977 'field' => 'soft_credit_type_id',
979 'context' => 'search',
983 $form->addField('financial_trxn_card_type_id', ['entity' => 'FinancialTrxn', 'name' => 'card_type_id', 'action' => 'get']);
985 $form->add('text', 'financial_trxn_pan_truncation', ts('Card Number'), [
988 'autocomplete' => 'off',
991 if (CRM_Contribute_BAO_Query
::isSiteHasProducts()) {
992 // CRM-16713 - contribution search by premiums on 'Find Contribution' form.
993 $form->add('select', 'contribution_product_id',
995 CRM_Contribute_PseudoConstant
::products(),
997 'class' => 'crm-select2',
998 'multiple' => 'multiple',
999 'placeholder' => ts('- any -'),
1004 self
::addCustomFormFields($form, ['Contribution']);
1006 CRM_Campaign_BAO_Campaign
::addCampaignInComponentSearch($form, 'contribution_campaign_id');
1009 $batches = CRM_Contribute_PseudoConstant
::batch();
1011 if (!empty($batches)) {
1012 $form->add('select', 'contribution_batch_id',
1015 '' => ts('- any -'),
1017 'IS NULL' => ts('None'),
1019 FALSE, ['class' => 'crm-select2']
1023 $form->assign('validCiviContribute', TRUE);
1024 $form->setDefaults(['contribution_test' => 0]);
1026 CRM_Contribute_BAO_ContributionRecur
::recurringContribution($form);
1032 * @todo better function comment needed - what IS the point of this?
1034 * @param array $tables
1036 public static function tableNames(&$tables) {
1037 // Add contribution table
1038 if (!empty($tables['civicrm_product'])) {
1039 $tables = array_merge(['civicrm_contribution' => 1], $tables);
1042 if (!empty($tables['civicrm_contribution_product']) && empty($tables['civicrm_product'])) {
1043 $tables['civicrm_product'] = 1;
1048 * Add the where for dates.
1050 * @param array $values
1051 * Array of query values.
1052 * @param object $query
1054 * @param string $name
1055 * Query field that is set.
1056 * @param string $field
1057 * Name of field to be set.
1058 * @param string $title
1059 * Title of the field.
1063 public static function buildDateWhere(&$values, $query, $name, $field, $title) {
1064 $fieldPart = strpos($name, $field);
1065 if ($fieldPart === FALSE) {
1068 // we only have recurring dates using this ATM so lets' short cut to find the table name
1069 $table = 'contribution_recur';
1070 $fieldName = explode($table . '_', $field);
1071 $query->dateQueryBuilder($values,
1072 'civicrm_' . $table, $field, $fieldName[1], $title
1078 * Add the soft credit fields to the select fields.
1080 * Extracted into separate function to improve readability of main select function.
1084 private static function addSoftCreditFields(&$query) {
1085 $includeSoftCredits = self
::isSoftCreditOptionEnabled($query->_params
);
1086 if (!empty($query->_returnProperties
['contribution_soft_credit_name'])) {
1087 if ($includeSoftCredits) {
1088 $query->_select
['contribution_soft_credit_name'] = "civicrm_contact_d.sort_name as contribution_soft_credit_name";
1089 // also include contact id. Will help build hyperlinks
1090 $query->_select
['contribution_soft_credit_contact_id'] = "civicrm_contact_d.id as contribution_soft_credit_contact_id";
1092 $query->_element
['contribution_soft_credit_name'] = 1;
1093 $query->_element
['contribution_soft_credit_contact_id'] = 1;
1095 $query->_tables
['civicrm_contribution'] = 1;
1096 $query->_tables
['civicrm_contribution_soft'] = 1;
1097 $query->_tables
['civicrm_contribution_soft_contact'] = 1;
1100 if (!empty($query->_returnProperties
['contribution_soft_credit_contact_id'])) {
1101 $query->_tables
['civicrm_contribution'] = 1;
1102 $query->_tables
['civicrm_contribution_soft'] = 1;
1103 $query->_tables
['civicrm_contribution_soft_contact'] = 1;
1106 if (!empty($query->_returnProperties
['contribution_soft_credit_amount'])) {
1107 if ($includeSoftCredits) {
1108 $query->_select
['contribution_soft_credit_amount'] = "civicrm_contribution_soft.amount as contribution_soft_credit_amount";
1110 $query->_element
['contribution_soft_credit_amount'] = 1;
1111 $query->_tables
['civicrm_contribution'] = 1;
1112 $query->_tables
['civicrm_contribution_soft'] = 1;
1115 if (!empty($query->_returnProperties
['contribution_soft_credit_type'])) {
1116 if ($includeSoftCredits) {
1117 $query->_select
['contribution_soft_credit_type'] = "contribution_softcredit_type.label as contribution_soft_credit_type";
1119 $query->_element
['contribution_soft_credit_type'] = 1;
1120 $query->_tables
['civicrm_contribution'] = 1;
1121 $query->_tables
['contribution_softcredit_type'] = 1;
1124 if (!empty($query->_returnProperties
['contribution_soft_credit_contribution_id'])) {
1125 if ($includeSoftCredits) {
1126 $query->_select
['contribution_soft_credit_contribution_id'] = "civicrm_contribution_soft.contribution_id as contribution_soft_credit_contribution_id";
1128 $query->_element
['contribution_soft_credit_contribution_id'] = 1;
1129 $query->_tables
['civicrm_contribution'] = 1;
1130 $query->_tables
['civicrm_contribution_soft'] = 1;
1133 if (!empty($query->_returnProperties
['contribution_soft_credit_email'])) {
1134 $query->_select
['contribution_soft_credit_email'] = "soft_email.email as contribution_soft_credit_email";
1135 $query->_element
['contribution_soft_credit_email'] = 1;
1136 $query->_tables
['civicrm_contribution'] = 1;
1137 $query->_tables
['civicrm_contribution_soft'] = 1;
1138 $query->_tables
['civicrm_contribution_soft_contact'] = 1;
1139 $query->_tables
['civicrm_contribution_soft_email'] = 1;
1142 if (!empty($query->_returnProperties
['contribution_soft_credit_phone'])) {
1143 $query->_select
['contribution_soft_credit_email'] = "soft_phone.phone as contribution_soft_credit_phone";
1144 $query->_element
['contribution_soft_credit_phone'] = 1;
1145 $query->_tables
['civicrm_contribution'] = 1;
1146 $query->_tables
['civicrm_contribution_soft'] = 1;
1147 $query->_tables
['civicrm_contribution_soft_contact'] = 1;
1148 $query->_tables
['civicrm_contribution_soft_phone'] = 1;
1151 if (!empty($query->_returnProperties
['contribution_soft_credit_pcp_id'])) {
1152 $query->_select
['contribution_soft_credit_pcp_id'] = "civicrm_contribution_soft.pcp_id as contribution_soft_credit_pcp_id";
1153 $query->_element
['contribution_soft_credit_pcp_id'] = 1;
1154 $query->_tables
['civicrm_contribution'] = 1;
1155 $query->_tables
['civicrm_contribution_soft'] = 1;