3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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 (!empty($this->_params
['group_bys'][$fieldName])) {
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 (!empty($this->_params
['group_bys_freq'][$fieldName])) {
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 (!empty($field['required']) ||
!empty($this->_params
['fields'][$fieldName])) {
275 // only include statistics columns if set
276 if (!empty($field['statistics'])) {
277 $this->_statFields
[] = 'civicrm_membership_member_count';
278 foreach ($field['statistics'] as $stat => $label) {
279 switch (strtolower($stat)) {
281 $select[] = "IFNULL(SUM({$field['dbAlias']}), 0) as {$tableName}_{$fieldName}_{$stat}";
282 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
283 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
284 $this->_statFields
[] = "{$tableName}_{$fieldName}_{$stat}";
288 $select[] = "COUNT({$field['dbAlias']}) as {$tableName}_{$fieldName}_{$stat}";
289 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
290 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
291 $this->_statFields
[] = "{$tableName}_{$fieldName}_{$stat}";
295 $select[] = "IFNULL(ROUND(AVG({$field['dbAlias']}),2), 0) as {$tableName}_{$fieldName}_{$stat}";
296 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
297 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
298 $this->_statFields
[] = "{$tableName}_{$fieldName}_{$stat}";
303 elseif ($fieldName == 'membership_type_id') {
304 if (empty($this->_params
['group_bys']['membership_type_id']) && !empty($this->_params
['group_bys']['join_date'])) {
305 $select[] = "GROUP_CONCAT(DISTINCT {$field['dbAlias']} ORDER BY {$field['dbAlias']} ) as {$tableName}_{$fieldName}";
308 $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);
314 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
315 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $field['title'];
316 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['operatorType'] = CRM_Utils_Array
::value('operatorType', $field);
321 $this->_columnHeaders
["civicrm_membership_member_count"] = array('title' => ts('Member Count'),
322 'type' => CRM_Utils_Type
::T_INT
,
325 //If grouping is availabled then remove join date from field
327 unset($select['joinDate']);
328 unset($this->_columnHeaders
["civicrm_membership_member_join_date"]);
330 $this->_select
= "SELECT " . implode(', ', $select) . " ";
335 FROM civicrm_membership {$this->_aliases['civicrm_membership']}
337 LEFT JOIN civicrm_contact {$this->_aliases['civicrm_contact']} ON ( {$this->_aliases['civicrm_membership']}.contact_id = {$this->_aliases['civicrm_contact']}.id )
339 LEFT JOIN civicrm_membership_status
340 ON ({$this->_aliases['civicrm_membership']}.status_id = civicrm_membership_status.id )
341 LEFT JOIN civicrm_membership_payment payment
342 ON ( {$this->_aliases['civicrm_membership']}.id = payment.membership_id )
343 LEFT JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']}
344 ON payment.contribution_id = {$this->_aliases['civicrm_contribution']}.id";
349 $this->_whereClauses
[] = "{$this->_aliases['civicrm_membership']}.is_test = 0 AND
350 {$this->_aliases['civicrm_contact']}.is_deleted = 0";
355 $this->_groupBy
= "";
356 if (is_array($this->_params
['group_bys']) &&
357 !empty($this->_params
['group_bys'])
359 foreach ($this->_columns
as $tableName => $table) {
360 if (array_key_exists('group_bys', $table)) {
361 foreach ($table['group_bys'] as $fieldName => $field) {
362 if (!empty($this->_params
['group_bys'][$fieldName])) {
363 if (!empty($field['chart'])) {
364 $this->assign('chartSupported', TRUE);
366 if (!empty($table['group_bys'][$fieldName]['frequency']) && !empty($this->_params
['group_bys_freq'][$fieldName])) {
368 $append = "YEAR({$field['dbAlias']}),";
369 if (in_array(strtolower($this->_params
['group_bys_freq'][$fieldName]),
374 $this->_groupBy
[] = "$append {$this->_params['group_bys_freq'][$fieldName]}({$field['dbAlias']})";
378 $this->_groupBy
[] = $field['dbAlias'];
385 $this->_rollup
= ' WITH ROLLUP';
386 $this->_groupBy
= 'GROUP BY ' . implode(', ', $this->_groupBy
) . " {$this->_rollup} ";
389 $this->_groupBy
= "GROUP BY {$this->_aliases['civicrm_membership']}.join_date";
393 function statistics(&$rows) {
394 $statistics = parent
::statistics($rows);
396 SELECT COUNT({$this->_aliases['civicrm_contribution']}.total_amount ) as count,
397 IFNULL(SUM({$this->_aliases['civicrm_contribution']}.total_amount ), 0) as amount,
398 IFNULL(ROUND(AVG({$this->_aliases['civicrm_contribution']}.total_amount), 2),0) as avg,
399 COUNT( DISTINCT {$this->_aliases['civicrm_membership']}.id ) as memberCount,
400 {$this->_aliases['civicrm_contribution']}.currency as currency
403 $sql = "{$select} {$this->_from} {$this->_where}
404 GROUP BY {$this->_aliases['civicrm_contribution']}.currency
407 $dao = CRM_Core_DAO
::executeQuery($sql);
409 $totalAmount = $average = array();
410 $count = $memberCount = 0;
411 while ($dao->fetch()) {
412 $totalAmount[] = CRM_Utils_Money
::format($dao->amount
, $dao->currency
)."(".$dao->count
.")";
413 $average[] = CRM_Utils_Money
::format($dao->avg
, $dao->currency
);
414 $count +
= $dao->count
;
415 $memberCount +
= $dao->memberCount
;
417 $statistics['counts']['amount'] = array(
418 'title' => ts('Total Amount'),
419 'value' => implode(', ', $totalAmount),
420 'type' => CRM_Utils_Type
::T_STRING
,
422 $statistics['counts']['count'] = array(
423 'title' => ts('Total Donations'),
426 $statistics['counts']['memberCount'] = array(
427 'title' => ts('Total Members'),
428 'value' => $memberCount,
430 $statistics['counts']['avg'] = array(
431 'title' => ts('Average'),
432 'value' => implode(', ', $average),
433 'type' => CRM_Utils_Type
::T_STRING
,
436 if (!(int)$statistics['counts']['amount']['value']) {
437 //if total amount is zero then hide Chart Options
438 $this->assign('chartSupported', FALSE);
444 function postProcess() {
445 parent
::postProcess();
448 function buildChart(&$rows) {
449 $graphRows = array();
451 $membershipTypeValues = CRM_Member_PseudoConstant
::membershipType();
452 $isMembershipType = CRM_Utils_Array
::value('membership_type_id', $this->_params
['group_bys']);
453 $isJoiningDate = CRM_Utils_Array
::value('join_date', $this->_params
['group_bys']);
454 if (!empty($this->_params
['charts'])) {
455 foreach ($rows as $key => $row) {
456 if (!($row['civicrm_membership_join_date_subtotal'] &&
457 $row['civicrm_membership_membership_type_id']
461 if ($isMembershipType) {
462 $join_date = CRM_Utils_Array
::value('civicrm_membership_join_date_start', $row);
463 $displayInterval = CRM_Utils_Array
::value('civicrm_membership_join_date_interval', $row);
465 list($year, $month) = explode('-', $join_date);
467 if (!empty($row['civicrm_membership_join_date_subtotal'])) {
469 switch ($this->_interval
) {
471 $displayRange = $displayInterval . ' ' . $year;
475 $displayRange = 'Quarter ' . $displayInterval . ' of ' . $year;
479 $displayRange = 'Week ' . $displayInterval . ' of ' . $year;
483 $displayRange = $year;
486 $membershipType = $displayRange . "-" . $membershipTypeValues[$row['civicrm_membership_membership_type_id']];
490 $membershipType = $membershipTypeValues[$row['civicrm_membership_membership_type_id']];
493 $interval[$membershipType] = $membershipType;
494 $display[$membershipType] = $row['civicrm_contribution_total_amount_sum'];
497 $graphRows['receive_date'][] = CRM_Utils_Array
::value('civicrm_membership_join_date_start', $row);
498 $graphRows[$this->_interval
][] = CRM_Utils_Array
::value('civicrm_membership_join_date_interval', $row);
499 $graphRows['value'][] = $row['civicrm_contribution_total_amount_sum'];
505 if ($isMembershipType) {
506 $graphRows['value'] = $display;
508 'legend' => 'Membership Summary',
509 'xname' => 'Member Since / Member Type',
512 CRM_Utils_OpenFlashChart
::reportChart($graphRows, $this->_params
['charts'], $interval, $chartInfo);
515 CRM_Utils_OpenFlashChart
::chart($graphRows, $this->_params
['charts'], $this->_interval
);
518 $this->assign('chartType', $this->_params
['charts']);
521 function alterDisplay(&$rows) {
522 // custom code to alter rows
524 foreach ($rows as $rowNum => $row) {
525 // make count columns point to detail report
526 if (!empty($this->_params
['group_bys']['join_date']) && !empty($row['civicrm_membership_join_date_start']) &&
527 $row['civicrm_membership_join_date_start'] &&
528 $row['civicrm_membership_join_date_subtotal']
531 $dateStart = CRM_Utils_Date
::customFormat($row['civicrm_membership_join_date_start'], '%Y%m%d');
532 $endDate = new DateTime($dateStart);
535 list($dateEnd['Y'], $dateEnd['M'], $dateEnd['d']) = explode(':', $endDate->format('Y:m:d'));
537 switch (strtolower($this->_params
['group_bys_freq']['join_date'])) {
539 $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'] +
1,
540 $dateEnd['d'] - 1, $dateEnd['Y']
545 $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'],
546 $dateEnd['d'] - 1, $dateEnd['Y'] +
1
551 $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'],
552 $dateEnd['d'] +
6, $dateEnd['Y']
557 $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'] +
3,
558 $dateEnd['d'] - 1, $dateEnd['Y']
563 if (!empty($this->_params
['group_bys']['membership_type_id']) &&
564 $typeID = $row['civicrm_membership_membership_type_id']
566 $typeUrl = "&tid_op=in&tid_value={$typeID}";
569 if (!empty($this->_params
['status_id_value'])) {
570 $statusUrl = "&sid_op=in&sid_value=" . implode(",", $this->_params
['status_id_value']);
572 $url = CRM_Report_Utils_Report
::getNextUrl('member/detail',
573 "reset=1&force=1&join_date_from={$dateStart}&join_date_to={$dateEnd}{$typeUrl}{$statusUrl}",
574 $this->_absoluteUrl
, $this->_id
, $this->_drilldownReport
576 $row['civicrm_membership_join_date_start'] = CRM_Utils_Date
::format($row['civicrm_membership_join_date_start']);
577 $rows[$rowNum]['civicrm_membership_join_date_start_link'] = $url;
578 $rows[$rowNum]['civicrm_membership_join_date_start_hover'] = ts("Lists Summary of Memberships for this date unit.");
583 // handle Membership Types
584 if (array_key_exists('civicrm_membership_membership_type_id', $row)) {
585 if ($value = $row['civicrm_membership_membership_type_id']) {
586 $value = explode(',', $value);
587 foreach ($value as $key => $id) {
588 $value[$key] = CRM_Member_PseudoConstant
::membershipType($id, FALSE);
590 $rows[$rowNum]['civicrm_membership_membership_type_id'] = implode(' , ', $value);
595 // make subtotals look nicer
596 if (array_key_exists('civicrm_membership_join_date_subtotal', $row) &&
597 !$row['civicrm_membership_join_date_subtotal']
599 $this->fixSubTotalDisplay($rows[$rowNum], $this->_statFields
);
602 elseif (array_key_exists('civicrm_membership_join_date_subtotal', $row) &&
603 $row['civicrm_membership_join_date_subtotal'] &&
604 !$row['civicrm_membership_membership_type_id']
606 $this->fixSubTotalDisplay($rows[$rowNum], $this->_statFields
, FALSE);
607 $rows[$rowNum]['civicrm_membership_membership_type_id'] = '<b>SubTotal</b>';
612 // If using campaigns, convert campaign_id to campaign title
613 if (array_key_exists('civicrm_membership_campaign_id', $row)) {
614 if ($value = $row['civicrm_membership_campaign_id']) {
615 $rows[$rowNum]['civicrm_membership_campaign_id'] = $this->activeCampaigns
[$value];
620 // skip looking further in rows, if first row itself doesn't
621 // have the column we need