Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
06b69b18 | 5 | | CiviCRM version 4.5 | |
6a488035 | 6 | +--------------------------------------------------------------------+ |
06b69b18 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
8 | +--------------------------------------------------------------------+ |
9 | | This file is a part of CiviCRM. | | |
10 | | | | |
11 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
12 | | under the terms of the GNU Affero General Public License | | |
13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
14 | | | | |
15 | | CiviCRM is distributed in the hope that it will be useful, but | | |
16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
18 | | See the GNU Affero General Public License for more details. | | |
19 | | | | |
20 | | You should have received a copy of the GNU Affero General Public | | |
21 | | License and the CiviCRM Licensing Exception along | | |
22 | | with this program; if not, contact CiviCRM LLC | | |
23 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
24 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
26 | +--------------------------------------------------------------------+ | |
27 | */ | |
28 | ||
29 | /** | |
30 | * | |
31 | * @package CRM | |
06b69b18 | 32 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
33 | * $Id$ |
34 | * | |
35 | */ | |
36 | class CRM_Report_Form_Contribute_TopDonor extends CRM_Report_Form { | |
37 | ||
38 | protected $_summary = NULL; | |
39 | ||
40 | public $_drilldownReport = array('contribute/detail' => 'Link to Detail Report'); | |
41 | ||
42 | protected $_charts = array( | |
43 | '' => 'Tabular', | |
44 | 'barChart' => 'Bar Chart', | |
45 | 'pieChart' => 'Pie Chart', | |
46 | ); | |
2f4c2f5d | 47 | |
74cf4551 EM |
48 | /** |
49 | * | |
50 | */ | |
51 | /** | |
52 | * | |
53 | */ | |
6a488035 TO |
54 | function __construct() { |
55 | $this->_columns = array( | |
56 | 'civicrm_contact' => | |
57 | array( | |
58 | 'dao' => 'CRM_Contact_DAO_Contact', | |
59 | 'fields' => | |
60 | array( | |
61 | 'id' => | |
62 | array( | |
63 | 'no_display' => TRUE, | |
64 | 'required' => TRUE, | |
65 | ), | |
66 | 'display_name' => | |
67 | array('title' => ts('Contact Name'), | |
68 | 'required' => TRUE, | |
69 | 'no_repeat' => TRUE, | |
70 | ), | |
30f85891 RN |
71 | 'first_name' => array( |
72 | 'title' => ts('First Name'), | |
6a488035 | 73 | ), |
30f85891 RN |
74 | 'last_name' => array( |
75 | 'title' => ts('Last Name'), | |
76 | ), | |
77 | 'contact_type' => | |
78 | array( | |
79 | 'title' => ts('Contact Type'), | |
80 | ), | |
81 | 'contact_sub_type' => | |
82 | array( | |
83 | 'title' => ts('Contact SubType'), | |
6a488035 TO |
84 | ), |
85 | ), | |
86 | ), | |
21d62de7 DG |
87 | ) |
88 | + $this->getAddressColumns() | |
89 | + array( | |
6a488035 TO |
90 | 'civicrm_contribution' => |
91 | array( | |
92 | 'dao' => 'CRM_Contribute_DAO_Contribution', | |
93 | 'fields' => | |
94 | array( | |
95 | 'total_amount' => | |
96 | array('title' => ts('Amount Statistics'), | |
97 | 'required' => TRUE, | |
98 | 'statistics' => | |
99 | array('sum' => ts('Aggregate Amount'), | |
100 | 'count' => ts('Donations'), | |
101 | 'avg' => ts('Average'), | |
102 | ), | |
103 | ), | |
2f4c2f5d | 104 | 'currency' => |
7a961f19 | 105 | array('required' => TRUE, |
106 | 'no_display' => TRUE, | |
107 | ), | |
6a488035 TO |
108 | ), |
109 | 'filters' => | |
110 | array( | |
111 | 'receive_date' => | |
112 | array( | |
113 | 'default' => 'this.year', | |
114 | 'operatorType' => CRM_Report_Form::OP_DATE, | |
115 | ), | |
7a961f19 | 116 | 'currency' => |
f3bc9ff5 | 117 | array('title' => 'Currency', |
118 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
0637f1c4 | 119 | 'options' => CRM_Core_OptionGroup::values('currencies_enabled'), |
d1b0931b | 120 | 'default' => NULL, |
7a961f19 | 121 | 'type' => CRM_Utils_Type::T_STRING, |
f3bc9ff5 | 122 | ), |
6a488035 TO |
123 | 'total_range' => |
124 | array('title' => ts('Show no. of Top Donors'), | |
125 | 'type' => CRM_Utils_Type::T_INT, | |
126 | 'default_op' => 'eq', | |
127 | ), | |
f3bc9ff5 | 128 | 'financial_type_id' => |
b914f4e8 PN |
129 | array('name' => 'financial_type_id', |
130 | 'title' => ts('Financial Type'), | |
6a488035 | 131 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
b914f4e8 | 132 | 'options' => CRM_Contribute_PseudoConstant::financialType() , |
6a488035 TO |
133 | ), |
134 | 'contribution_status_id' => | |
135 | array('title' => ts('Donation Status'), | |
136 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
137 | 'options' => CRM_Contribute_PseudoConstant::contributionStatus(), | |
138 | 'default' => array(1), | |
139 | ), | |
140 | ), | |
141 | ), | |
2f4c2f5d | 142 | 'civicrm_email' => |
6a488035 TO |
143 | array( |
144 | 'dao' => 'CRM_Core_DAO_Email', | |
145 | 'fields' => | |
146 | array( | |
147 | 'email' => | |
148 | array('title' => ts('Email'), | |
149 | 'default' => TRUE, | |
150 | 'no_repeat' => TRUE, | |
151 | ), | |
152 | ), | |
153 | 'grouping' => 'email-fields', | |
154 | ), | |
2f4c2f5d | 155 | |
6a488035 TO |
156 | 'civicrm_phone' => |
157 | array( | |
158 | 'dao' => 'CRM_Core_DAO_Phone', | |
159 | 'fields' => | |
160 | array( | |
161 | 'phone' => | |
162 | array('title' => ts('Phone'), | |
163 | 'default' => TRUE, | |
164 | 'no_repeat' => TRUE, | |
165 | ), | |
166 | ), | |
167 | 'grouping' => 'phone-fields', | |
168 | ), | |
6a488035 TO |
169 | ); |
170 | ||
16e2e80c | 171 | $this->_groupFilter = TRUE; |
6a488035 | 172 | $this->_tagFilter = TRUE; |
7a961f19 | 173 | $this->_currencyColumn = 'civicrm_contribution_currency'; |
6a488035 TO |
174 | parent::__construct(); |
175 | } | |
176 | ||
177 | function preProcess() { | |
178 | parent::preProcess(); | |
179 | } | |
180 | ||
181 | function select() { | |
182 | $select = array(); | |
183 | $this->_columnHeaders = array(); | |
184 | //Headers for Rank column | |
185 | $this->_columnHeaders["civicrm_donor_rank"]['title'] = ts('Rank'); | |
186 | $this->_columnHeaders["civicrm_donor_rank"]['type'] = 1; | |
187 | //$select[] ="(@rank:=@rank+1) as civicrm_donor_rank "; | |
188 | ||
189 | foreach ($this->_columns as $tableName => $table) { | |
190 | if (array_key_exists('fields', $table)) { | |
191 | foreach ($table['fields'] as $fieldName => $field) { | |
8cc574cf | 192 | if (!empty($field['required']) || !empty($this->_params['fields'][$fieldName])) { |
6a488035 | 193 | // only include statistics columns if set |
a7488080 | 194 | if (!empty($field['statistics'])) { |
6a488035 TO |
195 | foreach ($field['statistics'] as $stat => $label) { |
196 | switch (strtolower($stat)) { | |
197 | case 'sum': | |
198 | $select[] = "SUM({$field['dbAlias']}) as {$tableName}_{$fieldName}_{$stat}"; | |
199 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label; | |
200 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type']; | |
201 | $this->_statFields[] = "{$tableName}_{$fieldName}_{$stat}"; | |
202 | break; | |
203 | ||
204 | case 'count': | |
205 | $select[] = "COUNT({$field['dbAlias']}) as {$tableName}_{$fieldName}_{$stat}"; | |
206 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label; | |
207 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT; | |
208 | $this->_statFields[] = "{$tableName}_{$fieldName}_{$stat}"; | |
209 | break; | |
210 | ||
211 | case 'avg': | |
212 | $select[] = "ROUND(AVG({$field['dbAlias']}),2) as {$tableName}_{$fieldName}_{$stat}"; | |
213 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type']; | |
214 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label; | |
215 | $this->_statFields[] = "{$tableName}_{$fieldName}_{$stat}"; | |
216 | break; | |
217 | } | |
218 | } | |
219 | } | |
220 | else { | |
221 | $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}"; | |
21d62de7 DG |
222 | // $field['type'] is not always set. Use string type as default if not set. |
223 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = isset($field['type']) ? $field['type'] : 2; | |
6a488035 TO |
224 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = $field['title']; |
225 | } | |
226 | } | |
227 | } | |
228 | } | |
229 | } | |
65f9ed10 | 230 | |
6a488035 TO |
231 | $this->_select = " SELECT * FROM ( SELECT " . implode(', ', $select) . " "; |
232 | } | |
233 | ||
74cf4551 EM |
234 | /** |
235 | * @param $fields | |
236 | * @param $files | |
237 | * @param $self | |
238 | * | |
239 | * @return array | |
240 | */ | |
6a488035 TO |
241 | static function formRule($fields, $files, $self) { |
242 | $errors = array(); | |
243 | ||
244 | $op = CRM_Utils_Array::value('total_range_op', $fields); | |
245 | $val = CRM_Utils_Array::value('total_range_value', $fields); | |
246 | ||
247 | if (!in_array($op, array( | |
248 | 'eq', 'lte'))) { | |
249 | $errors['total_range_op'] = ts("Please select 'Is equal to' OR 'Is Less than or equal to' operator"); | |
250 | } | |
251 | ||
252 | if ($val && !CRM_Utils_Rule::positiveInteger($val)) { | |
253 | $errors['total_range_value'] = ts("Please enter positive number"); | |
254 | } | |
255 | return $errors; | |
256 | } | |
257 | ||
258 | function from() { | |
259 | $this->_from = " | |
260 | FROM civicrm_contact {$this->_aliases['civicrm_contact']} {$this->_aclFrom} | |
65f9ed10 E |
261 | INNER JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']} |
262 | ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_contribution']}.contact_id AND {$this->_aliases['civicrm_contribution']}.is_test = 0 | |
2f4c2f5d | 263 | LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']} |
264 | ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id | |
6a488035 | 265 | AND {$this->_aliases['civicrm_email']}.is_primary = 1 |
2f4c2f5d | 266 | LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']} |
6a488035 | 267 | ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id AND |
2f4c2f5d | 268 | {$this->_aliases['civicrm_phone']}.is_primary = 1 |
65f9ed10 | 269 | "; |
21d62de7 | 270 | $this->addAddressFromClause(); |
6a488035 TO |
271 | } |
272 | ||
273 | function where() { | |
274 | $clauses = array(); | |
93406a82 | 275 | $this->_tempClause = $this->_outerCluase = $this->_groupLimit = ''; |
6a488035 TO |
276 | foreach ($this->_columns as $tableName => $table) { |
277 | if (array_key_exists('filters', $table)) { | |
278 | foreach ($table['filters'] as $fieldName => $field) { | |
279 | $clause = NULL; | |
280 | if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE) { | |
281 | $relative = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params); | |
282 | $from = CRM_Utils_Array::value("{$fieldName}_from", $this->_params); | |
283 | $to = CRM_Utils_Array::value("{$fieldName}_to", $this->_params); | |
284 | ||
285 | if ($relative || $from || $to) { | |
286 | $clause = $this->dateClause($field['name'], $relative, $from, $to, $field['type']); | |
287 | } | |
288 | } | |
289 | else { | |
290 | $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params); | |
291 | if ($op) { | |
292 | $clause = $this->whereClause($field, | |
293 | $op, | |
294 | CRM_Utils_Array::value("{$fieldName}_value", $this->_params), | |
295 | CRM_Utils_Array::value("{$fieldName}_min", $this->_params), | |
296 | CRM_Utils_Array::value("{$fieldName}_max", $this->_params) | |
297 | ); | |
298 | } | |
299 | } | |
300 | ||
301 | if (!empty($clause)) { | |
302 | if ($fieldName == 'total_range') { | |
303 | $value = CRM_Utils_Array::value("total_range_value", $this->_params); | |
304 | $this->_outerCluase = " WHERE (( @rows := @rows + 1) <= {$value}) "; | |
93406a82 | 305 | $this->_groupLimit = " LIMIT {$value}"; |
6a488035 TO |
306 | } |
307 | else { | |
308 | $clauses[] = $clause; | |
309 | } | |
310 | } | |
311 | } | |
312 | } | |
313 | } | |
314 | if (empty($clauses)) { | |
315 | $this->_where = "WHERE ( 1 ) "; | |
316 | } | |
317 | else { | |
318 | $this->_where = "WHERE " . implode(' AND ', $clauses); | |
319 | } | |
320 | ||
321 | if ($this->_aclWhere) { | |
322 | $this->_where .= " AND {$this->_aclWhere} "; | |
323 | } | |
324 | } | |
325 | ||
326 | function groupBy() { | |
7a961f19 | 327 | $this->_groupBy = "GROUP BY {$this->_aliases['civicrm_contact']}.id, {$this->_aliases['civicrm_contribution']}.currency"; |
6a488035 TO |
328 | } |
329 | ||
330 | function postProcess() { | |
331 | ||
332 | $this->beginPostProcess(); | |
333 | ||
334 | // get the acl clauses built before we assemble the query | |
335 | $this->buildACLClause($this->_aliases['civicrm_contact']); | |
336 | ||
337 | $this->select(); | |
338 | ||
339 | $this->from(); | |
340 | ||
341 | $this->where(); | |
342 | ||
343 | $this->groupBy(); | |
344 | ||
345 | $this->limit(); | |
346 | ||
347 | ||
348 | //set the variable value rank, rows = 0 | |
349 | $setVariable = " SET @rows:=0, @rank=0 "; | |
350 | CRM_Core_DAO::singleValueQuery($setVariable); | |
351 | ||
2f4c2f5d | 352 | $sql = " {$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} |
6a488035 TO |
353 | ORDER BY civicrm_contribution_total_amount_sum DESC |
354 | ) as abc {$this->_outerCluase} $this->_limit | |
355 | "; | |
356 | ||
357 | $dao = CRM_Core_DAO::executeQuery($sql); | |
358 | ||
359 | while ($dao->fetch()) { | |
360 | $row = array(); | |
361 | foreach ($this->_columnHeaders as $key => $value) { | |
362 | if (property_exists($dao, $key)) { | |
363 | $row[$key] = $dao->$key; | |
364 | } | |
365 | } | |
366 | $rows[] = $row; | |
367 | } | |
368 | $this->formatDisplay($rows); | |
369 | ||
370 | $this->doTemplateAssignment($rows); | |
371 | ||
372 | $this->endPostProcess($rows); | |
373 | } | |
374 | ||
74cf4551 EM |
375 | /** |
376 | * @param $groupID | |
377 | */ | |
6a488035 TO |
378 | function add2group($groupID) { |
379 | if (is_numeric($groupID)) { | |
380 | ||
2f4c2f5d | 381 | $sql = " |
382 | {$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} | |
6a488035 | 383 | ORDER BY civicrm_contribution_total_amount_sum DESC |
93406a82 | 384 | ) as abc {$this->_groupLimit}"; |
6a488035 TO |
385 | $dao = CRM_Core_DAO::executeQuery($sql); |
386 | ||
387 | $contact_ids = array(); | |
388 | // Add resulting contacts to group | |
389 | while ($dao->fetch()) { | |
390 | $contact_ids[$dao->civicrm_contact_id] = $dao->civicrm_contact_id; | |
391 | } | |
392 | ||
393 | CRM_Contact_BAO_GroupContact::addContactsToGroup($contact_ids, $groupID); | |
394 | CRM_Core_Session::setStatus(ts("Listed contact(s) have been added to the selected group."), ts('Contacts Added'), 'success'); | |
395 | } | |
396 | } | |
397 | ||
74cf4551 EM |
398 | /** |
399 | * @param int $rowCount | |
400 | */ | |
6a488035 TO |
401 | function limit($rowCount = CRM_Report_Form::ROW_COUNT_LIMIT) { |
402 | // lets do the pager if in html mode | |
403 | $this->_limit = NULL; | |
74cf4551 | 404 | |
dbb4a0f9 PN |
405 | // CRM-14115, over-ride row count if rowCount is specified in URL |
406 | if ($this->_dashBoardRowCount) { | |
407 | $rowCount = $this->_dashBoardRowCount; | |
408 | } | |
6a488035 TO |
409 | if ($this->_outputMode == 'html' || $this->_outputMode == 'group') { |
410 | //replace only first occurence of SELECT | |
411 | $this->_select = preg_replace('/SELECT/', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select, 1); | |
412 | $pageId = CRM_Utils_Request::retrieve('crmPID', 'Integer', CRM_Core_DAO::$_nullObject); | |
413 | ||
414 | if (!$pageId && !empty($_POST) && isset($_POST['crmPID_B'])) { | |
415 | if (!isset($_POST['PagerBottomButton'])) { | |
416 | unset($_POST['crmPID_B']); | |
417 | } | |
418 | else { | |
419 | $pageId = max((int)@$_POST['crmPID_B'], 1); | |
420 | } | |
421 | } | |
422 | ||
423 | $pageId = $pageId ? $pageId : 1; | |
424 | $this->set(CRM_Utils_Pager::PAGE_ID, $pageId); | |
425 | $offset = ($pageId - 1) * $rowCount; | |
426 | ||
bf00d1b6 DL |
427 | $offset = CRM_Utils_Type::escape($offset, 'Int'); |
428 | $rowCount = CRM_Utils_Type::escape($rowCount, 'Int'); | |
429 | ||
6a488035 TO |
430 | $this->_limit = " LIMIT $offset, " . $rowCount; |
431 | } | |
432 | } | |
433 | ||
74cf4551 EM |
434 | /** |
435 | * @param $rows | |
436 | */ | |
6a488035 TO |
437 | function alterDisplay(&$rows) { |
438 | // custom code to alter rows | |
439 | ||
440 | $entryFound = FALSE; | |
441 | $rank = 1; | |
442 | if (!empty($rows)) { | |
443 | foreach ($rows as $rowNum => $row) { | |
444 | ||
445 | $rows[$rowNum]['civicrm_donor_rank'] = $rank++; | |
446 | // convert display name to links | |
447 | if (array_key_exists('civicrm_contact_display_name', $row) && | |
8cc574cf | 448 | array_key_exists('civicrm_contact_id', $row) && !empty($row['civicrm_contribution_currency'])) { |
6a488035 | 449 | $url = CRM_Report_Utils_Report::getNextUrl('contribute/detail', |
7a961f19 | 450 | 'reset=1&force=1&id_op=eq&id_value=' . $row['civicrm_contact_id'] . "¤cy_value=" . $row['civicrm_contribution_currency'], |
6a488035 TO |
451 | $this->_absoluteUrl, $this->_id, $this->_drilldownReport |
452 | ); | |
453 | $rows[$rowNum]['civicrm_contact_display_name_link'] = $url; | |
454 | $entryFound = TRUE; | |
455 | } | |
21d62de7 | 456 | $entryFound = $this->alterDisplayAddressFields($row, $rows, $rowNum, 'contribute/detail', 'List all contribution(s)') ? TRUE : $entryFound; |
6a488035 TO |
457 | |
458 | // skip looking further in rows, if first row itself doesn't | |
459 | // have the column we need | |
460 | if (!$entryFound) { | |
461 | break; | |
462 | } | |
463 | } | |
464 | } | |
465 | } | |
466 | } | |
467 |