3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
35 class CRM_Contribute_BAO_Query
{
38 * static field for all the export/import contribution fields
43 static $_contributionFields = NULL;
46 * Function get the import/export fields for contribution
48 * @return array self::$_contributionFields associative array of contribution fields
51 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
70 static function select(&$query) {
71 // if contribute mode add contribution id
72 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
73 $query->_select
['contribution_id'] = "civicrm_contribution.id as contribution_id";
74 $query->_element
['contribution_id'] = 1;
75 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
79 if (CRM_Utils_Array
::value('financial_type', $query->_returnProperties
)) {
80 $query->_select
['financial_type'] = "civicrm_financial_type.name as financial_type";
81 $query->_element
['financial_type'] = 1;
82 $query->_tables
['civicrm_contribution'] = 1;
83 $query->_tables
['civicrm_financial_type'] = 1;
86 // get accounting code
87 if (CRM_Utils_Array
::value( 'accounting_code', $query->_returnProperties
)) {
88 $query->_select
['accounting_code'] = "civicrm_financial_account.accounting_code as accounting_code";
89 $query->_element
['accounting_code'] = 1;
90 $query->_tables
['civicrm_accounting_code'] = 1;
91 $query->_tables
['civicrm_financial_account'] = 1;
94 if (CRM_Utils_Array
::value('contribution_note', $query->_returnProperties
)) {
95 $query->_select
['contribution_note'] = "civicrm_note.note as contribution_note";
96 $query->_element
['contribution_note'] = 1;
97 $query->_tables
['contribution_note'] = 1;
100 if (CRM_Utils_Array
::value('contribution_batch', $query->_returnProperties
)) {
101 $query->_select
['contribution_batch'] = "civicrm_batch.title as contribution_batch";
102 $query->_element
['contribution_batch'] = 1;
103 $query->_tables
['contribution_batch'] = 1;
106 // get contribution_status
107 if (CRM_Utils_Array
::value('contribution_status_id', $query->_returnProperties
)) {
108 $query->_select
['contribution_status_id'] = "contribution_status.value as contribution_status_id";
109 $query->_element
['contribution_status_id'] = 1;
110 $query->_tables
['civicrm_contribution'] = 1;
111 $query->_tables
['contribution_status'] = 1;
114 // get contribution_status label
115 if (CRM_Utils_Array
::value('contribution_status', $query->_returnProperties
)) {
116 $query->_select
['contribution_status'] = "contribution_status.label as contribution_status";
117 $query->_element
['contribution_status'] = 1;
118 $query->_tables
['civicrm_contribution'] = 1;
119 $query->_tables
['contribution_status'] = 1;
122 // get payment instruments
123 if (CRM_Utils_Array
::value('payment_instrument', $query->_returnProperties
)) {
124 $query->_select
['contribution_payment_instrument'] = "payment_instrument.name as contribution_payment_instrument";
125 $query->_element
['contribution_payment_instrument'] = 1;
126 $query->_tables
['civicrm_contribution'] = 1;
127 $query->_tables
['contribution_payment_instrument'] = 1;
130 // get honor contact name
131 if (CRM_Utils_Array
::value('honor_contact_name', $query->_returnProperties
)) {
132 $query->_select
['contribution_honor_contact_name'] = "civicrm_contact_c.display_name as contribution_honor_contact_name";
133 $query->_element
['contribution_honor_contact_name'] = 1;
134 $query->_tables
['civicrm_contribution'] = 1;
135 $query->_tables
['contribution_honor_contact_name'] = 1;
138 // get honor type label
139 if (CRM_Utils_Array
::value('honor_type_label', $query->_returnProperties
)) {
140 $query->_select
['contribution_honor_type_label'] = "honor_type.label as contribution_honor_type_label";
141 $query->_element
['contribution_honor_type_label'] = 1;
142 $query->_tables
['civicrm_contribution'] = 1;
143 $query->_tables
['contribution_honor_type_label'] = 1;
146 // get honor contact email
147 if (CRM_Utils_Array
::value('honor_contact_email', $query->_returnProperties
)) {
148 $query->_select
['contribution_honor_contact_email'] = "honor_email.email as contribution_honor_contact_email";
149 $query->_element
['contribution_honor_contact_email'] = 1;
150 $query->_tables
['civicrm_contribution'] = 1;
151 $query->_tables
['contribution_honor_contact_email'] = 1;
154 // get honor contact id
155 if (CRM_Utils_Array
::value('honor_contact_id', $query->_returnProperties
)) {
156 $query->_select
['contribution_honor_contact_id'] = "civicrm_contribution.honor_contact_id as contribution_honor_contact_id";
157 $query->_element
['contribution_honor_contact_id'] = 1;
158 $query->_tables
['civicrm_contribution'] = 1;
162 if (CRM_Utils_Array
::value('check_number', $query->_returnProperties
)) {
163 $query->_select
['contribution_check_number'] = "civicrm_contribution.check_number as contribution_check_number";
164 $query->_element
['contribution_check_number'] = 1;
165 $query->_tables
['civicrm_contribution'] = 1;
168 if (CRM_Utils_Array
::value('contribution_campaign_id', $query->_returnProperties
)) {
169 $query->_select
['contribution_campaign_id'] = 'civicrm_contribution.campaign_id as contribution_campaign_id';
170 $query->_element
['contribution_campaign_id'] = 1;
171 $query->_tables
['civicrm_contribution'] = 1;
175 if (CRM_Utils_Array
::value('soft_credit_name', $query->_returnProperties
)) {
176 $query->_select
['contribution_soft_credit_name'] = "civicrm_contact_d.display_name as contribution_soft_credit_name";
177 $query->_element
['contribution_soft_credit_name'] = 1;
178 $query->_tables
['civicrm_contribution'] = 1;
179 $query->_tables
['civicrm_contribution_soft'] = 1;
180 $query->_tables
['civicrm_contribution_soft_contact'] = 1;
183 if (CRM_Utils_Array
::value('soft_credit_email', $query->_returnProperties
)) {
184 $query->_select
['contribution_soft_credit_email'] = "soft_email.email as contribution_soft_credit_email";
185 $query->_element
['contribution_soft_credit_email'] = 1;
186 $query->_tables
['civicrm_contribution'] = 1;
187 $query->_tables
['civicrm_contribution_soft'] = 1;
188 $query->_tables
['civicrm_contribution_soft_contact'] = 1;
189 $query->_tables
['civicrm_contribution_soft_email'] = 1;
192 if (CRM_Utils_Array
::value('soft_credit_phone', $query->_returnProperties
)) {
193 $query->_select
['contribution_soft_credit_email'] = "soft_phone.phone as contribution_soft_credit_phone";
194 $query->_element
['contribution_soft_credit_phone'] = 1;
195 $query->_tables
['civicrm_contribution'] = 1;
196 $query->_tables
['civicrm_contribution_soft'] = 1;
197 $query->_tables
['civicrm_contribution_soft_contact'] = 1;
198 $query->_tables
['civicrm_contribution_soft_phone'] = 1;
203 static function where(&$query) {
205 foreach (array_keys($query->_params
) as $id) {
206 if (!CRM_Utils_Array
::value(0, $query->_params
[$id])) {
209 if (substr($query->_params
[$id][0], 0, 13) == 'contribution_' ||
substr($query->_params
[$id][0], 0, 10) == 'financial_') {
210 if ($query->_mode
== CRM_Contact_BAO_QUERY
::MODE_CONTACTS
) {
211 $query->_useDistinct
= TRUE;
215 $query->_params
[$id][0] == 'contribution_type_id' ||
216 $query->_params
[$id][0] == 'contribution_type'
218 CRM_Core_Session
::setStatus(
219 ts('The contribution type criteria is now obsolete, please update your smart group'),
226 $grouping = $query->_params
[$id][3];
227 self
::whereClauseSingle($query->_params
[$id], $query);
232 static function whereClauseSingle(&$values, &$query) {
233 list($name, $op, $value, $grouping, $wildcard) = $values;
235 $fields = self
::getFields();
237 if (!empty($value) && !is_array($value)) {
238 $quoteValue = "\"$value\"";
241 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
242 foreach (self
::getRecurringFields() as $dateField => $dateFieldTitle) {
243 if(self
::buildDateWhere($values, $query, $name, $dateField, $dateFieldTitle)) {
248 case 'contribution_date':
249 case 'contribution_date_low':
250 case 'contribution_date_low_time':
251 case 'contribution_date_high':
252 case 'contribution_date_high_time':
253 // process to / from date
254 $query->dateQueryBuilder($values,
255 'civicrm_contribution', 'contribution_date', 'receive_date', 'Contribution Date'
259 case 'contribution_amount':
260 case 'contribution_amount_low':
261 case 'contribution_amount_high':
262 // process min/max amount
263 $query->numberRangeBuilder($values,
264 'civicrm_contribution', 'contribution_amount',
265 'total_amount', 'Contribution Amount',
270 case 'contribution_total_amount':
271 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.total_amount",
274 $query->_qill
[$grouping][] = ts('Contribution Total Amount %1 %2', array(1 => $op, 2 => $value));
275 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
278 case 'contribution_thankyou_date_is_not_null':
281 $query->_qill
[$grouping][] = ts('Contribution Thank-you Sent');
285 $query->_qill
[$grouping][] = ts('Contribution Thank-you Not Sent');
287 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.thankyou_date", $op);
288 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
291 case 'contribution_receipt_date_is_not_null':
294 $query->_qill
[$grouping][] = ts('Contribution Receipt Sent');
298 $query->_qill
[$grouping][] = ts('Contribution Receipt Not Sent');
300 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.receipt_date", $op);
301 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
304 case 'financial_type_id':
305 case 'financial_type':
306 // The financial_type_id might be an array (from aggregate contributions custom search)
307 // In this case, we need to change the query.
308 if (is_array($value)) {
310 // Rebuild the array to get the data we're interested in as array
311 // values not array keys.
312 foreach ($value as $k => $v) {
317 if (count($val) > 1) {
318 // Overwrite $value so it works with an IN where statement.
320 $value = '(' . implode(',', $val) . ')';
323 // If we somehow have an empty array, just return
328 $types = CRM_Contribute_PseudoConstant
::financialType();
330 // Ensure we have a sensible string to display to the user.
332 if (isset($val) && is_array($val)) {
333 foreach($val as $id) {
334 $names[] = $types[$id];
338 $names[] = $types[$value];
341 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.financial_type_id",
342 $op, $value, "Integer"
344 $query->_qill
[$grouping][] = ts('Financial Type %1', array(1 => $op)) . ' ' . implode(' ' . ts('or') . ' ', $names);
345 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
348 case 'contribution_page_id':
350 $pages = CRM_Contribute_PseudoConstant
::contributionPage();
351 $query->_where
[$grouping][] = "civicrm_contribution.contribution_page_id = $cPage";
352 $query->_qill
[$grouping][] = ts('Contribution Page - %1', array(1 => $pages[$cPage]));
353 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
356 case 'contribution_pcp_made_through_id':
358 $pcpages = CRM_Contribute_PseudoConstant
::pcPage();
359 $query->_where
[$grouping][] = "civicrm_contribution_soft.pcp_id = $pcPage";
360 $query->_qill
[$grouping][] = ts('Personal Campaign Page - %1', array(1 => $pcpages[$pcPage]));
361 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
364 case 'contribution_payment_instrument_id':
365 case 'contribution_payment_instrument':
367 $pis = CRM_Contribute_PseudoConstant
::paymentInstrument();
368 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.payment_instrument_id",
369 $op, $value, "Integer"
372 $query->_qill
[$grouping][] = ts('Paid By - %1', array(1 => $pis[$pi]));
373 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
376 case 'contribution_in_honor_of':
377 $name = trim($value);
378 $newName = str_replace(',', " ", $name);
379 $pieces = explode(' ', $newName);
380 foreach ($pieces as $piece) {
381 $value = $strtolower(CRM_Core_DAO
::escapeString(trim($piece)));
382 $value = "'%$value%'";
383 $sub[] = " ( contact_b.sort_name LIKE $value )";
386 $query->_where
[$grouping][] = ' ( ' . implode(' OR ', $sub) . ' ) ';
387 $query->_qill
[$grouping][] = ts('Honor name like - \'%1\'', array(1 => $name));
388 $query->_tables
['civicrm_contact_b'] = $query->_whereTables
['civicrm_contact_b'] = 1;
389 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
392 case 'contribution_status':
393 case 'contribution_status_id':
394 if (is_array($value)) {
395 foreach ($value as $k => $v) {
401 $status = implode(',', $val);
403 if (count($val) > 1) {
405 $status = "({$status})";
413 $statusValues = CRM_Core_OptionGroup
::values("contribution_status");
419 foreach ($val as $id => $dontCare) {
420 $names[] = $statusValues[$id];
424 $names[] = $statusValues[$value];
427 $query->_qill
[$grouping][] = ts('Contribution Status %1', array(1 => $op)) . ' ' . implode(' ' . ts('or') . ' ', $names);
428 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.contribution_status_id",
433 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
436 case 'contribution_source':
437 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
442 $wc = ($op != 'LIKE') ?
"LOWER(civicrm_contribution.source)" : "civicrm_contribution.source";
443 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($wc, $op, $value, "String");
444 $query->_qill
[$grouping][] = ts('Contribution Source %1 %2', array(1 => $op, 2 => $quoteValue));
445 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
448 case 'contribution_trxn_id':
449 case 'contribution_transaction_id':
450 $wc = ($op != 'LIKE') ?
"LOWER(civicrm_contribution.trxn_id)" : "civicrm_contribution.trxn_id";
451 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($wc, $op, $value, "String");
452 $query->_qill
[$grouping][] = ts('Transaction ID %1 %2', array(1 => $op, 2 => $quoteValue));
453 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
456 case 'contribution_check_number':
457 $wc = ($op != 'LIKE') ?
"LOWER(civicrm_contribution.check_number)" : "civicrm_contribution.check_number";
458 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($wc, $op, $value, "String");
459 $query->_qill
[$grouping][] = ts('Check Number %1 %2', array(1 => $op, 2 => $quoteValue));
460 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
463 case 'contribution_is_test':
464 case 'contribution_test':
465 // We dont want to include all tests for sql OR CRM-7827
466 if (!$value ||
$query->getOperator() != 'OR') {
467 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.is_test", $op, $value, "Boolean");
469 $query->_qill
[$grouping][] = ts("Only Display Test Contributions");
471 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
475 case 'contribution_is_pay_later':
476 case 'contribution_pay_later':
477 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.is_pay_later", $op, $value, "Boolean");
479 $query->_qill
[$grouping][] = ts("Find Pay Later Contributions");
482 $query->_qill
[$grouping][] = ts("Exclude Pay Later Contributions");
484 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
487 case 'contribution_recurring':
489 $query->_where
[$grouping][] = "civicrm_contribution.contribution_recur_id IS NOT NULL";
490 $query->_qill
[$grouping][] = ts("Find Recurring Contributions");
491 $query->_tables
['civicrm_contribution_recur'] = $query->_whereTables
['civicrm_contribution_recur'] = 1;
494 $query->_where
[$grouping][] = "civicrm_contribution.contribution_recur_id IS NULL";
495 $query->_qill
[$grouping][] = ts("Exclude Recurring Contributions");
499 case 'contribution_recur_id':
500 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.contribution_recur_id",
501 $op, $value, "Integer"
503 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
506 case 'contribution_id':
507 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.id", $op, $value, "Integer");
508 $query->_qill
[$grouping][] = ts('Contribution ID %1 %2', array(1 => $op, 2 => $quoteValue));
509 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
512 case 'contribution_note':
513 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
518 $wc = ($op != 'LIKE') ?
"LOWER(civicrm_note.note)" : "civicrm_note.note";
519 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($wc, $op, $value, "String");
520 $query->_qill
[$grouping][] = ts('Contribution Note %1 %2', array(1 => $op, 2 => $quoteValue));
521 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = $query->_whereTables
['contribution_note'] = 1;
524 case 'contribution_membership_id':
525 $query->_where
[$grouping][] = " civicrm_membership.id $op $value";
526 $query->_tables
['contribution_membership'] = $query->_whereTables
['contribution_membership'] = 1;
530 case 'contribution_participant_id':
531 $query->_where
[$grouping][] = " civicrm_participant.id $op $value";
532 $query->_tables
['contribution_participant'] = $query->_whereTables
['contribution_participant'] = 1;
535 case 'contribution_pcp_display_in_roll':
536 $query->_where
[$grouping][] = " civicrm_contribution_soft.pcp_display_in_roll $op '$value'";
538 $query->_qill
[$grouping][] = ts("Personal Campaign Page Honor Roll");
541 $query->_qill
[$grouping][] = ts("NOT Personal Campaign Page Honor Roll");
543 $query->_tables
['civicrm_contribution_soft'] = $query->_whereTables
['civicrm_contribution_soft'] = 1;
546 // Supporting search for currency type -- CRM-4711
548 case 'contribution_currency_type':
549 $currencySymbol = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'currency', array('labelColumn' => 'name'));
550 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_contribution.currency",
551 $op, $currencySymbol[$value], "String"
553 $query->_qill
[$grouping][] = ts('Currency Type - %1', array(1 => $currencySymbol[$value]));
554 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
557 case 'contribution_campaign_id':
560 'campaign' => $value,
561 'grouping' => $grouping,
562 'tableName' => 'civicrm_contribution',
564 CRM_Campaign_BAO_Query
::componentSearchClause($campParams, $query);
567 case 'contribution_batch_id':
568 $batches = CRM_Contribute_PseudoConstant
::batch();
569 $query->_where
[$grouping][] = " civicrm_entity_batch.batch_id $op $value";
570 $query->_qill
[$grouping][] = ts('Batch Name %1 %2', array(1 => $op, 2 => $batches[$value]));
571 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
572 $query->_tables
['contribution_batch'] = $query->_whereTables
['contribution_batch'] = 1;
576 //all other elements are handle in this case
577 $fldName = substr($name, 13);
578 if (!isset($fields[$fldName])) {
580 CRM_Core_Session
::setStatus(ts(
581 'We did not recognize the search field: %1. Please check and fix your contribution related smart groups.',
587 $whereTable = $fields[$fldName];
588 $value = trim($value);
590 //contribution fields (decimal fields) which don't require a quote in where clause.
591 $moneyFields = array('non_deductible_amount', 'fee_amount', 'net_amount');
593 $dateFields = array('receive_date', 'cancel_date', 'receipt_date', 'thankyou_date', 'fulfilled_date');
595 if (in_array($fldName, $dateFields)) {
598 elseif (in_array($fldName, $moneyFields)) {
602 $dataType = "String";
605 $wc = ($op != 'LIKE' && $dataType != 'Date') ?
"LOWER($whereTable[where])" : "$whereTable[where]";
606 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($wc, $op, $value, $dataType);
607 $query->_qill
[$grouping][] = "$whereTable[title] $op $quoteValue";
608 list($tableName, $fieldName) = explode('.', $whereTable['where'], 2);
609 $query->_tables
[$tableName] = $query->_whereTables
[$tableName] = 1;
610 if ($tableName == 'civicrm_contribution_product') {
611 $query->_tables
['civicrm_product'] = $query->_whereTables
['civicrm_product'] = 1;
612 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
615 $query->_tables
['civicrm_contribution'] = $query->_whereTables
['civicrm_contribution'] = 1;
620 static function from($name, $mode, $side) {
623 case 'civicrm_contribution':
624 $from = " $side JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id ";
627 case 'civicrm_contribution_recur':
629 // in contact mode join directly onto profile - in case no contributions exist yet
630 $from = " $side JOIN civicrm_contribution_recur ON contact_a.id = civicrm_contribution_recur.contact_id ";
633 $from = " $side JOIN civicrm_contribution_recur ON civicrm_contribution.contribution_recur_id = civicrm_contribution_recur.id ";
637 case 'civicrm_financial_type':
638 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
639 $from = " INNER JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
642 $from = " $side JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
646 case 'civicrm_accounting_code':
647 $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' ";
648 $from .= " INNER JOIN civicrm_financial_account ON civicrm_financial_account.id = civicrm_entity_financial_account.financial_account_id ";
649 $from .= " INNER JOIN civicrm_option_value cov ON cov.value = civicrm_entity_financial_account.account_relationship AND cov.name = 'Income Account is' ";
650 $from .= " INNER JOIN civicrm_option_group cog ON cog.id = cov.option_group_id AND cog.name = 'account_relationship' ";
653 case 'civicrm_contribution_page':
654 $from = " $side JOIN civicrm_contribution_page ON civicrm_contribution.contribution_page ON civicrm_contribution.contribution_page.id";
657 case 'civicrm_product':
658 $from = " $side JOIN civicrm_contribution_product ON civicrm_contribution_product.contribution_id = civicrm_contribution.id";
659 $from .= " $side JOIN civicrm_product ON civicrm_contribution_product.product_id =civicrm_product.id ";
662 case 'contribution_payment_instrument':
663 $from = " $side JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')";
664 $from .= " $side JOIN civicrm_option_value payment_instrument ON (civicrm_contribution.payment_instrument_id = payment_instrument.value
665 AND option_group_payment_instrument.id = payment_instrument.option_group_id ) ";
668 case 'civicrm_contact_b':
669 $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_contribution.honor_contact_id = contact_b.id )";
672 case 'contribution_status':
673 $from = " $side JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')";
674 $from .= " $side JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
675 AND option_group_contribution_status.id = contribution_status.option_group_id ) ";
678 case 'contribution_note':
679 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contribution' AND
680 civicrm_contribution.id = civicrm_note.entity_id )";
683 case 'contribution_honor_contact_name':
684 $from .= " $side JOIN civicrm_contact civicrm_contact_c ON (civicrm_contribution.honor_contact_id = civicrm_contact_c.id )";
687 case 'contribution_honor_contact_email':
688 $from .= " $side JOIN civicrm_email as honor_email ON (civicrm_contribution.honor_contact_id = honor_email.contact_id AND honor_email.is_primary = 1 )";
691 case 'contribution_honor_type_label':
692 $from = " $side JOIN civicrm_option_group option_group_honor_type ON ( option_group_honor_type.name = 'honor_type')";
693 $from .= " $side JOIN civicrm_option_value honor_type ON (civicrm_contribution.honor_type_id = honor_type.value
694 AND option_group_honor_type.id = honor_type.option_group_id ) ";
697 case 'contribution_membership':
698 $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.contribution_id = civicrm_contribution.id";
699 $from .= " $side JOIN civicrm_membership ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
702 case 'contribution_participant':
703 $from = " $side JOIN civicrm_participant_payment ON civicrm_participant_payment.contribution_id = civicrm_contribution.id";
704 $from .= " $side JOIN civicrm_participant ON civicrm_participant_payment.participant_id = civicrm_participant.id ";
707 case 'civicrm_contribution_soft':
708 $from = " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.contribution_id = civicrm_contribution.id";
711 case 'civicrm_contribution_soft_contact':
712 $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution_soft.contact_id = civicrm_contact_d.id )";
715 case 'civicrm_contribution_soft_email':
716 $from .= " $side JOIN civicrm_email as soft_email ON (civicrm_contact_d.id = soft_email.contact_id )";
719 case 'civicrm_contribution_soft_phone':
720 $from .= " $side JOIN civicrm_phone as soft_phone ON (civicrm_contact_d.id = soft_phone.contact_id )";
723 case 'contribution_batch':
724 $from .= " $side JOIN civicrm_entity_financial_trxn ON (
725 civicrm_entity_financial_trxn.entity_table = 'civicrm_contribution'
726 AND civicrm_contribution.id = civicrm_entity_financial_trxn.entity_id )";
728 $from .= " $side JOIN civicrm_financial_trxn ON (
729 civicrm_entity_financial_trxn.financial_trxn_id = civicrm_financial_trxn.id )";
731 $from .= " $side JOIN civicrm_entity_batch ON ( civicrm_entity_batch.entity_table = 'civicrm_financial_trxn'
732 AND civicrm_financial_trxn.id = civicrm_entity_batch.entity_id )";
734 $from .= " $side JOIN civicrm_batch ON civicrm_entity_batch.batch_id = civicrm_batch.id";
740 static function defaultReturnProperties($mode, $includeCustomFields = TRUE) {
742 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
745 'contact_sub_type' => 1,
748 'financial_type' => 1,
749 'contribution_source' => 1,
751 'thankyou_date' => 1,
754 'accounting_code' => 1,
755 'payment_instrument' => 1,
757 'non_deductible_amount' => 1,
763 'cancel_reason' => 1,
767 'product_option' => 1,
768 'fulfilled_date' => 1,
769 'contribution_start_date' => 1,
770 'contribution_end_date' => 1,
773 'contribution_status' => 1,
774 'contribution_status_id' => 1,
775 'contribution_recur_id' => 1,
777 'contribution_note' => 1,
778 'contribution_batch' => 1,
779 'contribution_campaign_id' => 1
782 if ($includeCustomFields) {
783 // also get all the custom contribution properties
784 $fields = CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution');
785 if (!empty($fields)) {
786 foreach ($fields as $name => $dontCare) {
787 $properties[$name] = 1;
796 * add all the elements shared between contribute search and advnaced search
803 static function buildSearchForm(&$form) {
805 // Added contribution source
806 $form->addElement('text', 'contribution_source', ts('Contribution Source'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'source'));
808 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_date', 1, '_low', '_high', ts('From:'), FALSE);
810 $form->add('text', 'contribution_amount_low', ts('From'), array('size' => 8, 'maxlength' => 8));
811 $form->addRule('contribution_amount_low', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money
::format('9.99', ' '))), 'money');
813 $form->add('text', 'contribution_amount_high', ts('To'), array('size' => 8, 'maxlength' => 8));
814 $form->addRule('contribution_amount_high', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money
::format('99.99', ' '))), 'money');
816 // Adding select option for curreny type -- CRM-4711
817 $form->add('select', 'contribution_currency_type',
820 '' => ts('- any -')) +
821 CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'currency', array('labelColumn' => 'name'))
824 $form->add('select', 'financial_type_id',
825 ts('Financial Type'),
827 '' => ts('- any -')) +
828 CRM_Contribute_PseudoConstant
::financialType()
831 $form->add('select', 'contribution_page_id',
832 ts('Contribution Page'),
834 '' => ts('- any -')) +
835 CRM_Contribute_PseudoConstant
::contributionPage()
839 $form->add('select', 'contribution_payment_instrument_id',
840 ts('Payment Instrument'),
842 '' => ts('- any -')) +
843 CRM_Contribute_PseudoConstant
::paymentInstrument()
846 $form->add('select', 'contribution_pcp_made_through_id',
847 ts('Personal Campaign Page'),
849 '' => ts('- any -')) +
850 CRM_Contribute_PseudoConstant
::pcPage()
855 $statusValues = CRM_Core_OptionGroup
::values("contribution_status");
856 // Remove status values that are only used for recurring contributions or pledges (In Progress, Overdue).
857 unset($statusValues['5'], $statusValues['6']);
859 foreach ($statusValues as $key => $val) {
860 $status[] = $form->createElement('advcheckbox', $key, NULL, $val);
863 $form->addGroup($status, 'contribution_status_id', ts('Contribution Status'));
865 // Add fields for thank you and receipt
866 $form->addYesNo('contribution_thankyou_date_is_not_null', ts('Thank-you sent?'));
867 $form->addYesNo('contribution_receipt_date_is_not_null', ts('Receipt sent?'));
869 // Add fields for honor search
870 $form->addElement('text', 'contribution_in_honor_of', ts("In Honor Of"));
872 $form->addYesNo('contribution_pay_later', ts('Contribution is Pay Later?'));
873 $form->addYesNo('contribution_recurring', ts('Contribution is Recurring?'));
875 // Recurring contribution fields
876 foreach (self
::getRecurringFields() as $key => $label) {
877 CRM_Core_Form_Date
::buildDateRange($form, $key, 1, '_low', '_high', $label, FALSE);
878 // If data has been entered for a recurring field, tell the tpl layer to open the pane
879 if (!empty($form->_formValues
[$key . '_relative']) ||
!empty($form->_formValues
[$key . '_low']) ||
!empty($form->_formValues
[$key . '_high'])) {
880 $form->assign('contribution_recur_pane_open', TRUE);
884 $form->addYesNo('contribution_test', ts('Contribution is a Test?'));
886 // Add field for transaction ID search
887 $form->addElement('text', 'contribution_transaction_id', ts("Transaction ID"));
889 $form->addElement('text', 'contribution_check_number', ts('Check Number'));
891 // Add field for pcp display in roll search
892 $form->addYesNo('contribution_pcp_display_in_roll', ts('Personal Campaign Page Honor Roll?'));
894 // Add all the custom searchable fields
895 $contribution = array('Contribution');
896 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $contribution);
898 $form->assign('contributeGroupTree', $groupDetails);
899 foreach ($groupDetails as $group) {
900 foreach ($group['fields'] as $field) {
901 $fieldId = $field['id'];
902 $elementName = 'custom_' . $fieldId;
903 CRM_Core_BAO_CustomField
::addQuickFormElement($form,
912 CRM_Campaign_BAO_Campaign
::addCampaignInComponentSearch($form, 'contribution_campaign_id');
915 $batches = CRM_Contribute_PseudoConstant
::batch();
917 if ( !empty( $batches ) ) {
918 $form->add('select', 'contribution_batch_id',
920 array( '' => ts('- any -')) +
$batches );
923 $form->assign('validCiviContribute', TRUE);
924 $form->setDefaults(array('contribution_test' => 0));
927 static function addShowHide(&$showHide) {
928 $showHide->addHide('contributeForm');
929 $showHide->addShow('contributeForm_show');
932 static function searchAction(&$row, $id) {
935 static function tableNames(&$tables) {
936 // Add contribution table
937 if (CRM_Utils_Array
::value('civicrm_product', $tables)) {
938 $tables = array_merge(array('civicrm_contribution' => 1), $tables);
941 if (CRM_Utils_Array
::value('civicrm_contribution_product', $tables) &&
942 !CRM_Utils_Array
::value('civicrm_product', $tables)) {
943 $tables['civicrm_product'] = 1;
948 * Add the where for dates
949 * @param array $values array of query values
950 * @param object $query the query object
951 * @param string $name query field that is set
952 * @param string $field name of field to be set
953 * @param string $title title of the field
955 static function buildDateWhere(&$values, $query, $name, $field, $title) {
956 $fieldPart = strpos($name, $field);
957 if($fieldPart === FALSE) {
960 // we only have recurring dates using this ATM so lets' short cut to find the table name
961 $table = 'contribution_recur';
962 $fieldName = split($table . '_', $field);
963 $query->dateQueryBuilder($values,
964 'civicrm_' . $table, $field, $fieldName[1], $title
969 static function getRecurringFields() {
971 'contribution_recur_start_date' => ts('Recurring Contribution Start Date'),
972 'contribution_recur_next_sched_contribution_date' => ts('Next Scheduled Recurring Contribution'),
973 'contribution_recur_cancel_date' => ts('Recurring Contribution Cancel Date'),
974 'contribution_recur_end_date' => ts('Recurring Contribution End Date'),
975 'contribution_recur_create_date' => ('Recurring Contribution Create Date'),
976 'contribution_recur_modified_date' => ('Recurring Contribution Modified Date'),
977 'contribution_recur_failure_retry_date' => ts('Failed Recurring Contribution Retry Date'),