3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Contribute_BAO_Query
{
38 * Static field for all the export/import contribution fields
42 static $_contributionFields = NULL;
44 static $_contribOrSoftCredit = "only_contribs";
47 * Function get the import/export fields for contribution
50 * self::$_contributionFields associative array of contribution fields
52 public static function &getFields() {
53 if (!self
::$_contributionFields) {
54 self
::$_contributionFields = array();
56 $fields = CRM_Contribute_BAO_Contribution
::exportableFields();
58 unset($fields['contribution_contact_id']);
60 self
::$_contributionFields = $fields;
62 return self
::$_contributionFields;
66 * If contributions are involved, add the specific contribute fields
72 public static function select(&$query) {
73 // if contribute mode add contribution id
74 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
75 $query->_select
['contribution_id'] = "civicrm_contribution.id as contribution_id";
76 $query->_element
['contribution_id'] = 1;
77 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
81 if (!empty($query->_returnProperties
['financial_type'])) {
82 $query->_select
['financial_type'] = "civicrm_financial_type.name as financial_type";
83 $query->_element
['financial_type'] = 1;
84 $query->_tables
['civicrm_contribution'] = 1;
85 $query->_tables
['civicrm_financial_type'] = 1;
88 // get accounting code
89 if (!empty($query->_returnProperties
['accounting_code'])) {
90 $query->_select
['accounting_code'] = "civicrm_financial_account.accounting_code as accounting_code";
91 $query->_element
['accounting_code'] = 1;
92 $query->_tables
['civicrm_accounting_code'] = 1;
93 $query->_tables
['civicrm_financial_account'] = 1;
96 if (!empty($query->_returnProperties
['contribution_note'])) {
97 $query->_select
['contribution_note'] = "civicrm_note.note as contribution_note";
98 $query->_element
['contribution_note'] = 1;
99 $query->_tables
['contribution_note'] = 1;
100 $query->_tables
['civicrm_contribution'] = 1;
103 if (!empty($query->_returnProperties
['contribution_batch'])) {
104 $query->_select
['contribution_batch'] = "civicrm_batch.title as contribution_batch";
105 $query->_element
['contribution_batch'] = 1;
106 $query->_tables
['contribution_batch'] = 1;
109 if (!empty($query->_returnProperties
['contribution_source'])) {
110 $query->_select
['contribution_source'] = "civicrm_contribution.source as contribution_source";
111 $query->_element
['contribution_source'] = 1;
112 $query->_tables
['civicrm_contribution'] = 1;
115 // get contribution_status
116 if (!empty($query->_returnProperties
['contribution_status_id'])) {
117 $query->_select
['contribution_status_id'] = "contribution_status.value as contribution_status_id";
118 $query->_element
['contribution_status_id'] = 1;
119 $query->_tables
['civicrm_contribution'] = 1;
120 $query->_tables
['contribution_status'] = 1;
123 // get contribution_status label
124 if (!empty($query->_returnProperties
['contribution_status'])) {
125 $query->_select
['contribution_status'] = "contribution_status.label as contribution_status";
126 $query->_element
['contribution_status'] = 1;
127 $query->_tables
['civicrm_contribution'] = 1;
128 $query->_tables
['contribution_status'] = 1;
131 // get payment instrument
132 if (!empty($query->_returnProperties
['payment_instrument'])) {
133 $query->_select
['payment_instrument'] = "contribution_payment_instrument.label as payment_instrument";
134 $query->_element
['payment_instrument'] = 1;
135 $query->_tables
['civicrm_contribution'] = 1;
136 $query->_tables
['contribution_payment_instrument'] = 1;
139 // get payment instrument id
140 if (!empty($query->_returnProperties
['payment_instrument_id'])) {
141 $query->_select
['instrument_id'] = "contribution_payment_instrument.value as instrument_id";
142 $query->_select
['payment_instrument_id'] = "contribution_payment_instrument.value as payment_instrument_id";
143 $query->_element
['instrument_id'] = $query->_element
['payment_instrument_id'] = 1;
144 $query->_tables
['civicrm_contribution'] = 1;
145 $query->_tables
['contribution_payment_instrument'] = 1;
148 if (!empty($query->_returnProperties
['check_number'])) {
149 $query->_select
['contribution_check_number'] = "civicrm_contribution.check_number as contribution_check_number";
150 $query->_element
['contribution_check_number'] = 1;
151 $query->_tables
['civicrm_contribution'] = 1;
154 if (!empty($query->_returnProperties
['contribution_campaign_id'])) {
155 $query->_select
['contribution_campaign_id'] = 'civicrm_contribution.campaign_id as contribution_campaign_id';
156 $query->_element
['contribution_campaign_id'] = 1;
157 $query->_tables
['civicrm_contribution'] = 1;
161 if (!empty($query->_returnProperties
['contribution_soft_credit_name'])) {
162 $query->_select
['contribution_soft_credit_name'] = "civicrm_contact_d.sort_name as contribution_soft_credit_name";
163 $query->_element
['contribution_soft_credit_name'] = 1;
165 // also include contact id. Will help build hyperlinks
166 $query->_select
['contribution_soft_credit_contact_id'] = "civicrm_contact_d.id as contribution_soft_credit_contact_id";
167 $query->_element
['contribution_soft_credit_contact_id'] = 1;
169 $query->_tables
['civicrm_contribution'] = 1;
170 $query->_tables
['civicrm_contribution_soft'] = 1;
171 $query->_tables
['civicrm_contribution_soft_contact'] = 1;
174 if (!empty($query->_returnProperties
['contribution_soft_credit_contact_id'])) {
175 $query->_tables
['civicrm_contribution'] = 1;
176 $query->_tables
['civicrm_contribution_soft'] = 1;
179 if (!empty($query->_returnProperties
['contribution_soft_credit_amount'])) {
180 $query->_select
['contribution_soft_credit_amount'] = "civicrm_contribution_soft.amount as contribution_soft_credit_amount";
181 $query->_element
['contribution_soft_credit_amount'] = 1;
182 $query->_tables
['civicrm_contribution'] = 1;
183 $query->_tables
['civicrm_contribution_soft'] = 1;
186 if (!empty($query->_returnProperties
['contribution_soft_credit_type'])) {
187 $query->_select
['contribution_soft_credit_type'] = "contribution_softcredit_type.label as contribution_soft_credit_type";
188 $query->_element
['contribution_soft_credit_type'] = 1;
189 $query->_tables
['civicrm_contribution'] = 1;
190 $query->_tables
['contribution_softcredit_type'] = 1;
193 if (!empty($query->_returnProperties
['contribution_soft_credit_contribution_id'])) {
194 $query->_select
['contribution_soft_credit_contribution_id'] = "civicrm_contribution_soft.contribution_id as contribution_soft_credit_contribution_id";
195 $query->_element
['contribution_soft_credit_contribution_id'] = 1;
196 $query->_tables
['civicrm_contribution'] = 1;
197 $query->_tables
['civicrm_contribution_soft'] = 1;
200 if (!empty($query->_returnProperties
['contribution_soft_credit_email'])) {
201 $query->_select
['contribution_soft_credit_email'] = "soft_email.email as contribution_soft_credit_email";
202 $query->_element
['contribution_soft_credit_email'] = 1;
203 $query->_tables
['civicrm_contribution'] = 1;
204 $query->_tables
['civicrm_contribution_soft'] = 1;
205 $query->_tables
['civicrm_contribution_soft_contact'] = 1;
206 $query->_tables
['civicrm_contribution_soft_email'] = 1;
209 if (!empty($query->_returnProperties
['contribution_soft_credit_phone'])) {
210 $query->_select
['contribution_soft_credit_email'] = "soft_phone.phone as contribution_soft_credit_phone";
211 $query->_element
['contribution_soft_credit_phone'] = 1;
212 $query->_tables
['civicrm_contribution'] = 1;
213 $query->_tables
['civicrm_contribution_soft'] = 1;
214 $query->_tables
['civicrm_contribution_soft_contact'] = 1;
215 $query->_tables
['civicrm_contribution_soft_phone'] = 1;
223 public static function where(&$query) {
225 self
::initializeAnySoftCreditClause($query);
226 foreach (array_keys($query->_params
) as $id) {
227 if (empty($query->_params
[$id][0])) {
230 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_') {
231 if ($query->_mode
== CRM_Contact_BAO_QUERY
::MODE_CONTACTS
) {
232 $query->_useDistinct
= TRUE;
236 $query->_params
[$id][0] == 'contribution_type_id' ||
237 $query->_params
[$id][0] == 'contribution_type'
239 CRM_Core_Session
::setStatus(
240 ts('The contribution type criteria is now obsolete, please update your smart group'),
247 $grouping = $query->_params
[$id][3];
248 self
::whereClauseSingle($query->_params
[$id], $query);
257 public static function whereClauseSingle(&$values, &$query) {
258 list($name, $op, $value, $grouping, $wildcard) = $values;
261 $fields = array_merge(CRM_Contribute_BAO_Contribution
::fields(), self
::getFields());
263 if (!empty($value) && !is_array($value)) {
264 $quoteValue = "\"$value\"";
267 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
268 foreach (self
::getRecurringFields() as $dateField => $dateFieldTitle) {
269 if (self
::buildDateWhere($values, $query, $name, $dateField, $dateFieldTitle)) {
274 case 'contribution_date':
275 case 'contribution_date_low':
276 case 'contribution_date_low_time':
277 case 'contribution_date_high':
278 case 'contribution_date_high_time':
279 // process to / from date
280 $query->dateQueryBuilder($values,
281 'civicrm_contribution', 'contribution_date', 'receive_date', 'Contribution Date'
285 case 'contribution_amount':
286 case 'contribution_amount_low':
287 case 'contribution_amount_high':
288 // process min/max amount
289 $query->numberRangeBuilder($values,
290 'civicrm_contribution', 'contribution_amount',
291 'total_amount', 'Contribution Amount',
296 case 'contribution_thankyou_date_is_not_null':
299 $query->_qill
[$grouping][] = ts('Contribution Thank-you Sent');
303 $query->_qill
[$grouping][] = ts('Contribution Thank-you Not Sent');
305 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.thankyou_date", $op);
306 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
309 case 'contribution_receipt_date_is_not_null':
312 $query->_qill
[$grouping][] = ts('Contribution Receipt Sent');
316 $query->_qill
[$grouping][] = ts('Contribution Receipt Not Sent');
318 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.receipt_date", $op);
319 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
322 case 'financial_type_id':
323 case 'contribution_page_id':
324 case 'contribution_status_id':
325 case 'contribution_id':
326 case 'contribution_currency_type':
327 case 'contribution_currency':
328 case 'contribution_source':
329 case 'contribution_trxn_id':
330 case 'contribution_check_number':
331 case (strpos($name, '_amount') !== FALSE):
332 case (strpos($name, '_date') !== FALSE):
334 $pseudoExtraParam = NULL;
335 if ((strpos($name, '_amount') !== FALSE) ||
(strpos($name, '_date') !== FALSE) ||
in_array($name,
338 'contribution_currency',
339 'contribution_source',
340 'contribution_trxn_id',
341 'contribution_check_number',
345 $name = str_replace('contribution_', '', $name);
346 if (!in_array($name, array('source', 'id'))) {
347 $qillName = str_replace('contribution_', '', $qillName);
350 if (in_array($name, array('contribution_currency', 'contribution_currency_type'))) {
351 $qillName = $name = 'currency';
352 $pseudoExtraParam = array('labelColumn' => 'name');
355 $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type
::typeToString($fields[$qillName]['type']) : 'String';
357 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.$name", $op, $value, $dataType);
358 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op, $pseudoExtraParam);
359 $query->_qill
[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $op, 3 => $value));
360 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
363 case 'financial_type':
364 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($fields[$name]['where'], $op, $value, 'String');
365 CRM_Core_Error
::debug('$query', $query->_where
[$grouping]);
366 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op);
367 $query->_qill
[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$name]['title'], 2 => $op, 3 => $value));
368 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
369 $query->_tables
['civicrm_financial_type'] = $query->_whereTables
['civicrm_financial_type'] = 1;
372 case 'contribution_page':
373 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($fields[$name]['where'], $op, $value, 'String');
374 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op);
375 $query->_qill
[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$name]['title'], 2 => $op, 3 => $value));
376 $query->_tables
['civicrm_contribution_page'] = $query->_whereTables
['civicrm_contribution_page'] = 1;
377 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
380 case 'contribution_payment_instrument':
381 case 'contribution_payment_instrument_id':
382 $name = str_replace('contribution_', '', $name);
383 case 'payment_instrument':
384 case 'payment_instrument_id':
385 if ($name == 'payment_instrument') {
386 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("contribution_payment_instrument.label", $op, $value);
389 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("contribution_payment_instrument.value", $op, $value, 'Int');
391 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', 'payment_instrument_id', $value, $op);
392 $query->_qill
[$grouping][] = ts('%1 %2 %3', array(1 => $fields['payment_instrument']['title'], 2 => $op, 3 => $value));
393 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
394 $query->_tables
['contribution_payment_instrument'] = $query->_whereTables
['contribution_payment_instrument'] = 1;
397 case 'contribution_status':
398 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("$name.label", $op, $value, 'String');
399 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op);
400 $query->_qill
[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$name]['title'], 2 => $op, 3 => $value));
401 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
402 $query->_tables
[$name] = $query->_whereTables
[$name] = 1;
405 case 'contribution_pcp_made_through_id':
406 case 'contribution_soft_credit_type_id':
408 if ($name == 'contribution_pcp_made_through_id') {
409 $qillName = $name = 'pcp_id';
410 $fields[$name] = array('title' => ts('Personal Campaign Page'), 'type' => 2);
412 if ($name == 'contribution_soft_credit_type_id') {
413 $qillName = str_replace('_id', '', $qillName);
414 $fields[$qillName]['type'] = $fields[$qillName]['data_type'];
415 $name = str_replace('contribution_', '', $name);
417 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution_soft.$name",
418 $op, $value, CRM_Utils_Type
::typeToString($fields[$qillName]['type'])
420 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contribute_DAO_ContributionSoft', $name, $value, $op);
421 $query->_qill
[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $op, 3 => $value));
422 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
425 case 'contribution_or_softcredits':
426 if ($value == 'only_scredits') {
427 $query->_where
[$grouping][] = "contribution_search_scredit_combined.scredit_id IS NOT NULL";
428 $query->_qill
[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits Only');
429 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
430 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
432 elseif ($value == 'both_related') {
433 $query->_where
[$grouping][] = "contribution_search_scredit_combined.filter_id IS NOT NULL";
434 $query->_qill
[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits with related Hard Credit');
435 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
436 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
438 elseif ($value == 'both') {
439 $query->_qill
[$grouping][] = ts('Contributions OR Soft Credits? - Both');
440 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
441 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
443 // default option: $value == 'only_contribs'
446 case 'contribution_is_test':
447 // By default is Contribution Search form we choose is_test = 0 in otherwords always show active contribution
448 // so in case if any one choose any Yes/No avoid the default clause otherwise it will be conflict in whereClause
449 $key = array_search('civicrm_contribution.is_test = 0', $query->_where
[$grouping]);
451 unset($query->_where
[$grouping][$key]);
453 case 'contribution_test':
454 // We dont want to include all tests for sql OR CRM-7827
455 if (!$value ||
$query->getOperator() != 'OR') {
456 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.is_test", $op, $value, "Boolean");
458 $query->_qill
[$grouping][] = ts("Only Display Test Contributions");
460 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
464 case 'contribution_is_pay_later':
465 case 'contribution_pay_later':
466 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.is_pay_later", $op, $value, "Boolean");
468 $query->_qill
[$grouping][] = ts("Find Pay Later Contributions");
471 $query->_qill
[$grouping][] = ts("Exclude Pay Later Contributions");
473 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
476 case 'contribution_recurring':
478 $query->_where
[$grouping][] = "civicrm_contribution.contribution_recur_id IS NOT NULL";
479 $query->_qill
[$grouping][] = ts("Find Recurring Contributions");
480 $query->_tables
['civicrm_contribution_recur'] = $query->_whereTables
['civicrm_contribution_recur'] = 1;
483 $query->_where
[$grouping][] = "civicrm_contribution.contribution_recur_id IS NULL";
484 $query->_qill
[$grouping][] = ts("Exclude Recurring Contributions");
488 case 'contribution_recur_id':
489 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.contribution_recur_id",
490 $op, $value, "Integer"
492 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
495 case 'contribution_note':
496 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
501 $wc = ($op != 'LIKE') ?
"LOWER(civicrm_note.note)" : "civicrm_note.note";
502 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($wc, $op, $value, "String");
503 $query->_qill
[$grouping][] = ts('Contribution Note %1 %2', array(1 => $op, 2 => $quoteValue));
504 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = $query->_whereTables
['contribution_note'] = 1;
507 case 'contribution_membership_id':
508 $query->_where
[$grouping][] = " civicrm_membership.id $op $value";
509 $query->_tables
['contribution_membership'] = $query->_whereTables
['contribution_membership'] = 1;
513 case 'contribution_participant_id':
514 $query->_where
[$grouping][] = " civicrm_participant.id $op $value";
515 $query->_tables
['contribution_participant'] = $query->_whereTables
['contribution_participant'] = 1;
518 case 'contribution_pcp_display_in_roll':
519 $query->_where
[$grouping][] = " civicrm_contribution_soft.pcp_display_in_roll $op '$value'";
521 $query->_qill
[$grouping][] = ts("Personal Campaign Page Honor Roll");
524 $query->_qill
[$grouping][] = ts("NOT Personal Campaign Page Honor Roll");
526 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
529 case 'contribution_campaign_id':
532 'campaign' => $value,
533 'grouping' => $grouping,
534 'tableName' => 'civicrm_contribution',
536 CRM_Campaign_BAO_Query
::componentSearchClause($campParams, $query);
539 case 'contribution_batch_id':
540 $batches = CRM_Contribute_PseudoConstant
::batch();
541 $query->_where
[$grouping][] = " civicrm_entity_batch.batch_id $op $value";
542 $query->_qill
[$grouping][] = ts('Batch Name %1 %2', array(1 => $op, 2 => $batches[$value]));
543 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
544 $query->_tables
['contribution_batch'] = $query->_whereTables
['contribution_batch'] = 1;
548 //all other elements are handle in this case
549 $fldName = substr($name, 13);
550 if (!isset($fields[$fldName])) {
552 CRM_Core_Session
::setStatus(ts(
553 'We did not recognize the search field: %1. Please check and fix your contribution related smart groups.',
559 $whereTable = $fields[$fldName];
560 $value = trim($value);
562 $dataType = "String";
563 if (!empty($whereTable['type'])) {
564 $dataType = CRM_Utils_Type
::typeToString($whereTable['type']);
567 $wc = ($op != 'LIKE' && $dataType != 'Date') ?
"LOWER($whereTable[where])" : "$whereTable[where]";
568 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($wc, $op, $value, $dataType);
569 $query->_qill
[$grouping][] = "$whereTable[title] $op $quoteValue";
570 list($tableName, $fieldName) = explode('.', $whereTable['where'], 2);
571 $query->_tables
[$tableName] = $query->_whereTables
[$tableName] = 1;
572 if ($tableName == 'civicrm_contribution_product') {
573 $query->_tables
['civicrm_product'] = $query->_whereTables
['civicrm_product'] = 1;
574 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
577 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
583 * @param string $name
587 * @return NULL|string
589 public static function from($name, $mode, $side) {
592 case 'civicrm_contribution':
593 $from = " $side JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id ";
594 if (in_array(self
::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
595 // switch the from table if its only soft credit search
596 $from = " $side JOIN contribution_search_scredit_combined ON contribution_search_scredit_combined.contact_id = contact_a.id ";
597 $from .= " $side JOIN civicrm_contribution ON civicrm_contribution.id = contribution_search_scredit_combined.id ";
598 $from .= " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.id = contribution_search_scredit_combined.scredit_id";
602 case 'civicrm_contribution_recur':
604 // in contact mode join directly onto profile - in case no contributions exist yet
605 $from = " $side JOIN civicrm_contribution_recur ON contact_a.id = civicrm_contribution_recur.contact_id ";
608 $from = " $side JOIN civicrm_contribution_recur ON civicrm_contribution.contribution_recur_id = civicrm_contribution_recur.id ";
612 case 'civicrm_financial_type':
613 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
614 $from = " INNER JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
617 $from = " $side JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
621 case 'civicrm_financial_account':
622 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTACTS
) {
623 $from = " $side JOIN civicrm_financial_account ON contact_a.id = civicrm_financial_account.contact_id ";
627 case 'civicrm_accounting_code':
628 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
629 $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' ";
630 $from .= " INNER JOIN civicrm_financial_account ON civicrm_financial_account.id = civicrm_entity_financial_account.financial_account_id ";
631 $from .= " INNER JOIN civicrm_option_value cov ON cov.value = civicrm_entity_financial_account.account_relationship AND cov.name = 'Income Account is' ";
632 $from .= " INNER JOIN civicrm_option_group cog ON cog.id = cov.option_group_id AND cog.name = 'account_relationship' ";
636 case 'civicrm_contribution_page':
637 $from = " $side JOIN civicrm_contribution_page ON civicrm_contribution.contribution_page_id = civicrm_contribution_page.id";
640 case 'civicrm_product':
641 $from = " $side JOIN civicrm_contribution_product ON civicrm_contribution_product.contribution_id = civicrm_contribution.id";
642 $from .= " $side JOIN civicrm_product ON civicrm_contribution_product.product_id =civicrm_product.id ";
645 case 'contribution_payment_instrument':
646 $from = " $side JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')";
647 $from .= " $side JOIN civicrm_option_value contribution_payment_instrument ON (civicrm_contribution.payment_instrument_id = contribution_payment_instrument.value
648 AND option_group_payment_instrument.id = contribution_payment_instrument.option_group_id ) ";
651 case 'contribution_status':
652 $from = " $side JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')";
653 $from .= " $side JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
654 AND option_group_contribution_status.id = contribution_status.option_group_id ) ";
657 case 'contribution_softcredit_type':
658 $from = " $side JOIN civicrm_option_group option_group_contribution_softcredit_type ON
659 (option_group_contribution_softcredit_type.name = 'soft_credit_type')";
660 $from .= " $side JOIN civicrm_option_value contribution_softcredit_type ON
661 ( civicrm_contribution_soft.soft_credit_type_id = contribution_softcredit_type.value
662 AND option_group_contribution_softcredit_type.id = contribution_softcredit_type.option_group_id )";
665 case 'contribution_note':
666 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contribution' AND
667 civicrm_contribution.id = civicrm_note.entity_id )";
670 case 'contribution_membership':
671 $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.contribution_id = civicrm_contribution.id";
672 $from .= " $side JOIN civicrm_membership ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
675 case 'contribution_participant':
676 $from = " $side JOIN civicrm_participant_payment ON civicrm_participant_payment.contribution_id = civicrm_contribution.id";
677 $from .= " $side JOIN civicrm_participant ON civicrm_participant_payment.participant_id = civicrm_participant.id ";
680 case 'civicrm_contribution_soft':
681 if (!in_array(self
::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
682 $from = " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.contribution_id = civicrm_contribution.id";
686 case 'civicrm_contribution_soft_contact':
687 if (in_array(self
::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
688 $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution.contact_id = civicrm_contact_d.id )
689 AND contribution_search_scredit_combined.scredit_id IS NOT NULL";
692 $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution_soft.contact_id = civicrm_contact_d.id )";
696 case 'civicrm_contribution_soft_email':
697 $from .= " $side JOIN civicrm_email as soft_email ON (civicrm_contact_d.id = soft_email.contact_id )";
700 case 'civicrm_contribution_soft_phone':
701 $from .= " $side JOIN civicrm_phone as soft_phone ON (civicrm_contact_d.id = soft_phone.contact_id )";
704 case 'contribution_batch':
705 $from .= " $side JOIN civicrm_entity_financial_trxn ON (
706 civicrm_entity_financial_trxn.entity_table = 'civicrm_contribution'
707 AND civicrm_contribution.id = civicrm_entity_financial_trxn.entity_id )";
709 $from .= " $side JOIN civicrm_financial_trxn ON (
710 civicrm_entity_financial_trxn.financial_trxn_id = civicrm_financial_trxn.id )";
712 $from .= " $side JOIN civicrm_entity_batch ON ( civicrm_entity_batch.entity_table = 'civicrm_financial_trxn'
713 AND civicrm_financial_trxn.id = civicrm_entity_batch.entity_id )";
715 $from .= " $side JOIN civicrm_batch ON civicrm_entity_batch.batch_id = civicrm_batch.id";
724 public static function initializeAnySoftCreditClause(&$query) {
725 if (self
::isSoftCreditOptionEnabled($query->_params
)) {
726 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
727 unset($query->_distinctComponentClause
);
728 $query->_rowCountClause
= " count(civicrm_contribution.id)";
729 $query->_groupByComponentClause
= " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
735 * @param array $queryParams
739 public static function isSoftCreditOptionEnabled($queryParams = array()) {
740 static $tempTableFilled = FALSE;
741 if (!empty($queryParams)) {
742 foreach (array_keys($queryParams) as $id) {
743 if (empty($queryParams[$id][0])) {
746 if ($queryParams[$id][0] == 'contribution_or_softcredits') {
747 self
::$_contribOrSoftCredit = $queryParams[$id][2];
751 if (in_array(self
::$_contribOrSoftCredit,
752 array("only_scredits", "both_related", "both"))) {
753 if (!$tempTableFilled) {
754 // build a temp table which is union of contributions and soft credits
755 // note: group-by in first part ensures uniqueness in counts
757 CREATE TEMPORARY TABLE IF NOT EXISTS contribution_search_scredit_combined AS
758 SELECT con.id as id, con.contact_id, cso.id as filter_id, NULL as scredit_id
759 FROM civicrm_contribution con
760 LEFT JOIN civicrm_contribution_soft cso ON con.id = cso.contribution_id
761 GROUP BY id, contact_id, scredit_id
763 SELECT scredit.contribution_id as id, scredit.contact_id, scredit.id as filter_id, scredit.id as scredit_id
764 FROM civicrm_contribution_soft as scredit";
765 CRM_Core_DAO
::executeQuery($tempQuery);
766 $tempTableFilled = TRUE;
774 * @param bool $isExportMode
778 public static function softCreditReturnProperties($isExportMode = FALSE) {
780 'contribution_soft_credit_name' => 1,
781 'contribution_soft_credit_amount' => 1,
782 'contribution_soft_credit_type' => 1,
785 $properties['contribution_soft_credit_contribution_id'] = 1;
792 * @param bool $includeCustomFields
796 public static function defaultReturnProperties($mode, $includeCustomFields = TRUE) {
798 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
801 'contact_sub_type' => 1,
804 'financial_type' => 1,
805 'contribution_source' => 1,
807 'thankyou_date' => 1,
810 'accounting_code' => 1,
811 'payment_instrument' => 1,
812 'payment_instrument_id' => 1,
814 'non_deductible_amount' => 1,
820 'cancel_reason' => 1,
824 'product_option' => 1,
825 'fulfilled_date' => 1,
826 'contribution_start_date' => 1,
827 'contribution_end_date' => 1,
830 'contribution_status' => 1,
831 'contribution_status_id' => 1,
832 'contribution_recur_id' => 1,
834 'contribution_note' => 1,
835 'contribution_batch' => 1,
836 'contribution_campaign_id' => 1,
838 if (self
::isSoftCreditOptionEnabled()) {
839 $properties = array_merge($properties, self
::softCreditReturnProperties());
841 if ($includeCustomFields) {
842 // also get all the custom contribution properties
843 $fields = CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution');
844 if (!empty($fields)) {
845 foreach ($fields as $name => $dontCare) {
846 $properties[$name] = 1;
855 * Add all the elements shared between contribute search and advnaced search
858 * @param CRM_Core_Form $form
862 public static function buildSearchForm(&$form) {
864 // Added contribution source
865 $form->addElement('text', 'contribution_source', ts('Contribution Source'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'source'));
867 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_date', 1, '_low', '_high', ts('From:'), FALSE);
869 $form->add('text', 'contribution_amount_low', ts('From'), array('size' => 8, 'maxlength' => 8));
870 $form->addRule('contribution_amount_low', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money
::format('9.99', ' '))), 'money');
872 $form->add('text', 'contribution_amount_high', ts('To'), array('size' => 8, 'maxlength' => 8));
873 $form->addRule('contribution_amount_high', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money
::format('99.99', ' '))), 'money');
875 // Adding select option for curreny type -- CRM-4711
876 $form->add('select', 'contribution_currency_type',
881 CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'currency', array('labelColumn' => 'name')),
882 FALSE, array('class' => 'crm-select2')
886 $form->addSelect('financial_type_id',
887 array('entity' => 'contribution', 'multiple' => 'multiple', 'context' => 'search')
890 $form->add('select', 'contribution_page_id',
891 ts('Contribution Page'),
895 CRM_Contribute_PseudoConstant
::contributionPage(),
896 FALSE, array('class' => 'crm-select2')
899 $form->addSelect('payment_instrument_id',
900 array('entity' => 'contribution', 'label' => ts('Payment Method'), 'option_url' => NULL, 'placeholder' => ts('- any -'))
903 $form->add('select', 'contribution_pcp_made_through_id',
904 ts('Personal Campaign Page'),
908 CRM_Contribute_PseudoConstant
::pcPage(),
909 FALSE, array('class' => 'crm-select2')
914 $statusValues = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'contribution_status');
915 // Remove status values that are only used for recurring contributions or pledges (In Progress, Overdue).
916 unset($statusValues['5'], $statusValues['6']);
918 $form->addSelect('contribution_status_id',
919 array('entity' => 'contribution', 'multiple' => 'multiple', 'label' => ts('Contribution Status(s)'), 'option_url' => NULL, 'placeholder' => ts('- any -'))
922 // Add fields for thank you and receipt
923 $form->addYesNo('contribution_thankyou_date_is_not_null', ts('Thank-you sent?'), TRUE);
924 $form->addYesNo('contribution_receipt_date_is_not_null', ts('Receipt sent?'), TRUE);
926 $form->addYesNo('contribution_pay_later', ts('Contribution is Pay Later?'), TRUE);
927 $form->addYesNo('contribution_recurring', ts('Contribution is Recurring?'), TRUE);
929 // Recurring contribution fields
930 foreach (self
::getRecurringFields() as $key => $label) {
931 CRM_Core_Form_Date
::buildDateRange($form, $key, 1, '_low', '_high');
932 // If data has been entered for a recurring field, tell the tpl layer to open the pane
933 if (!empty($form->_formValues
[$key . '_relative']) ||
!empty($form->_formValues
[$key . '_low']) ||
!empty($form->_formValues
[$key . '_high'])) {
934 $form->assign('contribution_recur_pane_open', TRUE);
938 $form->addYesNo('contribution_test', ts('Contribution is a Test?'), TRUE);
940 // Add field for transaction ID search
941 $form->addElement('text', 'contribution_trxn_id', ts("Transaction ID"));
943 $form->addElement('text', 'contribution_check_number', ts('Check Number'));
945 // Add field for pcp display in roll search
946 $form->addYesNo('contribution_pcp_display_in_roll', ts('Personal Campaign Page Honor Roll?'), TRUE);
948 // Soft credit related fields
950 'only_contribs' => ts('Contributions Only'),
951 'only_scredits' => ts('Soft Credits Only'),
952 'both_related' => ts('Soft Credits with related Hard Credit'),
953 'both' => ts('Both'),
955 $form->add('select', 'contribution_or_softcredits', ts('Contributions OR Soft Credits?'), $options, FALSE, array('class' => "crm-select2"));
957 'contribution_soft_credit_type_id',
959 'entity' => 'contribution_soft',
960 'field' => 'soft_credit_type_id',
962 'context' => 'search',
966 // Add all the custom searchable fields
967 $contribution = array('Contribution');
968 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $contribution);
970 $form->assign('contributeGroupTree', $groupDetails);
971 foreach ($groupDetails as $group) {
972 foreach ($group['fields'] as $field) {
973 $fieldId = $field['id'];
974 $elementName = 'custom_' . $fieldId;
975 CRM_Core_BAO_CustomField
::addQuickFormElement($form,
984 CRM_Campaign_BAO_Campaign
::addCampaignInComponentSearch($form, 'contribution_campaign_id');
987 $batches = CRM_Contribute_PseudoConstant
::batch();
989 if (!empty($batches)) {
990 $form->add('select', 'contribution_batch_id',
992 array('' => ts('- any -')) +
$batches,
993 FALSE, array('class' => 'crm-select2')
997 $form->assign('validCiviContribute', TRUE);
998 $form->setDefaults(array('contribution_test' => 0));
1005 public static function searchAction(&$row, $id) {
1011 public static function tableNames(&$tables) {
1012 // Add contribution table
1013 if (!empty($tables['civicrm_product'])) {
1014 $tables = array_merge(array('civicrm_contribution' => 1), $tables);
1017 if (!empty($tables['civicrm_contribution_product']) && empty($tables['civicrm_product'])) {
1018 $tables['civicrm_product'] = 1;
1023 * Add the where for dates
1025 * @param array $values
1026 * Array of query values.
1027 * @param object $query
1029 * @param string $name
1030 * Query field that is set.
1031 * @param string $field
1032 * Name of field to be set.
1033 * @param string $title
1034 * Title of the field.
1038 public static function buildDateWhere(&$values, $query, $name, $field, $title) {
1039 $fieldPart = strpos($name, $field);
1040 if ($fieldPart === FALSE) {
1043 // we only have recurring dates using this ATM so lets' short cut to find the table name
1044 $table = 'contribution_recur';
1045 $fieldName = explode($table . '_', $field);
1046 $query->dateQueryBuilder($values,
1047 'civicrm_' . $table, $field, $fieldName[1], $title
1055 public static function getRecurringFields() {
1057 'contribution_recur_start_date' => ts('Recurring Contribution Start Date'),
1058 'contribution_recur_next_sched_contribution_date' => ts('Next Scheduled Recurring Contribution'),
1059 'contribution_recur_cancel_date' => ts('Recurring Contribution Cancel Date'),
1060 'contribution_recur_end_date' => ts('Recurring Contribution End Date'),
1061 'contribution_recur_create_date' => ('Recurring Contribution Create Date'),
1062 'contribution_recur_modified_date' => ('Recurring Contribution Modified Date'),
1063 'contribution_recur_failure_retry_date' => ts('Failed Recurring Contribution Retry Date'),