Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
232624b1 | 4 | | CiviCRM version 4.4 | |
6a488035 TO |
5 | +--------------------------------------------------------------------+ |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
31 | * @copyright CiviCRM LLC (c) 2004-2013 | |
32 | * $Id$ | |
33 | * | |
34 | */ | |
35 | class CRM_Report_Form_Contribute_Summary extends CRM_Report_Form { | |
36 | protected $_addressField = FALSE; | |
37 | ||
38 | protected $_charts = array( | |
39 | '' => 'Tabular', | |
40 | 'barChart' => 'Bar Chart', | |
41 | 'pieChart' => 'Pie Chart', | |
42 | ); | |
43 | protected $_customGroupExtends = array('Contribution'); | |
f813f78e | 44 | protected $_customGroupGroupBy = TRUE; |
6a488035 TO |
45 | |
46 | public $_drilldownReport = array('contribute/detail' => 'Link to Detail Report'); | |
47 | ||
48 | function __construct() { | |
f813f78e | 49 | |
50 | // Check if CiviCampaign is a) enabled and b) has active campaigns | |
51 | $config = CRM_Core_Config::singleton(); | |
6a488035 TO |
52 | $campaignEnabled = in_array("CiviCampaign", $config->enableComponents); |
53 | if ($campaignEnabled) { | |
54 | $getCampaigns = CRM_Campaign_BAO_Campaign::getPermissionedCampaigns(NULL, NULL, TRUE, FALSE, TRUE); | |
55 | $this->activeCampaigns = $getCampaigns['campaigns']; | |
56 | asort($this->activeCampaigns); | |
57 | } | |
f813f78e | 58 | |
6a488035 TO |
59 | $this->_columns = array( |
60 | 'civicrm_contact' => | |
61 | array( | |
62 | 'dao' => 'CRM_Contact_DAO_Contact', | |
63 | 'fields' => | |
64 | array( | |
65 | 'sort_name' => | |
66 | array('title' => ts('Contact Name'), | |
67 | 'no_repeat' => TRUE, | |
68 | ), | |
69 | 'postal_greeting_display' => | |
70 | array('title' => ts('Postal Greeting')), | |
71 | 'id' => | |
72 | array( | |
73 | 'no_display' => TRUE, | |
74 | 'required' => TRUE, | |
75 | ), | |
30f85891 RN |
76 | 'contact_type' => |
77 | array( | |
78 | 'title' => ts('Contact Type'), | |
79 | ), | |
80 | 'contact_sub_type' => | |
81 | array( | |
82 | 'title' => ts('Contact SubType'), | |
83 | ), | |
6a488035 TO |
84 | ), |
85 | 'grouping' => 'contact-fields', | |
86 | 'group_bys' => | |
87 | array( | |
88 | 'id' => | |
89 | array('title' => ts('Contact ID')), | |
90 | 'sort_name' => | |
91 | array('title' => ts('Contact Name'), | |
92 | ), | |
93 | ), | |
94 | ), | |
95 | 'civicrm_email' => | |
96 | array( | |
97 | 'dao' => 'CRM_Core_DAO_Email', | |
98 | 'fields' => | |
99 | array( | |
100 | 'email' => | |
101 | array('title' => ts('Email'), | |
102 | 'no_repeat' => TRUE, | |
103 | ), | |
104 | ), | |
105 | 'grouping' => 'contact-fields', | |
106 | ), | |
107 | 'civicrm_phone' => | |
108 | array( | |
109 | 'dao' => 'CRM_Core_DAO_Phone', | |
110 | 'fields' => | |
111 | array( | |
112 | 'phone' => | |
113 | array('title' => ts('Phone'), | |
114 | 'no_repeat' => TRUE, | |
115 | ), | |
116 | ), | |
117 | 'grouping' => 'contact-fields', | |
118 | ), | |
b914f4e8 PN |
119 | 'civicrm_financial_type' => |
120 | array('dao' => 'CRM_Financial_DAO_FinancialType', | |
f813f78e | 121 | 'fields' => array('financial_type' => null,), |
6a488035 | 122 | 'grouping' => 'contri-fields', |
f813f78e | 123 | 'group_bys' => array( |
124 | 'financial_type' => array('title' => ts('Financial Type')), | |
125 | ), | |
b914f4e8 | 126 | ), |
6a488035 TO |
127 | 'civicrm_contribution' => |
128 | array( | |
129 | 'dao' => 'CRM_Contribute_DAO_Contribution', | |
130 | //'bao' => 'CRM_Contribute_BAO_Contribution', | |
131 | 'fields' => | |
132 | array( | |
83abdecd | 133 | 'contribution_source' => array('title' => ts('Source'), ), |
35d8497b | 134 | 'currency' => |
135 | array('required' => TRUE, | |
136 | 'no_display' => TRUE, | |
137 | ), | |
6a488035 | 138 | 'total_amount' => |
9b0380d9 | 139 | array('title' => ts('Contribution Amount Stats'), |
6a488035 | 140 | 'default' => TRUE, |
6a488035 | 141 | 'statistics' => |
9b0380d9 DS |
142 | array('sum' => ts('Contributions Aggregate'), |
143 | 'count' => ts('Contributions'), | |
144 | 'avg' => ts('Contributions Avg'), | |
6a488035 TO |
145 | ), |
146 | ), | |
147 | ), | |
148 | 'grouping' => 'contri-fields', | |
149 | 'filters' => | |
150 | array( | |
151 | 'receive_date' => | |
152 | array('operatorType' => CRM_Report_Form::OP_DATE), | |
153 | 'contribution_status_id' => | |
154 | array('title' => ts('Donation Status'), | |
155 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
156 | 'options' => CRM_Contribute_PseudoConstant::contributionStatus(), | |
157 | 'default' => array(1), | |
158 | 'type' => CRM_Utils_Type::T_INT, | |
159 | ), | |
35d8497b | 160 | 'currency' => |
161 | array('title' => 'Currency', | |
162 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
163 | 'options' => CRM_Core_OptionGroup::values('currencies_enabled'), | |
d1b0931b | 164 | 'default' => NULL, |
35d8497b | 165 | 'type' => CRM_Utils_Type::T_STRING, |
166 | ), | |
b914f4e8 | 167 | 'financial_type_id' => |
f813f78e | 168 | array('title' => ts('Financial Type'), |
6a488035 | 169 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
b914f4e8 | 170 | 'options' => CRM_Contribute_PseudoConstant::financialType(), |
6a488035 TO |
171 | 'type' => CRM_Utils_Type::T_INT, |
172 | ), | |
0d0e945a DG |
173 | 'contribution_page_id' => |
174 | array('title' => ts('Contribution Page'), | |
175 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
176 | 'options' => CRM_Contribute_PseudoConstant::contributionPage(), | |
177 | 'type' => CRM_Utils_Type::T_INT, | |
c93f6d83 | 178 | ), |
6a488035 | 179 | 'total_amount' => |
9b0380d9 | 180 | array('title' => ts('Contribution Amount'), |
6a488035 TO |
181 | ), |
182 | 'total_sum' => | |
9b0380d9 | 183 | array('title' => ts('Contributions Aggregate'), |
6a488035 TO |
184 | 'type' => CRM_Report_Form::OP_INT, |
185 | 'dbAlias' => 'civicrm_contribution_total_amount_sum', | |
186 | 'having' => TRUE, | |
187 | ), | |
188 | 'total_count' => | |
9b0380d9 | 189 | array('title' => ts('Contributions Count'), |
6a488035 TO |
190 | 'type' => CRM_Report_Form::OP_INT, |
191 | 'dbAlias' => 'civicrm_contribution_total_amount_count', | |
192 | 'having' => TRUE, | |
193 | ), | |
194 | 'total_avg' => | |
9b0380d9 | 195 | array('title' => ts('Contributions Avg'), |
6a488035 TO |
196 | 'type' => CRM_Report_Form::OP_INT, |
197 | 'dbAlias' => 'civicrm_contribution_total_amount_avg', | |
198 | 'having' => TRUE, | |
199 | ), | |
200 | ), | |
201 | 'group_bys' => | |
202 | array( | |
203 | 'receive_date' => | |
204 | array( | |
205 | 'frequency' => TRUE, | |
206 | 'default' => TRUE, | |
207 | 'chart' => TRUE, | |
208 | ), | |
209 | 'contribution_source' => NULL, | |
210 | ), | |
211 | ), | |
9b0380d9 DS |
212 | 'civicrm_contribution_soft' => |
213 | array( | |
214 | 'dao' => 'CRM_Contribute_DAO_ContributionSoft', | |
215 | 'fields' => | |
216 | array( | |
217 | 'soft_amount' => | |
218 | array( | |
219 | 'title' => ts('Soft Credit Amount Stats'), | |
220 | 'name' => 'amount', | |
221 | 'statistics' => | |
222 | array('sum' => ts('Soft Credit Aggregate'), | |
223 | 'count' => ts('Soft Credits'), | |
224 | 'avg' => ts('Soft Credit Avg'), | |
225 | ), | |
226 | ), | |
227 | ), | |
228 | 'grouping' => 'contri-fields', | |
229 | 'filters' => | |
230 | array( | |
231 | 'amount' => | |
232 | array('title' => ts('Soft Credit Amount'), | |
233 | ), | |
51fa20cb | 234 | 'soft_credit_type_id' => |
235 | array('title' => 'Soft Credit Type', | |
236 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
237 | 'options' => CRM_Core_OptionGroup::values('soft_credit_type'), | |
238 | 'default' => NULL, | |
239 | 'type' => CRM_Utils_Type::T_STRING, | |
240 | ), | |
9b0380d9 DS |
241 | 'soft_sum' => |
242 | array('title' => ts('Soft Credit Aggregate'), | |
243 | 'type' => CRM_Report_Form::OP_INT, | |
244 | 'dbAlias' => 'civicrm_contribution_soft_soft_amount_sum', | |
245 | 'having' => TRUE, | |
246 | ), | |
247 | 'soft_count' => | |
248 | array('title' => ts('Soft Credits Count'), | |
249 | 'type' => CRM_Report_Form::OP_INT, | |
250 | 'dbAlias' => 'civicrm_contribution_soft_soft_amount_count', | |
251 | 'having' => TRUE, | |
252 | ), | |
253 | 'soft_avg' => | |
254 | array('title' => ts('Soft Credit Avg'), | |
255 | 'type' => CRM_Report_Form::OP_INT, | |
256 | 'dbAlias' => 'civicrm_contribution_soft_soft_amount_avg', | |
257 | 'having' => TRUE, | |
258 | ), | |
259 | ), | |
260 | ), | |
6a488035 TO |
261 | 'civicrm_group' => |
262 | array( | |
263 | 'dao' => 'CRM_Contact_DAO_GroupContact', | |
264 | 'alias' => 'cgroup', | |
265 | 'filters' => | |
266 | array( | |
267 | 'gid' => | |
268 | array( | |
269 | 'name' => 'group_id', | |
270 | 'title' => ts('Group'), | |
271 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
272 | 'group' => TRUE, | |
273 | 'options' => CRM_Core_PseudoConstant::group(), | |
274 | 'type' => CRM_Utils_Type::T_INT, | |
275 | ), | |
276 | ), | |
277 | ), | |
278 | ) + $this->addAddressFields(); | |
279 | ||
a7dbbc5d | 280 | // If we have a campaign, build out the relevant elements |
6a488035 TO |
281 | $this->_tagFilter = TRUE; |
282 | if ($campaignEnabled && !empty($this->activeCampaigns)) { | |
283 | $this->_columns['civicrm_contribution']['fields']['campaign_id'] = array( | |
284 | 'title' => 'Campaign', | |
285 | 'default' => 'false', | |
286 | ); | |
287 | $this->_columns['civicrm_contribution']['filters']['campaign_id'] = array('title' => ts('Campaign'), | |
288 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
289 | 'options' => $this->activeCampaigns, | |
290 | ); | |
6a488035 TO |
291 | $this->_columns['civicrm_contribution']['group_bys']['campaign_id'] = array('title' => ts('Campaign')); |
292 | } | |
35d8497b | 293 | |
294 | $this->_currencyColumn = 'civicrm_contribution_currency'; | |
6a488035 TO |
295 | parent::__construct(); |
296 | } | |
297 | ||
298 | function preProcess() { | |
299 | parent::preProcess(); | |
300 | } | |
301 | ||
302 | function setDefaultValues($freeze = TRUE) { | |
303 | return parent::setDefaultValues($freeze); | |
304 | } | |
305 | ||
306 | function select() { | |
307 | $select = array(); | |
308 | $this->_columnHeaders = array(); | |
309 | foreach ($this->_columns as $tableName => $table) { | |
310 | if (array_key_exists('group_bys', $table)) { | |
311 | foreach ($table['group_bys'] as $fieldName => $field) { | |
312 | if ($tableName == 'civicrm_address') { | |
313 | $this->_addressField = TRUE; | |
314 | } | |
a7488080 | 315 | if (!empty($this->_params['group_bys'][$fieldName])) { |
6a488035 TO |
316 | switch (CRM_Utils_Array::value($fieldName, $this->_params['group_bys_freq'])) { |
317 | case 'YEARWEEK': | |
318 | $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start"; | |
319 | $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal"; | |
320 | $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval"; | |
321 | $field['title'] = 'Week'; | |
322 | break; | |
323 | ||
324 | case 'YEAR': | |
325 | $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start"; | |
326 | $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal"; | |
327 | $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval"; | |
328 | $field['title'] = 'Year'; | |
329 | break; | |
330 | ||
331 | case 'MONTH': | |
332 | $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start"; | |
333 | $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal"; | |
334 | $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval"; | |
335 | $field['title'] = 'Month'; | |
336 | break; | |
337 | ||
338 | case 'QUARTER': | |
339 | $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start"; | |
340 | $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal"; | |
341 | $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval"; | |
342 | $field['title'] = 'Quarter'; | |
343 | break; | |
344 | } | |
a7488080 | 345 | if (!empty($this->_params['group_bys_freq'][$fieldName])) { |
6a488035 TO |
346 | $this->_interval = $field['title']; |
347 | $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['title'] = $field['title'] . ' Beginning'; | |
348 | $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['type'] = $field['type']; | |
349 | $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params['group_bys_freq'][$fieldName]; | |
350 | ||
351 | // just to make sure these values are transfered to rows. | |
352 | // since we need that for calculation purpose, | |
353 | // e.g making subtotals look nicer or graphs | |
354 | $this->_columnHeaders["{$tableName}_{$fieldName}_interval"] = array('no_display' => TRUE); | |
355 | $this->_columnHeaders["{$tableName}_{$fieldName}_subtotal"] = array('no_display' => TRUE); | |
356 | } | |
357 | } | |
358 | } | |
359 | } | |
360 | ||
361 | if (array_key_exists('fields', $table)) { | |
362 | foreach ($table['fields'] as $fieldName => $field) { | |
363 | if ($tableName == 'civicrm_address') { | |
364 | $this->_addressField = TRUE; | |
365 | } | |
8cc574cf | 366 | if (!empty($field['required']) || !empty($this->_params['fields'][$fieldName])) { |
6a488035 TO |
367 | |
368 | // only include statistics columns if set | |
a7488080 | 369 | if (!empty($field['statistics'])) { |
6a488035 TO |
370 | foreach ($field['statistics'] as $stat => $label) { |
371 | switch (strtolower($stat)) { | |
372 | case 'sum': | |
373 | $select[] = "SUM({$field['dbAlias']}) as {$tableName}_{$fieldName}_{$stat}"; | |
374 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label; | |
375 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type']; | |
376 | $this->_statFields[] = "{$tableName}_{$fieldName}_{$stat}"; | |
377 | break; | |
378 | ||
379 | case 'count': | |
380 | $select[] = "COUNT({$field['dbAlias']}) as {$tableName}_{$fieldName}_{$stat}"; | |
381 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT; | |
382 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label; | |
383 | $this->_statFields[] = "{$tableName}_{$fieldName}_{$stat}"; | |
384 | break; | |
385 | ||
386 | case 'avg': | |
387 | $select[] = "ROUND(AVG({$field['dbAlias']}),2) as {$tableName}_{$fieldName}_{$stat}"; | |
388 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type']; | |
389 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label; | |
390 | $this->_statFields[] = "{$tableName}_{$fieldName}_{$stat}"; | |
391 | break; | |
392 | } | |
393 | } | |
394 | } | |
395 | else { | |
396 | $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}"; | |
397 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field); | |
398 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array::value('title', $field); | |
399 | } | |
400 | } | |
401 | } | |
402 | } | |
403 | } | |
404 | ||
405 | $this->_select = "SELECT " . implode(', ', $select) . " "; | |
406 | } | |
407 | ||
408 | static function formRule($fields, $files, $self) { | |
409 | $errors = $grouping = array(); | |
410 | //check for searching combination of dispaly columns and | |
411 | //grouping criteria | |
412 | $ignoreFields = array('total_amount', 'sort_name'); | |
413 | $errors = $self->customDataFormRule($fields, $ignoreFields); | |
414 | ||
a7488080 CW |
415 | if (empty($fields['group_bys']['receive_date'])) { |
416 | if (!empty($fields['receive_date_relative']) || | |
6a488035 TO |
417 | CRM_Utils_Date::isDate($fields['receive_date_from']) || |
418 | CRM_Utils_Date::isDate($fields['receive_date_to']) | |
419 | ) { | |
420 | $errors['receive_date_relative'] = ts("Do not use filter on Date if group by Receive Date is not used "); | |
421 | } | |
422 | } | |
a7488080 | 423 | if (empty($fields['fields']['total_amount'])) { |
6a488035 TO |
424 | foreach (array( |
425 | 'total_count_value', 'total_sum_value', 'total_avg_value') as $val) { | |
a7488080 | 426 | if (!empty($fields[$val])) { |
6a488035 TO |
427 | $errors[$val] = ts("Please select the Amount Statistics"); |
428 | } | |
429 | } | |
430 | } | |
431 | ||
432 | return $errors; | |
433 | } | |
434 | ||
435 | function from() { | |
9b0380d9 | 436 | $softCreditJoin = "LEFT"; |
8cc574cf | 437 | if (!empty($this->_params['fields']['soft_amount']) && empty($this->_params['fields']['total_amount'])) { |
9b0380d9 DS |
438 | // if its only soft credit stats, use inner join |
439 | $softCreditJoin = "INNER"; | |
440 | } | |
441 | ||
6a488035 TO |
442 | $this->_from = " |
443 | FROM civicrm_contact {$this->_aliases['civicrm_contact']} | |
f813f78e | 444 | INNER JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']} |
6a488035 TO |
445 | ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_contribution']}.contact_id AND |
446 | {$this->_aliases['civicrm_contribution']}.is_test = 0 | |
9b0380d9 DS |
447 | {$softCreditJoin} JOIN civicrm_contribution_soft {$this->_aliases['civicrm_contribution_soft']} |
448 | ON {$this->_aliases['civicrm_contribution_soft']}.contribution_id = {$this->_aliases['civicrm_contribution']}.id | |
f813f78e | 449 | LEFT JOIN civicrm_financial_type {$this->_aliases['civicrm_financial_type']} |
6a488035 | 450 | ON {$this->_aliases['civicrm_contribution']}.financial_type_id ={$this->_aliases['civicrm_financial_type']}.id |
f813f78e | 451 | LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']} |
452 | ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id AND | |
453 | {$this->_aliases['civicrm_email']}.is_primary = 1) | |
454 | ||
455 | LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']} | |
456 | ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id AND | |
6a488035 TO |
457 | {$this->_aliases['civicrm_phone']}.is_primary = 1)"; |
458 | ||
459 | if ($this->_addressField) { | |
460 | $this->_from .= " | |
f813f78e | 461 | LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']} |
462 | ON {$this->_aliases['civicrm_contact']}.id = | |
463 | {$this->_aliases['civicrm_address']}.contact_id AND | |
6a488035 TO |
464 | {$this->_aliases['civicrm_address']}.is_primary = 1\n"; |
465 | } | |
466 | } | |
467 | ||
468 | function groupBy() { | |
469 | $this->_groupBy = ""; | |
470 | $append = FALSE; | |
471 | if (is_array($this->_params['group_bys']) && | |
472 | !empty($this->_params['group_bys']) | |
473 | ) { | |
474 | foreach ($this->_columns as $tableName => $table) { | |
475 | if (array_key_exists('group_bys', $table)) { | |
476 | foreach ($table['group_bys'] as $fieldName => $field) { | |
a7488080 CW |
477 | if (!empty($this->_params['group_bys'][$fieldName])) { |
478 | if (!empty($field['chart'])) { | |
6a488035 TO |
479 | $this->assign('chartSupported', TRUE); |
480 | } | |
481 | ||
8cc574cf | 482 | if (!empty($table['group_bys'][$fieldName]['frequency']) && !empty($this->_params['group_bys_freq'][$fieldName])) { |
6a488035 TO |
483 | |
484 | $append = "YEAR({$field['dbAlias']}),"; | |
485 | if (in_array(strtolower($this->_params['group_bys_freq'][$fieldName]), | |
486 | array('year') | |
487 | )) { | |
488 | $append = ''; | |
489 | } | |
490 | $this->_groupBy[] = "$append {$this->_params['group_bys_freq'][$fieldName]}({$field['dbAlias']})"; | |
491 | $append = TRUE; | |
492 | } | |
493 | else { | |
494 | $this->_groupBy[] = $field['dbAlias']; | |
495 | } | |
496 | } | |
497 | } | |
498 | } | |
499 | } | |
500 | ||
501 | if (!empty($this->_statFields) && | |
502 | (($append && count($this->_groupBy) <= 1) || (!$append)) && !$this->_having | |
503 | ) { | |
504 | $this->_rollup = " WITH ROLLUP"; | |
505 | } | |
506 | $this->_groupBy = "GROUP BY " . implode(', ', $this->_groupBy) . " {$this->_rollup} "; | |
507 | } | |
508 | else { | |
509 | $this->_groupBy = "GROUP BY {$this->_aliases['civicrm_contact']}.id"; | |
510 | } | |
511 | } | |
512 | ||
51fa20cb | 513 | function storeWhereHavingClauseArray(){ |
514 | parent::storeWhereHavingClauseArray(); | |
a7488080 | 515 | if (empty($this->_params['fields']['soft_amount']) && !empty($this->_havingClauses)){ |
51fa20cb | 516 | foreach ($this->_havingClauses as $key => $havingClause) { |
517 | if (stristr($havingClause, 'soft_soft')){ | |
518 | unset($this->_havingClauses[$key]); | |
519 | } | |
520 | } | |
521 | } | |
522 | } | |
523 | ||
6a488035 TO |
524 | function statistics(&$rows) { |
525 | $statistics = parent::statistics($rows); | |
526 | ||
9b0380d9 DS |
527 | $softCredit = CRM_Utils_Array::value('soft_amount', $this->_params['fields']); |
528 | $onlySoftCredit = $softCredit && !CRM_Utils_Array::value('total_amount', $this->_params['fields']); | |
51fa20cb | 529 | $totalAmount = $average = $softTotalAmount = $softAverage = array(); |
35d8497b | 530 | |
c93f6d83 | 531 | $select = "SELECT |
9b0380d9 DS |
532 | COUNT({$this->_aliases['civicrm_contribution']}.total_amount ) as civicrm_contribution_total_amount_count, |
533 | SUM({$this->_aliases['civicrm_contribution']}.total_amount ) as civicrm_contribution_total_amount_sum, | |
534 | ROUND(AVG({$this->_aliases['civicrm_contribution']}.total_amount), 2) as civicrm_contribution_total_amount_avg, | |
535 | {$this->_aliases['civicrm_contribution']}.currency as currency"; | |
536 | ||
537 | if ($softCredit) { | |
c93f6d83 | 538 | $select .= ", |
9b0380d9 DS |
539 | COUNT({$this->_aliases['civicrm_contribution_soft']}.amount ) as civicrm_contribution_soft_soft_amount_count, |
540 | SUM({$this->_aliases['civicrm_contribution_soft']}.amount ) as civicrm_contribution_soft_soft_amount_sum, | |
541 | ROUND(AVG({$this->_aliases['civicrm_contribution_soft']}.amount), 2) as civicrm_contribution_soft_soft_amount_avg"; | |
542 | } | |
543 | $group = "\nGROUP BY {$this->_aliases['civicrm_contribution']}.currency"; | |
544 | $sql = "{$select} {$this->_from} {$this->_where} {$group} {$this->_having}"; | |
c93f6d83 | 545 | |
9b0380d9 DS |
546 | $dao = CRM_Core_DAO::executeQuery($sql); |
547 | $totalAmount = $average = $softTotalAmount = $softAverage = array(); | |
548 | $count = $softCount = 0; | |
549 | while ($dao->fetch()) { | |
0d0e945a | 550 | $totalAmount[] = CRM_Utils_Money::format($dao->civicrm_contribution_total_amount_sum, $dao->currency)." (".$dao->civicrm_contribution_total_amount_count.")"; |
9b0380d9 DS |
551 | $average[] = CRM_Utils_Money::format($dao->civicrm_contribution_total_amount_avg, $dao->currency); |
552 | $count += $dao->civicrm_contribution_total_amount_count; | |
c93f6d83 | 553 | |
9b0380d9 | 554 | if ($softCredit) { |
0d0e945a | 555 | $softTotalAmount[] = CRM_Utils_Money::format($dao->civicrm_contribution_soft_soft_amount_sum, $dao->currency)." (".$dao->civicrm_contribution_soft_soft_amount_count.")"; |
9b0380d9 DS |
556 | $softAverage[] = CRM_Utils_Money::format($dao->civicrm_contribution_soft_soft_amount_avg, $dao->currency); |
557 | $softCount += $dao->civicrm_contribution_soft_soft_amount_count; | |
558 | } | |
559 | } | |
c93f6d83 | 560 | |
9b0380d9 | 561 | if (!$onlySoftCredit) { |
35d8497b | 562 | $statistics['counts']['amount'] = array( |
563 | 'title' => ts('Total Amount'), | |
564 | 'value' => implode(', ', $totalAmount), | |
565 | 'type' => CRM_Utils_Type::T_STRING, | |
566 | ); | |
567 | $statistics['counts']['count'] = array( | |
568 | 'title' => ts('Total Donations'), | |
569 | 'value' => $count, | |
570 | ); | |
571 | $statistics['counts']['avg'] = array( | |
572 | 'title' => ts('Average'), | |
573 | 'value' => implode(', ', $average), | |
574 | 'type' => CRM_Utils_Type::T_STRING, | |
575 | ); | |
9b0380d9 DS |
576 | } |
577 | if ($softCredit) { | |
578 | $statistics['counts']['soft_amount'] = array( | |
579 | 'title' => ts('Total Soft Credit Amount'), | |
580 | 'value' => implode(', ', $softTotalAmount), | |
581 | 'type' => CRM_Utils_Type::T_STRING, | |
582 | ); | |
583 | $statistics['counts']['soft_count'] = array( | |
584 | 'title' => ts('Total Soft Credits'), | |
585 | 'value' => $softCount, | |
586 | ); | |
587 | $statistics['counts']['soft_avg'] = array( | |
588 | 'title' => ts('Average Soft Credit'), | |
589 | 'value' => implode(', ', $softAverage), | |
590 | 'type' => CRM_Utils_Type::T_STRING, | |
591 | ); | |
6a488035 TO |
592 | } |
593 | return $statistics; | |
594 | } | |
595 | ||
596 | function postProcess() { | |
0c00c2f2 | 597 | $this->buildACLClause($this->_aliases['civicrm_contact']); |
6a488035 TO |
598 | parent::postProcess(); |
599 | } | |
600 | ||
601 | function buildChart(&$rows) { | |
602 | $graphRows = array(); | |
6a488035 | 603 | |
a7488080 CW |
604 | if (!empty($this->_params['charts'])) { |
605 | if (!empty($this->_params['group_bys']['receive_date'])) { | |
0c98098b | 606 | |
0d8afee2 CW |
607 | $contrib = !empty($this->_params['fields']['total_amount']) ? TRUE : FALSE; |
608 | $softContrib = !empty($this->_params['fields']['soft_amount']) ? TRUE : FALSE; | |
0c98098b DS |
609 | |
610 | foreach ($rows as $key => $row) { | |
611 | if ($row['civicrm_contribution_receive_date_subtotal']) { | |
612 | $graphRows['receive_date'][] = $row['civicrm_contribution_receive_date_start']; | |
613 | $graphRows[$this->_interval][] = $row['civicrm_contribution_receive_date_interval']; | |
614 | if ($softContrib && $contrib) { | |
615 | // both contri & soft contri stats are present | |
616 | $graphRows['multiValue'][0][] = $row['civicrm_contribution_total_amount_sum']; | |
617 | $graphRows['multiValue'][1][] = $row['civicrm_contribution_soft_soft_amount_sum']; | |
618 | } else if ($softContrib) { | |
619 | // only soft contributions | |
620 | $graphRows['multiValue'][0][] = $row['civicrm_contribution_soft_soft_amount_sum']; | |
621 | } else { | |
622 | // only contributions | |
623 | $graphRows['multiValue'][0][] = $row['civicrm_contribution_total_amount_sum']; | |
624 | } | |
625 | } | |
6a488035 | 626 | } |
6a488035 | 627 | |
0c98098b DS |
628 | if ($softContrib && $contrib) { |
629 | $graphRows['barKeys'][0] = ts('Contributions'); | |
630 | $graphRows['barKeys'][1] = ts('Soft Credits'); | |
631 | $graphRows['legend'] = ts('Contributions and Soft Credits'); | |
632 | } else if ($softContrib) { | |
633 | $graphRows['legend'] = ts('Soft Credits'); | |
634 | } | |
6a488035 TO |
635 | |
636 | // build the chart. | |
637 | $config = CRM_Core_Config::Singleton(); | |
638 | $graphRows['xname'] = $this->_interval; | |
639 | $graphRows['yname'] = "Amount ({$config->defaultCurrency})"; | |
640 | CRM_Utils_OpenFlashChart::chart($graphRows, $this->_params['charts'], $this->_interval); | |
641 | $this->assign('chartType', $this->_params['charts']); | |
642 | } | |
643 | } | |
644 | } | |
645 | ||
646 | function alterDisplay(&$rows) { | |
647 | // custom code to alter rows | |
648 | $entryFound = FALSE; | |
649 | ||
650 | foreach ($rows as $rowNum => $row) { | |
651 | // make count columns point to detail report | |
8cc574cf CW |
652 | if (!empty($this->_params['group_bys']['receive_date']) && !empty($row['civicrm_contribution_receive_date_start']) && |
653 | CRM_Utils_Array::value('civicrm_contribution_receive_date_start', $row) && !empty($row['civicrm_contribution_receive_date_subtotal'])) { | |
6a488035 TO |
654 | |
655 | $dateStart = CRM_Utils_Date::customFormat($row['civicrm_contribution_receive_date_start'], '%Y%m%d'); | |
656 | $endDate = new DateTime($dateStart); | |
657 | $dateEnd = array(); | |
658 | ||
659 | list($dateEnd['Y'], $dateEnd['M'], $dateEnd['d']) = explode(':', $endDate->format('Y:m:d')); | |
660 | ||
661 | switch (strtolower($this->_params['group_bys_freq']['receive_date'])) { | |
662 | case 'month': | |
663 | $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'] + 1, | |
664 | $dateEnd['d'] - 1, $dateEnd['Y'] | |
665 | )); | |
666 | break; | |
667 | ||
668 | case 'year': | |
669 | $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'], | |
670 | $dateEnd['d'] - 1, $dateEnd['Y'] + 1 | |
671 | )); | |
672 | break; | |
673 | ||
674 | case 'yearweek': | |
675 | $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'], | |
676 | $dateEnd['d'] + 6, $dateEnd['Y'] | |
677 | )); | |
678 | break; | |
679 | ||
680 | case 'quarter': | |
681 | $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'] + 3, | |
682 | $dateEnd['d'] - 1, $dateEnd['Y'] | |
683 | )); | |
684 | break; | |
685 | } | |
686 | $url = CRM_Report_Utils_Report::getNextUrl('contribute/detail', | |
687 | "reset=1&force=1&receive_date_from={$dateStart}&receive_date_to={$dateEnd}", | |
688 | $this->_absoluteUrl, | |
689 | $this->_id, | |
690 | $this->_drilldownReport | |
691 | ); | |
692 | $rows[$rowNum]['civicrm_contribution_receive_date_start_link'] = $url; | |
693 | $rows[$rowNum]['civicrm_contribution_receive_date_start_hover'] = ts('List all contribution(s) for this date unit.'); | |
694 | $entryFound = TRUE; | |
695 | } | |
696 | ||
697 | // make subtotals look nicer | |
698 | if (array_key_exists('civicrm_contribution_receive_date_subtotal', $row) && | |
699 | !$row['civicrm_contribution_receive_date_subtotal'] | |
700 | ) { | |
701 | $this->fixSubTotalDisplay($rows[$rowNum], $this->_statFields); | |
702 | $entryFound = TRUE; | |
703 | } | |
704 | ||
705 | // convert display name to links | |
706 | if (array_key_exists('civicrm_contact_sort_name', $row) && | |
707 | array_key_exists('civicrm_contact_id', $row) | |
708 | ) { | |
709 | $url = CRM_Report_Utils_Report::getNextUrl('contribute/detail', | |
710 | 'reset=1&force=1&id_op=eq&id_value=' . $row['civicrm_contact_id'], | |
711 | $this->_absoluteUrl, $this->_id, $this->_drilldownReport | |
712 | ); | |
713 | $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url; | |
714 | $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("Lists detailed contribution(s) for this record."); | |
715 | $entryFound = TRUE; | |
716 | } | |
717 | ||
a7dbbc5d | 718 | // If using campaigns, convert campaign_id to campaign title |
6a488035 TO |
719 | if (array_key_exists('civicrm_contribution_campaign_id', $row)) { |
720 | if ($value = $row['civicrm_contribution_campaign_id']) { | |
721 | $rows[$rowNum]['civicrm_contribution_campaign_id'] = $this->activeCampaigns[$value]; | |
722 | } | |
723 | $entryFound = TRUE; | |
724 | } | |
2ebf49a4 | 725 | |
6a488035 TO |
726 | $entryFound = $this->alterDisplayAddressFields($row, $rows, $rowNum, 'contribute/detail', 'List all contribution(s) for this ') ? TRUE : $entryFound; |
727 | ||
6a488035 TO |
728 | // skip looking further in rows, if first row itself doesn't |
729 | // have the column we need | |
730 | if (!$entryFound) { | |
731 | break; | |
732 | } | |
733 | } | |
734 | } | |
735 | } | |
736 |