Commit | Line | Data |
---|---|---|
c1413e28 DG |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
c1413e28 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
c1413e28 DG |
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 | */ |
c1413e28 DG |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
c1413e28 DG |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | class CRM_Report_Form_Contribute_Recur extends CRM_Report_Form { | |
36 | ||
1728e9a0 | 37 | /** |
38 | * This report has not been optimised for group filtering. | |
39 | * | |
40 | * The functionality for group filtering has been improved but not | |
41 | * all reports have been adjusted to take care of it. This report has not | |
42 | * and will run an inefficient query until fixed. | |
43 | * | |
44 | * CRM-19170 | |
45 | * | |
46 | * @var bool | |
47 | */ | |
48 | protected $groupFilterNotOptimised = TRUE; | |
49 | ||
ced9bfed EM |
50 | /** |
51 | * Class constructor. | |
52 | */ | |
00be9182 | 53 | public function __construct() { |
c1413e28 DG |
54 | $this->_columns = array( |
55 | 'civicrm_contact' => array( | |
56 | 'dao' => 'CRM_Contact_DAO_Contact', | |
57 | 'order_bys' => array( | |
58 | 'sort_name' => array( | |
59 | 'title' => ts("Last name, First name"), | |
60 | ), | |
61 | ), | |
62 | 'fields' => array( | |
63 | 'sort_name' => array( | |
64 | 'title' => ts('Contact Name'), | |
65 | 'no_repeat' => TRUE, | |
66 | 'default' => TRUE, | |
67 | ), | |
68 | 'id' => array( | |
69 | 'no_display' => TRUE, | |
70 | 'required' => TRUE, | |
71 | ), | |
72 | ), | |
73 | ), | |
74 | 'civicrm_email' => array( | |
75 | 'dao' => 'CRM_Core_DAO_Email', | |
76 | 'fields' => array( | |
77 | 'email' => array( | |
78 | 'title' => ts('Email'), | |
79 | 'no_repeat' => TRUE, | |
80 | ), | |
81 | ), | |
82 | 'grouping' => 'contact-fields', | |
83 | ), | |
84 | 'civicrm_phone' => array( | |
85 | 'dao' => 'CRM_Core_DAO_Phone', | |
86 | 'fields' => array( | |
87 | 'phone' => array( | |
88 | 'title' => ts('Phone'), | |
89 | 'no_repeat' => TRUE, | |
90 | ), | |
91 | ), | |
92 | 'grouping' => 'contact-fields', | |
93 | ), | |
94 | 'civicrm_contribution' => array( | |
95 | 'dao' => 'CRM_Contribute_DAO_Contribution', | |
96 | 'fields' => array( | |
97 | 'id' => array( | |
98 | 'no_display' => TRUE, | |
99 | 'required' => TRUE, | |
100 | ), | |
101 | 'total_amount' => array( | |
102 | 'title' => ts('Amount Contributed to Date'), | |
103 | 'statistics' => array( | |
21dfd5f5 | 104 | 'sum' => ts("Total Amount Contributed"), |
c1413e28 DG |
105 | ), |
106 | ), | |
107 | ), | |
108 | ), | |
96b82f45 E |
109 | 'civicrm_financial_trxn' => array( |
110 | 'dao' => 'CRM_Financial_DAO_FinancialTrxn', | |
111 | 'fields' => array( | |
5e0343e8 | 112 | 'card_type_id' => array( |
d72b084a | 113 | 'title' => ts('Credit Card Type'), |
5e0343e8 | 114 | 'dbAlias' => 'GROUP_CONCAT(financial_trxn_civireport.card_type_id SEPARATOR ",")', |
96b82f45 E |
115 | ), |
116 | ), | |
117 | 'filters' => array( | |
5e0343e8 | 118 | 'card_type_id' => array( |
d72b084a | 119 | 'title' => ts('Credit Card Type'), |
96b82f45 | 120 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
5e0343e8 | 121 | 'options' => CRM_Financial_DAO_FinancialTrxn::buildOptions('card_type_id'), |
96b82f45 E |
122 | 'default' => NULL, |
123 | 'type' => CRM_Utils_Type::T_STRING, | |
124 | ), | |
125 | ), | |
126 | ), | |
c1413e28 DG |
127 | 'civicrm_contribution_recur' => array( |
128 | 'dao' => 'CRM_Contribute_DAO_ContributionRecur', | |
129 | 'fields' => array( | |
130 | 'id' => array( | |
131 | 'no_display' => TRUE, | |
132 | 'required' => TRUE, | |
133 | ), | |
134 | 'currency' => array( | |
135 | 'title' => ts("Currency"), | |
136 | 'required' => TRUE, | |
137 | 'no_display' => TRUE, | |
138 | ), | |
c1413e28 | 139 | 'contribution_status_id' => array( |
be205937 | 140 | 'title' => ts('Contribution Status'), |
c1413e28 DG |
141 | ), |
142 | 'frequency_interval' => array( | |
143 | 'title' => ts('Frequency interval'), | |
144 | 'default' => TRUE, | |
145 | ), | |
146 | 'frequency_unit' => array( | |
147 | 'title' => ts('Frequency unit'), | |
148 | 'default' => TRUE, | |
149 | ), | |
2006e4c4 | 150 | 'amount' => array( |
979f1561 | 151 | 'title' => ts('Installment Amount'), |
2006e4c4 | 152 | 'default' => TRUE, |
979f1561 | 153 | ), |
c1413e28 DG |
154 | 'installments' => array( |
155 | 'title' => ts('Installments'), | |
156 | 'default' => TRUE, | |
157 | ), | |
158 | 'start_date' => array( | |
159 | 'title' => ts('Start Date'), | |
160 | ), | |
161 | 'create_date' => array( | |
162 | 'title' => ts('Create Date'), | |
163 | ), | |
164 | 'modified_date' => array( | |
165 | 'title' => ts('Modified Date'), | |
166 | ), | |
167 | 'cancel_date' => array( | |
168 | 'title' => ts('Cancel Date'), | |
169 | ), | |
170 | 'end_date' => array( | |
171 | 'title' => ts('End Date'), | |
172 | ), | |
173 | 'next_sched_contribution_date' => array( | |
174 | 'title' => ts('Next Scheduled Contribution Date'), | |
175 | ), | |
176 | 'failure_count' => array( | |
177 | 'title' => ts('Failure Count'), | |
178 | ), | |
179 | 'failure_retry_date' => array( | |
180 | 'title' => ts('Failure Retry Date'), | |
181 | ), | |
182 | ), | |
183 | 'filters' => array( | |
184 | 'contribution_status_id' => array( | |
be205937 | 185 | 'title' => ts('Contribution Status'), |
c1413e28 DG |
186 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
187 | 'options' => CRM_Contribute_PseudoConstant::contributionStatus(), | |
188 | 'default' => array(5), | |
189 | 'type' => CRM_Utils_Type::T_INT, | |
190 | ), | |
191 | 'currency' => array( | |
fd6a6828 | 192 | 'title' => ts('Currency'), |
c1413e28 DG |
193 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
194 | 'options' => CRM_Core_OptionGroup::values('currencies_enabled'), | |
195 | 'default' => NULL, | |
196 | 'type' => CRM_Utils_Type::T_STRING, | |
197 | ), | |
198 | 'financial_type_id' => array( | |
199 | 'title' => ts('Financial Type'), | |
200 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
b9af0d35 | 201 | 'options' => CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes(), |
c1413e28 DG |
202 | 'type' => CRM_Utils_Type::T_INT, |
203 | ), | |
204 | 'frequency_unit' => array( | |
205 | 'title' => ts('Frequency Unit'), | |
206 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
84178120 | 207 | 'options' => CRM_Core_OptionGroup::values('recur_frequency_units'), |
d3f09acb | 208 | 'type' => CRM_Utils_Type::T_STRING, |
c1413e28 DG |
209 | ), |
210 | 'frequency_interval' => array( | |
211 | 'title' => ts('Frequency Interval'), | |
212 | 'type' => CRM_Utils_Type::T_INT, | |
213 | ), | |
2006e4c4 | 214 | 'amount' => array( |
215 | 'title' => ts('Installment Amount'), | |
216 | 'type' => CRM_Utils_Type::T_MONEY, | |
217 | ), | |
c1413e28 DG |
218 | 'installments' => array( |
219 | 'title' => ts('Installments'), | |
220 | 'type' => CRM_Utils_Type::T_INT, | |
221 | ), | |
222 | 'start_date' => array( | |
223 | 'title' => ts('Start Date'), | |
224 | 'operatorType' => CRM_Report_Form::OP_DATE, | |
8fea776b | 225 | 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, |
c1413e28 DG |
226 | ), |
227 | 'next_sched_contribution_date' => array( | |
228 | 'title' => ts('Next Scheduled Contribution Date'), | |
229 | 'operatorType' => CRM_Report_Form::OP_DATE, | |
8fea776b | 230 | 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, |
c1413e28 DG |
231 | ), |
232 | 'end_date' => array( | |
233 | 'title' => ts('End Date'), | |
234 | 'operatorType' => CRM_Report_Form::OP_DATE, | |
8fea776b | 235 | 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, |
c1413e28 | 236 | ), |
8fea776b | 237 | 'modified_date' => array( |
979f1561 | 238 | 'title' => ts('Last Contribution Processed'), |
239 | 'operatorType' => CRM_Report_Form::OP_DATE, | |
8fea776b | 240 | 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, |
979f1561 | 241 | ), |
c1413e28 DG |
242 | 'calculated_end_date' => array( |
243 | 'title' => ts('Calculated end date (either end date or date all installments will be made)'), | |
244 | 'description' => "does this work?", | |
245 | 'operatorType' => CRM_Report_Form::OP_DATE, | |
21dfd5f5 | 246 | 'pseudofield' => TRUE, |
c1413e28 DG |
247 | ), |
248 | ), | |
21dfd5f5 | 249 | ), |
c1413e28 DG |
250 | ); |
251 | $this->_currencyColumn = 'civicrm_contribution_recur_currency'; | |
979f1561 | 252 | $this->_groupFilter = TRUE; |
c1413e28 DG |
253 | parent::__construct(); |
254 | } | |
353ffa53 | 255 | |
ced9bfed EM |
256 | /** |
257 | * Get template file name. | |
258 | * | |
259 | * @return string | |
260 | */ | |
00be9182 | 261 | public function getTemplateName() { |
84178120 | 262 | return 'CRM/Report/Form.tpl'; |
c1413e28 DG |
263 | } |
264 | ||
ced9bfed EM |
265 | /** |
266 | * Generate FROM SQL clause. | |
267 | */ | |
00be9182 | 268 | public function from() { |
c1413e28 DG |
269 | $this->_from = " |
270 | FROM civicrm_contact {$this->_aliases['civicrm_contact']} | |
271 | INNER JOIN civicrm_contribution_recur {$this->_aliases['civicrm_contribution_recur']} | |
272 | ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_contribution_recur']}.contact_id"; | |
273 | $this->_from .= " | |
274 | LEFT JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']} | |
275 | ON {$this->_aliases['civicrm_contribution_recur']}.id = {$this->_aliases['civicrm_contribution']}.contribution_recur_id"; | |
3b2bbbfb | 276 | |
277 | $this->joinPhoneFromContact(); | |
278 | $this->joinEmailFromContact(); | |
96b82f45 E |
279 | |
280 | // for credit card type | |
987c1844 | 281 | $this->addFinancialTrxnFromClause(); |
c1413e28 DG |
282 | } |
283 | ||
00be9182 | 284 | public function groupBy() { |
b708c08d | 285 | $this->_groupBy = CRM_Contact_BAO_Query::getGroupByFromSelectColumns($this->_selectClauses, "{$this->_aliases['civicrm_contribution_recur']}.id"); |
c1413e28 DG |
286 | } |
287 | ||
00be9182 | 288 | public function where() { |
c1413e28 DG |
289 | parent::where(); |
290 | // Handle calculated end date. This can come from one of two sources: | |
291 | // Either there is a specified end date for the end_date field | |
292 | // Or, we calculate the end date based on the start date + | |
293 | // installments * intervals using the mysql date_add function, along | |
294 | // with the interval unit (e.g. DATE_ADD(start_date, INTERVAL 12 * 1 MONTH) | |
295 | $date_suffixes = array('relative', 'from', 'to'); | |
e34af001 | 296 | foreach ($date_suffixes as $suffix) { |
979f1561 | 297 | $isBreak = FALSE; |
c1413e28 | 298 | // Check to see if the user wants to search by calculated date. |
22e263ad | 299 | if (!empty($this->_params['calculated_end_date_' . $suffix])) { |
c1413e28 DG |
300 | // The calculated date field is in use - spring into action |
301 | // Gather values | |
302 | $relative = CRM_Utils_Array::value("calculated_end_date_relative", $this->_params); | |
303 | $from = CRM_Utils_Array::value("calculated_end_date_from", $this->_params); | |
304 | $to = CRM_Utils_Array::value("calculated_end_date_to", $this->_params); | |
305 | $end_date_db_alias = $this->_columns['civicrm_contribution_recur']['filters']['end_date']['dbAlias']; | |
306 | $end_date_type = $this->_columns['civicrm_contribution_recur']['filters']['end_date']['type']; | |
307 | $start_date_type = $this->_columns['civicrm_contribution_recur']['filters']['start_date']['type']; | |
308 | $frequency_unit_db_alias = $this->_columns['civicrm_contribution_recur']['filters']['frequency_unit']['dbAlias']; | |
309 | $frequency_interval_db_alias = $this->_columns['civicrm_contribution_recur']['filters']['frequency_interval']['dbAlias']; | |
310 | $installments_db_alias = $this->_columns['civicrm_contribution_recur']['filters']['installments']['dbAlias']; | |
311 | $start_date_db_alias = $this->_columns['civicrm_contribution_recur']['filters']['start_date']['dbAlias']; | |
312 | ||
313 | // The end date clause is simple to construct | |
353ffa53 | 314 | $end_date_clause = $this->dateClause($end_date_db_alias, $relative, $from, $to, $end_date_type, NULL, NULL); |
c1413e28 DG |
315 | |
316 | // NOTE: For the calculation based on installment, there doesn't | |
317 | // seem to be a way to include the interval unit (e.g. month, | |
318 | // date, etc) as a field name - so we have to build a complex | |
319 | // OR statement instead. | |
320 | ||
979f1561 | 321 | $this->_where .= 'AND (' . |
c1413e28 | 322 | $this->dateClause("DATE_ADD($start_date_db_alias, INTERVAL $installments_db_alias * COALESCE($frequency_interval_db_alias,1) month)", |
353ffa53 | 323 | $relative, $from, $to, $start_date_type, NULL, NULL); |
979f1561 | 324 | $this->_where .= " AND $frequency_unit_db_alias = 'month' ) OR \n"; |
c1413e28 | 325 | |
979f1561 | 326 | $this->_where .= '(' . |
c1413e28 | 327 | $this->dateClause("DATE_ADD($start_date_db_alias, INTERVAL $installments_db_alias * COALESCE($frequency_interval_db_alias,1) day)", |
353ffa53 | 328 | $relative, $from, $to, $start_date_type, NULL, NULL); |
979f1561 | 329 | $this->_where .= " AND $frequency_unit_db_alias = 'day' ) OR \n"; |
c1413e28 | 330 | |
979f1561 | 331 | $this->_where .= '(' . |
c1413e28 | 332 | $this->dateClause("DATE_ADD($start_date_db_alias, INTERVAL $installments_db_alias * COALESCE($frequency_interval_db_alias, 1) week)", |
353ffa53 | 333 | $relative, $from, $to, $start_date_type, NULL, NULL); |
cc3360ca | 334 | $this->_where .= " AND $frequency_unit_db_alias = 'week' ) OR \n"; |
c1413e28 | 335 | |
979f1561 | 336 | $this->_where .= '(' . |
c1413e28 | 337 | $this->dateClause("DATE_ADD($start_date_db_alias, INTERVAL $installments_db_alias * COALESCE($frequency_interval_db_alias, 1) year)", |
353ffa53 | 338 | $relative, $from, $to, $start_date_type, NULL, NULL); |
979f1561 | 339 | $this->_where .= " AND $frequency_unit_db_alias = 'year' ) |
340 | AND (($end_date_db_alias IS NOT NULL AND $end_date_clause) | |
341 | OR ($installments_db_alias IS NOT NULL)) | |
342 | "; | |
343 | $isBreak = TRUE; | |
344 | } | |
8fea776b | 345 | if (!empty($this->_params['modified_date_' . $suffix])) { |
346 | $this->_where .= " AND {$this->_aliases['civicrm_contribution_recur']}.contribution_status_id = 1"; | |
979f1561 | 347 | $isBreak = TRUE; |
348 | } | |
349 | if (!empty($isBreak)) { | |
c1413e28 DG |
350 | break; |
351 | } | |
352 | } | |
353 | } | |
354 | ||
355 | ||
ced9bfed EM |
356 | /** |
357 | * Alter display of rows. | |
358 | * | |
359 | * Iterate through the rows retrieved via SQL and make changes for display purposes, | |
360 | * such as rendering contacts as links. | |
361 | * | |
362 | * @param array $rows | |
363 | * Rows generated by SQL, with an array for each row. | |
364 | */ | |
00be9182 | 365 | public function alterDisplay(&$rows) { |
c1413e28 DG |
366 | $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(); |
367 | foreach ($rows as $rowNum => $row) { | |
368 | // convert display name to links | |
369 | if (array_key_exists('civicrm_contact_sort_name', $row) && | |
370 | CRM_Utils_Array::value('civicrm_contact_sort_name', $rows[$rowNum]) && | |
371 | array_key_exists('civicrm_contact_id', $row) | |
372 | ) { | |
373 | $url = CRM_Utils_System::url('civicrm/contact/view', | |
374 | 'reset=1&cid=' . $row['civicrm_contact_id'], | |
375 | $this->_absoluteUrl | |
376 | ); | |
377 | $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url; | |
378 | $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts('View Contact Summary for this Contact.'); | |
379 | } | |
380 | ||
381 | // handle contribution status id | |
382 | if ($value = CRM_Utils_Array::value('civicrm_contribution_recur_contribution_status_id', $row)) { | |
383 | $rows[$rowNum]['civicrm_contribution_recur_contribution_status_id'] = $contributionStatus[$value]; | |
384 | } | |
84178120 | 385 | |
c1413e28 | 386 | if ($value = CRM_Utils_Array::value('civicrm_contribution_recur_amount', $row)) { |
84178120 | 387 | $rows[$rowNum]['civicrm_contribution_recur_amount'] = CRM_Utils_Money::format($rows[$rowNum]['civicrm_contribution_recur_amount'], $rows[$rowNum]['civicrm_contribution_recur_currency']); |
44fd0292 | 388 | } |
96b82f45 | 389 | |
5e0343e8 | 390 | if (!empty($row['civicrm_financial_trxn_card_type_id'])) { |
391 | $rows[$rowNum]['civicrm_financial_trxn_card_type_id'] = $this->getLabels($row['civicrm_financial_trxn_card_type_id'], 'CRM_Financial_DAO_FinancialTrxn', 'card_type_id'); | |
96b82f45 | 392 | } |
c1413e28 DG |
393 | } |
394 | } | |
96025800 | 395 | |
ef10e0b5 | 396 | } |