3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
34 class CRM_Contribute_BAO_Query
{
37 * Static field for all the export/import contribution fields.
41 static $_contributionFields = NULL;
43 static $_contribOrSoftCredit = "only_contribs";
46 * Function get the import/export fields for contribution
49 * self::$_contributionFields associative array of contribution fields
51 public static function &getFields() {
52 if (!self
::$_contributionFields) {
53 self
::$_contributionFields = array();
55 $fields = CRM_Contribute_BAO_Contribution
::exportableFields();
57 unset($fields['contribution_contact_id']);
59 self
::$_contributionFields = $fields;
61 return self
::$_contributionFields;
65 * If contributions are involved, add the specific contribute fields.
71 public static function select(&$query) {
72 // if contribute mode add contribution id
73 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
74 $query->_select
['contribution_id'] = "civicrm_contribution.id as contribution_id";
75 $query->_element
['contribution_id'] = 1;
76 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
80 if (!empty($query->_returnProperties
['financial_type'])) {
81 $query->_select
['financial_type'] = "civicrm_financial_type.name as financial_type";
82 $query->_element
['financial_type'] = 1;
83 $query->_tables
['civicrm_contribution'] = 1;
84 $query->_tables
['civicrm_financial_type'] = 1;
87 // get accounting code
88 if (!empty($query->_returnProperties
['accounting_code'])) {
89 $query->_select
['accounting_code'] = "civicrm_financial_account.accounting_code as accounting_code";
90 $query->_element
['accounting_code'] = 1;
91 $query->_tables
['civicrm_accounting_code'] = 1;
92 $query->_tables
['civicrm_financial_account'] = 1;
95 if (!empty($query->_returnProperties
['contribution_note'])) {
96 $query->_select
['contribution_note'] = "civicrm_note.note as contribution_note";
97 $query->_element
['contribution_note'] = 1;
98 $query->_tables
['contribution_note'] = 1;
99 $query->_tables
['civicrm_contribution'] = 1;
102 if (!empty($query->_returnProperties
['contribution_batch'])) {
103 $query->_select
['contribution_batch'] = "civicrm_batch.title as contribution_batch";
104 $query->_element
['contribution_batch'] = 1;
105 $query->_tables
['contribution_batch'] = 1;
108 if (!empty($query->_returnProperties
['contribution_source'])) {
109 $query->_select
['contribution_source'] = "civicrm_contribution.source as contribution_source";
110 $query->_element
['contribution_source'] = 1;
111 $query->_tables
['civicrm_contribution'] = 1;
114 // get contribution_status
115 if (!empty($query->_returnProperties
['contribution_status_id'])) {
116 $query->_select
['contribution_status_id'] = "contribution_status.value as contribution_status_id";
117 $query->_element
['contribution_status_id'] = 1;
118 $query->_tables
['civicrm_contribution'] = 1;
119 $query->_tables
['contribution_status'] = 1;
122 // get contribution_status label
123 if (!empty($query->_returnProperties
['contribution_status'])) {
124 $query->_select
['contribution_status'] = "contribution_status.label as contribution_status";
125 $query->_element
['contribution_status'] = 1;
126 $query->_tables
['civicrm_contribution'] = 1;
127 $query->_tables
['contribution_status'] = 1;
130 // get payment instrument
131 if (!empty($query->_returnProperties
['payment_instrument'])) {
132 $query->_select
['payment_instrument'] = "contribution_payment_instrument.label as payment_instrument";
133 $query->_element
['payment_instrument'] = 1;
134 $query->_tables
['civicrm_contribution'] = 1;
135 $query->_tables
['contribution_payment_instrument'] = 1;
138 // get payment instrument id
139 if (!empty($query->_returnProperties
['payment_instrument_id'])) {
140 $query->_select
['instrument_id'] = "contribution_payment_instrument.value as instrument_id";
141 $query->_select
['payment_instrument_id'] = "contribution_payment_instrument.value as payment_instrument_id";
142 $query->_element
['instrument_id'] = $query->_element
['payment_instrument_id'] = 1;
143 $query->_tables
['civicrm_contribution'] = 1;
144 $query->_tables
['contribution_payment_instrument'] = 1;
147 if (!empty($query->_returnProperties
['check_number'])) {
148 $query->_select
['contribution_check_number'] = "civicrm_contribution.check_number as contribution_check_number";
149 $query->_element
['contribution_check_number'] = 1;
150 $query->_tables
['civicrm_contribution'] = 1;
153 if (!empty($query->_returnProperties
['contribution_campaign_id'])) {
154 $query->_select
['contribution_campaign_id'] = 'civicrm_contribution.campaign_id as contribution_campaign_id';
155 $query->_element
['contribution_campaign_id'] = 1;
156 $query->_tables
['civicrm_contribution'] = 1;
160 if (!empty($query->_returnProperties
['contribution_soft_credit_name'])) {
161 $query->_select
['contribution_soft_credit_name'] = "civicrm_contact_d.sort_name as contribution_soft_credit_name";
162 $query->_element
['contribution_soft_credit_name'] = 1;
164 // also include contact id. Will help build hyperlinks
165 $query->_select
['contribution_soft_credit_contact_id'] = "civicrm_contact_d.id as contribution_soft_credit_contact_id";
166 $query->_element
['contribution_soft_credit_contact_id'] = 1;
168 $query->_tables
['civicrm_contribution'] = 1;
169 $query->_tables
['civicrm_contribution_soft'] = 1;
170 $query->_tables
['civicrm_contribution_soft_contact'] = 1;
173 if (!empty($query->_returnProperties
['contribution_soft_credit_contact_id'])) {
174 $query->_tables
['civicrm_contribution'] = 1;
175 $query->_tables
['civicrm_contribution_soft'] = 1;
178 if (!empty($query->_returnProperties
['contribution_soft_credit_amount'])) {
179 $query->_select
['contribution_soft_credit_amount'] = "civicrm_contribution_soft.amount as contribution_soft_credit_amount";
180 $query->_element
['contribution_soft_credit_amount'] = 1;
181 $query->_tables
['civicrm_contribution'] = 1;
182 $query->_tables
['civicrm_contribution_soft'] = 1;
185 if (!empty($query->_returnProperties
['contribution_soft_credit_type'])) {
186 $query->_select
['contribution_soft_credit_type'] = "contribution_softcredit_type.label as contribution_soft_credit_type";
187 $query->_element
['contribution_soft_credit_type'] = 1;
188 $query->_tables
['civicrm_contribution'] = 1;
189 $query->_tables
['contribution_softcredit_type'] = 1;
192 if (!empty($query->_returnProperties
['contribution_soft_credit_contribution_id'])) {
193 $query->_select
['contribution_soft_credit_contribution_id'] = "civicrm_contribution_soft.contribution_id as contribution_soft_credit_contribution_id";
194 $query->_element
['contribution_soft_credit_contribution_id'] = 1;
195 $query->_tables
['civicrm_contribution'] = 1;
196 $query->_tables
['civicrm_contribution_soft'] = 1;
199 if (!empty($query->_returnProperties
['contribution_soft_credit_email'])) {
200 $query->_select
['contribution_soft_credit_email'] = "soft_email.email as contribution_soft_credit_email";
201 $query->_element
['contribution_soft_credit_email'] = 1;
202 $query->_tables
['civicrm_contribution'] = 1;
203 $query->_tables
['civicrm_contribution_soft'] = 1;
204 $query->_tables
['civicrm_contribution_soft_contact'] = 1;
205 $query->_tables
['civicrm_contribution_soft_email'] = 1;
208 if (!empty($query->_returnProperties
['contribution_soft_credit_phone'])) {
209 $query->_select
['contribution_soft_credit_email'] = "soft_phone.phone as contribution_soft_credit_phone";
210 $query->_element
['contribution_soft_credit_phone'] = 1;
211 $query->_tables
['civicrm_contribution'] = 1;
212 $query->_tables
['civicrm_contribution_soft'] = 1;
213 $query->_tables
['civicrm_contribution_soft_contact'] = 1;
214 $query->_tables
['civicrm_contribution_soft_phone'] = 1;
216 if (!empty($query->_returnProperties
['contribution_campaign_title'])) {
217 $query->_select
['contribution_campaign_title'] = "civicrm_campaign.title as contribution_campaign_title";
218 $query->_element
['contribution_campaign_title'] = $query->_tables
['civicrm_campaign'] = 1;
220 //CRM-16116: get financial_type_id
221 if (!empty($query->_returnProperties
['financial_type_id'])) {
222 $query->_select
['financial_type_id'] = "civicrm_contribution.financial_type_id as financial_type_id";
223 $query->_element
['financial_type_id'] = $query->_tables
['civicrm_contribution'] = 1;
231 public static function where(&$query) {
233 self
::initializeAnySoftCreditClause($query);
234 foreach (array_keys($query->_params
) as $id) {
235 if (empty($query->_params
[$id][0])) {
238 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_') {
239 if ($query->_mode
== CRM_Contact_BAO_QUERY
::MODE_CONTACTS
) {
240 $query->_useDistinct
= TRUE;
244 $query->_params
[$id][0] == 'contribution_type_id' ||
245 $query->_params
[$id][0] == 'contribution_type'
247 CRM_Core_Session
::setStatus(
248 ts('The contribution type criteria is now obsolete, please update your smart group'),
255 $grouping = $query->_params
[$id][3];
256 self
::whereClauseSingle($query->_params
[$id], $query);
265 public static function whereClauseSingle(&$values, &$query) {
266 list($name, $op, $value, $grouping, $wildcard) = $values;
269 $fields = array_merge(CRM_Contribute_BAO_Contribution
::fields(), self
::getFields());
271 if (!empty($value) && !is_array($value)) {
272 $quoteValue = "\"$value\"";
275 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
276 foreach (self
::getRecurringFields() as $dateField => $dateFieldTitle) {
277 if (self
::buildDateWhere($values, $query, $name, $dateField, $dateFieldTitle)) {
282 case 'contribution_date':
283 case 'contribution_date_low':
284 case 'contribution_date_low_time':
285 case 'contribution_date_high':
286 case 'contribution_date_high_time':
287 // process to / from date
288 $query->dateQueryBuilder($values,
289 'civicrm_contribution', 'contribution_date', 'receive_date', 'Contribution Date'
293 case 'contribution_amount':
294 case 'contribution_amount_low':
295 case 'contribution_amount_high':
296 // process min/max amount
297 $query->numberRangeBuilder($values,
298 'civicrm_contribution', 'contribution_amount',
299 'total_amount', 'Contribution Amount',
304 case 'contribution_thankyou_date_is_not_null':
307 $query->_qill
[$grouping][] = ts('Contribution Thank-you Sent');
311 $query->_qill
[$grouping][] = ts('Contribution Thank-you Not Sent');
313 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.thankyou_date", $op);
314 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
317 case 'contribution_receipt_date_is_not_null':
320 $query->_qill
[$grouping][] = ts('Contribution Receipt Sent');
324 $query->_qill
[$grouping][] = ts('Contribution Receipt Not Sent');
326 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.receipt_date", $op);
327 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
330 case 'financial_type':
331 case 'contribution_page':
332 case 'payment_instrument':
333 case 'contribution_payment_instrument':
334 case 'contribution_status':
336 case 'financial_type_id':
337 case 'payment_instrument_id':
338 case 'contribution_payment_instrument_id':
339 case 'contribution_page_id':
340 case 'contribution_status_id':
341 case 'contribution_id':
342 case 'contribution_currency_type':
343 case 'contribution_currency':
344 case 'contribution_source':
345 case 'contribution_trxn_id':
346 case 'contribution_check_number':
347 case 'contribution_contact_id':
348 case (strpos($name, '_amount') !== FALSE):
349 case (strpos($name, '_date') !== FALSE && $name != 'contribution_fulfilled_date'):
351 $pseudoExtraParam = NULL;
352 if ((strpos($name, '_amount') !== FALSE) ||
(strpos($name, '_date') !== FALSE) ||
in_array($name,
355 'contribution_currency',
356 'contribution_source',
357 'contribution_trxn_id',
358 'contribution_check_number',
359 'contribution_payment_instrument_id',
360 'contribution_contact_id',
364 $name = str_replace('contribution_', '', $name);
365 if (!in_array($name, array('source', 'id', 'contact_id'))) {
366 $qillName = str_replace('contribution_', '', $qillName);
369 if (in_array($name, array('contribution_currency', 'contribution_currency_type'))) {
370 $qillName = $name = 'currency';
371 $pseudoExtraParam = array('labelColumn' => 'name');
374 $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type
::typeToString($fields[$qillName]['type']) : 'String';
376 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.$name", $op, $value, $dataType);
377 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op, $pseudoExtraParam);
378 $query->_qill
[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $op, 3 => $value));
379 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
382 case 'contribution_pcp_made_through_id':
383 case 'contribution_soft_credit_type_id':
385 if ($name == 'contribution_pcp_made_through_id') {
386 $qillName = $name = 'pcp_id';
387 $fields[$name] = array('title' => ts('Personal Campaign Page'), 'type' => 2);
389 if ($name == 'contribution_soft_credit_type_id') {
390 $qillName = str_replace('_id', '', $qillName);
391 $fields[$qillName]['type'] = $fields[$qillName]['data_type'];
392 $name = str_replace('contribution_', '', $name);
394 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution_soft.$name",
395 $op, $value, CRM_Utils_Type
::typeToString($fields[$qillName]['type'])
397 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contribute_DAO_ContributionSoft', $name, $value, $op);
398 $query->_qill
[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $op, 3 => $value));
399 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
402 case 'contribution_or_softcredits':
403 if ($value == 'only_scredits') {
404 $query->_where
[$grouping][] = "contribution_search_scredit_combined.scredit_id IS NOT NULL";
405 $query->_qill
[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits Only');
406 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
407 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
409 elseif ($value == 'both_related') {
410 $query->_where
[$grouping][] = "contribution_search_scredit_combined.filter_id IS NOT NULL";
411 $query->_qill
[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits with related Hard Credit');
412 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
413 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
415 elseif ($value == 'both') {
416 $query->_qill
[$grouping][] = ts('Contributions OR Soft Credits? - Both');
417 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
418 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
420 // default option: $value == 'only_contribs'
423 case 'contribution_is_test':
424 // By default is Contribution Search form we choose is_test = 0 in otherwords always show active contribution
425 // so in case if any one choose any Yes/No avoid the default clause otherwise it will be conflict in whereClause
426 $key = array_search('civicrm_contribution.is_test = 0', $query->_where
[$grouping]);
428 unset($query->_where
[$grouping][$key]);
430 case 'contribution_test':
431 // We dont want to include all tests for sql OR CRM-7827
432 if (!$value ||
$query->getOperator() != 'OR') {
433 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.is_test", $op, $value, "Boolean");
435 $query->_qill
[$grouping][] = ts("Only Display Test Contributions");
437 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
441 case 'contribution_is_pay_later':
442 case 'contribution_pay_later':
443 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.is_pay_later", $op, $value, "Boolean");
445 $query->_qill
[$grouping][] = ts("Find Pay Later Contributions");
448 $query->_qill
[$grouping][] = ts("Exclude Pay Later Contributions");
450 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
453 case 'contribution_recurring':
455 $query->_where
[$grouping][] = "civicrm_contribution.contribution_recur_id IS NOT NULL";
456 $query->_qill
[$grouping][] = ts("Find Recurring Contributions");
457 $query->_tables
['civicrm_contribution_recur'] = $query->_whereTables
['civicrm_contribution_recur'] = 1;
460 $query->_where
[$grouping][] = "civicrm_contribution.contribution_recur_id IS NULL";
461 $query->_qill
[$grouping][] = ts("Exclude Recurring Contributions");
465 case 'contribution_recur_id':
466 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.contribution_recur_id",
467 $op, $value, "Integer"
469 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
472 case 'contribution_note':
473 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
478 $wc = ($op != 'LIKE') ?
"LOWER(civicrm_note.note)" : "civicrm_note.note";
479 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($wc, $op, $value, "String");
480 $query->_qill
[$grouping][] = ts('Contribution Note %1 %2', array(1 => $op, 2 => $quoteValue));
481 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = $query->_whereTables
['contribution_note'] = 1;
484 case 'contribution_membership_id':
485 $query->_where
[$grouping][] = " civicrm_membership.id $op $value";
486 $query->_tables
['contribution_membership'] = $query->_whereTables
['contribution_membership'] = 1;
490 case 'contribution_participant_id':
491 $query->_where
[$grouping][] = " civicrm_participant.id $op $value";
492 $query->_tables
['contribution_participant'] = $query->_whereTables
['contribution_participant'] = 1;
495 case 'contribution_pcp_display_in_roll':
496 $query->_where
[$grouping][] = " civicrm_contribution_soft.pcp_display_in_roll $op '$value'";
498 $query->_qill
[$grouping][] = ts("Personal Campaign Page Honor Roll");
501 $query->_qill
[$grouping][] = ts("NOT Personal Campaign Page Honor Roll");
503 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
506 case 'contribution_campaign_id':
509 'campaign' => $value,
510 'grouping' => $grouping,
511 'tableName' => 'civicrm_contribution',
513 CRM_Campaign_BAO_Query
::componentSearchClause($campParams, $query);
516 case 'contribution_batch_id':
517 $batches = CRM_Contribute_PseudoConstant
::batch();
518 $query->_where
[$grouping][] = " civicrm_entity_batch.batch_id $op $value";
519 $query->_qill
[$grouping][] = ts('Batch Name %1 %2', array(1 => $op, 2 => $batches[$value]));
520 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
521 $query->_tables
['contribution_batch'] = $query->_whereTables
['contribution_batch'] = 1;
524 case 'contribution_product_id':
525 // CRM-16713 - contribution search by premiums on 'Find Contribution' form.
527 list($operator, $productValue) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contribute_DAO_Product', $name, $value, $op);
528 $query->_qill
[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $operator, 3 => $productValue));
529 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_product.id", $op, $value);
530 $query->_tables
['civicrm_product'] = $query->_whereTables
['civicrm_product'] = 1;
534 //all other elements are handle in this case
535 $fldName = substr($name, 13);
536 if (!isset($fields[$fldName])) {
538 CRM_Core_Session
::setStatus(ts(
539 'We did not recognize the search field: %1. Please check and fix your contribution related smart groups.',
545 $whereTable = $fields[$fldName];
546 $value = trim($value);
548 $dataType = "String";
549 if (!empty($whereTable['type'])) {
550 $dataType = CRM_Utils_Type
::typeToString($whereTable['type']);
553 $wc = ($op != 'LIKE' && $dataType != 'Date') ?
"LOWER($whereTable[where])" : "$whereTable[where]";
554 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($wc, $op, $value, $dataType);
555 $query->_qill
[$grouping][] = "$whereTable[title] $op $quoteValue";
556 list($tableName, $fieldName) = explode('.', $whereTable['where'], 2);
557 $query->_tables
[$tableName] = $query->_whereTables
[$tableName] = 1;
558 if ($tableName == 'civicrm_contribution_product') {
559 $query->_tables
['civicrm_product'] = $query->_whereTables
['civicrm_product'] = 1;
560 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
563 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
569 * @param string $name
573 * @return NULL|string
575 public static function from($name, $mode, $side) {
578 case 'civicrm_contribution':
579 $from = " $side JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id ";
580 if (in_array(self
::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
581 // switch the from table if its only soft credit search
582 $from = " $side JOIN contribution_search_scredit_combined ON contribution_search_scredit_combined.contact_id = contact_a.id ";
583 $from .= " $side JOIN civicrm_contribution ON civicrm_contribution.id = contribution_search_scredit_combined.id ";
584 $from .= " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.id = contribution_search_scredit_combined.scredit_id";
588 case 'civicrm_contribution_recur':
590 // in contact mode join directly onto profile - in case no contributions exist yet
591 $from = " $side JOIN civicrm_contribution_recur ON contact_a.id = civicrm_contribution_recur.contact_id ";
594 $from = " $side JOIN civicrm_contribution_recur ON civicrm_contribution.contribution_recur_id = civicrm_contribution_recur.id ";
598 case 'civicrm_financial_type':
599 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
600 $from = " INNER JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
603 $from = " $side JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
607 case 'civicrm_financial_account':
608 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTACTS
) {
609 $from = " $side JOIN civicrm_financial_account ON contact_a.id = civicrm_financial_account.contact_id ";
613 case 'civicrm_accounting_code':
614 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
615 $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' ";
616 $from .= " INNER JOIN civicrm_financial_account ON civicrm_financial_account.id = civicrm_entity_financial_account.financial_account_id ";
617 $from .= " INNER JOIN civicrm_option_value cov ON cov.value = civicrm_entity_financial_account.account_relationship AND cov.name = 'Income Account is' ";
618 $from .= " INNER JOIN civicrm_option_group cog ON cog.id = cov.option_group_id AND cog.name = 'account_relationship' ";
622 case 'civicrm_contribution_page':
623 $from = " $side JOIN civicrm_contribution_page ON civicrm_contribution.contribution_page_id = civicrm_contribution_page.id";
626 case 'civicrm_product':
627 $from = " $side JOIN civicrm_contribution_product ON civicrm_contribution_product.contribution_id = civicrm_contribution.id";
628 $from .= " $side JOIN civicrm_product ON civicrm_contribution_product.product_id =civicrm_product.id ";
631 case 'contribution_payment_instrument':
632 $from = " $side JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')";
633 $from .= " $side JOIN civicrm_option_value contribution_payment_instrument ON (civicrm_contribution.payment_instrument_id = contribution_payment_instrument.value
634 AND option_group_payment_instrument.id = contribution_payment_instrument.option_group_id ) ";
637 case 'contribution_status':
638 $from = " $side JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')";
639 $from .= " $side JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
640 AND option_group_contribution_status.id = contribution_status.option_group_id ) ";
643 case 'contribution_softcredit_type':
644 $from = " $side JOIN civicrm_option_group option_group_contribution_softcredit_type ON
645 (option_group_contribution_softcredit_type.name = 'soft_credit_type')";
646 $from .= " $side JOIN civicrm_option_value contribution_softcredit_type ON
647 ( civicrm_contribution_soft.soft_credit_type_id = contribution_softcredit_type.value
648 AND option_group_contribution_softcredit_type.id = contribution_softcredit_type.option_group_id )";
651 case 'contribution_note':
652 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contribution' AND
653 civicrm_contribution.id = civicrm_note.entity_id )";
656 case 'contribution_membership':
657 $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.contribution_id = civicrm_contribution.id";
658 $from .= " $side JOIN civicrm_membership ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
661 case 'civicrm_campaign':
662 $from = " $side JOIN civicrm_campaign ON civicrm_campaign.id = civicrm_contribution.campaign_id";
665 case 'contribution_participant':
666 $from = " $side JOIN civicrm_participant_payment ON civicrm_participant_payment.contribution_id = civicrm_contribution.id";
667 $from .= " $side JOIN civicrm_participant ON civicrm_participant_payment.participant_id = civicrm_participant.id ";
670 case 'civicrm_contribution_soft':
671 if (!in_array(self
::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
672 $from = " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.contribution_id = civicrm_contribution.id";
676 case 'civicrm_contribution_soft_contact':
677 if (in_array(self
::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
678 $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution.contact_id = civicrm_contact_d.id )
679 AND contribution_search_scredit_combined.scredit_id IS NOT NULL";
682 $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution_soft.contact_id = civicrm_contact_d.id )";
686 case 'civicrm_contribution_soft_email':
687 $from .= " $side JOIN civicrm_email as soft_email ON (civicrm_contact_d.id = soft_email.contact_id )";
690 case 'civicrm_contribution_soft_phone':
691 $from .= " $side JOIN civicrm_phone as soft_phone ON (civicrm_contact_d.id = soft_phone.contact_id )";
694 case 'contribution_batch':
695 $from .= " $side JOIN civicrm_entity_financial_trxn ON (
696 civicrm_entity_financial_trxn.entity_table = 'civicrm_contribution'
697 AND civicrm_contribution.id = civicrm_entity_financial_trxn.entity_id )";
699 $from .= " $side JOIN civicrm_financial_trxn ON (
700 civicrm_entity_financial_trxn.financial_trxn_id = civicrm_financial_trxn.id )";
702 $from .= " $side JOIN civicrm_entity_batch ON ( civicrm_entity_batch.entity_table = 'civicrm_financial_trxn'
703 AND civicrm_financial_trxn.id = civicrm_entity_batch.entity_id )";
705 $from .= " $side JOIN civicrm_batch ON civicrm_entity_batch.batch_id = civicrm_batch.id";
714 public static function initializeAnySoftCreditClause(&$query) {
715 if (self
::isSoftCreditOptionEnabled($query->_params
)) {
716 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
717 unset($query->_distinctComponentClause
);
718 $query->_rowCountClause
= " count(civicrm_contribution.id)";
719 $query->_groupByComponentClause
= " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
725 * @param array $queryParams
729 public static function isSoftCreditOptionEnabled($queryParams = array()) {
730 static $tempTableFilled = FALSE;
731 if (!empty($queryParams)) {
732 foreach (array_keys($queryParams) as $id) {
733 if (empty($queryParams[$id][0])) {
736 if ($queryParams[$id][0] == 'contribution_or_softcredits') {
737 self
::$_contribOrSoftCredit = $queryParams[$id][2];
741 if (in_array(self
::$_contribOrSoftCredit,
742 array("only_scredits", "both_related", "both"))) {
743 if (!$tempTableFilled) {
744 // build a temp table which is union of contributions and soft credits
745 // note: group-by in first part ensures uniqueness in counts
747 CREATE TEMPORARY TABLE IF NOT EXISTS contribution_search_scredit_combined AS
748 SELECT con.id as id, con.contact_id, cso.id as filter_id, NULL as scredit_id
749 FROM civicrm_contribution con
750 LEFT JOIN civicrm_contribution_soft cso ON con.id = cso.contribution_id
751 GROUP BY id, contact_id, scredit_id
753 SELECT scredit.contribution_id as id, scredit.contact_id, scredit.id as filter_id, scredit.id as scredit_id
754 FROM civicrm_contribution_soft as scredit";
755 CRM_Core_DAO
::executeQuery($tempQuery);
756 $tempTableFilled = TRUE;
764 * @param bool $isExportMode
768 public static function softCreditReturnProperties($isExportMode = FALSE) {
770 'contribution_soft_credit_name' => 1,
771 'contribution_soft_credit_amount' => 1,
772 'contribution_soft_credit_type' => 1,
775 $properties['contribution_soft_credit_contribution_id'] = 1;
782 * @param bool $includeCustomFields
786 public static function defaultReturnProperties($mode, $includeCustomFields = TRUE) {
788 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
791 'contact_sub_type' => 1,
794 'financial_type' => 1,
795 'contribution_source' => 1,
797 'thankyou_date' => 1,
800 'accounting_code' => 1,
801 'payment_instrument' => 1,
802 'payment_instrument_id' => 1,
804 'non_deductible_amount' => 1,
810 'cancel_reason' => 1,
814 'product_option' => 1,
815 'fulfilled_date' => 1,
816 'contribution_start_date' => 1,
817 'contribution_end_date' => 1,
820 'contribution_status' => 1,
821 'contribution_status_id' => 1,
822 'contribution_recur_id' => 1,
824 'contribution_note' => 1,
825 'contribution_batch' => 1,
826 'contribution_campaign_title' => 1,
827 'contribution_campaign_id' => 1,
828 'contribution_product_id' => 1,
830 if (self
::isSoftCreditOptionEnabled()) {
831 $properties = array_merge($properties, self
::softCreditReturnProperties());
833 if ($includeCustomFields) {
834 // also get all the custom contribution properties
835 $fields = CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution');
836 if (!empty($fields)) {
837 foreach ($fields as $name => $dontCare) {
838 $properties[$name] = 1;
847 * Add all the elements shared between contribute search and advnaced search.
850 * @param CRM_Core_Form $form
854 public static function buildSearchForm(&$form) {
856 // Added contribution source
857 $form->addElement('text', 'contribution_source', ts('Contribution Source'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'source'));
859 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_date', 1, '_low', '_high', ts('From:'), FALSE);
861 $form->add('text', 'contribution_amount_low', ts('From'), array('size' => 8, 'maxlength' => 8));
862 $form->addRule('contribution_amount_low', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money
::format('9.99', ' '))), 'money');
864 $form->add('text', 'contribution_amount_high', ts('To'), array('size' => 8, 'maxlength' => 8));
865 $form->addRule('contribution_amount_high', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money
::format('99.99', ' '))), 'money');
867 // Adding select option for curreny type -- CRM-4711
868 $form->add('select', 'contribution_currency_type',
873 CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'currency', array('labelColumn' => 'name')),
874 FALSE, array('class' => 'crm-select2')
878 $form->addSelect('financial_type_id',
879 array('entity' => 'contribution', 'multiple' => 'multiple', 'context' => 'search')
882 $form->add('select', 'contribution_page_id',
883 ts('Contribution Page'),
884 CRM_Contribute_PseudoConstant
::contributionPage(),
885 FALSE, array('class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -'))
888 $form->addSelect('payment_instrument_id',
889 array('entity' => 'contribution', 'label' => ts('Payment Method'), 'option_url' => NULL, 'placeholder' => ts('- any -'))
892 // Fixme: Not a true entityRef field. Relies on PCP.js.tpl
893 $form->add('text', 'contribution_pcp_made_through_id', ts('Personal Campaign Page'), array('class' => 'twenty', 'id' => 'pcp_made_through_id', 'placeholder' => ts('- any -')));
895 $form->add('hidden', 'pcp_made_through');
897 $statusValues = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'contribution_status');
898 // Remove status values that are only used for recurring contributions or pledges (In Progress, Overdue).
899 unset($statusValues['5'], $statusValues['6']);
901 $form->addSelect('contribution_status_id',
902 array('entity' => 'contribution', 'multiple' => 'multiple', 'label' => ts('Contribution Status(s)'), 'option_url' => NULL, 'placeholder' => ts('- any -'))
905 // Add fields for thank you and receipt
906 $form->addYesNo('contribution_thankyou_date_is_not_null', ts('Thank-you sent?'), TRUE);
907 $form->addYesNo('contribution_receipt_date_is_not_null', ts('Receipt sent?'), TRUE);
909 $form->addYesNo('contribution_pay_later', ts('Contribution is Pay Later?'), TRUE);
910 $form->addYesNo('contribution_recurring', ts('Contribution is Recurring?'), TRUE);
912 // Recurring contribution fields
913 foreach (self
::getRecurringFields() as $key => $label) {
914 CRM_Core_Form_Date
::buildDateRange($form, $key, 1, '_low', '_high');
915 // If data has been entered for a recurring field, tell the tpl layer to open the pane
916 if (!empty($form->_formValues
[$key . '_relative']) ||
!empty($form->_formValues
[$key . '_low']) ||
!empty($form->_formValues
[$key . '_high'])) {
917 $form->assign('contribution_recur_pane_open', TRUE);
921 $form->addYesNo('contribution_test', ts('Contribution is a Test?'), TRUE);
923 // Add field for transaction ID search
924 $form->addElement('text', 'contribution_trxn_id', ts("Transaction ID"));
926 $form->addElement('text', 'contribution_check_number', ts('Check Number'));
928 // Add field for pcp display in roll search
929 $form->addYesNo('contribution_pcp_display_in_roll', ts('Personal Campaign Page Honor Roll?'), TRUE);
931 // Soft credit related fields
933 'only_contribs' => ts('Contributions Only'),
934 'only_scredits' => ts('Soft Credits Only'),
935 'both_related' => ts('Soft Credits with related Hard Credit'),
936 'both' => ts('Both'),
938 $form->add('select', 'contribution_or_softcredits', ts('Contributions OR Soft Credits?'), $options, FALSE, array('class' => "crm-select2"));
940 'contribution_soft_credit_type_id',
942 'entity' => 'contribution_soft',
943 'field' => 'soft_credit_type_id',
945 'context' => 'search',
949 // CRM-16713 - contribution search by premiums on 'Find Contribution' form.
950 $form->add('select', 'contribution_product_id',
952 CRM_Contribute_PseudoConstant
::products(),
953 FALSE, array('class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -'))
956 // Add all the custom searchable fields
957 $contribution = array('Contribution');
958 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $contribution);
960 $form->assign('contributeGroupTree', $groupDetails);
961 foreach ($groupDetails as $group) {
962 foreach ($group['fields'] as $field) {
963 $fieldId = $field['id'];
964 $elementName = 'custom_' . $fieldId;
965 CRM_Core_BAO_CustomField
::addQuickFormElement($form,
974 CRM_Campaign_BAO_Campaign
::addCampaignInComponentSearch($form, 'contribution_campaign_id');
977 $batches = CRM_Contribute_PseudoConstant
::batch();
979 if (!empty($batches)) {
980 $form->add('select', 'contribution_batch_id',
982 array('' => ts('- any -')) +
$batches,
983 FALSE, array('class' => 'crm-select2')
987 $form->assign('validCiviContribute', TRUE);
988 $form->setDefaults(array('contribution_test' => 0));
995 public static function searchAction(&$row, $id) {
1001 public static function tableNames(&$tables) {
1002 // Add contribution table
1003 if (!empty($tables['civicrm_product'])) {
1004 $tables = array_merge(array('civicrm_contribution' => 1), $tables);
1007 if (!empty($tables['civicrm_contribution_product']) && empty($tables['civicrm_product'])) {
1008 $tables['civicrm_product'] = 1;
1013 * Add the where for dates.
1015 * @param array $values
1016 * Array of query values.
1017 * @param object $query
1019 * @param string $name
1020 * Query field that is set.
1021 * @param string $field
1022 * Name of field to be set.
1023 * @param string $title
1024 * Title of the field.
1028 public static function buildDateWhere(&$values, $query, $name, $field, $title) {
1029 $fieldPart = strpos($name, $field);
1030 if ($fieldPart === FALSE) {
1033 // we only have recurring dates using this ATM so lets' short cut to find the table name
1034 $table = 'contribution_recur';
1035 $fieldName = explode($table . '_', $field);
1036 $query->dateQueryBuilder($values,
1037 'civicrm_' . $table, $field, $fieldName[1], $title
1045 public static function getRecurringFields() {
1047 'contribution_recur_start_date' => ts('Recurring Contribution Start Date'),
1048 'contribution_recur_next_sched_contribution_date' => ts('Next Scheduled Recurring Contribution'),
1049 'contribution_recur_cancel_date' => ts('Recurring Contribution Cancel Date'),
1050 'contribution_recur_end_date' => ts('Recurring Contribution End Date'),
1051 'contribution_recur_create_date' => ('Recurring Contribution Create Date'),
1052 'contribution_recur_modified_date' => ('Recurring Contribution Modified Date'),
1053 'contribution_recur_failure_retry_date' => ts('Failed Recurring Contribution Retry Date'),