Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 | 16 | */ |
86a0d21e | 17 | class CRM_Contribute_BAO_Query extends CRM_Core_BAO_Query { |
6a488035 | 18 | |
1330f57a | 19 | public static $_contribOrSoftCredit = "only_contribs"; |
3dbf477c | 20 | |
1330f57a | 21 | public static $_contribRecurPayment = NULL; |
95974e8e | 22 | |
6a488035 | 23 | /** |
8f165fa5 | 24 | * Function get the searchable fields for contribution. |
25 | * | |
26 | * This is basically the contribution fields plus some related entity fields. | |
6a488035 | 27 | * |
e9ff5391 | 28 | * @param bool $checkPermission |
29 | * | |
a6c01b45 | 30 | * @return array |
e9ff5391 | 31 | * Associative array of contribution fields |
6a488035 | 32 | */ |
0ed9f379 | 33 | public static function getFields($checkPermission = TRUE) { |
23faf53d | 34 | if (!isset(\Civi::$statics[__CLASS__]) || !isset(\Civi::$statics[__CLASS__]['fields']) || !isset(\Civi::$statics[__CLASS__]['fields']['contribution'])) { |
4edbe907 | 35 | $recurFields = CRM_Contribute_DAO_ContributionRecur::fields(); |
36 | foreach ($recurFields as $fieldKey => $field) { | |
37 | // We can only safely add in those with unique names as those without could clobber others. | |
38 | // The array is keyed by unique names so if it doesn't match the key there is no unique name & we unset | |
39 | // Refer to CRM_Contribute_Form_SearchTest for existing tests ... and to add more! | |
40 | if ($field['name'] === $fieldKey) { | |
41 | unset($recurFields[$fieldKey]); | |
42 | } | |
43 | } | |
23faf53d | 44 | $fields = array_merge($recurFields, CRM_Contribute_BAO_Contribution::exportableFields($checkPermission)); |
a0090e6b | 45 | CRM_Contribute_BAO_Contribution::appendPseudoConstantsToFields($fields); |
6a488035 | 46 | unset($fields['contribution_contact_id']); |
33a766c6 | 47 | \Civi::$statics[__CLASS__]['fields']['contribution'] = $fields; |
6a488035 | 48 | } |
33a766c6 | 49 | return \Civi::$statics[__CLASS__]['fields']['contribution']; |
6a488035 TO |
50 | } |
51 | ||
52 | /** | |
7fe37828 | 53 | * If contributions are involved, add the specific contribute fields. |
6a488035 | 54 | * |
35e6241a | 55 | * @param CRM_Contact_BAO_Query $query |
6a488035 | 56 | */ |
00be9182 | 57 | public static function select(&$query) { |
6a488035 TO |
58 | // if contribute mode add contribution id |
59 | if ($query->_mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) { | |
60 | $query->_select['contribution_id'] = "civicrm_contribution.id as contribution_id"; | |
61 | $query->_element['contribution_id'] = 1; | |
62 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; | |
63 | } | |
64 | ||
6a488035 | 65 | // get accounting code |
a7488080 | 66 | if (!empty($query->_returnProperties['accounting_code'])) { |
353ffa53 | 67 | $query->_select['accounting_code'] = "civicrm_financial_account.accounting_code as accounting_code"; |
6a488035 TO |
68 | $query->_element['accounting_code'] = 1; |
69 | $query->_tables['civicrm_accounting_code'] = 1; | |
70 | $query->_tables['civicrm_financial_account'] = 1; | |
71 | } | |
39b795ba | 72 | |
a7488080 | 73 | if (!empty($query->_returnProperties['contribution_note'])) { |
6a488035 TO |
74 | $query->_select['contribution_note'] = "civicrm_note.note as contribution_note"; |
75 | $query->_element['contribution_note'] = 1; | |
76 | $query->_tables['contribution_note'] = 1; | |
739189e4 | 77 | $query->_tables['civicrm_contribution'] = 1; |
6a488035 TO |
78 | } |
79 | ||
a7488080 | 80 | if (!empty($query->_returnProperties['contribution_batch'])) { |
6a488035 TO |
81 | $query->_select['contribution_batch'] = "civicrm_batch.title as contribution_batch"; |
82 | $query->_element['contribution_batch'] = 1; | |
898bfdcd | 83 | $query->_tables['civicrm_financial_trxn'] = 1; |
6a488035 TO |
84 | $query->_tables['contribution_batch'] = 1; |
85 | } | |
86 | ||
9ebd3386 | 87 | if (!empty($query->_returnProperties['contribution_campaign_title'])) { |
88 | $query->_select['contribution_campaign_title'] = "civicrm_campaign.title as contribution_campaign_title"; | |
89 | $query->_element['contribution_campaign_title'] = $query->_tables['civicrm_campaign'] = 1; | |
90 | } | |
739a8336 | 91 | |
686df921 | 92 | self::addSoftCreditFields($query); |
6a488035 TO |
93 | } |
94 | ||
186c9c17 | 95 | /** |
35e6241a EM |
96 | * Get where clause. |
97 | * | |
98 | * @param CRM_Contact_BAO_Query $query | |
149b03d6 | 99 | * |
100 | * @throws \CRM_Core_Exception | |
101 | * @throws \CiviCRM_API3_Exception | |
186c9c17 | 102 | */ |
00be9182 | 103 | public static function where(&$query) { |
f654cacf | 104 | self::initializeAnySoftCreditClause($query); |
6a488035 | 105 | foreach (array_keys($query->_params) as $id) { |
a7488080 | 106 | if (empty($query->_params[$id][0])) { |
6a488035 TO |
107 | continue; |
108 | } | |
afa0b07c | 109 | if (substr($query->_params[$id][0], 0, 13) == 'contribution_' || substr($query->_params[$id][0], 0, 10) == 'financial_' || substr($query->_params[$id][0], 0, 8) == 'payment_') { |
2da8c6c4 | 110 | if ($query->_mode == CRM_Contact_BAO_Query::MODE_CONTACTS) { |
6a488035 TO |
111 | $query->_useDistinct = TRUE; |
112 | } | |
39b795ba | 113 | |
6a488035 TO |
114 | self::whereClauseSingle($query->_params[$id], $query); |
115 | } | |
116 | } | |
6a488035 TO |
117 | } |
118 | ||
186c9c17 | 119 | /** |
35e6241a EM |
120 | * Get where clause for a single value. |
121 | * | |
122 | * @param array $values | |
123 | * @param CRM_Contact_BAO_Query $query | |
7123f88c | 124 | * |
125 | * @throws \CiviCRM_API3_Exception | |
126 | * @throws \CRM_Core_Exception | |
186c9c17 | 127 | */ |
00be9182 | 128 | public static function whereClauseSingle(&$values, &$query) { |
6a488035 TO |
129 | list($name, $op, $value, $grouping, $wildcard) = $values; |
130 | ||
dbc6f6d6 | 131 | $quoteValue = NULL; |
9d5c7f14 | 132 | $fields = self::getFields(); |
163b1da9 KJ |
133 | |
134 | if (!empty($value) && !is_array($value)) { | |
6a488035 TO |
135 | $quoteValue = "\"$value\""; |
136 | } | |
137 | ||
e1bbe1bf | 138 | $fieldAliases = self::getLegacySupportedFields(); |
139 | ||
140 | $fieldName = $name = self::getFieldName($values); | |
3123273f | 141 | $qillName = $name; |
4fc150ab | 142 | if (in_array($name, $fieldAliases)) { |
143 | $qillName = array_search($name, $fieldAliases); | |
144 | } | |
be2fb01f | 145 | $pseudoExtraParam = []; |
4edbe907 | 146 | $fieldSpec = CRM_Utils_Array::value($fieldName, $fields, []); |
147 | $tableName = CRM_Utils_Array::value('table_name', $fieldSpec, 'civicrm_contribution'); | |
148 | $dataType = CRM_Utils_Type::typeToString(CRM_Utils_Array::value('type', $fieldSpec)); | |
149 | if ($dataType === 'Timestamp' || $dataType === 'Date') { | |
1157f03f | 150 | $title = empty($fieldSpec['unique_title']) ? $fieldSpec['title'] : $fieldSpec['unique_title']; |
4edbe907 | 151 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; |
152 | $query->dateQueryBuilder($values, | |
1157f03f | 153 | $tableName, $fieldName, $fieldSpec['name'], $title |
4edbe907 | 154 | ); |
155 | return; | |
156 | } | |
3123273f | 157 | |
6a488035 TO |
158 | switch ($name) { |
159 | case 'contribution_date': | |
160 | case 'contribution_date_low': | |
161 | case 'contribution_date_low_time': | |
162 | case 'contribution_date_high': | |
163 | case 'contribution_date_high_time': | |
0ae18acf | 164 | CRM_Core_Error::deprecatedFunctionWarning('search by receive_date'); |
6a488035 TO |
165 | // process to / from date |
166 | $query->dateQueryBuilder($values, | |
70c907d4 | 167 | 'civicrm_contribution', 'contribution_date', 'receive_date', ts('Contribution Date') |
6a488035 TO |
168 | ); |
169 | return; | |
170 | ||
171 | case 'contribution_amount': | |
172 | case 'contribution_amount_low': | |
173 | case 'contribution_amount_high': | |
174 | // process min/max amount | |
175 | $query->numberRangeBuilder($values, | |
176 | 'civicrm_contribution', 'contribution_amount', | |
177 | 'total_amount', 'Contribution Amount', | |
178 | NULL | |
179 | ); | |
180 | return; | |
181 | ||
6a488035 TO |
182 | case 'contribution_thankyou_date_is_not_null': |
183 | if ($value) { | |
184 | $op = "IS NOT NULL"; | |
185 | $query->_qill[$grouping][] = ts('Contribution Thank-you Sent'); | |
186 | } | |
187 | else { | |
188 | $op = "IS NULL"; | |
189 | $query->_qill[$grouping][] = ts('Contribution Thank-you Not Sent'); | |
190 | } | |
191 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.thankyou_date", $op); | |
192 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; | |
193 | return; | |
194 | ||
195 | case 'contribution_receipt_date_is_not_null': | |
196 | if ($value) { | |
197 | $op = "IS NOT NULL"; | |
198 | $query->_qill[$grouping][] = ts('Contribution Receipt Sent'); | |
199 | } | |
200 | else { | |
201 | $op = "IS NULL"; | |
202 | $query->_qill[$grouping][] = ts('Contribution Receipt Not Sent'); | |
203 | } | |
204 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.receipt_date", $op); | |
205 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; | |
206 | return; | |
40c655aa | 207 | |
4ca8b3e8 | 208 | case 'financial_type_id': |
b5a37491 | 209 | case 'invoice_id': |
9cad3ff4 | 210 | case 'invoice_number': |
8fb22579 PN |
211 | case 'payment_instrument_id': |
212 | case 'contribution_payment_instrument_id': | |
3c151c70 | 213 | case 'contribution_page_id': |
7051f2e5 | 214 | case 'contribution_status_id': |
3c151c70 | 215 | case 'contribution_id': |
216 | case 'contribution_currency_type': | |
217 | case 'contribution_currency': | |
218 | case 'contribution_source': | |
3c151c70 | 219 | case 'contribution_trxn_id': |
3a6eb174 | 220 | case 'contribution_check_number': |
994567a3 | 221 | case 'contribution_contact_id': |
3c151c70 | 222 | case (strpos($name, '_amount') !== FALSE): |
6f56dc34 | 223 | case 'contribution_campaign_id': |
3123273f | 224 | |
be2fb01f | 225 | $fieldNamesNotToStripContributionFrom = [ |
93548514 | 226 | 'contribution_currency_type', |
227 | 'contribution_status_id', | |
228 | 'contribution_page_id', | |
be2fb01f | 229 | ]; |
93548514 | 230 | // @todo these are mostly legacy params. Find a better way to deal with them. |
231 | if (!in_array($name, $fieldNamesNotToStripContributionFrom) | |
3c151c70 | 232 | ) { |
3123273f | 233 | if (!isset($fields[$name])) { |
3c151c70 | 234 | $qillName = str_replace('contribution_', '', $qillName); |
dbc6f6d6 | 235 | } |
3123273f | 236 | $name = str_replace('contribution_', '', $name); |
5bbd985a | 237 | } |
be2fb01f | 238 | if (in_array($name, ['contribution_currency', 'contribution_currency_type'])) { |
3c151c70 | 239 | $qillName = $name = 'currency'; |
be2fb01f | 240 | $pseudoExtraParam = ['labelColumn' => 'name']; |
3c151c70 | 241 | } |
5bbd985a | 242 | |
3c151c70 | 243 | $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String'; |
244 | ||
245 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.$name", $op, $value, $dataType); | |
9ab34172 | 246 | list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op, $pseudoExtraParam); |
6822e118 | 247 | if (!($name == 'id' && $value == 0)) { |
be2fb01f | 248 | $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $op, 3 => $value]); |
6822e118 | 249 | } |
6a488035 TO |
250 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; |
251 | return; | |
252 | ||
6a488035 | 253 | case 'contribution_pcp_made_through_id': |
3c151c70 | 254 | case 'contribution_soft_credit_type_id': |
255 | $qillName = $name; | |
256 | if ($name == 'contribution_pcp_made_through_id') { | |
257 | $qillName = $name = 'pcp_id'; | |
be2fb01f | 258 | $fields[$name] = ['title' => ts('Personal Campaign Page'), 'type' => 2]; |
3c151c70 | 259 | } |
260 | if ($name == 'contribution_soft_credit_type_id') { | |
261 | $qillName = str_replace('_id', '', $qillName); | |
262 | $fields[$qillName]['type'] = $fields[$qillName]['data_type']; | |
263 | $name = str_replace('contribution_', '', $name); | |
264 | } | |
265 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_soft.$name", | |
266 | $op, $value, CRM_Utils_Type::typeToString($fields[$qillName]['type']) | |
267 | ); | |
9ab34172 | 268 | list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_ContributionSoft', $name, $value, $op); |
be2fb01f | 269 | $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $op, 3 => $value]); |
6a488035 TO |
270 | $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1; |
271 | return; | |
272 | ||
36bf52ef DS |
273 | case 'contribution_or_softcredits': |
274 | if ($value == 'only_scredits') { | |
3dbf477c | 275 | $query->_where[$grouping][] = "contribution_search_scredit_combined.scredit_id IS NOT NULL"; |
36bf52ef | 276 | $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits Only'); |
ed81a415 | 277 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; |
36bf52ef | 278 | $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1; |
0db6c3e1 | 279 | } |
4c9b6178 | 280 | elseif ($value == 'both_related') { |
3dbf477c | 281 | $query->_where[$grouping][] = "contribution_search_scredit_combined.filter_id IS NOT NULL"; |
4f3846df | 282 | $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits with related Hard Credit'); |
ed81a415 | 283 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; |
3dbf477c | 284 | $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1; |
0db6c3e1 | 285 | } |
4c9b6178 | 286 | elseif ($value == 'both') { |
36bf52ef | 287 | $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Both'); |
ed81a415 | 288 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; |
36bf52ef DS |
289 | $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1; |
290 | } | |
291 | // default option: $value == 'only_contribs' | |
292 | return; | |
293 | ||
6a488035 | 294 | case 'contribution_is_test': |
3a6eb174 | 295 | // By default is Contribution Search form we choose is_test = 0 in otherwords always show active contribution |
296 | // so in case if any one choose any Yes/No avoid the default clause otherwise it will be conflict in whereClause | |
297 | $key = array_search('civicrm_contribution.is_test = 0', $query->_where[$grouping]); | |
298 | if (!empty($key)) { | |
299 | unset($query->_where[$grouping][$key]); | |
300 | } | |
6a488035 | 301 | case 'contribution_test': |
4b58de38 CW |
302 | // We dont want to include all tests for sql OR CRM-7827 |
303 | if (!$value || $query->getOperator() != 'OR') { | |
304 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.is_test", $op, $value, "Boolean"); | |
305 | if ($value) { | |
306 | $query->_qill[$grouping][] = ts("Only Display Test Contributions"); | |
307 | } | |
308 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; | |
6a488035 | 309 | } |
6a488035 TO |
310 | return; |
311 | ||
312 | case 'contribution_is_pay_later': | |
313 | case 'contribution_pay_later': | |
314 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.is_pay_later", $op, $value, "Boolean"); | |
315 | if ($value) { | |
316 | $query->_qill[$grouping][] = ts("Find Pay Later Contributions"); | |
317 | } | |
318 | else { | |
319 | $query->_qill[$grouping][] = ts("Exclude Pay Later Contributions"); | |
320 | } | |
321 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; | |
322 | return; | |
323 | ||
324 | case 'contribution_recurring': | |
325 | if ($value) { | |
326 | $query->_where[$grouping][] = "civicrm_contribution.contribution_recur_id IS NOT NULL"; | |
327 | $query->_qill[$grouping][] = ts("Find Recurring Contributions"); | |
328 | $query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1; | |
329 | } | |
330 | else { | |
331 | $query->_where[$grouping][] = "civicrm_contribution.contribution_recur_id IS NULL"; | |
332 | $query->_qill[$grouping][] = ts("Exclude Recurring Contributions"); | |
333 | } | |
334 | return; | |
335 | ||
336 | case 'contribution_recur_id': | |
337 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.contribution_recur_id", | |
338 | $op, $value, "Integer" | |
339 | ); | |
340 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; | |
341 | return; | |
342 | ||
5951bdaa | 343 | case 'contribution_recur_payment_processor_id': |
64127e03 | 344 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_recur.payment_processor_id", $op, $value, "String"); |
be2fb01f CW |
345 | $paymentProcessors = civicrm_api3('PaymentProcessor', 'get', []); |
346 | $paymentProcessorNames = []; | |
64127e03 MWMC |
347 | foreach ($value as $paymentProcessorId) { |
348 | $paymentProcessorNames[] = $paymentProcessors['values'][$paymentProcessorId]['name']; | |
349 | } | |
be2fb01f | 350 | $query->_qill[$grouping][] = ts("Recurring Contribution Payment Processor %1 %2", [1 => $op, 2 => implode(', ', $paymentProcessorNames)]); |
64127e03 MWMC |
351 | $query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1; |
352 | return; | |
353 | ||
354 | case 'contribution_recur_processor_id': | |
95974e8e | 355 | case 'contribution_recur_trxn_id': |
23faf53d | 356 | $spec = $fields[$name]; |
357 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($spec['where'], | |
95974e8e DG |
358 | $op, $value, "String" |
359 | ); | |
23faf53d | 360 | $query->_qill[$grouping][] = ts("Recurring Contribution %1 %2 '%3'", [1 => $fields[$name]['title'], 2 => $op, 3 => $value]); |
361 | $query->_tables[$spec['table_name']] = $query->_whereTables[$spec['table_name']] = 1; | |
95974e8e DG |
362 | return; |
363 | ||
364 | case 'contribution_recur_payment_made': | |
365 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_recur.id", 'IS NOT EMPTY'); | |
5aae2a90 | 366 | if ($value == 2) { |
95974e8e DG |
367 | $query->_qill[$grouping][] = ts("Recurring contributions with at least one payment"); |
368 | self::$_contribRecurPayment = TRUE; | |
369 | } | |
370 | else { | |
371 | $query->_qill[$grouping][] = ts("All recurring contributions regardless of payments"); | |
372 | self::$_contribRecurPayment = FALSE; | |
373 | } | |
374 | $query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1; | |
5af1389d VH |
375 | return; |
376 | ||
377 | case 'contribution_recur_contribution_status_id': | |
378 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_recur.contribution_status_id", $op, $value, 'String'); | |
379 | list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_ContributionRecur', 'contribution_status_id', $value, $op, $pseudoExtraParam); | |
be2fb01f | 380 | $query->_qill[$grouping][] = ts("Recurring Contribution Status %1 '%2'", [1 => $op, 2 => $value]); |
5af1389d | 381 | $query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1; |
95974e8e DG |
382 | return; |
383 | ||
6a488035 | 384 | case 'contribution_note': |
d817ca8d | 385 | $value = CRM_Core_DAO::escapeString($value); |
6a488035 TO |
386 | if ($wildcard) { |
387 | $value = "%$value%"; | |
388 | $op = 'LIKE'; | |
389 | } | |
d817ca8d | 390 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_note.note', $op, $value, "String"); |
be2fb01f | 391 | $query->_qill[$grouping][] = ts('Contribution Note %1 %2', [1 => $op, 2 => $quoteValue]); |
6a488035 TO |
392 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = $query->_whereTables['contribution_note'] = 1; |
393 | return; | |
394 | ||
395 | case 'contribution_membership_id': | |
396 | $query->_where[$grouping][] = " civicrm_membership.id $op $value"; | |
397 | $query->_tables['contribution_membership'] = $query->_whereTables['contribution_membership'] = 1; | |
398 | ||
399 | return; | |
400 | ||
401 | case 'contribution_participant_id': | |
402 | $query->_where[$grouping][] = " civicrm_participant.id $op $value"; | |
403 | $query->_tables['contribution_participant'] = $query->_whereTables['contribution_participant'] = 1; | |
404 | return; | |
405 | ||
406 | case 'contribution_pcp_display_in_roll': | |
407 | $query->_where[$grouping][] = " civicrm_contribution_soft.pcp_display_in_roll $op '$value'"; | |
408 | if ($value) { | |
409 | $query->_qill[$grouping][] = ts("Personal Campaign Page Honor Roll"); | |
410 | } | |
411 | else { | |
412 | $query->_qill[$grouping][] = ts("NOT Personal Campaign Page Honor Roll"); | |
413 | } | |
414 | $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1; | |
415 | return; | |
416 | ||
6a488035 | 417 | case 'contribution_batch_id': |
3086e282 | 418 | list($qillOp, $qillValue) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Batch_BAO_EntityBatch', 'batch_id', $value, $op); |
be2fb01f | 419 | $query->_qill[$grouping][] = ts('Batch Name %1 %2', [1 => $qillOp, 2 => $qillValue]); |
3086e282 | 420 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_entity_batch.batch_id', $op, $value); |
39b795ba | 421 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; |
898bfdcd | 422 | $query->_tables['civicrm_financial_trxn'] = $query->_whereTables['civicrm_financial_trxn'] = 1; |
6a488035 TO |
423 | $query->_tables['contribution_batch'] = $query->_whereTables['contribution_batch'] = 1; |
424 | return; | |
425 | ||
6ffab5b7 WA |
426 | case 'contribution_product_id': |
427 | // CRM-16713 - contribution search by premiums on 'Find Contribution' form. | |
428 | $qillName = $name; | |
429 | list($operator, $productValue) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Product', $name, $value, $op); | |
be2fb01f | 430 | $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $operator, 3 => $productValue]); |
6ffab5b7 WA |
431 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_product.id", $op, $value); |
432 | $query->_tables['civicrm_product'] = $query->_whereTables['civicrm_product'] = 1; | |
433 | return; | |
434 | ||
d42c359d PN |
435 | case 'contribution_is_payment': |
436 | $query->_where[$grouping][] = " civicrm_financial_trxn.is_payment $op $value"; | |
898bfdcd PN |
437 | $query->_tables['civicrm_financial_trxn'] = $query->_whereTables['civicrm_financial_trxn'] = 1; |
438 | return; | |
439 | ||
d72b084a | 440 | case 'financial_trxn_card_type_id': |
441 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_financial_trxn.card_type_id', $op, $value); | |
898bfdcd PN |
442 | $query->_tables['civicrm_financial_trxn'] = $query->_whereTables['civicrm_financial_trxn'] = 1; |
443 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; | |
d72b084a | 444 | list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Financial_DAO_FinancialTrxn', 'card_type_id', $value, $op); |
be2fb01f | 445 | $query->_qill[$grouping][] = ts('Card Type %1 %2', [1 => $op, 2 => $value]); |
d42c359d PN |
446 | return; |
447 | ||
c6ba3619 E |
448 | case 'financial_trxn_pan_truncation': |
449 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_financial_trxn.pan_truncation', $op, $value); | |
450 | $query->_tables['civicrm_financial_trxn'] = $query->_whereTables['civicrm_financial_trxn'] = 1; | |
451 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; | |
452 | list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Financial_DAO_FinancialTrxn', 'pan_truncation', $value, $op); | |
be2fb01f | 453 | $query->_qill[$grouping][] = ts('Card Number %1 %2', [1 => $op, 2 => $value]); |
c6ba3619 E |
454 | return; |
455 | ||
6a488035 TO |
456 | default: |
457 | //all other elements are handle in this case | |
353ffa53 | 458 | $fldName = substr($name, 13); |
ec8c4582 | 459 | if (!isset($fields[$fldName])) { |
ec8c4582 DL |
460 | return; |
461 | } | |
6a488035 | 462 | $whereTable = $fields[$fldName]; |
927898c5 | 463 | if (!is_array($value)) { |
464 | $value = trim($value); | |
465 | } | |
6a488035 | 466 | |
33f5d765 | 467 | $dataType = 'String'; |
3c151c70 | 468 | if (!empty($whereTable['type'])) { |
469 | $dataType = CRM_Utils_Type::typeToString($whereTable['type']); | |
6a488035 TO |
470 | } |
471 | ||
2b3e31ac | 472 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($whereTable['where'], $op, $value, $dataType); |
6a488035 | 473 | $query->_qill[$grouping][] = "$whereTable[title] $op $quoteValue"; |
2b3e31ac | 474 | list($tableName) = explode('.', $whereTable['where'], 2); |
6a488035 | 475 | $query->_tables[$tableName] = $query->_whereTables[$tableName] = 1; |
4edbe907 | 476 | if ($tableName === 'civicrm_contribution_product') { |
6a488035 TO |
477 | $query->_tables['civicrm_product'] = $query->_whereTables['civicrm_product'] = 1; |
478 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; | |
479 | } | |
480 | else { | |
481 | $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1; | |
482 | } | |
483 | } | |
484 | } | |
485 | ||
186c9c17 | 486 | /** |
35e6241a EM |
487 | * Get from clause. |
488 | * | |
100fef9d | 489 | * @param string $name |
35e6241a EM |
490 | * @param string $mode |
491 | * @param string $side | |
186c9c17 | 492 | * |
e60f24eb | 493 | * @return NULL|string |
186c9c17 | 494 | */ |
00be9182 | 495 | public static function from($name, $mode, $side) { |
6a488035 TO |
496 | $from = NULL; |
497 | switch ($name) { | |
353ffa53 TO |
498 | case 'civicrm_contribution': |
499 | $from = " $side JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id "; | |
be2fb01f | 500 | if (in_array(self::$_contribOrSoftCredit, ["only_scredits", "both_related", "both"])) { |
353ffa53 | 501 | // switch the from table if its only soft credit search |
bc438a52 | 502 | $from = " $side JOIN " . \Civi::$statics[__CLASS__]['soft_credit_temp_table_name'] . " as contribution_search_scredit_combined ON contribution_search_scredit_combined.contact_id = contact_a.id "; |
353ffa53 TO |
503 | $from .= " $side JOIN civicrm_contribution ON civicrm_contribution.id = contribution_search_scredit_combined.id "; |
504 | $from .= " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.id = contribution_search_scredit_combined.scredit_id"; | |
505 | } | |
506 | break; | |
6a488035 TO |
507 | |
508 | case 'civicrm_contribution_recur': | |
86845f9b | 509 | if ($mode == 1) { |
95974e8e | 510 | // 'Made payment for the recurring contributions?' is ticked yes |
1415b394 | 511 | $from = " $side JOIN civicrm_contribution_recur ON contact_a.id = civicrm_contribution_recur.contact_id "; |
24782d26 | 512 | if (self::$_contribRecurPayment == TRUE) { |
5aae2a90 | 513 | $from .= " INNER JOIN civicrm_contribution cr ON cr.contribution_recur_id = civicrm_contribution_recur.id "; |
95974e8e | 514 | } |
86845f9b | 515 | } |
516 | else { | |
517 | $from = " $side JOIN civicrm_contribution_recur ON civicrm_contribution.contribution_recur_id = civicrm_contribution_recur.id "; | |
518 | } | |
6a488035 TO |
519 | break; |
520 | ||
521 | case 'civicrm_financial_type': | |
522 | if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) { | |
523 | $from = " INNER JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id "; | |
524 | } | |
525 | else { | |
526 | $from = " $side JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id "; | |
527 | } | |
528 | break; | |
529 | ||
6ef17211 | 530 | case 'civicrm_financial_account': |
531 | if ($mode & CRM_Contact_BAO_Query::MODE_CONTACTS) { | |
532 | $from = " $side JOIN civicrm_financial_account ON contact_a.id = civicrm_financial_account.contact_id "; | |
533 | } | |
534 | break; | |
535 | ||
6a488035 | 536 | case 'civicrm_accounting_code': |
6ef17211 | 537 | if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) { |
538 | $from = " $side JOIN civicrm_entity_financial_account ON civicrm_entity_financial_account.entity_id = civicrm_contribution.financial_type_id AND civicrm_entity_financial_account.entity_table = 'civicrm_financial_type' "; | |
539 | $from .= " INNER JOIN civicrm_financial_account ON civicrm_financial_account.id = civicrm_entity_financial_account.financial_account_id "; | |
540 | $from .= " INNER JOIN civicrm_option_value cov ON cov.value = civicrm_entity_financial_account.account_relationship AND cov.name = 'Income Account is' "; | |
541 | $from .= " INNER JOIN civicrm_option_group cog ON cog.id = cov.option_group_id AND cog.name = 'account_relationship' "; | |
542 | } | |
39b795ba | 543 | break; |
6a488035 TO |
544 | |
545 | case 'civicrm_contribution_page': | |
3c151c70 | 546 | $from = " $side JOIN civicrm_contribution_page ON civicrm_contribution.contribution_page_id = civicrm_contribution_page.id"; |
6a488035 TO |
547 | break; |
548 | ||
549 | case 'civicrm_product': | |
550 | $from = " $side JOIN civicrm_contribution_product ON civicrm_contribution_product.contribution_id = civicrm_contribution.id"; | |
551 | $from .= " $side JOIN civicrm_product ON civicrm_contribution_product.product_id =civicrm_product.id "; | |
552 | break; | |
553 | ||
36bf52ef | 554 | case 'contribution_softcredit_type': |
353ffa53 | 555 | $from = " $side JOIN civicrm_option_group option_group_contribution_softcredit_type ON |
36bf52ef | 556 | (option_group_contribution_softcredit_type.name = 'soft_credit_type')"; |
77b97be7 | 557 | $from .= " $side JOIN civicrm_option_value contribution_softcredit_type ON |
36bf52ef DS |
558 | ( civicrm_contribution_soft.soft_credit_type_id = contribution_softcredit_type.value |
559 | AND option_group_contribution_softcredit_type.id = contribution_softcredit_type.option_group_id )"; | |
560 | break; | |
561 | ||
6a488035 TO |
562 | case 'contribution_note': |
563 | $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contribution' AND | |
564 | civicrm_contribution.id = civicrm_note.entity_id )"; | |
565 | break; | |
566 | ||
6a488035 TO |
567 | case 'contribution_membership': |
568 | $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.contribution_id = civicrm_contribution.id"; | |
569 | $from .= " $side JOIN civicrm_membership ON civicrm_membership_payment.membership_id = civicrm_membership.id "; | |
570 | break; | |
571 | ||
9ebd3386 | 572 | case 'civicrm_campaign': |
38310a51 | 573 | //CRM-16764 - get survey clause from campaign bao |
574 | if (!CRM_Campaign_BAO_Query::$_applySurveyClause) { | |
575 | $from = " $side JOIN civicrm_campaign ON civicrm_campaign.id = civicrm_contribution.campaign_id"; | |
576 | } | |
9ebd3386 | 577 | break; |
578 | ||
6a488035 TO |
579 | case 'contribution_participant': |
580 | $from = " $side JOIN civicrm_participant_payment ON civicrm_participant_payment.contribution_id = civicrm_contribution.id"; | |
581 | $from .= " $side JOIN civicrm_participant ON civicrm_participant_payment.participant_id = civicrm_participant.id "; | |
582 | break; | |
583 | ||
584 | case 'civicrm_contribution_soft': | |
be2fb01f | 585 | if (!in_array(self::$_contribOrSoftCredit, ["only_scredits", "both_related", "both"])) { |
3dbf477c DS |
586 | $from = " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.contribution_id = civicrm_contribution.id"; |
587 | } | |
6a488035 TO |
588 | break; |
589 | ||
590 | case 'civicrm_contribution_soft_contact': | |
be2fb01f | 591 | if (in_array(self::$_contribOrSoftCredit, ["only_scredits", "both_related", "both"])) { |
77b97be7 | 592 | $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution.contact_id = civicrm_contact_d.id ) |
3dbf477c | 593 | AND contribution_search_scredit_combined.scredit_id IS NOT NULL"; |
0db6c3e1 TO |
594 | } |
595 | else { | |
3dbf477c DS |
596 | $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution_soft.contact_id = civicrm_contact_d.id )"; |
597 | } | |
6a488035 TO |
598 | break; |
599 | ||
600 | case 'civicrm_contribution_soft_email': | |
601 | $from .= " $side JOIN civicrm_email as soft_email ON (civicrm_contact_d.id = soft_email.contact_id )"; | |
602 | break; | |
603 | ||
604 | case 'civicrm_contribution_soft_phone': | |
605 | $from .= " $side JOIN civicrm_phone as soft_phone ON (civicrm_contact_d.id = soft_phone.contact_id )"; | |
606 | break; | |
39b795ba | 607 | |
6a488035 | 608 | case 'contribution_batch': |
61412579 | 609 | $from .= " $side JOIN civicrm_entity_batch ON ( civicrm_entity_batch.entity_table = 'civicrm_financial_trxn' |
610 | AND civicrm_financial_trxn.id = civicrm_entity_batch.entity_id )"; | |
611 | ||
6a488035 TO |
612 | $from .= " $side JOIN civicrm_batch ON civicrm_entity_batch.batch_id = civicrm_batch.id"; |
613 | break; | |
898bfdcd PN |
614 | |
615 | case 'civicrm_financial_trxn': | |
616 | $from .= " $side JOIN civicrm_entity_financial_trxn ON ( | |
617 | civicrm_entity_financial_trxn.entity_table = 'civicrm_contribution' | |
618 | AND civicrm_contribution.id = civicrm_entity_financial_trxn.entity_id )"; | |
619 | ||
620 | $from .= " $side JOIN civicrm_financial_trxn ON ( | |
621 | civicrm_entity_financial_trxn.financial_trxn_id = civicrm_financial_trxn.id )"; | |
622 | break; | |
6a488035 TO |
623 | } |
624 | return $from; | |
625 | } | |
626 | ||
186c9c17 | 627 | /** |
35e6241a EM |
628 | * Initialise the soft credit clause. |
629 | * | |
630 | * @param CRM_Contact_BAO_Query $query | |
186c9c17 | 631 | */ |
00be9182 | 632 | public static function initializeAnySoftCreditClause(&$query) { |
5928ea72 | 633 | // @todo have a generic initialize on all components that gets called every query |
634 | // & rename this to match that fn name. | |
9ae25b56 | 635 | if ($query->_mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) { |
636 | if (self::isSoftCreditOptionEnabled($query->_params)) { | |
ed81a415 | 637 | unset($query->_distinctComponentClause); |
f654cacf | 638 | $query->_rowCountClause = " count(civicrm_contribution.id)"; |
ed81a415 | 639 | $query->_groupByComponentClause = " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id "; |
36bf52ef | 640 | } |
9ae25b56 | 641 | else { |
642 | $query->_distinctComponentClause = ' civicrm_contribution.id'; | |
643 | } | |
f654cacf DS |
644 | } |
645 | } | |
646 | ||
186c9c17 | 647 | /** |
35e6241a EM |
648 | * Check if soft credits are enables. |
649 | * | |
186c9c17 EM |
650 | * @param array $queryParams |
651 | * | |
652 | * @return bool | |
653 | */ | |
be2fb01f | 654 | public static function isSoftCreditOptionEnabled($queryParams = []) { |
f654cacf DS |
655 | if (!empty($queryParams)) { |
656 | foreach (array_keys($queryParams) as $id) { | |
657 | if (empty($queryParams[$id][0])) { | |
658 | continue; | |
659 | } | |
38e1cb31 DS |
660 | if ($queryParams[$id][0] == 'contribution_or_softcredits') { |
661 | self::$_contribOrSoftCredit = $queryParams[$id][2]; | |
662 | } | |
f654cacf DS |
663 | } |
664 | } | |
77b97be7 | 665 | if (in_array(self::$_contribOrSoftCredit, |
be2fb01f | 666 | ["only_scredits", "both_related", "both"])) { |
bc438a52 | 667 | if (!isset(\Civi::$statics[__CLASS__]['soft_credit_temp_table_name'])) { |
353ffa53 TO |
668 | // build a temp table which is union of contributions and soft credits |
669 | // note: group-by in first part ensures uniqueness in counts | |
bc438a52 | 670 | $tempQuery = ' |
77b97be7 | 671 | SELECT con.id as id, con.contact_id, cso.id as filter_id, NULL as scredit_id |
3dbf477c | 672 | FROM civicrm_contribution con |
4f3846df | 673 | LEFT JOIN civicrm_contribution_soft cso ON con.id = cso.contribution_id |
e5cceea5 | 674 | GROUP BY id, contact_id, scredit_id, cso.id |
3dbf477c | 675 | UNION ALL |
77b97be7 | 676 | SELECT scredit.contribution_id as id, scredit.contact_id, scredit.id as filter_id, scredit.id as scredit_id |
bc438a52 | 677 | FROM civicrm_contribution_soft as scredit'; |
678 | \Civi::$statics[__CLASS__]['soft_credit_temp_table_name'] = CRM_Utils_SQL_TempTable::build()->createWithQuery( | |
679 | $tempQuery | |
680 | )->getName(); | |
f654cacf | 681 | } |
353ffa53 TO |
682 | return TRUE; |
683 | } | |
36bf52ef DS |
684 | return FALSE; |
685 | } | |
686 | ||
186c9c17 | 687 | /** |
35e6241a EM |
688 | * Get return properties for soft credits. |
689 | * | |
186c9c17 EM |
690 | * @param bool $isExportMode |
691 | * | |
692 | * @return array | |
693 | */ | |
353ffa53 | 694 | public static function softCreditReturnProperties($isExportMode = FALSE) { |
be2fb01f | 695 | $properties = [ |
353ffa53 | 696 | 'contribution_soft_credit_name' => 1, |
4f3846df | 697 | 'contribution_soft_credit_amount' => 1, |
353ffa53 | 698 | 'contribution_soft_credit_type' => 1, |
be2fb01f | 699 | ]; |
4f3846df | 700 | if ($isExportMode) { |
5850d2e9 | 701 | $properties['contribution_soft_credit_contact_id'] = 1; |
4f3846df DS |
702 | $properties['contribution_soft_credit_contribution_id'] = 1; |
703 | } | |
704 | return $properties; | |
705 | } | |
706 | ||
186c9c17 | 707 | /** |
c7940124 | 708 | * Get the list of fields required to populate the selector. |
709 | * | |
710 | * The default return properties array returns far too many fields for 'everyday use. Every field you add to this array | |
711 | * kills a small kitten so add carefully. | |
b4bb60fc OH |
712 | * |
713 | * @param array $queryParams | |
714 | * @return array | |
c7940124 | 715 | */ |
b4bb60fc | 716 | public static function selectorReturnProperties($queryParams) { |
be2fb01f | 717 | $properties = [ |
c7940124 | 718 | 'contact_type' => 1, |
719 | 'contact_sub_type' => 1, | |
720 | 'sort_name' => 1, | |
721 | 'financial_type' => 1, | |
722 | 'contribution_source' => 1, | |
723 | 'is_test' => 1, | |
724 | 'receive_date' => 1, | |
725 | 'is_pay_later' => 1, | |
726 | 'thankyou_date' => 1, | |
727 | 'total_amount' => 1, | |
5deb2f24 | 728 | // Without this value here we get an e-notice BUT the value does not appear to be rendered anywhere. |
729 | 'contribution_campaign_id' => 1, | |
c7940124 | 730 | 'contribution_status_id' => 1, |
731 | // @todo return this & fix query to do pseudoconstant thing. | |
732 | 'contribution_status' => 1, | |
9a59ce91 | 733 | 'currency' => 1, |
3be1a625 | 734 | 'contribution_cancel_date' => 1, |
2e80df5b | 735 | 'contribution_recur_id' => 1, |
be2fb01f | 736 | ]; |
c8dd6301 | 737 | if (self::isSiteHasProducts()) { |
738 | $properties['product_name'] = 1; | |
739 | $properties['contribution_product_id'] = 1; | |
740 | } | |
b4bb60fc | 741 | if (self::isSoftCreditOptionEnabled($queryParams)) { |
8f7c2652 | 742 | $properties = array_merge($properties, self::softCreditReturnProperties()); |
743 | } | |
744 | ||
745 | return $properties; | |
c7940124 | 746 | } |
747 | ||
c8dd6301 | 748 | /** |
749 | * Do any products exist in this site's database. | |
750 | * | |
751 | * @return bool | |
752 | */ | |
753 | public static function isSiteHasProducts() { | |
754 | if (!isset(\Civi::$statics[__CLASS__]['has_products'])) { | |
755 | \Civi::$statics[__CLASS__]['has_products'] = (bool) CRM_Core_DAO::singleValueQuery('SELECT id FROM civicrm_contribution_product LIMIT 1'); | |
756 | } | |
757 | return \Civi::$statics[__CLASS__]['has_products']; | |
758 | } | |
759 | ||
c7940124 | 760 | /** |
761 | * Function you should avoid. | |
762 | * | |
763 | * This function returns default properties for contribution queries. However, they are | |
764 | * far more than are required in 'most' cases and you should always try to return the return properties | |
765 | * you actually require. | |
766 | * | |
767 | * It would be nice to throw an e-notice when this is called but it would trash the tests :-(. | |
768 | * | |
769 | * @param int $mode | |
186c9c17 EM |
770 | * @param bool $includeCustomFields |
771 | * | |
e60f24eb | 772 | * @return array|NULL |
186c9c17 | 773 | */ |
00be9182 | 774 | public static function defaultReturnProperties($mode, $includeCustomFields = TRUE) { |
6a488035 TO |
775 | $properties = NULL; |
776 | if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) { | |
be2fb01f | 777 | $properties = [ |
5928ea72 | 778 | // add |
6a488035 | 779 | 'contact_type' => 1, |
5928ea72 | 780 | // fields |
6a488035 | 781 | 'contact_sub_type' => 1, |
5928ea72 | 782 | // to |
6a488035 | 783 | 'sort_name' => 1, |
5928ea72 | 784 | //this |
6a488035 | 785 | 'display_name' => 1, |
5928ea72 | 786 | // array |
6a488035 | 787 | 'financial_type' => 1, |
5928ea72 | 788 | // to |
6a488035 | 789 | 'contribution_source' => 1, |
5928ea72 | 790 | // strangle |
6a488035 | 791 | 'receive_date' => 1, |
5928ea72 | 792 | // site |
6a488035 | 793 | 'thankyou_date' => 1, |
5928ea72 | 794 | // performance |
6e7cc0f5 | 795 | 'contribution_cancel_date' => 1, |
5928ea72 | 796 | // and |
6a488035 | 797 | 'total_amount' => 1, |
5928ea72 | 798 | // torture |
6a488035 | 799 | 'accounting_code' => 1, |
5928ea72 | 800 | // small |
afa0b07c | 801 | 'payment_instrument' => 1, |
5928ea72 | 802 | // kittens |
3a6eb174 | 803 | 'payment_instrument_id' => 1, |
5928ea72 | 804 | // argh |
7bc1d4da | 805 | 'contribution_check_number' => 1, |
5928ea72 | 806 | // no |
6a488035 | 807 | 'non_deductible_amount' => 1, |
5928ea72 | 808 | // not |
6a488035 | 809 | 'fee_amount' => 1, |
5928ea72 | 810 | // another |
6a488035 | 811 | 'net_amount' => 1, |
5928ea72 | 812 | // expensive |
6a488035 | 813 | 'trxn_id' => 1, |
5928ea72 | 814 | // join |
6a488035 | 815 | 'invoice_id' => 1, |
802c1c41 | 816 | 'invoice_number' => 1, |
5928ea72 | 817 | // added |
6a488035 | 818 | 'currency' => 1, |
5928ea72 | 819 | // to |
6a488035 | 820 | 'cancel_reason' => 1, |
5928ea72 | 821 | //every |
6a488035 | 822 | 'receipt_date' => 1, |
5928ea72 | 823 | // query |
5928ea72 | 824 | //whether |
5928ea72 | 825 | // or |
5928ea72 | 826 | // not |
5928ea72 | 827 | // the |
5928ea72 | 828 | // field |
5928ea72 | 829 | // is |
6a488035 | 830 | 'is_test' => 1, |
5928ea72 | 831 | // actually |
6a488035 | 832 | 'is_pay_later' => 1, |
5928ea72 | 833 | // required |
6a488035 | 834 | 'contribution_status' => 1, |
5928ea72 | 835 | // instead |
6a488035 | 836 | 'contribution_status_id' => 1, |
5928ea72 | 837 | // of |
6a488035 | 838 | 'contribution_recur_id' => 1, |
5928ea72 | 839 | // adding |
6a488035 | 840 | 'amount_level' => 1, |
5928ea72 | 841 | // here |
6a488035 | 842 | 'contribution_note' => 1, |
5928ea72 | 843 | // set |
6a488035 | 844 | 'contribution_batch' => 1, |
5928ea72 | 845 | // return properties |
9ebd3386 | 846 | 'contribution_campaign_title' => 1, |
5928ea72 | 847 | // on |
36bf52ef | 848 | 'contribution_campaign_id' => 1, |
5928ea72 | 849 | // calling |
5928ea72 | 850 | //function |
be2fb01f | 851 | ]; |
c8dd6301 | 852 | if (self::isSiteHasProducts()) { |
853 | $properties['fulfilled_date'] = 1; | |
854 | $properties['product_name'] = 1; | |
855 | $properties['contribution_product_id'] = 1; | |
856 | $properties['product_option'] = 1; | |
857 | $properties['sku'] = 1; | |
858 | $properties['contribution_start_date'] = 1; | |
859 | $properties['contribution_end_date'] = 1; | |
860 | } | |
d4e2b978 | 861 | if (self::isSoftCreditOptionEnabled()) { |
4f3846df | 862 | $properties = array_merge($properties, self::softCreditReturnProperties()); |
36bf52ef | 863 | } |
6a488035 TO |
864 | if ($includeCustomFields) { |
865 | // also get all the custom contribution properties | |
866 | $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Contribution'); | |
867 | if (!empty($fields)) { | |
868 | foreach ($fields as $name => $dontCare) { | |
869 | $properties[$name] = 1; | |
870 | } | |
871 | } | |
872 | } | |
873 | } | |
874 | return $properties; | |
875 | } | |
876 | ||
7123f88c | 877 | /** |
878 | * Get the metadata for fields to be included on the search form. | |
879 | * | |
880 | * @throws \CiviCRM_API3_Exception | |
881 | */ | |
882 | public static function getSearchFieldMetadata() { | |
883 | $fields = [ | |
884 | 'contribution_source', | |
885 | 'cancel_reason', | |
886 | 'invoice_number', | |
6e7cc0f5 SL |
887 | 'receive_date', |
888 | 'contribution_cancel_date', | |
cd8ae813 | 889 | 'contribution_page_id', |
7123f88c | 890 | ]; |
891 | $metadata = civicrm_api3('Contribution', 'getfields', [])['values']; | |
892 | return array_intersect_key($metadata, array_flip($fields)); | |
893 | } | |
894 | ||
6a488035 | 895 | /** |
c0aaecf9 | 896 | * Add all the elements shared between contribute search and advanced search. |
6a488035 | 897 | * |
7123f88c | 898 | * @param \CRM_Contribute_Form_Search $form |
899 | * | |
900 | * @throws \CRM_Core_Exception | |
901 | * @throws \CiviCRM_API3_Exception | |
6a488035 | 902 | */ |
00be9182 | 903 | public static function buildSearchForm(&$form) { |
6a488035 | 904 | |
7123f88c | 905 | $form->addSearchFieldMetadata(['Contribution' => self::getSearchFieldMetadata()]); |
1157f03f | 906 | $form->addSearchFieldMetadata(['ContributionRecur' => CRM_Contribute_BAO_ContributionRecur::getContributionRecurSearchFieldMetadata()]); |
7123f88c | 907 | $form->addFormFieldsFromMetadata(); |
6a488035 | 908 | |
be2fb01f CW |
909 | $form->add('text', 'contribution_amount_low', ts('From'), ['size' => 8, 'maxlength' => 8]); |
910 | $form->addRule('contribution_amount_low', ts('Please enter a valid money value (e.g. %1).', [1 => CRM_Utils_Money::format('9.99', ' ')]), 'money'); | |
6a488035 | 911 | |
be2fb01f CW |
912 | $form->add('text', 'contribution_amount_high', ts('To'), ['size' => 8, 'maxlength' => 8]); |
913 | $form->addRule('contribution_amount_high', ts('Please enter a valid money value (e.g. %1).', [1 => CRM_Utils_Money::format('99.99', ' ')]), 'money'); | |
6a488035 TO |
914 | |
915 | // Adding select option for curreny type -- CRM-4711 | |
916 | $form->add('select', 'contribution_currency_type', | |
917 | ts('Currency Type'), | |
be2fb01f | 918 | [ |
7c550ca0 | 919 | '' => ts('- any -'), |
be2fb01f CW |
920 | ] + |
921 | CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'currency', ['labelColumn' => 'name']), | |
922 | FALSE, ['class' => 'crm-select2'] | |
6a488035 TO |
923 | ); |
924 | ||
1f0d8c92 | 925 | // CRM-13848 |
573fd305 | 926 | CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes, CRM_Core_Action::VIEW); |
15cf9198 | 927 | $form->addSelect('financial_type_id', |
be2fb01f | 928 | ['entity' => 'contribution', 'multiple' => 'multiple', 'context' => 'search', 'options' => $financialTypes] |
6a488035 TO |
929 | ); |
930 | ||
6e219d15 SP |
931 | // use contribution_payment_instrument_id instead of payment_instrument_id |
932 | // Contribution Edit form (pop-up on contribution/Contact(display Result as Contribution) open on search form), | |
933 | // then payment method change action not working properly because of same html ID present two time on one page | |
934 | $form->addSelect('contribution_payment_instrument_id', | |
be2fb01f | 935 | ['entity' => 'contribution', 'field' => 'payment_instrument_id', 'multiple' => 'multiple', 'label' => ts('Payment Method'), 'option_url' => NULL, 'placeholder' => ts('- any -')] |
6a488035 TO |
936 | ); |
937 | ||
1517c3e8 | 938 | $form->add('select', |
939 | 'contribution_pcp_made_through_id', | |
940 | ts('Personal Campaign Page'), | |
be2fb01f | 941 | CRM_Contribute_PseudoConstant::pcPage(), FALSE, ['class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -')]); |
6a488035 | 942 | |
c0aaecf9 | 943 | $statusValues = CRM_Contribute_BAO_Contribution::buildOptions('contribution_status_id', 'search'); |
2b65bb8c | 944 | $form->add('select', 'contribution_status_id', |
945 | ts('Contribution Status'), $statusValues, | |
be2fb01f | 946 | FALSE, ['class' => 'crm-select2', 'multiple' => 'multiple'] |
3c151c70 | 947 | ); |
6a488035 TO |
948 | |
949 | // Add fields for thank you and receipt | |
8a4f27dc CW |
950 | $form->addYesNo('contribution_thankyou_date_is_not_null', ts('Thank-you sent?'), TRUE); |
951 | $form->addYesNo('contribution_receipt_date_is_not_null', ts('Receipt sent?'), TRUE); | |
6a488035 | 952 | |
8a4f27dc CW |
953 | $form->addYesNo('contribution_pay_later', ts('Contribution is Pay Later?'), TRUE); |
954 | $form->addYesNo('contribution_recurring', ts('Contribution is Recurring?'), TRUE); | |
b32bc653 | 955 | |
8a4f27dc | 956 | $form->addYesNo('contribution_test', ts('Contribution is a Test?'), TRUE); |
6a488035 TO |
957 | |
958 | // Add field for transaction ID search | |
3c151c70 | 959 | $form->addElement('text', 'contribution_trxn_id', ts("Transaction ID")); |
6a488035 TO |
960 | $form->addElement('text', 'contribution_check_number', ts('Check Number')); |
961 | ||
962 | // Add field for pcp display in roll search | |
8a4f27dc | 963 | $form->addYesNo('contribution_pcp_display_in_roll', ts('Personal Campaign Page Honor Roll?'), TRUE); |
6a488035 | 964 | |
36bf52ef | 965 | // Soft credit related fields |
be2fb01f | 966 | $options = [ |
3dbf477c | 967 | 'only_contribs' => ts('Contributions Only'), |
e0b774f0 | 968 | 'only_scredits' => ts('Soft Credits Only'), |
353ffa53 TO |
969 | 'both_related' => ts('Soft Credits with related Hard Credit'), |
970 | 'both' => ts('Both'), | |
be2fb01f CW |
971 | ]; |
972 | $form->add('select', 'contribution_or_softcredits', ts('Contributions OR Soft Credits?'), $options, FALSE, ['class' => "crm-select2"]); | |
e88186f4 | 973 | $form->addSelect( |
77b97be7 | 974 | 'contribution_soft_credit_type_id', |
be2fb01f | 975 | [ |
353ffa53 TO |
976 | 'entity' => 'contribution_soft', |
977 | 'field' => 'soft_credit_type_id', | |
978 | 'multiple' => TRUE, | |
979 | 'context' => 'search', | |
be2fb01f | 980 | ] |
e88186f4 | 981 | ); |
36bf52ef | 982 | |
be2fb01f | 983 | $form->addField('financial_trxn_card_type_id', ['entity' => 'FinancialTrxn', 'name' => 'card_type_id', 'action' => 'get']); |
898bfdcd | 984 | |
be2fb01f | 985 | $form->add('text', 'financial_trxn_pan_truncation', ts('Card Number'), [ |
c6ba3619 E |
986 | 'size' => 5, |
987 | 'maxlength' => 4, | |
988 | 'autocomplete' => 'off', | |
be2fb01f | 989 | ]); |
c6ba3619 | 990 | |
c8dd6301 | 991 | if (CRM_Contribute_BAO_Query::isSiteHasProducts()) { |
992 | // CRM-16713 - contribution search by premiums on 'Find Contribution' form. | |
993 | $form->add('select', 'contribution_product_id', | |
994 | ts('Premium'), | |
995 | CRM_Contribute_PseudoConstant::products(), | |
996 | FALSE, [ | |
997 | 'class' => 'crm-select2', | |
998 | 'multiple' => 'multiple', | |
1330f57a | 999 | 'placeholder' => ts('- any -'), |
c8dd6301 | 1000 | ] |
1001 | ); | |
1002 | } | |
6ffab5b7 | 1003 | |
be2fb01f | 1004 | self::addCustomFormFields($form, ['Contribution']); |
6a488035 TO |
1005 | |
1006 | CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'contribution_campaign_id'); | |
1007 | ||
1008 | // Add batch select | |
91aff94c | 1009 | $batches = CRM_Contribute_PseudoConstant::batch(); |
39b795ba | 1010 | |
481a74f4 | 1011 | if (!empty($batches)) { |
6a488035 TO |
1012 | $form->add('select', 'contribution_batch_id', |
1013 | ts('Batch Name'), | |
be2fb01f | 1014 | [ |
dc7b39df JV |
1015 | '' => ts('- any -'), |
1016 | // CRM-19325 | |
3086e282 | 1017 | 'IS NULL' => ts('None'), |
be2fb01f CW |
1018 | ] + $batches, |
1019 | FALSE, ['class' => 'crm-select2'] | |
ab345ca5 | 1020 | ); |
6a488035 TO |
1021 | } |
1022 | ||
1023 | $form->assign('validCiviContribute', TRUE); | |
be2fb01f | 1024 | $form->setDefaults(['contribution_test' => 0]); |
24782d26 | 1025 | |
1026 | CRM_Contribute_BAO_ContributionRecur::recurringContribution($form); | |
6a488035 TO |
1027 | } |
1028 | ||
186c9c17 | 1029 | /** |
35e6241a EM |
1030 | * Get table names. |
1031 | * | |
1032 | * @todo better function comment needed - what IS the point of this? | |
1033 | * | |
1034 | * @param array $tables | |
186c9c17 | 1035 | */ |
00be9182 | 1036 | public static function tableNames(&$tables) { |
6a488035 | 1037 | // Add contribution table |
a7488080 | 1038 | if (!empty($tables['civicrm_product'])) { |
be2fb01f | 1039 | $tables = array_merge(['civicrm_contribution' => 1], $tables); |
6a488035 TO |
1040 | } |
1041 | ||
8cc574cf | 1042 | if (!empty($tables['civicrm_contribution_product']) && empty($tables['civicrm_product'])) { |
6a488035 TO |
1043 | $tables['civicrm_product'] = 1; |
1044 | } | |
1045 | } | |
a91e698a | 1046 | |
1047 | /** | |
fe482240 | 1048 | * Add the where for dates. |
77b97be7 | 1049 | * |
014c4014 TO |
1050 | * @param array $values |
1051 | * Array of query values. | |
1052 | * @param object $query | |
1053 | * The query object. | |
1054 | * @param string $name | |
1055 | * Query field that is set. | |
1056 | * @param string $field | |
1057 | * Name of field to be set. | |
1058 | * @param string $title | |
1059 | * Title of the field. | |
77b97be7 EM |
1060 | * |
1061 | * @return bool | |
a91e698a | 1062 | */ |
00be9182 | 1063 | public static function buildDateWhere(&$values, $query, $name, $field, $title) { |
a91e698a | 1064 | $fieldPart = strpos($name, $field); |
22e263ad | 1065 | if ($fieldPart === FALSE) { |
7c550ca0 | 1066 | return NULL; |
a91e698a | 1067 | } |
1068 | // we only have recurring dates using this ATM so lets' short cut to find the table name | |
1069 | $table = 'contribution_recur'; | |
d3e86119 | 1070 | $fieldName = explode($table . '_', $field); |
a91e698a | 1071 | $query->dateQueryBuilder($values, |
1072 | 'civicrm_' . $table, $field, $fieldName[1], $title | |
1073 | ); | |
1074 | return TRUE; | |
1075 | } | |
b32bc653 | 1076 | |
686df921 | 1077 | /** |
1078 | * Add the soft credit fields to the select fields. | |
1079 | * | |
1080 | * Extracted into separate function to improve readability of main select function. | |
1081 | * | |
1082 | * @param $query | |
1083 | */ | |
1084 | private static function addSoftCreditFields(&$query) { | |
1085 | $includeSoftCredits = self::isSoftCreditOptionEnabled($query->_params); | |
1086 | if (!empty($query->_returnProperties['contribution_soft_credit_name'])) { | |
1087 | if ($includeSoftCredits) { | |
1088 | $query->_select['contribution_soft_credit_name'] = "civicrm_contact_d.sort_name as contribution_soft_credit_name"; | |
1089 | // also include contact id. Will help build hyperlinks | |
1090 | $query->_select['contribution_soft_credit_contact_id'] = "civicrm_contact_d.id as contribution_soft_credit_contact_id"; | |
1091 | } | |
1092 | $query->_element['contribution_soft_credit_name'] = 1; | |
1093 | $query->_element['contribution_soft_credit_contact_id'] = 1; | |
1094 | ||
1095 | $query->_tables['civicrm_contribution'] = 1; | |
1096 | $query->_tables['civicrm_contribution_soft'] = 1; | |
1097 | $query->_tables['civicrm_contribution_soft_contact'] = 1; | |
1098 | } | |
1099 | ||
1100 | if (!empty($query->_returnProperties['contribution_soft_credit_contact_id'])) { | |
1101 | $query->_tables['civicrm_contribution'] = 1; | |
1102 | $query->_tables['civicrm_contribution_soft'] = 1; | |
1103 | $query->_tables['civicrm_contribution_soft_contact'] = 1; | |
1104 | } | |
1105 | ||
1106 | if (!empty($query->_returnProperties['contribution_soft_credit_amount'])) { | |
1107 | if ($includeSoftCredits) { | |
1108 | $query->_select['contribution_soft_credit_amount'] = "civicrm_contribution_soft.amount as contribution_soft_credit_amount"; | |
1109 | } | |
1110 | $query->_element['contribution_soft_credit_amount'] = 1; | |
1111 | $query->_tables['civicrm_contribution'] = 1; | |
1112 | $query->_tables['civicrm_contribution_soft'] = 1; | |
1113 | } | |
1114 | ||
1115 | if (!empty($query->_returnProperties['contribution_soft_credit_type'])) { | |
1116 | if ($includeSoftCredits) { | |
1117 | $query->_select['contribution_soft_credit_type'] = "contribution_softcredit_type.label as contribution_soft_credit_type"; | |
1118 | } | |
1119 | $query->_element['contribution_soft_credit_type'] = 1; | |
1120 | $query->_tables['civicrm_contribution'] = 1; | |
1121 | $query->_tables['contribution_softcredit_type'] = 1; | |
1122 | } | |
1123 | ||
1124 | if (!empty($query->_returnProperties['contribution_soft_credit_contribution_id'])) { | |
1125 | if ($includeSoftCredits) { | |
1126 | $query->_select['contribution_soft_credit_contribution_id'] = "civicrm_contribution_soft.contribution_id as contribution_soft_credit_contribution_id"; | |
1127 | } | |
1128 | $query->_element['contribution_soft_credit_contribution_id'] = 1; | |
1129 | $query->_tables['civicrm_contribution'] = 1; | |
1130 | $query->_tables['civicrm_contribution_soft'] = 1; | |
1131 | } | |
1132 | ||
1133 | if (!empty($query->_returnProperties['contribution_soft_credit_email'])) { | |
1134 | $query->_select['contribution_soft_credit_email'] = "soft_email.email as contribution_soft_credit_email"; | |
1135 | $query->_element['contribution_soft_credit_email'] = 1; | |
1136 | $query->_tables['civicrm_contribution'] = 1; | |
1137 | $query->_tables['civicrm_contribution_soft'] = 1; | |
1138 | $query->_tables['civicrm_contribution_soft_contact'] = 1; | |
1139 | $query->_tables['civicrm_contribution_soft_email'] = 1; | |
1140 | } | |
1141 | ||
1142 | if (!empty($query->_returnProperties['contribution_soft_credit_phone'])) { | |
1143 | $query->_select['contribution_soft_credit_email'] = "soft_phone.phone as contribution_soft_credit_phone"; | |
1144 | $query->_element['contribution_soft_credit_phone'] = 1; | |
1145 | $query->_tables['civicrm_contribution'] = 1; | |
1146 | $query->_tables['civicrm_contribution_soft'] = 1; | |
1147 | $query->_tables['civicrm_contribution_soft_contact'] = 1; | |
1148 | $query->_tables['civicrm_contribution_soft_phone'] = 1; | |
1149 | } | |
1150 | ||
1151 | if (!empty($query->_returnProperties['contribution_soft_credit_pcp_id'])) { | |
1152 | $query->_select['contribution_soft_credit_pcp_id'] = "civicrm_contribution_soft.pcp_id as contribution_soft_credit_pcp_id"; | |
1153 | $query->_element['contribution_soft_credit_pcp_id'] = 1; | |
1154 | $query->_tables['civicrm_contribution'] = 1; | |
1155 | $query->_tables['civicrm_contribution_soft'] = 1; | |
1156 | } | |
1157 | } | |
1158 | ||
6a488035 | 1159 | } |