Merge pull request #7240 from sudhabisht/WebtestFix46
[civicrm-core.git] / CRM / Contribute / BAO / Query.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
26 */
27
28 /**
29 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2015
32 * $Id$
33 */
34 class CRM_Contribute_BAO_Query {
35
36 /**
37 * Static field for all the export/import contribution fields.
38 *
39 * @var array
40 */
41 static $_contributionFields = NULL;
42
43 static $_contribOrSoftCredit = "only_contribs";
44
45 /**
46 * Function get the import/export fields for contribution.
47 *
48 * @return array
49 * self::$_contributionFields associative array of contribution fields
50 */
51 public static function &getFields() {
52 if (!self::$_contributionFields) {
53 self::$_contributionFields = array();
54
55 $fields = CRM_Contribute_BAO_Contribution::exportableFields();
56
57 unset($fields['contribution_contact_id']);
58
59 self::$_contributionFields = $fields;
60 }
61 return self::$_contributionFields;
62 }
63
64 /**
65 * If contributions are involved, add the specific contribute fields.
66 *
67 * @param CRM_Contact_BAO_Query $query
68 */
69 public static function select(&$query) {
70 // if contribute mode add contribution id
71 if ($query->_mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
72 $query->_select['contribution_id'] = "civicrm_contribution.id as contribution_id";
73 $query->_element['contribution_id'] = 1;
74 $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
75 }
76
77 // get financial_type
78 if (!empty($query->_returnProperties['financial_type'])) {
79 $query->_select['financial_type'] = "civicrm_financial_type.name as financial_type";
80 $query->_element['financial_type'] = 1;
81 $query->_tables['civicrm_contribution'] = 1;
82 $query->_tables['civicrm_financial_type'] = 1;
83 }
84
85 // get accounting code
86 if (!empty($query->_returnProperties['accounting_code'])) {
87 $query->_select['accounting_code'] = "civicrm_financial_account.accounting_code as accounting_code";
88 $query->_element['accounting_code'] = 1;
89 $query->_tables['civicrm_accounting_code'] = 1;
90 $query->_tables['civicrm_financial_account'] = 1;
91 }
92
93 if (!empty($query->_returnProperties['contribution_note'])) {
94 $query->_select['contribution_note'] = "civicrm_note.note as contribution_note";
95 $query->_element['contribution_note'] = 1;
96 $query->_tables['contribution_note'] = 1;
97 $query->_tables['civicrm_contribution'] = 1;
98 }
99
100 if (!empty($query->_returnProperties['contribution_batch'])) {
101 $query->_select['contribution_batch'] = "civicrm_batch.title as contribution_batch";
102 $query->_element['contribution_batch'] = 1;
103 $query->_tables['contribution_batch'] = 1;
104 }
105
106 if (!empty($query->_returnProperties['contribution_source'])) {
107 $query->_select['contribution_source'] = "civicrm_contribution.source as contribution_source";
108 $query->_element['contribution_source'] = 1;
109 $query->_tables['civicrm_contribution'] = 1;
110 }
111
112 // get contribution_status
113 if (!empty($query->_returnProperties['contribution_status_id'])) {
114 $query->_select['contribution_status_id'] = "contribution_status.value as contribution_status_id";
115 $query->_element['contribution_status_id'] = 1;
116 $query->_tables['civicrm_contribution'] = 1;
117 $query->_tables['contribution_status'] = 1;
118 }
119
120 // get contribution_status label
121 if (!empty($query->_returnProperties['contribution_status'])) {
122 $query->_select['contribution_status'] = "contribution_status.label as contribution_status";
123 $query->_element['contribution_status'] = 1;
124 $query->_tables['civicrm_contribution'] = 1;
125 $query->_tables['contribution_status'] = 1;
126 }
127
128 // get payment instrument
129 if (!empty($query->_returnProperties['payment_instrument'])) {
130 $query->_select['payment_instrument'] = "contribution_payment_instrument.label as payment_instrument";
131 $query->_element['payment_instrument'] = 1;
132 $query->_tables['civicrm_contribution'] = 1;
133 $query->_tables['contribution_payment_instrument'] = 1;
134 }
135
136 // get payment instrument id
137 if (!empty($query->_returnProperties['payment_instrument_id'])) {
138 $query->_select['instrument_id'] = "contribution_payment_instrument.value as instrument_id";
139 $query->_select['payment_instrument_id'] = "contribution_payment_instrument.value as payment_instrument_id";
140 $query->_element['instrument_id'] = $query->_element['payment_instrument_id'] = 1;
141 $query->_tables['civicrm_contribution'] = 1;
142 $query->_tables['contribution_payment_instrument'] = 1;
143 }
144
145 if (!empty($query->_returnProperties['check_number'])) {
146 $query->_select['contribution_check_number'] = "civicrm_contribution.check_number as contribution_check_number";
147 $query->_element['contribution_check_number'] = 1;
148 $query->_tables['civicrm_contribution'] = 1;
149 }
150
151 if (!empty($query->_returnProperties['contribution_campaign_id'])) {
152 $query->_select['contribution_campaign_id'] = 'civicrm_contribution.campaign_id as contribution_campaign_id';
153 $query->_element['contribution_campaign_id'] = 1;
154 $query->_tables['civicrm_contribution'] = 1;
155 }
156
157 // LCD 716
158 if (!empty($query->_returnProperties['contribution_soft_credit_name'])) {
159 $query->_select['contribution_soft_credit_name'] = "civicrm_contact_d.sort_name as contribution_soft_credit_name";
160 $query->_element['contribution_soft_credit_name'] = 1;
161
162 // also include contact id. Will help build hyperlinks
163 $query->_select['contribution_soft_credit_contact_id'] = "civicrm_contact_d.id as contribution_soft_credit_contact_id";
164 $query->_element['contribution_soft_credit_contact_id'] = 1;
165
166 $query->_tables['civicrm_contribution'] = 1;
167 $query->_tables['civicrm_contribution_soft'] = 1;
168 $query->_tables['civicrm_contribution_soft_contact'] = 1;
169 }
170
171 if (!empty($query->_returnProperties['contribution_soft_credit_contact_id'])) {
172 $query->_tables['civicrm_contribution'] = 1;
173 $query->_tables['civicrm_contribution_soft'] = 1;
174 }
175
176 if (!empty($query->_returnProperties['contribution_soft_credit_amount'])) {
177 $query->_select['contribution_soft_credit_amount'] = "civicrm_contribution_soft.amount as contribution_soft_credit_amount";
178 $query->_element['contribution_soft_credit_amount'] = 1;
179 $query->_tables['civicrm_contribution'] = 1;
180 $query->_tables['civicrm_contribution_soft'] = 1;
181 }
182
183 if (!empty($query->_returnProperties['contribution_soft_credit_type'])) {
184 $query->_select['contribution_soft_credit_type'] = "contribution_softcredit_type.label as contribution_soft_credit_type";
185 $query->_element['contribution_soft_credit_type'] = 1;
186 $query->_tables['civicrm_contribution'] = 1;
187 $query->_tables['contribution_softcredit_type'] = 1;
188 }
189
190 if (!empty($query->_returnProperties['contribution_soft_credit_contribution_id'])) {
191 $query->_select['contribution_soft_credit_contribution_id'] = "civicrm_contribution_soft.contribution_id as contribution_soft_credit_contribution_id";
192 $query->_element['contribution_soft_credit_contribution_id'] = 1;
193 $query->_tables['civicrm_contribution'] = 1;
194 $query->_tables['civicrm_contribution_soft'] = 1;
195 }
196
197 if (!empty($query->_returnProperties['contribution_soft_credit_email'])) {
198 $query->_select['contribution_soft_credit_email'] = "soft_email.email as contribution_soft_credit_email";
199 $query->_element['contribution_soft_credit_email'] = 1;
200 $query->_tables['civicrm_contribution'] = 1;
201 $query->_tables['civicrm_contribution_soft'] = 1;
202 $query->_tables['civicrm_contribution_soft_contact'] = 1;
203 $query->_tables['civicrm_contribution_soft_email'] = 1;
204 }
205
206 if (!empty($query->_returnProperties['contribution_soft_credit_phone'])) {
207 $query->_select['contribution_soft_credit_email'] = "soft_phone.phone as contribution_soft_credit_phone";
208 $query->_element['contribution_soft_credit_phone'] = 1;
209 $query->_tables['civicrm_contribution'] = 1;
210 $query->_tables['civicrm_contribution_soft'] = 1;
211 $query->_tables['civicrm_contribution_soft_contact'] = 1;
212 $query->_tables['civicrm_contribution_soft_phone'] = 1;
213 }
214 if (!empty($query->_returnProperties['contribution_campaign_title'])) {
215 $query->_select['contribution_campaign_title'] = "civicrm_campaign.title as contribution_campaign_title";
216 $query->_element['contribution_campaign_title'] = $query->_tables['civicrm_campaign'] = 1;
217 }
218 // LCD 716 END
219 }
220
221 /**
222 * Get where clause.
223 *
224 * @param CRM_Contact_BAO_Query $query
225 */
226 public static function where(&$query) {
227 $grouping = NULL;
228 self::initializeAnySoftCreditClause($query);
229 foreach (array_keys($query->_params) as $id) {
230 if (empty($query->_params[$id][0])) {
231 continue;
232 }
233 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_') {
234 if ($query->_mode == CRM_Contact_BAO_QUERY::MODE_CONTACTS) {
235 $query->_useDistinct = TRUE;
236 }
237 // CRM-12065
238 if (
239 $query->_params[$id][0] == 'contribution_type_id' ||
240 $query->_params[$id][0] == 'contribution_type'
241 ) {
242 CRM_Core_Session::setStatus(
243 ts('The contribution type criteria is now obsolete, please update your smart group'),
244 '',
245 'alert'
246 );
247 continue;
248 }
249
250 $grouping = $query->_params[$id][3];
251 self::whereClauseSingle($query->_params[$id], $query);
252 }
253 }
254 }
255
256 /**
257 * Get where clause for a single value.
258 *
259 * @param array $values
260 * @param CRM_Contact_BAO_Query $query
261 */
262 public static function whereClauseSingle(&$values, &$query) {
263 list($name, $op, $value, $grouping, $wildcard) = $values;
264
265 $quoteValue = NULL;
266 $fields = array_merge(CRM_Contribute_BAO_Contribution::fields(), self::getFields());
267
268 if (!empty($value) && !is_array($value)) {
269 $quoteValue = "\"$value\"";
270 }
271
272 $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
273 foreach (self::getRecurringFields() as $dateField => $dateFieldTitle) {
274 if (self::buildDateWhere($values, $query, $name, $dateField, $dateFieldTitle)) {
275 return;
276 }
277 }
278 switch ($name) {
279 case 'contribution_date':
280 case 'contribution_date_low':
281 case 'contribution_date_low_time':
282 case 'contribution_date_high':
283 case 'contribution_date_high_time':
284 // process to / from date
285 $query->dateQueryBuilder($values,
286 'civicrm_contribution', 'contribution_date', 'receive_date', 'Contribution Date'
287 );
288 return;
289
290 case 'contribution_amount':
291 case 'contribution_amount_low':
292 case 'contribution_amount_high':
293 // process min/max amount
294 $query->numberRangeBuilder($values,
295 'civicrm_contribution', 'contribution_amount',
296 'total_amount', 'Contribution Amount',
297 NULL
298 );
299 return;
300
301 case 'contribution_thankyou_date_is_not_null':
302 if ($value) {
303 $op = "IS NOT NULL";
304 $query->_qill[$grouping][] = ts('Contribution Thank-you Sent');
305 }
306 else {
307 $op = "IS NULL";
308 $query->_qill[$grouping][] = ts('Contribution Thank-you Not Sent');
309 }
310 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.thankyou_date", $op);
311 $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
312 return;
313
314 case 'contribution_receipt_date_is_not_null':
315 if ($value) {
316 $op = "IS NOT NULL";
317 $query->_qill[$grouping][] = ts('Contribution Receipt Sent');
318 }
319 else {
320 $op = "IS NULL";
321 $query->_qill[$grouping][] = ts('Contribution Receipt Not Sent');
322 }
323 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.receipt_date", $op);
324 $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
325 return;
326
327 case 'financial_type':
328 case 'contribution_page':
329 case 'payment_instrument':
330 case 'contribution_payment_instrument':
331 case 'contribution_status':
332 $name .= '_id';
333 case 'financial_type_id':
334 case 'invoice_id':
335 case 'payment_instrument_id':
336 case 'contribution_payment_instrument_id':
337 case 'contribution_page_id':
338 case 'contribution_status_id':
339 case 'contribution_id':
340 case 'contribution_currency_type':
341 case 'contribution_currency':
342 case 'contribution_source':
343 case 'contribution_trxn_id':
344 case 'contribution_check_number':
345 case 'contribution_contact_id':
346 case (strpos($name, '_amount') !== FALSE):
347 case (strpos($name, '_date') !== FALSE && $name != 'contribution_fulfilled_date'):
348 $qillName = $name;
349 $pseudoExtraParam = NULL;
350 // @todo including names using a switch statement & then using an 'if' to filter them out is ... odd!
351 if ((strpos($name, '_amount') !== FALSE) || (strpos($name, '_date') !== FALSE) || in_array($name,
352 array(
353 'contribution_id',
354 'contribution_currency',
355 'contribution_source',
356 'contribution_trxn_id',
357 'contribution_check_number',
358 'contribution_payment_instrument_id',
359 'contribution_contact_id',
360 )
361 )
362 ) {
363 $name = str_replace('contribution_', '', $name);
364 if (!in_array($name, array('source', 'id', 'contact_id'))) {
365 $qillName = str_replace('contribution_', '', $qillName);
366 }
367 }
368 if (in_array($name, array('contribution_currency', 'contribution_currency_type'))) {
369 $qillName = $name = 'currency';
370 $pseudoExtraParam = array('labelColumn' => 'name');
371 }
372
373 $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
374
375 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.$name", $op, $value, $dataType);
376 list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op, $pseudoExtraParam);
377 $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $op, 3 => $value));
378 $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
379 return;
380
381 case 'contribution_pcp_made_through_id':
382 case 'contribution_soft_credit_type_id':
383 $qillName = $name;
384 if ($name == 'contribution_pcp_made_through_id') {
385 $qillName = $name = 'pcp_id';
386 $fields[$name] = array('title' => ts('Personal Campaign Page'), 'type' => 2);
387 }
388 if ($name == 'contribution_soft_credit_type_id') {
389 $qillName = str_replace('_id', '', $qillName);
390 $fields[$qillName]['type'] = $fields[$qillName]['data_type'];
391 $name = str_replace('contribution_', '', $name);
392 }
393 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_soft.$name",
394 $op, $value, CRM_Utils_Type::typeToString($fields[$qillName]['type'])
395 );
396 list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_ContributionSoft', $name, $value, $op);
397 $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $op, 3 => $value));
398 $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
399 return;
400
401 case 'contribution_or_softcredits':
402 if ($value == 'only_scredits') {
403 $query->_where[$grouping][] = "contribution_search_scredit_combined.scredit_id IS NOT NULL";
404 $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits Only');
405 $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
406 $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
407 }
408 elseif ($value == 'both_related') {
409 $query->_where[$grouping][] = "contribution_search_scredit_combined.filter_id IS NOT NULL";
410 $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits with related Hard Credit');
411 $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
412 $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
413 }
414 elseif ($value == 'both') {
415 $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Both');
416 $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
417 $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
418 }
419 // default option: $value == 'only_contribs'
420 return;
421
422 case 'contribution_is_test':
423 // By default is Contribution Search form we choose is_test = 0 in otherwords always show active contribution
424 // so in case if any one choose any Yes/No avoid the default clause otherwise it will be conflict in whereClause
425 $key = array_search('civicrm_contribution.is_test = 0', $query->_where[$grouping]);
426 if (!empty($key)) {
427 unset($query->_where[$grouping][$key]);
428 }
429 case 'contribution_test':
430 // We dont want to include all tests for sql OR CRM-7827
431 if (!$value || $query->getOperator() != 'OR') {
432 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.is_test", $op, $value, "Boolean");
433 if ($value) {
434 $query->_qill[$grouping][] = ts("Only Display Test Contributions");
435 }
436 $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
437 }
438 return;
439
440 case 'contribution_is_pay_later':
441 case 'contribution_pay_later':
442 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.is_pay_later", $op, $value, "Boolean");
443 if ($value) {
444 $query->_qill[$grouping][] = ts("Find Pay Later Contributions");
445 }
446 else {
447 $query->_qill[$grouping][] = ts("Exclude Pay Later Contributions");
448 }
449 $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
450 return;
451
452 case 'contribution_recurring':
453 if ($value) {
454 $query->_where[$grouping][] = "civicrm_contribution.contribution_recur_id IS NOT NULL";
455 $query->_qill[$grouping][] = ts("Find Recurring Contributions");
456 $query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1;
457 }
458 else {
459 $query->_where[$grouping][] = "civicrm_contribution.contribution_recur_id IS NULL";
460 $query->_qill[$grouping][] = ts("Exclude Recurring Contributions");
461 }
462 return;
463
464 case 'contribution_recur_id':
465 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.contribution_recur_id",
466 $op, $value, "Integer"
467 );
468 $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
469 return;
470
471 case 'contribution_note':
472 $value = $strtolower(CRM_Core_DAO::escapeString($value));
473 if ($wildcard) {
474 $value = "%$value%";
475 $op = 'LIKE';
476 }
477 $wc = ($op != 'LIKE') ? "LOWER(civicrm_note.note)" : "civicrm_note.note";
478 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($wc, $op, $value, "String");
479 $query->_qill[$grouping][] = ts('Contribution Note %1 %2', array(1 => $op, 2 => $quoteValue));
480 $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = $query->_whereTables['contribution_note'] = 1;
481 return;
482
483 case 'contribution_membership_id':
484 $query->_where[$grouping][] = " civicrm_membership.id $op $value";
485 $query->_tables['contribution_membership'] = $query->_whereTables['contribution_membership'] = 1;
486
487 return;
488
489 case 'contribution_participant_id':
490 $query->_where[$grouping][] = " civicrm_participant.id $op $value";
491 $query->_tables['contribution_participant'] = $query->_whereTables['contribution_participant'] = 1;
492 return;
493
494 case 'contribution_pcp_display_in_roll':
495 $query->_where[$grouping][] = " civicrm_contribution_soft.pcp_display_in_roll $op '$value'";
496 if ($value) {
497 $query->_qill[$grouping][] = ts("Personal Campaign Page Honor Roll");
498 }
499 else {
500 $query->_qill[$grouping][] = ts("NOT Personal Campaign Page Honor Roll");
501 }
502 $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
503 return;
504
505 case 'contribution_campaign_id':
506 if (CRM_Utils_Array::value($op, $value)) {
507 $value = $value[$op];
508 }
509 $campParams = array(
510 'op' => $op,
511 'campaign' => $value,
512 'grouping' => $grouping,
513 'tableName' => 'civicrm_contribution',
514 );
515 CRM_Campaign_BAO_Query::componentSearchClause($campParams, $query);
516 return;
517
518 case 'contribution_batch_id':
519 $batches = CRM_Contribute_PseudoConstant::batch();
520 $query->_where[$grouping][] = " civicrm_entity_batch.batch_id $op $value";
521 $query->_qill[$grouping][] = ts('Batch Name %1 %2', array(1 => $op, 2 => $batches[$value]));
522 $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
523 $query->_tables['contribution_batch'] = $query->_whereTables['contribution_batch'] = 1;
524 return;
525
526 default:
527 //all other elements are handle in this case
528 $fldName = substr($name, 13);
529 if (!isset($fields[$fldName])) {
530 // CRM-12597
531 CRM_Core_Session::setStatus(ts(
532 'We did not recognize the search field: %1. Please check and fix your contribution related smart groups.',
533 array(1 => $fldName)
534 )
535 );
536 return;
537 }
538 $whereTable = $fields[$fldName];
539 $value = trim($value);
540
541 $dataType = "String";
542 if (!empty($whereTable['type'])) {
543 $dataType = CRM_Utils_Type::typeToString($whereTable['type']);
544 }
545
546 $wc = ($op != 'LIKE' && $dataType != 'Date') ? "LOWER($whereTable[where])" : "$whereTable[where]";
547 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($wc, $op, $value, $dataType);
548 $query->_qill[$grouping][] = "$whereTable[title] $op $quoteValue";
549 list($tableName, $fieldName) = explode('.', $whereTable['where'], 2);
550 $query->_tables[$tableName] = $query->_whereTables[$tableName] = 1;
551 if ($tableName == 'civicrm_contribution_product') {
552 $query->_tables['civicrm_product'] = $query->_whereTables['civicrm_product'] = 1;
553 $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
554 }
555 else {
556 $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
557 }
558 }
559 }
560
561 /**
562 * Get from clause.
563 *
564 * @param string $name
565 * @param string $mode
566 * @param string $side
567 *
568 * @return NULL|string
569 */
570 public static function from($name, $mode, $side) {
571 $from = NULL;
572 switch ($name) {
573 case 'civicrm_contribution':
574 $from = " $side JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id ";
575 if (in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
576 // switch the from table if its only soft credit search
577 $from = " $side JOIN contribution_search_scredit_combined ON contribution_search_scredit_combined.contact_id = contact_a.id ";
578 $from .= " $side JOIN civicrm_contribution ON civicrm_contribution.id = contribution_search_scredit_combined.id ";
579 $from .= " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.id = contribution_search_scredit_combined.scredit_id";
580 }
581 break;
582
583 case 'civicrm_contribution_recur':
584 if ($mode == 1) {
585 // in contact mode join directly onto profile - in case no contributions exist yet
586 $from = " $side JOIN civicrm_contribution_recur ON contact_a.id = civicrm_contribution_recur.contact_id ";
587 }
588 else {
589 $from = " $side JOIN civicrm_contribution_recur ON civicrm_contribution.contribution_recur_id = civicrm_contribution_recur.id ";
590 }
591 break;
592
593 case 'civicrm_financial_type':
594 if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
595 $from = " INNER JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
596 }
597 else {
598 $from = " $side JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
599 }
600 break;
601
602 case 'civicrm_financial_account':
603 if ($mode & CRM_Contact_BAO_Query::MODE_CONTACTS) {
604 $from = " $side JOIN civicrm_financial_account ON contact_a.id = civicrm_financial_account.contact_id ";
605 }
606 break;
607
608 case 'civicrm_accounting_code':
609 if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
610 $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' ";
611 $from .= " INNER JOIN civicrm_financial_account ON civicrm_financial_account.id = civicrm_entity_financial_account.financial_account_id ";
612 $from .= " INNER JOIN civicrm_option_value cov ON cov.value = civicrm_entity_financial_account.account_relationship AND cov.name = 'Income Account is' ";
613 $from .= " INNER JOIN civicrm_option_group cog ON cog.id = cov.option_group_id AND cog.name = 'account_relationship' ";
614 }
615 break;
616
617 case 'civicrm_contribution_page':
618 $from = " $side JOIN civicrm_contribution_page ON civicrm_contribution.contribution_page_id = civicrm_contribution_page.id";
619 break;
620
621 case 'civicrm_product':
622 $from = " $side JOIN civicrm_contribution_product ON civicrm_contribution_product.contribution_id = civicrm_contribution.id";
623 $from .= " $side JOIN civicrm_product ON civicrm_contribution_product.product_id =civicrm_product.id ";
624 break;
625
626 case 'contribution_payment_instrument':
627 $from = " $side JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')";
628 $from .= " $side JOIN civicrm_option_value contribution_payment_instrument ON (civicrm_contribution.payment_instrument_id = contribution_payment_instrument.value
629 AND option_group_payment_instrument.id = contribution_payment_instrument.option_group_id ) ";
630 break;
631
632 case 'contribution_status':
633 $from = " $side JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')";
634 $from .= " $side JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
635 AND option_group_contribution_status.id = contribution_status.option_group_id ) ";
636 break;
637
638 case 'contribution_softcredit_type':
639 $from = " $side JOIN civicrm_option_group option_group_contribution_softcredit_type ON
640 (option_group_contribution_softcredit_type.name = 'soft_credit_type')";
641 $from .= " $side JOIN civicrm_option_value contribution_softcredit_type ON
642 ( civicrm_contribution_soft.soft_credit_type_id = contribution_softcredit_type.value
643 AND option_group_contribution_softcredit_type.id = contribution_softcredit_type.option_group_id )";
644 break;
645
646 case 'contribution_note':
647 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contribution' AND
648 civicrm_contribution.id = civicrm_note.entity_id )";
649 break;
650
651 case 'contribution_membership':
652 $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.contribution_id = civicrm_contribution.id";
653 $from .= " $side JOIN civicrm_membership ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
654 break;
655
656 case 'civicrm_campaign':
657 //CRM-16764 - get survey clause from campaign bao
658 if (!CRM_Campaign_BAO_Query::$_applySurveyClause) {
659 $from = " $side JOIN civicrm_campaign ON civicrm_campaign.id = civicrm_contribution.campaign_id";
660 }
661 break;
662
663 case 'contribution_participant':
664 $from = " $side JOIN civicrm_participant_payment ON civicrm_participant_payment.contribution_id = civicrm_contribution.id";
665 $from .= " $side JOIN civicrm_participant ON civicrm_participant_payment.participant_id = civicrm_participant.id ";
666 break;
667
668 case 'civicrm_contribution_soft':
669 if (!in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
670 $from = " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.contribution_id = civicrm_contribution.id";
671 }
672 break;
673
674 case 'civicrm_contribution_soft_contact':
675 if (in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
676 $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution.contact_id = civicrm_contact_d.id )
677 AND contribution_search_scredit_combined.scredit_id IS NOT NULL";
678 }
679 else {
680 $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution_soft.contact_id = civicrm_contact_d.id )";
681 }
682 break;
683
684 case 'civicrm_contribution_soft_email':
685 $from .= " $side JOIN civicrm_email as soft_email ON (civicrm_contact_d.id = soft_email.contact_id )";
686 break;
687
688 case 'civicrm_contribution_soft_phone':
689 $from .= " $side JOIN civicrm_phone as soft_phone ON (civicrm_contact_d.id = soft_phone.contact_id )";
690 break;
691
692 case 'contribution_batch':
693 $from .= " $side JOIN civicrm_entity_financial_trxn ON (
694 civicrm_entity_financial_trxn.entity_table = 'civicrm_contribution'
695 AND civicrm_contribution.id = civicrm_entity_financial_trxn.entity_id )";
696
697 $from .= " $side JOIN civicrm_financial_trxn ON (
698 civicrm_entity_financial_trxn.financial_trxn_id = civicrm_financial_trxn.id )";
699
700 $from .= " $side JOIN civicrm_entity_batch ON ( civicrm_entity_batch.entity_table = 'civicrm_financial_trxn'
701 AND civicrm_financial_trxn.id = civicrm_entity_batch.entity_id )";
702
703 $from .= " $side JOIN civicrm_batch ON civicrm_entity_batch.batch_id = civicrm_batch.id";
704 break;
705 }
706 return $from;
707 }
708
709 /**
710 * Initialise the soft credit clause.
711 *
712 * @param CRM_Contact_BAO_Query $query
713 */
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 ";
720 }
721 }
722 }
723
724 /**
725 * Check if soft credits are enables.
726 *
727 * @param array $queryParams
728 *
729 * @return bool
730 */
731 public static function isSoftCreditOptionEnabled($queryParams = array()) {
732 static $tempTableFilled = FALSE;
733 if (!empty($queryParams)) {
734 foreach (array_keys($queryParams) as $id) {
735 if (empty($queryParams[$id][0])) {
736 continue;
737 }
738 if ($queryParams[$id][0] == 'contribution_or_softcredits') {
739 self::$_contribOrSoftCredit = $queryParams[$id][2];
740 }
741 }
742 }
743 if (in_array(self::$_contribOrSoftCredit,
744 array("only_scredits", "both_related", "both"))) {
745 if (!$tempTableFilled) {
746 // build a temp table which is union of contributions and soft credits
747 // note: group-by in first part ensures uniqueness in counts
748 $tempQuery = "
749 CREATE TEMPORARY TABLE IF NOT EXISTS contribution_search_scredit_combined AS
750 SELECT con.id as id, con.contact_id, cso.id as filter_id, NULL as scredit_id
751 FROM civicrm_contribution con
752 LEFT JOIN civicrm_contribution_soft cso ON con.id = cso.contribution_id
753 GROUP BY id, contact_id, scredit_id
754 UNION ALL
755 SELECT scredit.contribution_id as id, scredit.contact_id, scredit.id as filter_id, scredit.id as scredit_id
756 FROM civicrm_contribution_soft as scredit";
757 CRM_Core_DAO::executeQuery($tempQuery);
758 $tempTableFilled = TRUE;
759 }
760 return TRUE;
761 }
762 return FALSE;
763 }
764
765 /**
766 * Get return properties for soft credits.
767 *
768 * @param bool $isExportMode
769 *
770 * @return array
771 */
772 public static function softCreditReturnProperties($isExportMode = FALSE) {
773 $properties = array(
774 'contribution_soft_credit_name' => 1,
775 'contribution_soft_credit_amount' => 1,
776 'contribution_soft_credit_type' => 1,
777 );
778 if ($isExportMode) {
779 $properties['contribution_soft_credit_contribution_id'] = 1;
780 }
781 return $properties;
782 }
783
784 /**
785 * @param $mode
786 * @param bool $includeCustomFields
787 *
788 * @return array|NULL
789 */
790 public static function defaultReturnProperties($mode, $includeCustomFields = TRUE) {
791 $properties = NULL;
792 if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
793 $properties = array(
794 'contact_type' => 1,
795 'contact_sub_type' => 1,
796 'sort_name' => 1,
797 'display_name' => 1,
798 'financial_type' => 1,
799 'contribution_source' => 1,
800 'receive_date' => 1,
801 'thankyou_date' => 1,
802 'cancel_date' => 1,
803 'total_amount' => 1,
804 'accounting_code' => 1,
805 'payment_instrument' => 1,
806 'payment_instrument_id' => 1,
807 'check_number' => 1,
808 'non_deductible_amount' => 1,
809 'fee_amount' => 1,
810 'net_amount' => 1,
811 'trxn_id' => 1,
812 'invoice_id' => 1,
813 'currency' => 1,
814 'cancel_reason' => 1,
815 'receipt_date' => 1,
816 'product_name' => 1,
817 'sku' => 1,
818 'product_option' => 1,
819 'fulfilled_date' => 1,
820 'contribution_start_date' => 1,
821 'contribution_end_date' => 1,
822 'is_test' => 1,
823 'is_pay_later' => 1,
824 'contribution_status' => 1,
825 'contribution_status_id' => 1,
826 'contribution_recur_id' => 1,
827 'amount_level' => 1,
828 'contribution_note' => 1,
829 'contribution_batch' => 1,
830 'contribution_campaign_title' => 1,
831 'contribution_campaign_id' => 1,
832 );
833 if (self::isSoftCreditOptionEnabled()) {
834 $properties = array_merge($properties, self::softCreditReturnProperties());
835 }
836 if ($includeCustomFields) {
837 // also get all the custom contribution properties
838 $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Contribution');
839 if (!empty($fields)) {
840 foreach ($fields as $name => $dontCare) {
841 $properties[$name] = 1;
842 }
843 }
844 }
845 }
846 return $properties;
847 }
848
849 /**
850 * Add all the elements shared between contribute search and advnaced search.
851 *
852 *
853 * @param CRM_Core_Form $form
854 *
855 * @return void
856 */
857 public static function buildSearchForm(&$form) {
858
859 // Added contribution source
860 $form->addElement('text', 'contribution_source', ts('Contribution Source'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution', 'source'));
861
862 CRM_Core_Form_Date::buildDateRange($form, 'contribution_date', 1, '_low', '_high', ts('From:'), FALSE);
863
864 $form->add('text', 'contribution_amount_low', ts('From'), array('size' => 8, 'maxlength' => 8));
865 $form->addRule('contribution_amount_low', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money::format('9.99', ' '))), 'money');
866
867 $form->add('text', 'contribution_amount_high', ts('To'), array('size' => 8, 'maxlength' => 8));
868 $form->addRule('contribution_amount_high', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money::format('99.99', ' '))), 'money');
869
870 // Adding select option for curreny type -- CRM-4711
871 $form->add('select', 'contribution_currency_type',
872 ts('Currency Type'),
873 array(
874 '' => ts('- any -'),
875 ) +
876 CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'currency', array('labelColumn' => 'name')),
877 FALSE, array('class' => 'crm-select2')
878 );
879
880 // CRM-13848
881 $form->addSelect('financial_type_id',
882 array('entity' => 'contribution', 'multiple' => 'multiple', 'context' => 'search')
883 );
884
885 $form->add('select', 'contribution_page_id',
886 ts('Contribution Page'),
887 array(
888 '' => ts('- any -'),
889 ) +
890 CRM_Contribute_PseudoConstant::contributionPage(),
891 FALSE, array('class' => 'crm-select2')
892 );
893
894 $form->addSelect('payment_instrument_id',
895 array('entity' => 'contribution', 'label' => ts('Payment Method'), 'option_url' => NULL, 'placeholder' => ts('- any -'))
896 );
897
898 $form->add('select',
899 'contribution_pcp_made_through_id',
900 ts('Personal Campaign Page'),
901 CRM_Contribute_PseudoConstant::pcPage(), FALSE, array('class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -')));
902
903 $statusValues = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id');
904 // Remove status values that are only used for recurring contributions or pledges (In Progress, Overdue).
905 unset($statusValues['5'], $statusValues['6']);
906 $form->add('select', 'contribution_status_id',
907 ts('Contribution Status'), $statusValues,
908 FALSE, array('class' => 'crm-select2', 'multiple' => 'multiple')
909 );
910
911 // Add fields for thank you and receipt
912 $form->addYesNo('contribution_thankyou_date_is_not_null', ts('Thank-you sent?'), TRUE);
913 $form->addYesNo('contribution_receipt_date_is_not_null', ts('Receipt sent?'), TRUE);
914
915 $form->addYesNo('contribution_pay_later', ts('Contribution is Pay Later?'), TRUE);
916 $form->addYesNo('contribution_recurring', ts('Contribution is Recurring?'), TRUE);
917
918 // Recurring contribution fields
919 foreach (self::getRecurringFields() as $key => $label) {
920 CRM_Core_Form_Date::buildDateRange($form, $key, 1, '_low', '_high');
921 // If data has been entered for a recurring field, tell the tpl layer to open the pane
922 if (!empty($form->_formValues[$key . '_relative']) || !empty($form->_formValues[$key . '_low']) || !empty($form->_formValues[$key . '_high'])) {
923 $form->assign('contribution_recur_pane_open', TRUE);
924 }
925 }
926
927 $form->addYesNo('contribution_test', ts('Contribution is a Test?'), TRUE);
928
929 // Add field for transaction ID search
930 $form->addElement('text', 'contribution_trxn_id', ts("Transaction ID"));
931 $form->addElement('text', 'invoice_id', ts("Invoice ID"));
932 $form->addElement('text', 'contribution_check_number', ts('Check Number'));
933
934 // Add field for pcp display in roll search
935 $form->addYesNo('contribution_pcp_display_in_roll', ts('Personal Campaign Page Honor Roll?'), TRUE);
936
937 // Soft credit related fields
938 $options = array(
939 'only_contribs' => ts('Contributions Only'),
940 'only_scredits' => ts('Soft Credits Only'),
941 'both_related' => ts('Soft Credits with related Hard Credit'),
942 'both' => ts('Both'),
943 );
944 $form->add('select', 'contribution_or_softcredits', ts('Contributions OR Soft Credits?'), $options, FALSE, array('class' => "crm-select2"));
945 $form->addSelect(
946 'contribution_soft_credit_type_id',
947 array(
948 'entity' => 'contribution_soft',
949 'field' => 'soft_credit_type_id',
950 'multiple' => TRUE,
951 'context' => 'search',
952 )
953 );
954
955 // Add all the custom searchable fields
956 $contribution = array('Contribution');
957 $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $contribution);
958 if ($groupDetails) {
959 $form->assign('contributeGroupTree', $groupDetails);
960 foreach ($groupDetails as $group) {
961 foreach ($group['fields'] as $field) {
962 $fieldId = $field['id'];
963 $elementName = 'custom_' . $fieldId;
964 CRM_Core_BAO_CustomField::addQuickFormElement($form,
965 $elementName,
966 $fieldId,
967 FALSE, FALSE, TRUE
968 );
969 }
970 }
971 }
972
973 CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'contribution_campaign_id');
974
975 // Add batch select
976 $batches = CRM_Contribute_PseudoConstant::batch();
977
978 if (!empty($batches)) {
979 $form->add('select', 'contribution_batch_id',
980 ts('Batch Name'),
981 array('' => ts('- any -')) + $batches,
982 FALSE, array('class' => 'crm-select2')
983 );
984 }
985
986 $form->assign('validCiviContribute', TRUE);
987 $form->setDefaults(array('contribution_test' => 0));
988 }
989
990 /**
991 * Function that may not be needed.
992 *
993 * @param array $row
994 * @param int $id
995 */
996 public static function searchAction(&$row, $id) {
997 }
998
999 /**
1000 * Get table names.
1001 *
1002 * @todo better function comment needed - what IS the point of this?
1003 *
1004 * @param array $tables
1005 */
1006 public static function tableNames(&$tables) {
1007 // Add contribution table
1008 if (!empty($tables['civicrm_product'])) {
1009 $tables = array_merge(array('civicrm_contribution' => 1), $tables);
1010 }
1011
1012 if (!empty($tables['civicrm_contribution_product']) && empty($tables['civicrm_product'])) {
1013 $tables['civicrm_product'] = 1;
1014 }
1015 }
1016
1017 /**
1018 * Add the where for dates.
1019 *
1020 * @param array $values
1021 * Array of query values.
1022 * @param object $query
1023 * The query object.
1024 * @param string $name
1025 * Query field that is set.
1026 * @param string $field
1027 * Name of field to be set.
1028 * @param string $title
1029 * Title of the field.
1030 *
1031 * @return bool
1032 */
1033 public static function buildDateWhere(&$values, $query, $name, $field, $title) {
1034 $fieldPart = strpos($name, $field);
1035 if ($fieldPart === FALSE) {
1036 return NULL;
1037 }
1038 // we only have recurring dates using this ATM so lets' short cut to find the table name
1039 $table = 'contribution_recur';
1040 $fieldName = explode($table . '_', $field);
1041 $query->dateQueryBuilder($values,
1042 'civicrm_' . $table, $field, $fieldName[1], $title
1043 );
1044 return TRUE;
1045 }
1046
1047 /**
1048 * Get fields for recurring contributions.
1049 *
1050 * @return array
1051 */
1052 public static function getRecurringFields() {
1053 return array(
1054 'contribution_recur_start_date' => ts('Recurring Contribution Start Date'),
1055 'contribution_recur_next_sched_contribution_date' => ts('Next Scheduled Recurring Contribution'),
1056 'contribution_recur_cancel_date' => ts('Recurring Contribution Cancel Date'),
1057 'contribution_recur_end_date' => ts('Recurring Contribution End Date'),
1058 'contribution_recur_create_date' => ('Recurring Contribution Create Date'),
1059 'contribution_recur_modified_date' => ('Recurring Contribution Modified Date'),
1060 'contribution_recur_failure_retry_date' => ts('Failed Recurring Contribution Retry Date'),
1061 );
1062 }
1063
1064 }