3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
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 'type' => CRM_Utils_Type
::T_INT
,
101 'operatorType' => CRM_Report_Form
::OP_INT
,
103 'membership_type_id' =>
104 array('title' => ts('Membership Type'),
105 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
106 'options' => CRM_Member_PseudoConstant
::membershipType(),
109 array('title' => ts('Membership Status'),
110 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
111 'options' => CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label'),
117 array('title' => ts('Member Since'),
123 'membership_type_id' =>
125 'title' => 'Membership Type',
133 'dao' => 'CRM_Contact_DAO_Contact',
138 'no_display' => TRUE,
142 'title' => ts('Contact Type'),
144 'contact_sub_type' =>
146 'title' => ts('Contact SubType'),
150 'civicrm_contribution' =>
152 'dao' => 'CRM_Contribute_DAO_Contribution',
156 array('required' => TRUE,
157 'no_display' => TRUE,
160 array('title' => ts('Amount Statistics'),
163 array('sum' => ts('Total Payments Made'),
164 'count' => ts('Contribution Count'),
165 'avg' => ts('Average'),
172 array('title' => 'Currency',
173 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
174 'options' => CRM_Core_OptionGroup
::values('currencies_enabled'),
176 'type' => CRM_Utils_Type
::T_STRING
,
178 'contribution_status_id' =>
179 array('title' => ts('Contribution Status'),
180 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
181 'options' => CRM_Contribute_PseudoConstant
::contributionStatus(),
184 'grouping' => 'member-fields',
187 $this->_tagFilter
= TRUE;
189 // If we have a campaign, build out the relevant elements
190 if ($campaignEnabled && !empty($this->activeCampaigns
)) {
191 $this->_columns
['civicrm_membership']['fields']['campaign_id'] = array(
192 'title' => 'Campaign',
193 'default' => 'false',
195 $this->_columns
['civicrm_membership']['filters']['campaign_id'] = array('title' => ts('Campaign'),
196 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
197 'options' => $this->activeCampaigns
,
199 $this->_columns
['civicrm_membership']['grouping']['campaign_id'] = 'contri-fields';
200 $this->_columns
['civicrm_membership']['group_bys']['campaign_id'] = array('title' => ts('Campaign'));
204 $this->_groupFilter
= TRUE;
205 $this->_currencyColumn
= 'civicrm_contribution_currency';
206 parent
::__construct();
212 $this->_columnHeaders
= array();
213 $select[] = " COUNT( DISTINCT {$this->_aliases['civicrm_membership']}.id ) as civicrm_membership_member_count";
214 $select['joinDate'] = " {$this->_aliases['civicrm_membership']}.join_date as civicrm_membership_member_join_date";
215 $this->_columnHeaders
["civicrm_membership_member_join_date"] = array('title' => ts('Member Since'),
216 'type' => CRM_Utils_Type
::T_DATE
,
218 foreach ($this->_columns
as $tableName => $table) {
219 if (array_key_exists('group_bys', $table)) {
220 foreach ($table['group_bys'] as $fieldName => $field) {
221 if (CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys'])) {
223 switch (CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys_freq'])) {
225 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
227 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
228 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
229 $field['title'] = 'Week';
233 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start";
234 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
235 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
236 $field['title'] = 'Year';
240 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
241 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
242 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
243 $field['title'] = 'Month';
247 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
248 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
249 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
250 $field['title'] = 'Quarter';
253 if (CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys_freq'])) {
254 $this->_interval
= $field['title'];
255 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['title'] = $field['title'] . ' Beginning';
256 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
257 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params
['group_bys_freq'][$fieldName];
259 // just to make sure these values are transfered to rows.
260 // since we need that for calculation purpose,
261 // e.g making subtotals look nicer or graphs
262 $this->_columnHeaders
["{$tableName}_{$fieldName}_interval"] = array('no_display' => TRUE);
263 $this->_columnHeaders
["{$tableName}_{$fieldName}_subtotal"] = array('no_display' => TRUE);
271 if (array_key_exists('fields', $table)) {
272 foreach ($table['fields'] as $fieldName => $field) {
273 if (CRM_Utils_Array
::value('required', $field) ||
274 CRM_Utils_Array
::value($fieldName, $this->_params
['fields'])
277 // only include statistics columns if set
278 if (CRM_Utils_Array
::value('statistics', $field)) {
279 $this->_statFields
[] = 'civicrm_membership_member_count';
280 foreach ($field['statistics'] as $stat => $label) {
281 switch (strtolower($stat)) {
283 $select[] = "IFNULL(SUM({$field['dbAlias']}), 0) as {$tableName}_{$fieldName}_{$stat}";
284 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
285 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
286 $this->_statFields
[] = "{$tableName}_{$fieldName}_{$stat}";
290 $select[] = "COUNT({$field['dbAlias']}) as {$tableName}_{$fieldName}_{$stat}";
291 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
292 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
293 $this->_statFields
[] = "{$tableName}_{$fieldName}_{$stat}";
297 $select[] = "IFNULL(ROUND(AVG({$field['dbAlias']}),2), 0) as {$tableName}_{$fieldName}_{$stat}";
298 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
299 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
300 $this->_statFields
[] = "{$tableName}_{$fieldName}_{$stat}";
305 elseif ($fieldName == 'membership_type_id') {
306 if (!CRM_Utils_Array
::value('membership_type_id', $this->_params
['group_bys']) &&
307 CRM_Utils_Array
::value('join_date', $this->_params
['group_bys'])
309 $select[] = "GROUP_CONCAT(DISTINCT {$field['dbAlias']} ORDER BY {$field['dbAlias']} ) as {$tableName}_{$fieldName}";
312 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
314 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $field['title'];
315 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['operatorType'] = CRM_Utils_Array
::value('operatorType', $field);
318 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
319 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $field['title'];
320 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['operatorType'] = CRM_Utils_Array
::value('operatorType', $field);
325 $this->_columnHeaders
["civicrm_membership_member_count"] = array('title' => ts('Member Count'),
326 'type' => CRM_Utils_Type
::T_INT
,
329 //If grouping is availabled then remove join date from field
331 unset($select['joinDate']);
332 unset($this->_columnHeaders
["civicrm_membership_member_join_date"]);
334 $this->_select
= "SELECT " . implode(', ', $select) . " ";
339 FROM civicrm_membership {$this->_aliases['civicrm_membership']}
341 LEFT JOIN civicrm_contact {$this->_aliases['civicrm_contact']} ON ( {$this->_aliases['civicrm_membership']}.contact_id = {$this->_aliases['civicrm_contact']}.id )
343 LEFT JOIN civicrm_membership_status
344 ON ({$this->_aliases['civicrm_membership']}.status_id = civicrm_membership_status.id )
345 LEFT JOIN civicrm_membership_payment payment
346 ON ( {$this->_aliases['civicrm_membership']}.id = payment.membership_id )
347 LEFT JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']}
348 ON payment.contribution_id = {$this->_aliases['civicrm_contribution']}.id";
353 $this->_whereClauses
[] = "{$this->_aliases['civicrm_membership']}.is_test = 0";
358 $this->_groupBy
= "";
359 if (is_array($this->_params
['group_bys']) &&
360 !empty($this->_params
['group_bys'])
362 foreach ($this->_columns
as $tableName => $table) {
363 if (array_key_exists('group_bys', $table)) {
364 foreach ($table['group_bys'] as $fieldName => $field) {
365 if (CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys'])) {
366 if (CRM_Utils_Array
::value('chart', $field)) {
367 $this->assign('chartSupported', TRUE);
369 if (CRM_Utils_Array
::value('frequency', $table['group_bys'][$fieldName]) &&
370 CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys_freq'])
373 $append = "YEAR({$field['dbAlias']}),";
374 if (in_array(strtolower($this->_params
['group_bys_freq'][$fieldName]),
379 $this->_groupBy
[] = "$append {$this->_params['group_bys_freq'][$fieldName]}({$field['dbAlias']})";
383 $this->_groupBy
[] = $field['dbAlias'];
390 $this->_rollup
= ' WITH ROLLUP';
391 $this->_groupBy
= 'GROUP BY ' . implode(', ', $this->_groupBy
) . " {$this->_rollup} ";
394 $this->_groupBy
= "GROUP BY {$this->_aliases['civicrm_membership']}.join_date";
398 function statistics(&$rows) {
399 $statistics = parent
::statistics($rows);
401 SELECT COUNT({$this->_aliases['civicrm_contribution']}.total_amount ) as count,
402 IFNULL(SUM({$this->_aliases['civicrm_contribution']}.total_amount ), 0) as amount,
403 IFNULL(ROUND(AVG({$this->_aliases['civicrm_contribution']}.total_amount), 2),0) as avg,
404 COUNT( DISTINCT {$this->_aliases['civicrm_membership']}.id ) as memberCount,
405 {$this->_aliases['civicrm_contribution']}.currency as currency
408 $sql = "{$select} {$this->_from} {$this->_where}
409 GROUP BY {$this->_aliases['civicrm_contribution']}.currency
412 $dao = CRM_Core_DAO
::executeQuery($sql);
414 $totalAmount = $average = array();
415 $count = $memberCount = 0;
416 while ($dao->fetch()) {
417 $totalAmount[] = CRM_Utils_Money
::format($dao->amount
, $dao->currency
)."(".$dao->count
.")";
418 $average[] = CRM_Utils_Money
::format($dao->avg
, $dao->currency
);
419 $count +
= $dao->count
;
420 $memberCount +
= $dao->memberCount
;
422 $statistics['counts']['amount'] = array(
423 'title' => ts('Total Amount'),
424 'value' => implode(', ', $totalAmount),
425 'type' => CRM_Utils_Type
::T_STRING
,
427 $statistics['counts']['count'] = array(
428 'title' => ts('Total Donations'),
431 $statistics['counts']['memberCount'] = array(
432 'title' => ts('Total Members'),
433 'value' => $memberCount,
435 $statistics['counts']['avg'] = array(
436 'title' => ts('Average'),
437 'value' => implode(', ', $average),
438 'type' => CRM_Utils_Type
::T_STRING
,
441 if (!(int)$statistics['counts']['amount']['value']) {
442 //if total amount is zero then hide Chart Options
443 $this->assign('chartSupported', FALSE);
449 function postProcess() {
450 parent
::postProcess();
453 function buildChart(&$rows) {
454 $graphRows = array();
456 $membershipTypeValues = CRM_Member_PseudoConstant
::membershipType();
457 $isMembershipType = CRM_Utils_Array
::value('membership_type_id', $this->_params
['group_bys']);
458 $isJoiningDate = CRM_Utils_Array
::value('join_date', $this->_params
['group_bys']);
459 if (CRM_Utils_Array
::value('charts', $this->_params
)) {
460 foreach ($rows as $key => $row) {
461 if (!($row['civicrm_membership_join_date_subtotal'] &&
462 $row['civicrm_membership_membership_type_id']
466 if ($isMembershipType) {
467 $join_date = CRM_Utils_Array
::value('civicrm_membership_join_date_start', $row);
468 $displayInterval = CRM_Utils_Array
::value('civicrm_membership_join_date_interval', $row);
470 list($year, $month) = explode('-', $join_date);
472 if (CRM_Utils_Array
::value('civicrm_membership_join_date_subtotal', $row)) {
474 switch ($this->_interval
) {
476 $displayRange = $displayInterval . ' ' . $year;
480 $displayRange = 'Quarter ' . $displayInterval . ' of ' . $year;
484 $displayRange = 'Week ' . $displayInterval . ' of ' . $year;
488 $displayRange = $year;
491 $membershipType = $displayRange . "-" . $membershipTypeValues[$row['civicrm_membership_membership_type_id']];
495 $membershipType = $membershipTypeValues[$row['civicrm_membership_membership_type_id']];
498 $interval[$membershipType] = $membershipType;
499 $display[$membershipType] = $row['civicrm_contribution_total_amount_sum'];
502 $graphRows['receive_date'][] = CRM_Utils_Array
::value('civicrm_membership_join_date_start', $row);
503 $graphRows[$this->_interval
][] = CRM_Utils_Array
::value('civicrm_membership_join_date_interval', $row);
504 $graphRows['value'][] = $row['civicrm_contribution_total_amount_sum'];
510 if ($isMembershipType) {
511 $graphRows['value'] = $display;
513 'legend' => 'Membership Summary',
514 'xname' => 'Member Since / Member Type',
517 CRM_Utils_OpenFlashChart
::reportChart($graphRows, $this->_params
['charts'], $interval, $chartInfo);
520 CRM_Utils_OpenFlashChart
::chart($graphRows, $this->_params
['charts'], $this->_interval
);
523 $this->assign('chartType', $this->_params
['charts']);
526 function alterDisplay(&$rows) {
527 // custom code to alter rows
529 foreach ($rows as $rowNum => $row) {
530 // make count columns point to detail report
531 if (CRM_Utils_Array
::value('join_date', $this->_params
['group_bys']) &&
532 CRM_Utils_Array
::value('civicrm_membership_join_date_start', $row) &&
533 $row['civicrm_membership_join_date_start'] &&
534 $row['civicrm_membership_join_date_subtotal']
537 $dateStart = CRM_Utils_Date
::customFormat($row['civicrm_membership_join_date_start'], '%Y%m%d');
538 $endDate = new DateTime($dateStart);
541 list($dateEnd['Y'], $dateEnd['M'], $dateEnd['d']) = explode(':', $endDate->format('Y:m:d'));
543 switch (strtolower($this->_params
['group_bys_freq']['join_date'])) {
545 $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'] +
1,
546 $dateEnd['d'] - 1, $dateEnd['Y']
551 $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'],
552 $dateEnd['d'] - 1, $dateEnd['Y'] +
1
557 $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'],
558 $dateEnd['d'] +
6, $dateEnd['Y']
563 $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'] +
3,
564 $dateEnd['d'] - 1, $dateEnd['Y']
569 if (CRM_Utils_Array
::value('membership_type_id', $this->_params
['group_bys']) &&
570 $typeID = $row['civicrm_membership_membership_type_id']
572 $typeUrl = "&tid_op=in&tid_value={$typeID}";
575 if (!empty($this->_params
['status_id_value'])) {
576 $statusUrl = "&sid_op=in&sid_value=" . implode(",", $this->_params
['status_id_value']);
578 $url = CRM_Report_Utils_Report
::getNextUrl('member/detail',
579 "reset=1&force=1&join_date_from={$dateStart}&join_date_to={$dateEnd}{$typeUrl}{$statusUrl}",
580 $this->_absoluteUrl
, $this->_id
, $this->_drilldownReport
582 $row['civicrm_membership_join_date_start'] = CRM_Utils_Date
::format($row['civicrm_membership_join_date_start']);
583 $rows[$rowNum]['civicrm_membership_join_date_start_link'] = $url;
584 $rows[$rowNum]['civicrm_membership_join_date_start_hover'] = ts("Lists Summary of Memberships for this date unit.");
589 // handle Membership Types
590 if (array_key_exists('civicrm_membership_membership_type_id', $row)) {
591 if ($value = $row['civicrm_membership_membership_type_id']) {
592 $value = explode(',', $value);
593 foreach ($value as $key => $id) {
594 $value[$key] = CRM_Member_PseudoConstant
::membershipType($id, FALSE);
596 $rows[$rowNum]['civicrm_membership_membership_type_id'] = implode(' , ', $value);
601 // make subtotals look nicer
602 if (array_key_exists('civicrm_membership_join_date_subtotal', $row) &&
603 !$row['civicrm_membership_join_date_subtotal']
605 $this->fixSubTotalDisplay($rows[$rowNum], $this->_statFields
);
608 elseif (array_key_exists('civicrm_membership_join_date_subtotal', $row) &&
609 $row['civicrm_membership_join_date_subtotal'] &&
610 !$row['civicrm_membership_membership_type_id']
612 $this->fixSubTotalDisplay($rows[$rowNum], $this->_statFields
, FALSE);
613 $rows[$rowNum]['civicrm_membership_membership_type_id'] = '<b>SubTotal</b>';
618 // If using campaigns, convert campaign_id to campaign title
619 if (array_key_exists('civicrm_membership_campaign_id', $row)) {
620 if ($value = $row['civicrm_membership_campaign_id']) {
621 $rows[$rowNum]['civicrm_membership_campaign_id'] = $this->activeCampaigns
[$value];
626 // skip looking further in rows, if first row itself doesn't
627 // have the column we need