3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
35 class CRM_Report_Form_Member_Summary
extends CRM_Report_Form
{
37 protected $_summary = NULL;
38 protected $_interval = NULL;
39 protected $_charts = array(
41 'barChart' => 'Bar Chart',
42 'pieChart' => 'Pie Chart',
44 protected $_add2groupSupported = FALSE;
46 protected $_customGroupExtends = array('Membership');
47 protected $_customGroupGroupBy = FALSE;
48 public $_drilldownReport = array('member/detail' => 'Link to Detail Report');
50 function __construct() {
52 // UI for selecting columns to appear in the report list
53 // Array containing the columns, group_bys and filters build and provided to Form
55 // Check if CiviCampaign is a) enabled and b) has active campaigns
56 $config = CRM_Core_Config
::singleton();
57 $campaignEnabled = in_array("CiviCampaign", $config->enableComponents
);
58 if ($campaignEnabled) {
59 $getCampaigns = CRM_Campaign_BAO_Campaign
::getPermissionedCampaigns(NULL, NULL, TRUE, FALSE, TRUE);
60 $this->activeCampaigns
= $getCampaigns['campaigns'];
61 asort($this->activeCampaigns
);
64 $this->_columns
= array(
65 'civicrm_membership' =>
67 'dao' => 'CRM_Member_DAO_MembershipType',
68 'grouping' => 'member-fields',
71 'membership_type_id' =>
73 'title' => 'Membership Type',
80 array('title' => ts('Member Since'),
81 'type' => CRM_Utils_Type
::T_DATE
,
82 'operatorType' => CRM_Report_Form
::OP_DATE
,
84 'membership_start_date' =>
86 'name' => 'start_date',
87 'title' => ts('Membership Start Date'),
88 'type' => CRM_Utils_Type
::T_DATE
,
89 'operatorType' => CRM_Report_Form
::OP_DATE
,
91 'membership_end_date' =>
94 'title' => ts('Membership End Date'),
95 'type' => CRM_Utils_Type
::T_DATE
,
96 'operatorType' => CRM_Report_Form
::OP_DATE
,
98 'owner_membership_id' =>
99 array('title' => ts('Membership Owner ID'),
100 'operatorType' => CRM_Report_Form
::OP_INT
,
102 'membership_type_id' =>
103 array('title' => ts('Membership Type'),
104 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
105 'options' => CRM_Member_PseudoConstant
::membershipType(),
108 array('title' => ts('Membership Status'),
109 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
110 'options' => CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label'),
116 array('title' => ts('Member Since'),
122 'membership_type_id' =>
124 'title' => 'Membership Type',
132 'dao' => 'CRM_Contact_DAO_Contact',
137 'no_display' => TRUE,
141 'civicrm_contribution' =>
143 'dao' => 'CRM_Contribute_DAO_Contribution',
147 array('required' => TRUE,
148 'no_display' => TRUE,
151 array('title' => ts('Amount Statistics'),
154 array('sum' => ts('Total Payments Made'),
155 'count' => ts('Contribution Count'),
156 'avg' => ts('Average'),
163 array('title' => 'Currency',
164 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
165 'options' => CRM_Core_OptionGroup
::values('currencies_enabled'),
167 'type' => CRM_Utils_Type
::T_STRING
,
169 'contribution_status_id' =>
170 array('title' => ts('Contribution Status'),
171 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
172 'options' => CRM_Contribute_PseudoConstant
::contributionStatus(),
175 'grouping' => 'member-fields',
178 $this->_tagFilter
= TRUE;
180 // If we have a campaign, build out the relevant elements
181 if ($campaignEnabled && !empty($this->activeCampaigns
)) {
182 $this->_columns
['civicrm_membership']['fields']['campaign_id'] = array(
183 'title' => 'Campaign',
184 'default' => 'false',
186 $this->_columns
['civicrm_membership']['filters']['campaign_id'] = array('title' => ts('Campaign'),
187 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
188 'options' => $this->activeCampaigns
,
190 $this->_columns
['civicrm_membership']['grouping']['campaign_id'] = 'contri-fields';
191 $this->_columns
['civicrm_membership']['group_bys']['campaign_id'] = array('title' => ts('Campaign'));
195 $this->_groupFilter
= TRUE;
196 $this->_currencyColumn
= 'civicrm_contribution_currency';
197 parent
::__construct();
203 $this->_columnHeaders
= array();
204 $select[] = " COUNT( DISTINCT {$this->_aliases['civicrm_membership']}.id ) as civicrm_membership_member_count";
205 $select['joinDate'] = " {$this->_aliases['civicrm_membership']}.join_date as civicrm_membership_member_join_date";
206 $this->_columnHeaders
["civicrm_membership_member_join_date"] = array('title' => ts('Member Since'),
207 'type' => CRM_Utils_Type
::T_DATE
,
209 foreach ($this->_columns
as $tableName => $table) {
210 if (array_key_exists('group_bys', $table)) {
211 foreach ($table['group_bys'] as $fieldName => $field) {
212 if (CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys'])) {
214 switch (CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys_freq'])) {
216 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
218 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
219 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
220 $field['title'] = 'Week';
224 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start";
225 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
226 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
227 $field['title'] = 'Year';
231 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
232 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
233 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
234 $field['title'] = 'Month';
238 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
239 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
240 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
241 $field['title'] = 'Quarter';
244 if (CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys_freq'])) {
245 $this->_interval
= $field['title'];
246 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['title'] = $field['title'] . ' Beginning';
247 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
248 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params
['group_bys_freq'][$fieldName];
250 // just to make sure these values are transfered to rows.
251 // since we need that for calculation purpose,
252 // e.g making subtotals look nicer or graphs
253 $this->_columnHeaders
["{$tableName}_{$fieldName}_interval"] = array('no_display' => TRUE);
254 $this->_columnHeaders
["{$tableName}_{$fieldName}_subtotal"] = array('no_display' => TRUE);
262 if (array_key_exists('fields', $table)) {
263 foreach ($table['fields'] as $fieldName => $field) {
264 if (CRM_Utils_Array
::value('required', $field) ||
265 CRM_Utils_Array
::value($fieldName, $this->_params
['fields'])
268 // only include statistics columns if set
269 if (CRM_Utils_Array
::value('statistics', $field)) {
270 $this->_statFields
[] = 'civicrm_membership_member_count';
271 foreach ($field['statistics'] as $stat => $label) {
272 switch (strtolower($stat)) {
274 $select[] = "IFNULL(SUM({$field['dbAlias']}), 0) as {$tableName}_{$fieldName}_{$stat}";
275 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
276 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
277 $this->_statFields
[] = "{$tableName}_{$fieldName}_{$stat}";
281 $select[] = "COUNT({$field['dbAlias']}) as {$tableName}_{$fieldName}_{$stat}";
282 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
283 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
284 $this->_statFields
[] = "{$tableName}_{$fieldName}_{$stat}";
288 $select[] = "IFNULL(ROUND(AVG({$field['dbAlias']}),2), 0) as {$tableName}_{$fieldName}_{$stat}";
289 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
290 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
291 $this->_statFields
[] = "{$tableName}_{$fieldName}_{$stat}";
296 elseif ($fieldName == 'membership_type_id') {
297 if (!CRM_Utils_Array
::value('membership_type_id', $this->_params
['group_bys']) &&
298 CRM_Utils_Array
::value('join_date', $this->_params
['group_bys'])
300 $select[] = "GROUP_CONCAT(DISTINCT {$field['dbAlias']} ORDER BY {$field['dbAlias']} ) as {$tableName}_{$fieldName}";
303 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
305 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $field['title'];
306 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['operatorType'] = CRM_Utils_Array
::value('operatorType', $field);
309 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
310 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $field['title'];
311 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['operatorType'] = CRM_Utils_Array
::value('operatorType', $field);
316 $this->_columnHeaders
["civicrm_membership_member_count"] = array('title' => ts('Member Count'),
317 'type' => CRM_Utils_Type
::T_INT
,
320 //If grouping is availabled then remove join date from field
322 unset($select['joinDate']);
323 unset($this->_columnHeaders
["civicrm_membership_member_join_date"]);
325 $this->_select
= "SELECT " . implode(', ', $select) . " ";
330 FROM civicrm_membership {$this->_aliases['civicrm_membership']}
332 LEFT JOIN civicrm_contact {$this->_aliases['civicrm_contact']} ON ( {$this->_aliases['civicrm_membership']}.contact_id = {$this->_aliases['civicrm_contact']}.id )
334 LEFT JOIN civicrm_membership_status
335 ON ({$this->_aliases['civicrm_membership']}.status_id = civicrm_membership_status.id )
336 LEFT JOIN civicrm_membership_payment payment
337 ON ( {$this->_aliases['civicrm_membership']}.id = payment.membership_id )
338 LEFT JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']}
339 ON payment.contribution_id = {$this->_aliases['civicrm_contribution']}.id";
345 foreach ($this->_columns
as $tableName => $table) {
346 if (array_key_exists('filters', $table)) {
347 foreach ($table['filters'] as $fieldName => $field) {
350 if ($field['operatorType'] & CRM_Utils_Type
::T_DATE
) {
351 $relative = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
);
352 $from = CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
);
353 $to = CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
);
355 if ($relative ||
$from ||
$to) {
356 $clause = $this->dateClause($field['name'], $relative, $from, $to, $field['type']);
360 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
362 $clause = $this->whereClause($field,
364 CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
),
365 CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
),
366 CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
)
370 if (!empty($clause)) {
371 $clauses[$fieldName] = $clause;
377 if (!empty($clauses)) {
378 $this->_where
= "WHERE {$this->_aliases['civicrm_membership']}.is_test = 0 AND " . implode(' AND ', $clauses);
381 $this->_where
= "WHERE {$this->_aliases['civicrm_membership']}.is_test = 0";
386 $this->_groupBy
= "";
387 if (is_array($this->_params
['group_bys']) &&
388 !empty($this->_params
['group_bys'])
390 foreach ($this->_columns
as $tableName => $table) {
391 if (array_key_exists('group_bys', $table)) {
392 foreach ($table['group_bys'] as $fieldName => $field) {
393 if (CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys'])) {
394 if (CRM_Utils_Array
::value('chart', $field)) {
395 $this->assign('chartSupported', TRUE);
397 if (CRM_Utils_Array
::value('frequency', $table['group_bys'][$fieldName]) &&
398 CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys_freq'])
401 $append = "YEAR({$field['dbAlias']}),";
402 if (in_array(strtolower($this->_params
['group_bys_freq'][$fieldName]),
407 $this->_groupBy
[] = "$append {$this->_params['group_bys_freq'][$fieldName]}({$field['dbAlias']})";
411 $this->_groupBy
[] = $field['dbAlias'];
418 $this->_rollup
= ' WITH ROLLUP';
419 $this->_groupBy
= 'GROUP BY ' . implode(', ', $this->_groupBy
) . " {$this->_rollup} ";
422 $this->_groupBy
= "GROUP BY {$this->_aliases['civicrm_membership']}.join_date";
426 function statistics(&$rows) {
427 $statistics = parent
::statistics($rows);
429 SELECT COUNT({$this->_aliases['civicrm_contribution']}.total_amount ) as count,
430 IFNULL(SUM({$this->_aliases['civicrm_contribution']}.total_amount ), 0) as amount,
431 IFNULL(ROUND(AVG({$this->_aliases['civicrm_contribution']}.total_amount), 2),0) as avg,
432 COUNT( DISTINCT {$this->_aliases['civicrm_membership']}.id ) as memberCount,
433 {$this->_aliases['civicrm_contribution']}.currency as currency
436 $sql = "{$select} {$this->_from} {$this->_where}
437 GROUP BY {$this->_aliases['civicrm_contribution']}.currency
440 $dao = CRM_Core_DAO
::executeQuery($sql);
442 $totalAmount = $average = array();
443 $count = $memberCount = 0;
444 while ($dao->fetch()) {
445 $totalAmount[] = CRM_Utils_Money
::format($dao->amount
, $dao->currency
)."(".$dao->count
.")";
446 $average[] = CRM_Utils_Money
::format($dao->avg
, $dao->currency
);
447 $count +
= $dao->count
;
448 $memberCount +
= $dao->memberCount
;
450 $statistics['counts']['amount'] = array(
451 'title' => ts('Total Amount'),
452 'value' => implode(', ', $totalAmount),
453 'type' => CRM_Utils_Type
::T_STRING
,
455 $statistics['counts']['count'] = array(
456 'title' => ts('Total Donations'),
459 $statistics['counts']['memberCount'] = array(
460 'title' => ts('Total Members'),
461 'value' => $memberCount,
463 $statistics['counts']['avg'] = array(
464 'title' => ts('Average'),
465 'value' => implode(', ', $average),
466 'type' => CRM_Utils_Type
::T_STRING
,
469 if (!(int)$statistics['counts']['amount']['value']) {
470 //if total amount is zero then hide Chart Options
471 $this->assign('chartSupported', FALSE);
477 function postProcess() {
478 parent
::postProcess();
481 function buildChart(&$rows) {
482 $graphRows = array();
484 $membershipTypeValues = CRM_Member_PseudoConstant
::membershipType();
485 $isMembershipType = CRM_Utils_Array
::value('membership_type_id', $this->_params
['group_bys']);
486 $isJoiningDate = CRM_Utils_Array
::value('join_date', $this->_params
['group_bys']);
487 if (CRM_Utils_Array
::value('charts', $this->_params
)) {
488 foreach ($rows as $key => $row) {
489 if (!($row['civicrm_membership_join_date_subtotal'] &&
490 $row['civicrm_membership_membership_type_id']
494 if ($isMembershipType) {
495 $join_date = CRM_Utils_Array
::value('civicrm_membership_join_date_start', $row);
496 $displayInterval = CRM_Utils_Array
::value('civicrm_membership_join_date_interval', $row);
498 list($year, $month) = explode('-', $join_date);
500 if (CRM_Utils_Array
::value('civicrm_membership_join_date_subtotal', $row)) {
502 switch ($this->_interval
) {
504 $displayRange = $displayInterval . ' ' . $year;
508 $displayRange = 'Quarter ' . $displayInterval . ' of ' . $year;
512 $displayRange = 'Week ' . $displayInterval . ' of ' . $year;
516 $displayRange = $year;
519 $membershipType = $displayRange . "-" . $membershipTypeValues[$row['civicrm_membership_membership_type_id']];
523 $membershipType = $membershipTypeValues[$row['civicrm_membership_membership_type_id']];
526 $interval[$membershipType] = $membershipType;
527 $display[$membershipType] = $row['civicrm_contribution_total_amount_sum'];
530 $graphRows['receive_date'][] = CRM_Utils_Array
::value('civicrm_membership_join_date_start', $row);
531 $graphRows[$this->_interval
][] = CRM_Utils_Array
::value('civicrm_membership_join_date_interval', $row);
532 $graphRows['value'][] = $row['civicrm_contribution_total_amount_sum'];
538 if ($isMembershipType) {
539 $graphRows['value'] = $display;
541 'legend' => 'Membership Summary',
542 'xname' => 'Member Since / Member Type',
545 CRM_Utils_OpenFlashChart
::reportChart($graphRows, $this->_params
['charts'], $interval, $chartInfo);
548 CRM_Utils_OpenFlashChart
::chart($graphRows, $this->_params
['charts'], $this->_interval
);
551 $this->assign('chartType', $this->_params
['charts']);
554 function alterDisplay(&$rows) {
555 // custom code to alter rows
557 foreach ($rows as $rowNum => $row) {
558 // make count columns point to detail report
559 if (CRM_Utils_Array
::value('join_date', $this->_params
['group_bys']) &&
560 CRM_Utils_Array
::value('civicrm_membership_join_date_start', $row) &&
561 $row['civicrm_membership_join_date_start'] &&
562 $row['civicrm_membership_join_date_subtotal']
565 $dateStart = CRM_Utils_Date
::customFormat($row['civicrm_membership_join_date_start'], '%Y%m%d');
566 $endDate = new DateTime($dateStart);
569 list($dateEnd['Y'], $dateEnd['M'], $dateEnd['d']) = explode(':', $endDate->format('Y:m:d'));
571 switch (strtolower($this->_params
['group_bys_freq']['join_date'])) {
573 $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'] +
1,
574 $dateEnd['d'] - 1, $dateEnd['Y']
579 $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'],
580 $dateEnd['d'] - 1, $dateEnd['Y'] +
1
585 $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'],
586 $dateEnd['d'] +
6, $dateEnd['Y']
591 $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'] +
3,
592 $dateEnd['d'] - 1, $dateEnd['Y']
597 if (CRM_Utils_Array
::value('membership_type_id', $this->_params
['group_bys']) &&
598 $typeID = $row['civicrm_membership_membership_type_id']
600 $typeUrl = "&tid_op=in&tid_value={$typeID}";
603 if (!empty($this->_params
['status_id_value'])) {
604 $statusUrl = "&sid_op=in&sid_value=" . implode(",", $this->_params
['status_id_value']);
606 $url = CRM_Report_Utils_Report
::getNextUrl('member/detail',
607 "reset=1&force=1&join_date_from={$dateStart}&join_date_to={$dateEnd}{$typeUrl}{$statusUrl}",
608 $this->_absoluteUrl
, $this->_id
, $this->_drilldownReport
610 $row['civicrm_membership_join_date_start'] = CRM_Utils_Date
::format($row['civicrm_membership_join_date_start']);
611 $rows[$rowNum]['civicrm_membership_join_date_start_link'] = $url;
612 $rows[$rowNum]['civicrm_membership_join_date_start_hover'] = ts("Lists Summary of Memberships for this date unit.");
617 // handle Membership Types
618 if (array_key_exists('civicrm_membership_membership_type_id', $row)) {
619 if ($value = $row['civicrm_membership_membership_type_id']) {
620 $value = explode(',', $value);
621 foreach ($value as $key => $id) {
622 $value[$key] = CRM_Member_PseudoConstant
::membershipType($id, FALSE);
624 $rows[$rowNum]['civicrm_membership_membership_type_id'] = implode(' , ', $value);
629 // make subtotals look nicer
630 if (array_key_exists('civicrm_membership_join_date_subtotal', $row) &&
631 !$row['civicrm_membership_join_date_subtotal']
633 $this->fixSubTotalDisplay($rows[$rowNum], $this->_statFields
);
636 elseif (array_key_exists('civicrm_membership_join_date_subtotal', $row) &&
637 $row['civicrm_membership_join_date_subtotal'] &&
638 !$row['civicrm_membership_membership_type_id']
640 $this->fixSubTotalDisplay($rows[$rowNum], $this->_statFields
, FALSE);
641 $rows[$rowNum]['civicrm_membership_membership_type_id'] = '<b>SubTotal</b>';
646 // If using campaigns, convert campaign_id to campaign title
647 if (array_key_exists('civicrm_membership_campaign_id', $row)) {
648 if ($value = $row['civicrm_membership_campaign_id']) {
649 $rows[$rowNum]['civicrm_membership_campaign_id'] = $this->activeCampaigns
[$value];
654 // skip looking further in rows, if first row itself doesn't
655 // have the column we need