Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
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_Pledge_BAO_Query extends CRM_Core_BAO_Query { |
c86d4e7c | 18 | |
ffd93213 | 19 | /** |
e9ff5391 | 20 | * Get pledge fields. |
21 | * | |
22 | * @param bool $checkPermission | |
23 | * | |
ffd93213 EM |
24 | * @return array |
25 | */ | |
0ed9f379 | 26 | public static function getFields($checkPermission = TRUE) { |
27 | return CRM_Pledge_BAO_Pledge::exportableFields($checkPermission); | |
6a488035 TO |
28 | } |
29 | ||
30 | /** | |
fe482240 | 31 | * Build select for Pledge. |
6a488035 | 32 | * |
0ed9f379 | 33 | * @param CRM_Contact_BAO_Query $query |
6a488035 | 34 | */ |
00be9182 | 35 | public static function select(&$query) { |
0ed9f379 | 36 | |
1d1fb1e8 | 37 | $statusId = implode(',', array_keys(CRM_Core_PseudoConstant::accountOptionValues("contribution_status", NULL, " AND v.name IN ('Pending', 'Overdue')"))); |
8cc574cf | 38 | if (($query->_mode & CRM_Contact_BAO_Query::MODE_PLEDGE) || !empty($query->_returnProperties['pledge_id'])) { |
6a488035 TO |
39 | $query->_select['pledge_id'] = 'civicrm_pledge.id as pledge_id'; |
40 | $query->_element['pledge_id'] = 1; | |
41 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
42 | } | |
43 | ||
cc28438b | 44 | // add pledge select |
a7488080 | 45 | if (!empty($query->_returnProperties['pledge_amount'])) { |
6a488035 TO |
46 | $query->_select['pledge_amount'] = 'civicrm_pledge.amount as pledge_amount'; |
47 | $query->_element['pledge_amount'] = 1; | |
48 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
49 | } | |
50 | ||
db517dfe NM |
51 | if (!empty($query->_returnProperties['pledge_original_installment_amount'])) { |
52 | $query->_select['pledge_original_installment_amount'] = 'civicrm_pledge.original_installment_amount as pledge_original_installment_amount'; | |
53 | $query->_element['pledge_original_installment_amount'] = 1; | |
54 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
55 | } | |
547cbec2 | 56 | |
db517dfe NM |
57 | if (!empty($query->_returnProperties['installments'])) { |
58 | $query->_select['installments'] = 'civicrm_pledge.installments as installments'; | |
59 | $query->_element['installments'] = 1; | |
60 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
61 | } | |
62 | ||
a7488080 | 63 | if (!empty($query->_returnProperties['pledge_create_date'])) { |
6a488035 TO |
64 | $query->_select['pledge_create_date'] = 'civicrm_pledge.create_date as pledge_create_date'; |
65 | $query->_element['pledge_create_date'] = 1; | |
66 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
67 | } | |
68 | ||
a5e468ff SL |
69 | if (!empty($query->_returnProperties['pledge_end_date'])) { |
70 | $query->_select['pledge_end_date'] = 'civicrm_pledge.end_date as pledge_end_date'; | |
71 | $query->_element['pledge_end_date'] = 1; | |
72 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
73 | } | |
74 | ||
4e2c4036 CW |
75 | if (!empty($query->_returnProperties['pledge_start_date'])) { |
76 | $query->_select['pledge_start_date'] = 'civicrm_pledge.start_date as pledge_start_date'; | |
77 | $query->_element['pledge_start_date'] = 1; | |
78 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
79 | } | |
80 | ||
a7488080 | 81 | if (!empty($query->_returnProperties['pledge_status_id'])) { |
6a488035 TO |
82 | $query->_select['pledge_status_id'] = 'pledge_status.value as pledge_status_id'; |
83 | $query->_element['pledge_status'] = 1; | |
84 | $query->_tables['pledge_status'] = $query->_whereTables['pledge_status'] = 1; | |
85 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
86 | } | |
87 | ||
a7488080 | 88 | if (!empty($query->_returnProperties['pledge_status'])) { |
6a488035 TO |
89 | $query->_select['pledge_status'] = 'pledge_status.label as pledge_status'; |
90 | $query->_element['pledge_status'] = 1; | |
91 | $query->_tables['pledge_status'] = $query->_whereTables['pledge_status'] = 1; | |
92 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
93 | } | |
94 | ||
a7488080 | 95 | if (!empty($query->_returnProperties['pledge_total_paid'])) { |
6a488035 TO |
96 | $query->_select['pledge_total_paid'] = ' (SELECT sum(civicrm_pledge_payment.actual_amount) FROM civicrm_pledge_payment WHERE civicrm_pledge_payment.pledge_id = civicrm_pledge.id AND civicrm_pledge_payment.status_id = 1 ) as pledge_total_paid'; |
97 | $query->_element['pledge_total_paid'] = 1; | |
98 | } | |
99 | ||
a7488080 | 100 | if (!empty($query->_returnProperties['pledge_next_pay_date'])) { |
1d1fb1e8 | 101 | $query->_select['pledge_next_pay_date'] = " (SELECT civicrm_pledge_payment.scheduled_date FROM civicrm_pledge_payment WHERE civicrm_pledge_payment.pledge_id = civicrm_pledge.id AND civicrm_pledge_payment.status_id IN ({$statusId}) ORDER BY civicrm_pledge_payment.scheduled_date ASC LIMIT 0, 1) as pledge_next_pay_date"; |
6a488035 TO |
102 | $query->_element['pledge_next_pay_date'] = 1; |
103 | } | |
104 | ||
a7488080 | 105 | if (!empty($query->_returnProperties['pledge_next_pay_amount'])) { |
1d1fb1e8 | 106 | $query->_select['pledge_next_pay_amount'] = " (SELECT civicrm_pledge_payment.scheduled_amount FROM civicrm_pledge_payment WHERE civicrm_pledge_payment.pledge_id = civicrm_pledge.id AND civicrm_pledge_payment.status_id IN ({$statusId}) ORDER BY civicrm_pledge_payment.scheduled_date ASC LIMIT 0, 1) as pledge_next_pay_amount"; |
6a488035 TO |
107 | $query->_element['pledge_next_pay_amount'] = 1; |
108 | ||
109 | $query->_select['pledge_outstanding_amount'] = " (SELECT sum(civicrm_pledge_payment.scheduled_amount) FROM civicrm_pledge_payment WHERE civicrm_pledge_payment.pledge_id = civicrm_pledge.id AND civicrm_pledge_payment.status_id = 6 ) as pledge_outstanding_amount"; | |
110 | $query->_element['pledge_outstanding_amount'] = 1; | |
111 | } | |
112 | ||
a7488080 | 113 | if (!empty($query->_returnProperties['pledge_financial_type'])) { |
353ffa53 | 114 | $query->_select['pledge_financial_type'] = "(SELECT civicrm_financial_type.name FROM civicrm_financial_type WHERE civicrm_financial_type.id = civicrm_pledge.financial_type_id) as pledge_financial_type"; |
6a488035 TO |
115 | $query->_element['pledge_financial_type'] = 1; |
116 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
117 | } | |
118 | ||
a7488080 | 119 | if (!empty($query->_returnProperties['pledge_contribution_page_id'])) { |
6a488035 TO |
120 | $query->_select['pledge_contribution_page_id'] = 'civicrm_pledge.contribution_page_id as pledge_contribution_page_id'; |
121 | $query->_element['pledge_contribution_page_id'] = 1; | |
122 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
123 | } | |
124 | ||
a7488080 | 125 | if (!empty($query->_returnProperties['pledge_payment_id'])) { |
6a488035 TO |
126 | $query->_select['pledge_payment_id'] = 'civicrm_pledge_payment.id as pledge_payment_id'; |
127 | $query->_element['pledge_payment_id'] = 1; | |
128 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
129 | } | |
130 | ||
a7488080 | 131 | if (!empty($query->_returnProperties['pledge_payment_scheduled_amount'])) { |
6a488035 TO |
132 | $query->_select['pledge_payment_scheduled_amount'] = 'civicrm_pledge_payment.scheduled_amount as pledge_payment_scheduled_amount'; |
133 | $query->_element['pledge_payment_scheduled_amount'] = 1; | |
134 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
135 | } | |
136 | ||
a7488080 | 137 | if (!empty($query->_returnProperties['pledge_payment_scheduled_date'])) { |
6a488035 TO |
138 | $query->_select['pledge_payment_scheduled_date'] = 'civicrm_pledge_payment.scheduled_date as pledge_payment_scheduled_date'; |
139 | $query->_element['pledge_payment_scheduled_date'] = 1; | |
140 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
141 | } | |
142 | ||
a7488080 | 143 | if (!empty($query->_returnProperties['pledge_payment_paid_amount'])) { |
6a488035 TO |
144 | $query->_select['pledge_payment_paid_amount'] = 'civicrm_pledge_payment.actual_amount as pledge_payment_paid_amount'; |
145 | $query->_element['pledge_payment_paid_amount'] = 1; | |
146 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
147 | } | |
148 | ||
a7488080 | 149 | if (!empty($query->_returnProperties['pledge_payment_paid_date'])) { |
6a488035 TO |
150 | $query->_select['pledge_payment_paid_date'] = 'payment_contribution.receive_date as pledge_payment_paid_date'; |
151 | $query->_element['pledge_payment_paid_date'] = 1; | |
152 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
153 | $query->_tables['payment_contribution'] = $query->_whereTables['payment_contribution'] = 1; | |
154 | } | |
155 | ||
a7488080 | 156 | if (!empty($query->_returnProperties['pledge_payment_reminder_date'])) { |
6a488035 TO |
157 | $query->_select['pledge_payment_reminder_date'] = 'civicrm_pledge_payment.reminder_date as pledge_payment_reminder_date'; |
158 | $query->_element['pledge_payment_reminder_date'] = 1; | |
159 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
160 | } | |
161 | ||
a7488080 | 162 | if (!empty($query->_returnProperties['pledge_payment_reminder_count'])) { |
6a488035 TO |
163 | $query->_select['pledge_payment_reminder_count'] = 'civicrm_pledge_payment.reminder_count as pledge_payment_reminder_count'; |
164 | $query->_element['pledge_payment_reminder_count'] = 1; | |
165 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
166 | } | |
167 | ||
a7488080 | 168 | if (!empty($query->_returnProperties['pledge_payment_status_id'])) { |
6a488035 TO |
169 | $query->_select['pledge_payment_status_id'] = 'payment_status.name as pledge_payment_status_id'; |
170 | $query->_element['pledge_payment_status_id'] = 1; | |
171 | $query->_tables['payment_status'] = $query->_whereTables['payment_status'] = 1; | |
172 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
173 | } | |
174 | ||
a7488080 | 175 | if (!empty($query->_returnProperties['pledge_payment_status'])) { |
6a488035 TO |
176 | $query->_select['pledge_payment_status'] = 'payment_status.label as pledge_payment_status'; |
177 | $query->_element['pledge_payment_status'] = 1; | |
178 | $query->_tables['payment_status'] = $query->_whereTables['payment_status'] = 1; | |
179 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
180 | } | |
181 | ||
a7488080 | 182 | if (!empty($query->_returnProperties['pledge_frequency_interval'])) { |
6a488035 TO |
183 | $query->_select['pledge_frequency_interval'] = 'civicrm_pledge.frequency_interval as pledge_frequency_interval'; |
184 | $query->_element['pledge_frequency_interval'] = 1; | |
185 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
186 | } | |
187 | ||
a7488080 | 188 | if (!empty($query->_returnProperties['pledge_frequency_unit'])) { |
6a488035 TO |
189 | $query->_select['pledge_frequency_unit'] = 'civicrm_pledge.frequency_unit as pledge_frequency_unit'; |
190 | $query->_element['pledge_frequency_unit'] = 1; | |
191 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
192 | } | |
193 | ||
a7488080 | 194 | if (!empty($query->_returnProperties['pledge_is_test'])) { |
6a488035 TO |
195 | $query->_select['pledge_is_test'] = 'civicrm_pledge.is_test as pledge_is_test'; |
196 | $query->_element['pledge_is_test'] = 1; | |
197 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
198 | } | |
a7488080 | 199 | if (!empty($query->_returnProperties['pledge_campaign_id'])) { |
6a488035 TO |
200 | $query->_select['pledge_campaign_id'] = 'civicrm_pledge.campaign_id as pledge_campaign_id'; |
201 | $query->_element['pledge_campaign_id'] = 1; | |
202 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
203 | } | |
204 | ||
a7488080 | 205 | if (!empty($query->_returnProperties['pledge_currency'])) { |
6a488035 TO |
206 | $query->_select['pledge_currency'] = 'civicrm_pledge.currency as pledge_currency'; |
207 | $query->_element['pledge_currency'] = 1; | |
208 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
209 | } | |
210 | } | |
211 | ||
ffd93213 EM |
212 | /** |
213 | * @param $query | |
214 | */ | |
00be9182 | 215 | public static function where(&$query) { |
28c666be | 216 | $grouping = NULL; |
6a488035 | 217 | foreach (array_keys($query->_params) as $id) { |
a7488080 | 218 | if (empty($query->_params[$id][0])) { |
6a488035 TO |
219 | continue; |
220 | } | |
221 | if (substr($query->_params[$id][0], 0, 7) == 'pledge_') { | |
2da8c6c4 | 222 | if ($query->_mode == CRM_Contact_BAO_Query::MODE_CONTACTS) { |
6a488035 TO |
223 | $query->_useDistinct = TRUE; |
224 | } | |
6a488035 TO |
225 | $grouping = $query->_params[$id][3]; |
226 | self::whereClauseSingle($query->_params[$id], $query); | |
227 | } | |
228 | } | |
6a488035 TO |
229 | } |
230 | ||
ffd93213 | 231 | /** |
33a17d7e | 232 | * Get where clause for field. |
233 | * | |
234 | * @todo most of this could be replaced by using metadata. | |
235 | * | |
236 | * @param array $values | |
237 | * @param \CRM_Contact_BAO_Query $query | |
238 | * | |
239 | * @throws \CRM_Core_Exception | |
ffd93213 | 240 | */ |
00be9182 | 241 | public static function whereClauseSingle(&$values, &$query) { |
33a17d7e | 242 | if ($query->buildDateRangeQuery($values)) { |
243 | // @todo - move this to Contact_Query in or near the call to | |
244 | // $this->buildRelativeDateQuery($values); | |
245 | return; | |
246 | } | |
6a488035 TO |
247 | list($name, $op, $value, $grouping, $wildcard) = $values; |
248 | ||
249 | switch ($name) { | |
6a488035 TO |
250 | case 'pledge_amount': |
251 | case 'pledge_amount_low': | |
252 | case 'pledge_amount_high': | |
253 | // process min/max amount | |
254 | $query->numberRangeBuilder($values, | |
255 | 'civicrm_pledge', 'pledge_amount', 'amount', 'Pledge Amount' | |
256 | ); | |
257 | return; | |
258 | ||
0ed9f379 | 259 | case 'pledge_installments_low': |
260 | case 'pledge_installments_high': | |
261 | // process min/max amount | |
262 | $query->numberRangeBuilder($values, | |
263 | 'civicrm_pledge', 'pledge_installments', 'installments', 'Number of Installments' | |
264 | ); | |
265 | return; | |
266 | ||
267 | case 'pledge_acknowledge_date_is_not_null': | |
268 | if ($value) { | |
269 | $op = "IS NOT NULL"; | |
270 | $query->_qill[$grouping][] = ts('Pledge Acknowledgement Sent'); | |
271 | } | |
272 | else { | |
273 | $op = "IS NULL"; | |
274 | $query->_qill[$grouping][] = ts('Pledge Acknowledgement Not Sent'); | |
275 | } | |
276 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_pledge.acknowledge_date", $op); | |
277 | return; | |
278 | ||
6a488035 | 279 | case 'pledge_payment_status_id': |
2b65bb8c | 280 | case 'pledge_status_id': |
281 | if ($name == 'pledge_status_id') { | |
282 | $tableName = 'civicrm_pledge'; | |
283 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
284 | $label = "Pledge Status"; | |
dc0f8909 JP |
285 | $qillDAO = 'CRM_Pledge_DAO_Pledge'; |
286 | $qillField = 'status_id'; | |
6a488035 TO |
287 | } |
288 | else { | |
2b65bb8c | 289 | $tableName = 'civicrm_pledge_payment'; |
290 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
291 | $label = "Pledge Payment Status"; | |
dc0f8909 JP |
292 | $qillDAO = 'CRM_Contribute_DAO_Contribution'; |
293 | $qillField = 'contribution_status_id'; | |
6a488035 | 294 | } |
2b65bb8c | 295 | $name = 'status_id'; |
296 | if (!empty($value) && is_array($value) && !in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) { | |
be2fb01f | 297 | $value = ['IN' => $value]; |
6a488035 TO |
298 | } |
299 | ||
2b65bb8c | 300 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("$tableName.$name", |
6a488035 | 301 | $op, |
2b65bb8c | 302 | $value, |
6a488035 TO |
303 | 'Integer' |
304 | ); | |
dc0f8909 | 305 | list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue($qillDAO, $qillField, $value, $op); |
be2fb01f | 306 | $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $label, 2 => $qillop, 3 => $qillVal]); |
6a488035 TO |
307 | return; |
308 | ||
309 | case 'pledge_test': | |
310 | case 'pledge_is_test': | |
28c666be CW |
311 | // We dont want to include all tests for sql OR CRM-7827 |
312 | if (!$value || $query->getOperator() != 'OR') { | |
313 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_pledge.is_test', | |
314 | $op, | |
315 | $value, | |
316 | 'Boolean' | |
317 | ); | |
318 | if ($value) { | |
319 | $query->_qill[$grouping][] = ts('Pledge is a Test'); | |
320 | } | |
321 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
6a488035 | 322 | } |
6a488035 TO |
323 | return; |
324 | ||
325 | case 'pledge_financial_type_id': | |
326 | $type = CRM_Contribute_PseudoConstant::financialType($value); | |
327 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_pledge.financial_type_id', | |
328 | $op, | |
329 | $value, | |
330 | 'Integer' | |
331 | ); | |
be2fb01f | 332 | $query->_qill[$grouping][] = ts('Financial Type - %1', [1 => $type]); |
6a488035 TO |
333 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; |
334 | return; | |
335 | ||
336 | case 'pledge_contribution_page_id': | |
337 | $page = CRM_Contribute_PseudoConstant::contributionPage($value); | |
338 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_pledge.contribution_page_id', | |
339 | $op, | |
340 | $value, | |
341 | 'Integer' | |
342 | ); | |
be2fb01f | 343 | $query->_qill[$grouping][] = ts('Financial Page - %1', [1 => $page]); |
6a488035 TO |
344 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; |
345 | return; | |
346 | ||
6a488035 | 347 | case 'pledge_id': |
59de5a50 EM |
348 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_pledge.id", |
349 | $op, | |
350 | $value, | |
351 | "Integer" | |
352 | ); | |
6a488035 TO |
353 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; |
354 | return; | |
355 | ||
356 | case 'pledge_frequency_interval': | |
357 | $query->_where[$grouping][] = "civicrm_pledge.frequency_interval $op $value"; | |
358 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
359 | return; | |
360 | ||
361 | case 'pledge_frequency_unit': | |
362 | $query->_where[$grouping][] = "civicrm_pledge.frequency_unit $op $value"; | |
363 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
364 | return; | |
365 | ||
d4e614ad | 366 | case 'pledge_contact_id': |
6f56dc34 | 367 | case 'pledge_campaign_id': |
d4e614ad SB |
368 | $name = str_replace('pledge_', '', $name); |
369 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_pledge.$name", $op, $value, 'Integer'); | |
370 | list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Pledge_DAO_Pledge', $name, $value, $op); | |
6f56dc34 | 371 | $label = ($name == 'campaign_id') ? 'Campaign' : 'Contact ID'; |
be2fb01f | 372 | $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $label, 2 => $op, 3 => $value]); |
d4e614ad SB |
373 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; |
374 | return; | |
6a488035 TO |
375 | } |
376 | } | |
377 | ||
ffd93213 | 378 | /** |
ad37ac8e | 379 | * From clause. |
380 | * | |
100fef9d | 381 | * @param string $name |
ad37ac8e | 382 | * @param string $mode |
383 | * @param string $side | |
ffd93213 EM |
384 | * |
385 | * @return null|string | |
386 | */ | |
00be9182 | 387 | public static function from($name, $mode, $side) { |
6a488035 TO |
388 | $from = NULL; |
389 | ||
390 | switch ($name) { | |
391 | case 'civicrm_pledge': | |
392 | $from = " $side JOIN civicrm_pledge ON civicrm_pledge.contact_id = contact_a.id "; | |
393 | break; | |
394 | ||
395 | case 'pledge_status': | |
01dac399 | 396 | $from .= " $side JOIN civicrm_option_group option_group_pledge_status ON (option_group_pledge_status.name = 'pledge_status')"; |
6a488035 TO |
397 | $from .= " $side JOIN civicrm_option_value pledge_status ON (civicrm_pledge.status_id = pledge_status.value AND option_group_pledge_status.id = pledge_status.option_group_id ) "; |
398 | break; | |
399 | ||
400 | case 'pledge_financial_type': | |
098201d8 | 401 | $from .= " $side JOIN civicrm_financial_type ON civicrm_pledge.financial_type_id = civicrm_financial_type.id "; |
6a488035 TO |
402 | break; |
403 | ||
6a488035 TO |
404 | case 'civicrm_pledge_payment': |
405 | $from .= " $side JOIN civicrm_pledge_payment ON civicrm_pledge_payment.pledge_id = civicrm_pledge.id "; | |
406 | break; | |
407 | ||
408 | case 'payment_contribution': | |
409 | $from .= " $side JOIN civicrm_contribution payment_contribution ON civicrm_pledge_payment.contribution_id = payment_contribution.id "; | |
410 | break; | |
411 | ||
412 | case 'payment_status': | |
413 | $from .= " $side JOIN civicrm_option_group option_group_payment_status ON (option_group_payment_status.name = 'contribution_status')"; | |
414 | $from .= " $side JOIN civicrm_option_value payment_status ON (civicrm_pledge_payment.status_id = payment_status.value AND option_group_payment_status.id = payment_status.option_group_id ) "; | |
415 | break; | |
416 | } | |
417 | ||
418 | return $from; | |
419 | } | |
420 | ||
6a488035 | 421 | /** |
fe482240 | 422 | * Ideally this function should include fields that are displayed in the selector. |
ad37ac8e | 423 | * |
424 | * @param int $mode | |
425 | * @param bool $includeCustomFields | |
426 | * | |
427 | * @return array|null | |
6a488035 | 428 | */ |
3bdca100 | 429 | public static function defaultReturnProperties( |
3295515a | 430 | $mode, |
6a488035 TO |
431 | $includeCustomFields = TRUE |
432 | ) { | |
433 | $properties = NULL; | |
434 | ||
435 | if ($mode & CRM_Contact_BAO_Query::MODE_PLEDGE) { | |
be2fb01f | 436 | $properties = [ |
6a488035 TO |
437 | 'contact_type' => 1, |
438 | 'contact_sub_type' => 1, | |
439 | 'sort_name' => 1, | |
440 | 'display_name' => 1, | |
441 | 'pledge_id' => 1, | |
442 | 'pledge_amount' => 1, | |
443 | 'pledge_total_paid' => 1, | |
444 | 'pledge_create_date' => 1, | |
4e2c4036 | 445 | 'pledge_start_date' => 1, |
6a488035 TO |
446 | 'pledge_next_pay_date' => 1, |
447 | 'pledge_next_pay_amount' => 1, | |
448 | 'pledge_status' => 1, | |
449 | 'pledge_status_id' => 1, | |
450 | 'pledge_is_test' => 1, | |
451 | 'pledge_contribution_page_id' => 1, | |
452 | 'pledge_financial_type' => 1, | |
453 | 'pledge_frequency_interval' => 1, | |
454 | 'pledge_frequency_unit' => 1, | |
455 | 'pledge_currency' => 1, | |
456 | 'pledge_campaign_id' => 1, | |
be2fb01f | 457 | ]; |
6a488035 TO |
458 | } |
459 | return $properties; | |
460 | } | |
461 | ||
462 | /** | |
fe482240 | 463 | * This includes any extra fields that might need for export etc. |
ea3ddccf | 464 | * |
465 | * @param string $mode | |
466 | * | |
467 | * @return array|null | |
6a488035 | 468 | */ |
00be9182 | 469 | public static function extraReturnProperties($mode) { |
6a488035 TO |
470 | $properties = NULL; |
471 | ||
472 | if ($mode & CRM_Contact_BAO_Query::MODE_PLEDGE) { | |
be2fb01f | 473 | $properties = [ |
6a488035 TO |
474 | 'pledge_balance_amount' => 1, |
475 | 'pledge_payment_id' => 1, | |
476 | 'pledge_payment_scheduled_amount' => 1, | |
477 | 'pledge_payment_scheduled_date' => 1, | |
478 | 'pledge_payment_paid_amount' => 1, | |
479 | 'pledge_payment_paid_date' => 1, | |
480 | 'pledge_payment_reminder_date' => 1, | |
481 | 'pledge_payment_reminder_count' => 1, | |
482 | 'pledge_payment_status_id' => 1, | |
483 | 'pledge_payment_status' => 1, | |
be2fb01f | 484 | ]; |
6a488035 TO |
485 | |
486 | // also get all the custom pledge properties | |
487 | $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Pledge'); | |
488 | if (!empty($fields)) { | |
489 | foreach ($fields as $name => $dontCare) { | |
490 | $properties[$name] = 1; | |
491 | } | |
492 | } | |
493 | } | |
494 | return $properties; | |
495 | } | |
496 | ||
ffd93213 | 497 | /** |
52ddd94d | 498 | * Get the metadata for fields to be included on the grant search form. |
499 | * | |
500 | * @throws \CiviCRM_API3_Exception | |
501 | */ | |
502 | public static function getSearchFieldMetadata() { | |
503 | $fields = [ | |
504 | 'pledge_status_id', | |
1519c828 SL |
505 | 'pledge_start_date', |
506 | 'pledge_end_date', | |
507 | 'pledge_create_date', | |
52ddd94d | 508 | ]; |
509 | $metadata = civicrm_api3('Pledge', 'getfields', [])['values']; | |
510 | return array_intersect_key($metadata, array_flip($fields)); | |
511 | } | |
512 | ||
1519c828 SL |
513 | /** |
514 | * Get the metadata for fields to be included on the grant search form. | |
515 | * | |
516 | * @throws \CiviCRM_API3_Exception | |
517 | */ | |
518 | public static function getPledgePaymentSearchFieldMetadata() { | |
519 | $fields = [ | |
520 | 'pledge_payment_scheduled_date', | |
521 | ]; | |
522 | $metadata = civicrm_api3('PledgePayment', 'getfields', [])['values']; | |
523 | return array_intersect_key($metadata, array_flip($fields)); | |
524 | } | |
525 | ||
52ddd94d | 526 | /** |
1f7b17e4 | 527 | * Build the search for pledges. |
52ddd94d | 528 | * |
529 | * @param CRM_Pledge_Form_Search|\CRM_Contact_Form_Search_Advanced $form | |
530 | * | |
531 | * @throws \CRM_Core_Exception | |
532 | * @throws \CiviCRM_API3_Exception | |
ffd93213 | 533 | */ |
00be9182 | 534 | public static function buildSearchForm(&$form) { |
6a488035 | 535 | // pledge related dates |
52ddd94d | 536 | $form->addSearchFieldMetadata(['Pledge' => self::getSearchFieldMetadata()]); |
1519c828 | 537 | $form->addSearchFieldMetadata(['PledgePayment' => self::getPledgePaymentSearchFieldMetadata()]); |
52ddd94d | 538 | $form->addFormFieldsFromMetadata(); |
6a488035 | 539 | |
8a4f27dc | 540 | $form->addYesNo('pledge_test', ts('Pledge is a Test?'), TRUE); |
be2fb01f | 541 | $form->add('text', 'pledge_amount_low', ts('From'), ['size' => 8, 'maxlength' => 8]); |
bf1cf004 | 542 | $form->addRule('pledge_amount_low', ts('Please enter a valid money value (e.g. %1).', [1 => CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency('9.99')]), 'money'); |
6a488035 | 543 | |
be2fb01f | 544 | $form->add('text', 'pledge_amount_high', ts('To'), ['size' => 8, 'maxlength' => 8]); |
bf1cf004 | 545 | $form->addRule('pledge_amount_high', ts('Please enter a valid money value (e.g. %1).', [1 => CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency('99.99')]), 'money'); |
6a488035 | 546 | |
0ed9f379 | 547 | $form->addYesNo('pledge_acknowledge_date_is_not_null', ts('Acknowledgement sent?'), TRUE); |
548 | ||
be2fb01f | 549 | $form->add('text', 'pledge_installments_low', ts('From'), ['size' => 8, 'maxlength' => 8]); |
0ed9f379 | 550 | $form->addRule('pledge_installments_low', ts('Please enter a number'), 'integer'); |
551 | ||
be2fb01f | 552 | $form->add('text', 'pledge_installments_high', ts('To'), ['size' => 8, 'maxlength' => 8]); |
0ed9f379 | 553 | $form->addRule('pledge_installments_high', ts('Please enter number.'), 'integer'); |
6a488035 | 554 | |
2b65bb8c | 555 | $form->add('select', 'pledge_payment_status_id', |
ab6ba136 | 556 | ts('Pledge Payment Status'), CRM_Pledge_BAO_PledgePayment::buildOptions('status_id'), |
be2fb01f | 557 | FALSE, ['class' => 'crm-select2', 'multiple' => 'multiple'] |
2b65bb8c | 558 | ); |
6a488035 TO |
559 | |
560 | $form->add('select', 'pledge_financial_type_id', | |
481a74f4 | 561 | ts('Financial Type'), |
be2fb01f CW |
562 | ['' => ts('- select -')] + CRM_Contribute_PseudoConstant::financialType(), |
563 | FALSE, ['class' => 'crm-select2'] | |
6a488035 TO |
564 | ); |
565 | ||
566 | $form->add('select', 'pledge_contribution_page_id', | |
567 | ts('Contribution Page'), | |
be2fb01f CW |
568 | ['' => ts('- any -')] + CRM_Contribute_PseudoConstant::contributionPage(), |
569 | FALSE, ['class' => 'crm-select2'] | |
6a488035 TO |
570 | ); |
571 | ||
cc28438b | 572 | // add fields for pledge frequency |
be2fb01f | 573 | $form->add('text', 'pledge_frequency_interval', ts('Every'), ['size' => 8, 'maxlength' => 8]); |
5a0739f2 | 574 | $form->addRule('pledge_frequency_interval', ts('Please enter valid Pledge Frequency Interval'), 'integer'); |
6a488035 TO |
575 | $frequencies = CRM_Core_OptionGroup::values('recur_frequency_units'); |
576 | foreach ($frequencies as $val => $label) { | |
be2fb01f | 577 | $freqUnitsDisplay["'{$val}'"] = ts('%1(s)', [1 => $label]); |
6a488035 TO |
578 | } |
579 | ||
580 | $form->add('select', 'pledge_frequency_unit', | |
581 | ts('Pledge Frequency'), | |
be2fb01f | 582 | ['' => ts('- any -')] + $freqUnitsDisplay |
6a488035 TO |
583 | ); |
584 | ||
be2fb01f | 585 | self::addCustomFormFields($form, ['Pledge']); |
6a488035 TO |
586 | |
587 | CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'pledge_campaign_id'); | |
588 | ||
589 | $form->assign('validCiviPledge', TRUE); | |
be2fb01f | 590 | $form->setDefaults(['pledge_test' => 0]); |
6a488035 TO |
591 | } |
592 | ||
ffd93213 EM |
593 | /** |
594 | * @param $tables | |
595 | */ | |
00be9182 | 596 | public static function tableNames(&$tables) { |
cc28438b | 597 | // add status table |
8cc574cf | 598 | if (!empty($tables['pledge_status']) || !empty($tables['civicrm_pledge_payment'])) { |
be2fb01f | 599 | $tables = array_merge(['civicrm_pledge' => 1], $tables); |
6a488035 TO |
600 | } |
601 | } | |
96025800 | 602 | |
6a488035 | 603 | } |