Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
fa938177 | 31 | * @copyright CiviCRM LLC (c) 2004-2016 |
6a488035 TO |
32 | */ |
33 | class CRM_Pledge_BAO_Query { | |
ffd93213 | 34 | /** |
e9ff5391 | 35 | * Get pledge fields. |
36 | * | |
37 | * @param bool $checkPermission | |
38 | * | |
ffd93213 EM |
39 | * @return array |
40 | */ | |
0ed9f379 | 41 | public static function getFields($checkPermission = TRUE) { |
42 | return CRM_Pledge_BAO_Pledge::exportableFields($checkPermission); | |
6a488035 TO |
43 | } |
44 | ||
45 | /** | |
fe482240 | 46 | * Build select for Pledge. |
6a488035 | 47 | * |
0ed9f379 | 48 | * @param CRM_Contact_BAO_Query $query |
6a488035 | 49 | */ |
00be9182 | 50 | public static function select(&$query) { |
0ed9f379 | 51 | |
1d1fb1e8 | 52 | $statusId = implode(',', array_keys(CRM_Core_PseudoConstant::accountOptionValues("contribution_status", NULL, " AND v.name IN ('Pending', 'Overdue')"))); |
8cc574cf | 53 | if (($query->_mode & CRM_Contact_BAO_Query::MODE_PLEDGE) || !empty($query->_returnProperties['pledge_id'])) { |
6a488035 TO |
54 | $query->_select['pledge_id'] = 'civicrm_pledge.id as pledge_id'; |
55 | $query->_element['pledge_id'] = 1; | |
56 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
57 | } | |
58 | ||
cc28438b | 59 | // add pledge select |
a7488080 | 60 | if (!empty($query->_returnProperties['pledge_amount'])) { |
6a488035 TO |
61 | $query->_select['pledge_amount'] = 'civicrm_pledge.amount as pledge_amount'; |
62 | $query->_element['pledge_amount'] = 1; | |
63 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
64 | } | |
65 | ||
a7488080 | 66 | if (!empty($query->_returnProperties['pledge_create_date'])) { |
6a488035 TO |
67 | $query->_select['pledge_create_date'] = 'civicrm_pledge.create_date as pledge_create_date'; |
68 | $query->_element['pledge_create_date'] = 1; | |
69 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
70 | } | |
71 | ||
4e2c4036 CW |
72 | if (!empty($query->_returnProperties['pledge_start_date'])) { |
73 | $query->_select['pledge_start_date'] = 'civicrm_pledge.start_date as pledge_start_date'; | |
74 | $query->_element['pledge_start_date'] = 1; | |
75 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
76 | } | |
77 | ||
a7488080 | 78 | if (!empty($query->_returnProperties['pledge_status_id'])) { |
6a488035 TO |
79 | $query->_select['pledge_status_id'] = 'pledge_status.value as pledge_status_id'; |
80 | $query->_element['pledge_status'] = 1; | |
81 | $query->_tables['pledge_status'] = $query->_whereTables['pledge_status'] = 1; | |
82 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
83 | } | |
84 | ||
a7488080 | 85 | if (!empty($query->_returnProperties['pledge_status'])) { |
6a488035 TO |
86 | $query->_select['pledge_status'] = 'pledge_status.label as pledge_status'; |
87 | $query->_element['pledge_status'] = 1; | |
88 | $query->_tables['pledge_status'] = $query->_whereTables['pledge_status'] = 1; | |
89 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
90 | } | |
91 | ||
a7488080 | 92 | if (!empty($query->_returnProperties['pledge_total_paid'])) { |
6a488035 TO |
93 | $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'; |
94 | $query->_element['pledge_total_paid'] = 1; | |
95 | } | |
96 | ||
a7488080 | 97 | if (!empty($query->_returnProperties['pledge_next_pay_date'])) { |
1d1fb1e8 | 98 | $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 |
99 | $query->_element['pledge_next_pay_date'] = 1; |
100 | } | |
101 | ||
a7488080 | 102 | if (!empty($query->_returnProperties['pledge_next_pay_amount'])) { |
1d1fb1e8 | 103 | $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 |
104 | $query->_element['pledge_next_pay_amount'] = 1; |
105 | ||
106 | $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"; | |
107 | $query->_element['pledge_outstanding_amount'] = 1; | |
108 | } | |
109 | ||
a7488080 | 110 | if (!empty($query->_returnProperties['pledge_financial_type'])) { |
353ffa53 | 111 | $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 |
112 | $query->_element['pledge_financial_type'] = 1; |
113 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
114 | } | |
115 | ||
a7488080 | 116 | if (!empty($query->_returnProperties['pledge_contribution_page_id'])) { |
6a488035 TO |
117 | $query->_select['pledge_contribution_page_id'] = 'civicrm_pledge.contribution_page_id as pledge_contribution_page_id'; |
118 | $query->_element['pledge_contribution_page_id'] = 1; | |
119 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
120 | } | |
121 | ||
a7488080 | 122 | if (!empty($query->_returnProperties['pledge_payment_id'])) { |
6a488035 TO |
123 | $query->_select['pledge_payment_id'] = 'civicrm_pledge_payment.id as pledge_payment_id'; |
124 | $query->_element['pledge_payment_id'] = 1; | |
125 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
126 | } | |
127 | ||
a7488080 | 128 | if (!empty($query->_returnProperties['pledge_payment_scheduled_amount'])) { |
6a488035 TO |
129 | $query->_select['pledge_payment_scheduled_amount'] = 'civicrm_pledge_payment.scheduled_amount as pledge_payment_scheduled_amount'; |
130 | $query->_element['pledge_payment_scheduled_amount'] = 1; | |
131 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
132 | } | |
133 | ||
a7488080 | 134 | if (!empty($query->_returnProperties['pledge_payment_scheduled_date'])) { |
6a488035 TO |
135 | $query->_select['pledge_payment_scheduled_date'] = 'civicrm_pledge_payment.scheduled_date as pledge_payment_scheduled_date'; |
136 | $query->_element['pledge_payment_scheduled_date'] = 1; | |
137 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
138 | } | |
139 | ||
a7488080 | 140 | if (!empty($query->_returnProperties['pledge_payment_paid_amount'])) { |
6a488035 TO |
141 | $query->_select['pledge_payment_paid_amount'] = 'civicrm_pledge_payment.actual_amount as pledge_payment_paid_amount'; |
142 | $query->_element['pledge_payment_paid_amount'] = 1; | |
143 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
144 | } | |
145 | ||
a7488080 | 146 | if (!empty($query->_returnProperties['pledge_payment_paid_date'])) { |
6a488035 TO |
147 | $query->_select['pledge_payment_paid_date'] = 'payment_contribution.receive_date as pledge_payment_paid_date'; |
148 | $query->_element['pledge_payment_paid_date'] = 1; | |
149 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
150 | $query->_tables['payment_contribution'] = $query->_whereTables['payment_contribution'] = 1; | |
151 | } | |
152 | ||
a7488080 | 153 | if (!empty($query->_returnProperties['pledge_payment_reminder_date'])) { |
6a488035 TO |
154 | $query->_select['pledge_payment_reminder_date'] = 'civicrm_pledge_payment.reminder_date as pledge_payment_reminder_date'; |
155 | $query->_element['pledge_payment_reminder_date'] = 1; | |
156 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
157 | } | |
158 | ||
a7488080 | 159 | if (!empty($query->_returnProperties['pledge_payment_reminder_count'])) { |
6a488035 TO |
160 | $query->_select['pledge_payment_reminder_count'] = 'civicrm_pledge_payment.reminder_count as pledge_payment_reminder_count'; |
161 | $query->_element['pledge_payment_reminder_count'] = 1; | |
162 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
163 | } | |
164 | ||
a7488080 | 165 | if (!empty($query->_returnProperties['pledge_payment_status_id'])) { |
6a488035 TO |
166 | $query->_select['pledge_payment_status_id'] = 'payment_status.name as pledge_payment_status_id'; |
167 | $query->_element['pledge_payment_status_id'] = 1; | |
168 | $query->_tables['payment_status'] = $query->_whereTables['payment_status'] = 1; | |
169 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
170 | } | |
171 | ||
a7488080 | 172 | if (!empty($query->_returnProperties['pledge_payment_status'])) { |
6a488035 TO |
173 | $query->_select['pledge_payment_status'] = 'payment_status.label as pledge_payment_status'; |
174 | $query->_element['pledge_payment_status'] = 1; | |
175 | $query->_tables['payment_status'] = $query->_whereTables['payment_status'] = 1; | |
176 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
177 | } | |
178 | ||
a7488080 | 179 | if (!empty($query->_returnProperties['pledge_frequency_interval'])) { |
6a488035 TO |
180 | $query->_select['pledge_frequency_interval'] = 'civicrm_pledge.frequency_interval as pledge_frequency_interval'; |
181 | $query->_element['pledge_frequency_interval'] = 1; | |
182 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
183 | } | |
184 | ||
a7488080 | 185 | if (!empty($query->_returnProperties['pledge_frequency_unit'])) { |
6a488035 TO |
186 | $query->_select['pledge_frequency_unit'] = 'civicrm_pledge.frequency_unit as pledge_frequency_unit'; |
187 | $query->_element['pledge_frequency_unit'] = 1; | |
188 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
189 | } | |
190 | ||
a7488080 | 191 | if (!empty($query->_returnProperties['pledge_is_test'])) { |
6a488035 TO |
192 | $query->_select['pledge_is_test'] = 'civicrm_pledge.is_test as pledge_is_test'; |
193 | $query->_element['pledge_is_test'] = 1; | |
194 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
195 | } | |
a7488080 | 196 | if (!empty($query->_returnProperties['pledge_campaign_id'])) { |
6a488035 TO |
197 | $query->_select['pledge_campaign_id'] = 'civicrm_pledge.campaign_id as pledge_campaign_id'; |
198 | $query->_element['pledge_campaign_id'] = 1; | |
199 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
200 | } | |
201 | ||
a7488080 | 202 | if (!empty($query->_returnProperties['pledge_currency'])) { |
6a488035 TO |
203 | $query->_select['pledge_currency'] = 'civicrm_pledge.currency as pledge_currency'; |
204 | $query->_element['pledge_currency'] = 1; | |
205 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
206 | } | |
207 | } | |
208 | ||
ffd93213 EM |
209 | /** |
210 | * @param $query | |
211 | */ | |
00be9182 | 212 | public static function where(&$query) { |
28c666be | 213 | $grouping = NULL; |
6a488035 | 214 | foreach (array_keys($query->_params) as $id) { |
a7488080 | 215 | if (empty($query->_params[$id][0])) { |
6a488035 TO |
216 | continue; |
217 | } | |
218 | if (substr($query->_params[$id][0], 0, 7) == 'pledge_') { | |
219 | if ($query->_mode == CRM_Contact_BAO_QUERY::MODE_CONTACTS) { | |
220 | $query->_useDistinct = TRUE; | |
221 | } | |
6a488035 TO |
222 | $grouping = $query->_params[$id][3]; |
223 | self::whereClauseSingle($query->_params[$id], $query); | |
224 | } | |
225 | } | |
6a488035 TO |
226 | } |
227 | ||
ffd93213 EM |
228 | /** |
229 | * @param $values | |
230 | * @param $query | |
231 | */ | |
00be9182 | 232 | public static function whereClauseSingle(&$values, &$query) { |
6a488035 TO |
233 | list($name, $op, $value, $grouping, $wildcard) = $values; |
234 | ||
235 | switch ($name) { | |
236 | case 'pledge_create_date_low': | |
237 | case 'pledge_create_date_high': | |
238 | // process to / from date | |
239 | $query->dateQueryBuilder($values, | |
240 | 'civicrm_pledge', 'pledge_create_date', 'create_date', 'Pledge Made' | |
241 | ); | |
242 | case 'pledge_start_date_low': | |
243 | case 'pledge_start_date_high': | |
244 | // process to / from date | |
245 | $query->dateQueryBuilder($values, | |
246 | 'civicrm_pledge', 'pledge_start_date', 'start_date', 'Pledge Start Date' | |
247 | ); | |
248 | return; | |
249 | ||
250 | case 'pledge_end_date_low': | |
251 | case 'pledge_end_date_high': | |
252 | // process to / from date | |
253 | $query->dateQueryBuilder($values, | |
254 | 'civicrm_pledge', 'pledge_end_date', 'end_date', 'Pledge End Date' | |
255 | ); | |
256 | return; | |
257 | ||
258 | case 'pledge_payment_date_low': | |
259 | case 'pledge_payment_date_high': | |
260 | // process to / from date | |
261 | $query->dateQueryBuilder($values, | |
262 | 'civicrm_pledge_payment', 'pledge_payment_date', 'scheduled_date', 'Payment Scheduled' | |
263 | ); | |
264 | return; | |
265 | ||
266 | case 'pledge_amount': | |
267 | case 'pledge_amount_low': | |
268 | case 'pledge_amount_high': | |
269 | // process min/max amount | |
270 | $query->numberRangeBuilder($values, | |
271 | 'civicrm_pledge', 'pledge_amount', 'amount', 'Pledge Amount' | |
272 | ); | |
273 | return; | |
274 | ||
0ed9f379 | 275 | case 'pledge_installments_low': |
276 | case 'pledge_installments_high': | |
277 | // process min/max amount | |
278 | $query->numberRangeBuilder($values, | |
279 | 'civicrm_pledge', 'pledge_installments', 'installments', 'Number of Installments' | |
280 | ); | |
281 | return; | |
282 | ||
283 | case 'pledge_acknowledge_date_is_not_null': | |
284 | if ($value) { | |
285 | $op = "IS NOT NULL"; | |
286 | $query->_qill[$grouping][] = ts('Pledge Acknowledgement Sent'); | |
287 | } | |
288 | else { | |
289 | $op = "IS NULL"; | |
290 | $query->_qill[$grouping][] = ts('Pledge Acknowledgement Not Sent'); | |
291 | } | |
292 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_pledge.acknowledge_date", $op); | |
293 | return; | |
294 | ||
6a488035 | 295 | case 'pledge_payment_status_id': |
2b65bb8c | 296 | case 'pledge_status_id': |
297 | if ($name == 'pledge_status_id') { | |
298 | $tableName = 'civicrm_pledge'; | |
299 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
300 | $label = "Pledge Status"; | |
6a488035 TO |
301 | } |
302 | else { | |
2b65bb8c | 303 | $tableName = 'civicrm_pledge_payment'; |
304 | $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1; | |
305 | $label = "Pledge Payment Status"; | |
6a488035 | 306 | } |
2b65bb8c | 307 | $name = 'status_id'; |
308 | if (!empty($value) && is_array($value) && !in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) { | |
309 | $value = array('IN' => $value); | |
6a488035 TO |
310 | } |
311 | ||
2b65bb8c | 312 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("$tableName.$name", |
6a488035 | 313 | $op, |
2b65bb8c | 314 | $value, |
6a488035 TO |
315 | 'Integer' |
316 | ); | |
2b65bb8c | 317 | list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', 'contribution_status_id', $value, $op); |
318 | $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $label, 2 => $qillop, 3 => $qillVal)); | |
6a488035 TO |
319 | return; |
320 | ||
321 | case 'pledge_test': | |
322 | case 'pledge_is_test': | |
28c666be CW |
323 | // We dont want to include all tests for sql OR CRM-7827 |
324 | if (!$value || $query->getOperator() != 'OR') { | |
325 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_pledge.is_test', | |
326 | $op, | |
327 | $value, | |
328 | 'Boolean' | |
329 | ); | |
330 | if ($value) { | |
331 | $query->_qill[$grouping][] = ts('Pledge is a Test'); | |
332 | } | |
333 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
6a488035 | 334 | } |
6a488035 TO |
335 | return; |
336 | ||
337 | case 'pledge_financial_type_id': | |
338 | $type = CRM_Contribute_PseudoConstant::financialType($value); | |
339 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_pledge.financial_type_id', | |
340 | $op, | |
341 | $value, | |
342 | 'Integer' | |
343 | ); | |
481a74f4 | 344 | $query->_qill[$grouping][] = ts('Financial Type - %1', array(1 => $type)); |
6a488035 TO |
345 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; |
346 | return; | |
347 | ||
348 | case 'pledge_contribution_page_id': | |
349 | $page = CRM_Contribute_PseudoConstant::contributionPage($value); | |
350 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_pledge.contribution_page_id', | |
351 | $op, | |
352 | $value, | |
353 | 'Integer' | |
354 | ); | |
355 | $query->_qill[$grouping][] = ts('Financial Page - %1', array(1 => $page)); | |
356 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
357 | return; | |
358 | ||
6a488035 | 359 | case 'pledge_id': |
59de5a50 EM |
360 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_pledge.id", |
361 | $op, | |
362 | $value, | |
363 | "Integer" | |
364 | ); | |
6a488035 TO |
365 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; |
366 | return; | |
367 | ||
368 | case 'pledge_frequency_interval': | |
369 | $query->_where[$grouping][] = "civicrm_pledge.frequency_interval $op $value"; | |
370 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
371 | return; | |
372 | ||
373 | case 'pledge_frequency_unit': | |
374 | $query->_where[$grouping][] = "civicrm_pledge.frequency_unit $op $value"; | |
375 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; | |
376 | return; | |
377 | ||
d4e614ad | 378 | case 'pledge_contact_id': |
6f56dc34 | 379 | case 'pledge_campaign_id': |
d4e614ad SB |
380 | $name = str_replace('pledge_', '', $name); |
381 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_pledge.$name", $op, $value, 'Integer'); | |
382 | list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Pledge_DAO_Pledge', $name, $value, $op); | |
6f56dc34 | 383 | $label = ($name == 'campaign_id') ? 'Campaign' : 'Contact ID'; |
384 | $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $label, 2 => $op, 3 => $value)); | |
d4e614ad SB |
385 | $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1; |
386 | return; | |
6a488035 TO |
387 | } |
388 | } | |
389 | ||
ffd93213 | 390 | /** |
ad37ac8e | 391 | * From clause. |
392 | * | |
100fef9d | 393 | * @param string $name |
ad37ac8e | 394 | * @param string $mode |
395 | * @param string $side | |
ffd93213 EM |
396 | * |
397 | * @return null|string | |
398 | */ | |
00be9182 | 399 | public static function from($name, $mode, $side) { |
6a488035 TO |
400 | $from = NULL; |
401 | ||
402 | switch ($name) { | |
403 | case 'civicrm_pledge': | |
404 | $from = " $side JOIN civicrm_pledge ON civicrm_pledge.contact_id = contact_a.id "; | |
405 | break; | |
406 | ||
407 | case 'pledge_status': | |
408 | $from .= " $side JOIN civicrm_option_group option_group_pledge_status ON (option_group_pledge_status.name = 'contribution_status')"; | |
409 | $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 ) "; | |
410 | break; | |
411 | ||
412 | case 'pledge_financial_type': | |
098201d8 | 413 | $from .= " $side JOIN civicrm_financial_type ON civicrm_pledge.financial_type_id = civicrm_financial_type.id "; |
6a488035 TO |
414 | break; |
415 | ||
6a488035 TO |
416 | case 'civicrm_pledge_payment': |
417 | $from .= " $side JOIN civicrm_pledge_payment ON civicrm_pledge_payment.pledge_id = civicrm_pledge.id "; | |
418 | break; | |
419 | ||
420 | case 'payment_contribution': | |
421 | $from .= " $side JOIN civicrm_contribution payment_contribution ON civicrm_pledge_payment.contribution_id = payment_contribution.id "; | |
422 | break; | |
423 | ||
424 | case 'payment_status': | |
425 | $from .= " $side JOIN civicrm_option_group option_group_payment_status ON (option_group_payment_status.name = 'contribution_status')"; | |
426 | $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 ) "; | |
427 | break; | |
428 | } | |
429 | ||
430 | return $from; | |
431 | } | |
432 | ||
433 | /** | |
fe482240 | 434 | * Getter for the qill object. |
6a488035 TO |
435 | * |
436 | * @return string | |
6a488035 | 437 | */ |
00be9182 | 438 | public function qill() { |
6a488035 TO |
439 | return (isset($this->_qill)) ? $this->_qill : ""; |
440 | } | |
441 | ||
442 | /** | |
fe482240 | 443 | * Ideally this function should include fields that are displayed in the selector. |
ad37ac8e | 444 | * |
445 | * @param int $mode | |
446 | * @param bool $includeCustomFields | |
447 | * | |
448 | * @return array|null | |
6a488035 | 449 | */ |
3bdca100 | 450 | public static function defaultReturnProperties( |
3295515a | 451 | $mode, |
6a488035 TO |
452 | $includeCustomFields = TRUE |
453 | ) { | |
454 | $properties = NULL; | |
455 | ||
456 | if ($mode & CRM_Contact_BAO_Query::MODE_PLEDGE) { | |
457 | $properties = array( | |
458 | 'contact_type' => 1, | |
459 | 'contact_sub_type' => 1, | |
460 | 'sort_name' => 1, | |
461 | 'display_name' => 1, | |
462 | 'pledge_id' => 1, | |
463 | 'pledge_amount' => 1, | |
464 | 'pledge_total_paid' => 1, | |
465 | 'pledge_create_date' => 1, | |
4e2c4036 | 466 | 'pledge_start_date' => 1, |
6a488035 TO |
467 | 'pledge_next_pay_date' => 1, |
468 | 'pledge_next_pay_amount' => 1, | |
469 | 'pledge_status' => 1, | |
470 | 'pledge_status_id' => 1, | |
471 | 'pledge_is_test' => 1, | |
472 | 'pledge_contribution_page_id' => 1, | |
473 | 'pledge_financial_type' => 1, | |
474 | 'pledge_frequency_interval' => 1, | |
475 | 'pledge_frequency_unit' => 1, | |
476 | 'pledge_currency' => 1, | |
477 | 'pledge_campaign_id' => 1, | |
478 | ); | |
479 | } | |
480 | return $properties; | |
481 | } | |
482 | ||
483 | /** | |
fe482240 | 484 | * This includes any extra fields that might need for export etc. |
ea3ddccf | 485 | * |
486 | * @param string $mode | |
487 | * | |
488 | * @return array|null | |
6a488035 | 489 | */ |
00be9182 | 490 | public static function extraReturnProperties($mode) { |
6a488035 TO |
491 | $properties = NULL; |
492 | ||
493 | if ($mode & CRM_Contact_BAO_Query::MODE_PLEDGE) { | |
494 | $properties = array( | |
495 | 'pledge_balance_amount' => 1, | |
496 | 'pledge_payment_id' => 1, | |
497 | 'pledge_payment_scheduled_amount' => 1, | |
498 | 'pledge_payment_scheduled_date' => 1, | |
499 | 'pledge_payment_paid_amount' => 1, | |
500 | 'pledge_payment_paid_date' => 1, | |
501 | 'pledge_payment_reminder_date' => 1, | |
502 | 'pledge_payment_reminder_count' => 1, | |
503 | 'pledge_payment_status_id' => 1, | |
504 | 'pledge_payment_status' => 1, | |
505 | ); | |
506 | ||
507 | // also get all the custom pledge properties | |
508 | $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Pledge'); | |
509 | if (!empty($fields)) { | |
510 | foreach ($fields as $name => $dontCare) { | |
511 | $properties[$name] = 1; | |
512 | } | |
513 | } | |
514 | } | |
515 | return $properties; | |
516 | } | |
517 | ||
ffd93213 | 518 | /** |
c490a46a | 519 | * @param CRM_Core_Form $form |
ffd93213 | 520 | */ |
00be9182 | 521 | public static function buildSearchForm(&$form) { |
6a488035 | 522 | // pledge related dates |
bc3f7f04 | 523 | CRM_Core_Form_Date::buildDateRange($form, 'pledge_start_date', 1, '_low', '_high', ts('From'), FALSE); |
524 | CRM_Core_Form_Date::buildDateRange($form, 'pledge_end_date', 1, '_low', '_high', ts('From'), FALSE); | |
525 | CRM_Core_Form_Date::buildDateRange($form, 'pledge_create_date', 1, '_low', '_high', ts('From'), FALSE); | |
6a488035 TO |
526 | |
527 | // pledge payment related dates | |
bc3f7f04 | 528 | CRM_Core_Form_Date::buildDateRange($form, 'pledge_payment_date', 1, '_low', '_high', ts('From'), FALSE); |
6a488035 | 529 | |
8a4f27dc | 530 | $form->addYesNo('pledge_test', ts('Pledge is a Test?'), TRUE); |
6a488035 TO |
531 | $form->add('text', 'pledge_amount_low', ts('From'), array('size' => 8, 'maxlength' => 8)); |
532 | $form->addRule('pledge_amount_low', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money::format('9.99', ' '))), 'money'); | |
533 | ||
534 | $form->add('text', 'pledge_amount_high', ts('To'), array('size' => 8, 'maxlength' => 8)); | |
535 | $form->addRule('pledge_amount_high', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money::format('99.99', ' '))), 'money'); | |
536 | ||
537 | $statusValues = CRM_Contribute_PseudoConstant::contributionStatus(); | |
6a488035 TO |
538 | // Remove status values that are only used for recurring contributions for now (Failed and In Progress). |
539 | unset($statusValues['4']); | |
0ed9f379 | 540 | // unset in progress for payment |
541 | unset($statusValues['5']); | |
2b65bb8c | 542 | $form->add('select', 'pledge_status_id', |
543 | ts('Pledge Status'), $statusValues, | |
544 | FALSE, array('class' => 'crm-select2', 'multiple' => 'multiple') | |
545 | ); | |
6a488035 | 546 | |
0ed9f379 | 547 | $form->addYesNo('pledge_acknowledge_date_is_not_null', ts('Acknowledgement sent?'), TRUE); |
548 | ||
549 | $form->add('text', 'pledge_installments_low', ts('From'), array('size' => 8, 'maxlength' => 8)); | |
550 | $form->addRule('pledge_installments_low', ts('Please enter a number'), 'integer'); | |
551 | ||
552 | $form->add('text', 'pledge_installments_high', ts('To'), array('size' => 8, 'maxlength' => 8)); | |
553 | $form->addRule('pledge_installments_high', ts('Please enter number.'), 'integer'); | |
6a488035 | 554 | |
2b65bb8c | 555 | $form->add('select', 'pledge_payment_status_id', |
556 | ts('Pledge Payment Status'), $statusValues, | |
557 | FALSE, array('class' => 'crm-select2', 'multiple' => 'multiple') | |
558 | ); | |
6a488035 TO |
559 | |
560 | $form->add('select', 'pledge_financial_type_id', | |
481a74f4 | 561 | ts('Financial Type'), |
ab345ca5 CW |
562 | array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::financialType(), |
563 | FALSE, array('class' => 'crm-select2') | |
6a488035 TO |
564 | ); |
565 | ||
566 | $form->add('select', 'pledge_contribution_page_id', | |
567 | ts('Contribution Page'), | |
ab345ca5 CW |
568 | array('' => ts('- any -')) + CRM_Contribute_PseudoConstant::contributionPage(), |
569 | FALSE, array('class' => 'crm-select2') | |
6a488035 TO |
570 | ); |
571 | ||
cc28438b | 572 | // add fields for pledge frequency |
6a488035 | 573 | $form->add('text', 'pledge_frequency_interval', ts('Every'), array('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) { | |
577 | $freqUnitsDisplay["'{$val}'"] = ts('%1(s)', array(1 => $label)); | |
578 | } | |
579 | ||
580 | $form->add('select', 'pledge_frequency_unit', | |
581 | ts('Pledge Frequency'), | |
ab345ca5 | 582 | array('' => ts('- any -')) + $freqUnitsDisplay |
6a488035 TO |
583 | ); |
584 | ||
585 | // add all the custom searchable fields | |
586 | $pledge = array('Pledge'); | |
587 | $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $pledge); | |
588 | if ($groupDetails) { | |
589 | $form->assign('pledgeGroupTree', $groupDetails); | |
590 | foreach ($groupDetails as $group) { | |
591 | foreach ($group['fields'] as $field) { | |
592 | $fieldId = $field['id']; | |
593 | $elementName = 'custom_' . $fieldId; | |
3a7773be | 594 | CRM_Core_BAO_CustomField::addQuickFormElement($form, $elementName, $fieldId, FALSE, TRUE); |
6a488035 TO |
595 | } |
596 | } | |
597 | } | |
598 | ||
599 | CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'pledge_campaign_id'); | |
600 | ||
601 | $form->assign('validCiviPledge', TRUE); | |
602 | $form->setDefaults(array('pledge_test' => 0)); | |
603 | } | |
604 | ||
ffd93213 EM |
605 | /** |
606 | * @param $row | |
100fef9d | 607 | * @param int $id |
ffd93213 | 608 | */ |
098201d8 TO |
609 | public static function searchAction(&$row, $id) { |
610 | } | |
6a488035 | 611 | |
ffd93213 EM |
612 | /** |
613 | * @param $tables | |
614 | */ | |
00be9182 | 615 | public static function tableNames(&$tables) { |
cc28438b | 616 | // add status table |
8cc574cf | 617 | if (!empty($tables['pledge_status']) || !empty($tables['civicrm_pledge_payment'])) { |
6a488035 TO |
618 | $tables = array_merge(array('civicrm_pledge' => 1), $tables); |
619 | } | |
620 | } | |
96025800 | 621 | |
6a488035 | 622 | } |